Skip to content

Commit

Permalink
Updated to kramdown-man 1.0.0 (closes #95)
Browse files Browse the repository at this point in the history
  • Loading branch information
postmodern committed Dec 4, 2023
1 parent f961196 commit dddfd37
Show file tree
Hide file tree
Showing 11 changed files with 59 additions and 59 deletions.
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
20 changes: 10 additions & 10 deletions man/ronin-payloads-build.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,38 +11,38 @@ 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

Postmodern <[email protected]>

## 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)
14 changes: 7 additions & 7 deletions man/ronin-payloads-encode.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,29 +11,29 @@ 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

Postmodern <[email protected]>

## 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)
8 changes: 4 additions & 4 deletions man/ronin-payloads-encoder.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,20 @@ 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

Postmodern <[email protected]>

## 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)
6 changes: 3 additions & 3 deletions man/ronin-payloads-encoders.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@ 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

Postmodern <[email protected]>

## 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)
4 changes: 2 additions & 2 deletions man/ronin-payloads-irb.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ Starts an interactive Ruby shell with `ronin/payloads` loaded.
## OPTIONS

`-h`, `--help`
Print help information
: Print help information

## AUTHOR

Postmodern <[email protected]>

## SEE ALSO

ronin-payloads(1)
[ronin-payloads](ronin-payloads.1.md)
10 changes: 5 additions & 5 deletions man/ronin-payloads-launch.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,23 @@ 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

Postmodern <[email protected]>

## 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)
6 changes: 3 additions & 3 deletions man/ronin-payloads-list.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@ 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

Postmodern <[email protected]>

## 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)
18 changes: 9 additions & 9 deletions man/ronin-payloads-new.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,36 +11,36 @@ 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

Postmodern <[email protected]>

## 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)
10 changes: 5 additions & 5 deletions man/ronin-payloads-show.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,23 @@ 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

Postmodern <[email protected]>

## 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)
20 changes: 10 additions & 10 deletions man/ronin-payloads.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,40 +11,40 @@ 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

Postmodern <[email protected]>

## 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)

0 comments on commit dddfd37

Please sign in to comment.