From dddfd37729f66b987a68b83aaa0ec4b708c1ae93 Mon Sep 17 00:00:00 2001 From: Postmodern Date: Mon, 4 Dec 2023 13:22:40 -0800 Subject: [PATCH] Updated to `kramdown-man` 1.0.0 (closes #95) --- Gemfile | 2 +- man/ronin-payloads-build.1.md | 20 ++++++++++---------- man/ronin-payloads-encode.1.md | 14 +++++++------- man/ronin-payloads-encoder.1.md | 8 ++++---- man/ronin-payloads-encoders.1.md | 6 +++--- man/ronin-payloads-irb.1.md | 4 ++-- man/ronin-payloads-launch.1.md | 10 +++++----- man/ronin-payloads-list.1.md | 6 +++--- man/ronin-payloads-new.1.md | 18 +++++++++--------- man/ronin-payloads-show.1.md | 10 +++++----- man/ronin-payloads.1.md | 20 ++++++++++---------- 11 files changed, 59 insertions(+), 59 deletions(-) diff --git a/Gemfile b/Gemfile index 844a22b0..36e508d0 100644 --- a/Gemfile +++ b/Gemfile @@ -35,7 +35,7 @@ group :development do gem 'simplecov', '~> 0.20' gem 'kramdown', '~> 2.0' - gem 'kramdown-man', '~> 0.1' + gem 'kramdown-man', '~> 1.0' gem 'redcarpet', platform: :mri gem 'yard', '~> 0.9' diff --git a/man/ronin-payloads-build.1.md b/man/ronin-payloads-build.1.md index 38245276..1a903ae0 100644 --- a/man/ronin-payloads-build.1.md +++ b/man/ronin-payloads-build.1.md @@ -11,33 +11,33 @@ Loads and builds a payload. ## ARGUMENTS *NAME* - The name of the payload to load. +: The name of the payload to load. ## OPTIONS `-f`, `--file` *FILE* - Optionally loads the payload from the file. +: Optionally loads the payload from the file. `-F`, `--format` `hex`\|`c`\|`shell`\|`powershell`\|`xml`\|`html`\|`js`\|`ruby` - Formats the built payload for another programming language. +: Formats the built payload for another programming language. `-p`, `--param` *NAME*`=`*VALUE* - Sets a param for the payload. +: Sets a param for the payload. `-o`, `--output` *FILE* - Writes the built payload to the given file instead of printing it to stdout. +: Writes the built payload to the given file instead of printing it to stdout. `-e`, `--encoder` *ENCODER* - Adds the encoder to the payload's encoder pipeline. +: Adds the encoder to the payload's encoder pipeline. `--encoder-param` *ENCODER*`.`*NAME*`.`*VALUE* - Sets a param on the given encoder. +: Sets a param on the given encoder. `-D`, `--debug` - Enables debugging messages. +: Enables debugging messages. `-h`, `--help` - Print help information +: Print help information ## AUTHOR @@ -45,4 +45,4 @@ Postmodern ## SEE ALSO -ronin-payloads-list(1) ronin-payloads-show(1) ronin-payloads-launch(1) +[ronin-payloads-list](ronin-payloads-list.1.md) [ronin-payloads-show](ronin-payloads-show.1.md) [ronin-payloads-launch](ronin-payloads-launch.1.md) \ No newline at end of file diff --git a/man/ronin-payloads-encode.1.md b/man/ronin-payloads-encode.1.md index c017cd93..27f995bc 100644 --- a/man/ronin-payloads-encode.1.md +++ b/man/ronin-payloads-encode.1.md @@ -11,24 +11,24 @@ Encodes data using one or more encoders. ## ARGUMENTS *FILE* - The optional file to read the data to encode from. +: The optional file to read the data to encode from. ## OPTIONS `-F`, `--format` `hex`\|`c`\|`shell`\|`powershell`\|`xml`\|`html`\|`js`\|`ruby` - Formats the encoded data. +: Formats the encoded data. `-E`, `--encode` *ENCODER* - Loads the encoder with the given name. +: Loads the encoder with the given name. `-p`, `--param` *ENCODER*`.`*NAME*`=`*VALUE* - Sets a param on one of the loaded encoders. +: Sets a param on one of the loaded encoders. `-s`, `--string` *STRING* - Encodes the given string. +: Encodes the given string. `-h`, `--help` - Print help information +: Print help information ## AUTHOR @@ -36,4 +36,4 @@ Postmodern ## SEE ALSO -ronin-payloads-encoders(1) ronin-payloads-encoder(1) +[ronin-payloads-encoders](ronin-payloads-encoders.1.md) [ronin-payloads-encoder](ronin-payloads-encoder.1.md) \ No newline at end of file diff --git a/man/ronin-payloads-encoder.1.md b/man/ronin-payloads-encoder.1.md index 503f8464..5b46a370 100644 --- a/man/ronin-payloads-encoder.1.md +++ b/man/ronin-payloads-encoder.1.md @@ -11,15 +11,15 @@ Prints information about a particular payload encoder. ## ARGUMENTS *NAME* - The name of the payload encoder to load. +: The name of the payload encoder to load. ## OPTIONS `-f`, `--file` *FILE* - The optional file to load the payload encoder from. +: The optional file to load the payload encoder from. `-h`, `--help` - Print help information +: Print help information ## AUTHOR @@ -27,4 +27,4 @@ Postmodern ## SEE ALSO -ronin-payloads-encoders(1) ronin-payloads-encode(1) +[ronin-payloads-encoders](ronin-payloads-encoders.1.md) [ronin-payloads-encode](ronin-payloads-encode.1.md) \ No newline at end of file diff --git a/man/ronin-payloads-encoders.1.md b/man/ronin-payloads-encoders.1.md index ecfa381f..dd96060b 100644 --- a/man/ronin-payloads-encoders.1.md +++ b/man/ronin-payloads-encoders.1.md @@ -11,12 +11,12 @@ Lists available payload encoders. ## ARGUMENTS *DIR* - The optional directory to list encoders from. +: The optional directory to list encoders from. ## OPTIONS `-h`, `--help` - Print help information +: Print help information ## AUTHOR @@ -24,4 +24,4 @@ Postmodern ## SEE ALSO -ronin-payloads-encoder(1) ronin-payloads-encode(1) +[ronin-payloads-encoder](ronin-payloads-encoder.1.md) [ronin-payloads-encode](ronin-payloads-encode.1.md) \ No newline at end of file diff --git a/man/ronin-payloads-irb.1.md b/man/ronin-payloads-irb.1.md index 4311ec13..68ad4615 100644 --- a/man/ronin-payloads-irb.1.md +++ b/man/ronin-payloads-irb.1.md @@ -11,7 +11,7 @@ Starts an interactive Ruby shell with `ronin/payloads` loaded. ## OPTIONS `-h`, `--help` - Print help information +: Print help information ## AUTHOR @@ -19,4 +19,4 @@ Postmodern ## SEE ALSO -ronin-payloads(1) +[ronin-payloads](ronin-payloads.1.md) \ No newline at end of file diff --git a/man/ronin-payloads-launch.1.md b/man/ronin-payloads-launch.1.md index b4d73575..ee0995f9 100644 --- a/man/ronin-payloads-launch.1.md +++ b/man/ronin-payloads-launch.1.md @@ -11,18 +11,18 @@ Launches a payload. ## ARGUMENTS *NAME* - The name of the payload to load. +: The name of the payload to load. ## OPTIONS `-f`, `--file` *FILE* - Optionally loads the payload from the file. +: Optionally loads the payload from the file. `-D`, `--debug` - Enables debugging messages. +: Enables debugging messages. `-h`, `--help` - Print help information +: Print help information ## AUTHOR @@ -30,4 +30,4 @@ Postmodern ## SEE ALSO -ronin-payloads-list(1) ronin-payloads-show(1) ronin-payloads-build(1) +[ronin-payloads-list](ronin-payloads-list.1.md) [ronin-payloads-show](ronin-payloads-show.1.md) [ronin-payloads-build](ronin-payloads-build.1.md) \ No newline at end of file diff --git a/man/ronin-payloads-list.1.md b/man/ronin-payloads-list.1.md index 58226bb7..e0ccef1d 100644 --- a/man/ronin-payloads-list.1.md +++ b/man/ronin-payloads-list.1.md @@ -11,12 +11,12 @@ Lists available payloads. ## ARGUMENTS *DIR* - The optional directory to list payloads from. +: The optional directory to list payloads from. ## OPTIONS `-h`, `--help` - Print help information +: Print help information ## AUTHOR @@ -24,4 +24,4 @@ Postmodern ## SEE ALSO -ronin-payloads-show(1) ronin-payloads-build(1) ronin-payloads-launch(1) +[ronin-payloads-show](ronin-payloads-show.1.md) [ronin-payloads-build](ronin-payloads-build.1.md) [ronin-payloads-launch](ronin-payloads-launch.1.md) \ No newline at end of file diff --git a/man/ronin-payloads-new.1.md b/man/ronin-payloads-new.1.md index 318d6630..e8cdce2a 100644 --- a/man/ronin-payloads-new.1.md +++ b/man/ronin-payloads-new.1.md @@ -11,31 +11,31 @@ Generates a new payload file. ## ARGUMENTS *PATH* - The path to the new payload file to generate. +: The path to the new payload file to generate. ## OPTIONS `-t`, `--type` `asm`\|`shellcode`\|`c`\|`go`\|`rust`\|`command`\|`shell`\|`powershell`\|`html`\|`javascript`\|`typescript`\|`java`\|`sql`\|`php`\|`python`\|`ruby`\|`nodejs` - The type of payload to generate. +: The type of payload to generate. `-a`, `--author` *NAME* - The name of the author. Defaults to the configured git author name or the +: The name of the author. Defaults to the configured git author name or the `USERNAME` environment variable. `-e`, `--author-email` *EMAIL* - The email address of the author. Defaults to the configured git author email. +: The email address of the author. Defaults to the configured git author email. `-S`, `--summary` *TEXT* - The summary text for the new payload. +: The summary text for the new payload. `-D`, `--description` *TEXT* - The description text for the new payload. +: The description text for the new payload. `-R`, `--reference` *URL* - Adds a reference URL to the new payload. +: Adds a reference URL to the new payload. `-h`, `--help` - Print help information +: Print help information ## AUTHOR @@ -43,4 +43,4 @@ Postmodern ## SEE ALSO -ronin-payloads-list(1) ronin-payloads-show(1) ronin-payloads-build(1) ronin-payloads-launch(1) +[ronin-payloads-list](ronin-payloads-list.1.md) [ronin-payloads-show](ronin-payloads-show.1.md) [ronin-payloads-build](ronin-payloads-build.1.md) [ronin-payloads-launch](ronin-payloads-launch.1.md) diff --git a/man/ronin-payloads-show.1.md b/man/ronin-payloads-show.1.md index 97130332..e72949ff 100644 --- a/man/ronin-payloads-show.1.md +++ b/man/ronin-payloads-show.1.md @@ -11,18 +11,18 @@ Prints information about a payload. ## ARGUMENTS *NAME* - The name of the payload to load. +: The name of the payload to load. ## OPTIONS `-v`, `--verbose` - Prints additional information about the payload. +: Prints additional information about the payload. `-f`, `--file` *FILE* - Optionally loads the payload from the file. +: Optionally loads the payload from the file. `-h`, `--help` - Print help information +: Print help information ## AUTHOR @@ -30,4 +30,4 @@ Postmodern ## SEE ALSO -ronin-payloads-list(1) ronin-payloads-build(1) ronin-payloads-launch(1) +[ronin-payloads-list](ronin-payloads-list.1.md) [ronin-payloads-build](ronin-payloads-build.1.md) [ronin-payloads-launch](ronin-payloads-launch.1.md) \ No newline at end of file diff --git a/man/ronin-payloads.1.md b/man/ronin-payloads.1.md index 912d9534..df53e9a5 100644 --- a/man/ronin-payloads.1.md +++ b/man/ronin-payloads.1.md @@ -11,35 +11,35 @@ Runs a `ronin-payloads` *COMMAND*. ## ARGUMENTS *COMMAND* - The `ronin-payloads` command to execute. +: The `ronin-payloads` command to execute. ## OPTIONS `-h`, `--help` - Print help information +: Print help information ## COMMANDS `build` - Builds a payload. +: Builds a payload. `encode` - Encodes a payload with one or more payload encoders. +: Encodes a payload with one or more payload encoders. `encoders` - Lists available encoders. +: Lists available encoders. `irb` - Starts ronin-payload's interactive Ruby shell. +: Starts ronin-payload's interactive Ruby shell. `launch` - Launches a payload. +: Launches a payload. `list` - Lists available payloads. +: Lists available payloads. `help` - Lists available commands or shows help about a specific command. +: Lists available commands or shows help about a specific command. ## AUTHOR @@ -47,4 +47,4 @@ Postmodern ## SEE ALSO -ronin-payloads-irb(1) ronin-payloads-build(1) ronin-payloads-encode(1) ronin-payloads-encoders(1) ronin-payloads-launch(1) ronin-payloads-list(1) +[ronin-payloads-irb](ronin-payloads-irb.1.md) [ronin-payloads-build](ronin-payloads-build.1.md) [ronin-payloads-encode](ronin-payloads-encode.1.md) [ronin-payloads-encoders](ronin-payloads-encoders.1.md) [ronin-payloads-launch](ronin-payloads-launch.1.md) [ronin-payloads-list](ronin-payloads-list.1.md)