Skip to content

Commit

Permalink
Normalize some of the option summaries.
Browse files Browse the repository at this point in the history
  • Loading branch information
@postmodern
postmodern committed Nov 23, 2024
1 parent 21720c2 commit 5456da6
Show file tree
Hide file tree
Showing 12 changed files with 61 additions and 61 deletions.
8 changes: 4 additions & 4 deletions lib/ronin/cli/commands/decode.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ module Commands
# -u, --uri URI decodes the data
# --http HTTP decodes the data
# -j, --js JavaScript decodes the data
# -S, --shell Encodes the data as a Shell String
# -P, --powershell Encodes the data as a PowerShell String
# -S, --shell Encodes the data as a Shell string
# -P, --powershell Encodes the data as a PowerShell string
# --punycode Decodes the data as Punycode
# -Q, --quoted-printable Decodes the data as Quoted Printable
# -R, --ruby Ruby decodes the data
Expand Down Expand Up @@ -136,13 +136,13 @@ class Decode < StringMethodsCommand
end

option :shell, short: '-S',
desc: 'Decodes the data as a Shell String' do
desc: 'Decodes the data as a Shell string' do
require 'ronin/support/encoding/shell'
@method_calls << :shell_decode
end

option :powershell, short: '-P',
desc: 'Decodes the data as a PowerShell String' do
desc: 'Decodes the data as a PowerShell string' do
require 'ronin/support/encoding/powershell'
@method_calls << :powershell_decode
end
Expand Down
12 changes: 6 additions & 6 deletions lib/ronin/cli/commands/encode.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ module Commands
# -u, --uri URI encodes the data
# --http HTTP encodes the data
# -j, --js JavaScript encodes the data
# -S, --shell Encodes the data as a Shell String
# -P, --powershell Encodes the data as a PowerShell String
# -S, --shell Encodes the data as a Shell string
# -P, --powershell Encodes the data as a PowerShell string
# --punycode Encodes the data as Punycode
# -Q, --quoted-printable Encodes the data as Quoted Printable
# -R, --ruby Encodes the data as a Ruby String
# -R, --ruby Encodes the data as a Ruby string
# --uuencode uuencodes the data
# -x, --xml XML encodes the data
# -h, --help Print help information
Expand Down Expand Up @@ -136,13 +136,13 @@ class Encode < StringMethodsCommand
end

option :shell, short: '-S',
desc: 'Encodes the data as a Shell String' do
desc: 'Encodes the data as a Shell string' do
require 'ronin/support/encoding/shell'
@method_calls << :shell_encode
end

option :powershell, short: '-P',
desc: 'Encodes the data as a PowerShell String' do
desc: 'Encodes the data as a PowerShell string' do
require 'ronin/support/encoding/powershell'
@method_calls << :powershell_encode
end
Expand All @@ -159,7 +159,7 @@ class Encode < StringMethodsCommand
end

option :ruby, short: '-R',
desc: 'Encodes the data as a Ruby String' do
desc: 'Encodes the data as a Ruby string' do
require 'ronin/support/encoding/ruby'
@method_calls << :ruby_encode
end
Expand Down
12 changes: 6 additions & 6 deletions lib/ronin/cli/commands/escape.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ module Commands
# -u, --uri URI escapes the data
# --http HTTP escapes the data
# -j, --js JavaScript escapes the data
# -S, --shell Escapes the data as a Shell String
# -P, --powershell Escapes the data as a PowerShell String
# -S, --shell Escapes the data as a Shell string
# -P, --powershell Escapes the data as a PowerShell string
# -Q, --quoted-printable Escapes the data as Quoted Printable
# -R, --ruby Escapes the data as a Ruby String
# -R, --ruby Escapes the data as a Ruby string
# -x, --xml XML escapes the data
# -h, --help Print help information
#
Expand Down Expand Up @@ -89,13 +89,13 @@ class Escape < StringMethodsCommand
end

option :shell, short: '-S',
desc: 'Escapes the data as a Shell String' do
desc: 'Escapes the data as a Shell string' do
require 'ronin/support/encoding/shell'
@method_calls << :shell_escape
end

option :powershell, short: '-P',
desc: 'Escapes the data as a PowerShell String' do
desc: 'Escapes the data as a PowerShell string' do
require 'ronin/support/encoding/powershell'
@method_calls << :powershell_escape
end
Expand All @@ -107,7 +107,7 @@ class Escape < StringMethodsCommand
end

option :ruby, short: '-R',
desc: 'Escapes the data as a Ruby String' do
desc: 'Escapes the data as a Ruby string' do
require 'ronin/support/encoding/ruby'
@method_calls << :ruby_escape
end
Expand Down
16 changes: 8 additions & 8 deletions lib/ronin/cli/commands/quote.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ module Commands
# -n, --keep-newlines Preserves newlines at the end of each line
# -X, --hex Quotes the data as a Hex string
# -c, --c Quotes the data as a C string
# -j, --js JavaScript quotes the data
# -S, --shell Quotes the data as a Shell String
# -P, --powershell Quotes the data as a PowerShell String
# -R, --ruby Quotes the data as a Ruby String
# -j, --js Quotes the data as a JavaScript string
# -S, --shell Quotes the data as a Shell string
# -P, --powershell Quotes the data as a PowerShell string
# -R, --ruby Quotes the data as a Ruby string
# -h, --help Print help information
#
# ## Arguments
Expand All @@ -61,25 +61,25 @@ class Quote < StringMethodsCommand
end

option :js, short: '-j',
desc: 'JavaScript quotes the data' do
desc: 'Quotes the data as a JavaScript string' do
require 'ronin/support/encoding/js'
@method_calls << :js_string
end

option :shell, short: '-S',
desc: 'Quotes the data as a Shell String' do
desc: 'Quotes the data as a Shell string' do
require 'ronin/support/encoding/shell'
@method_calls << :shell_string
end

option :powershell, short: '-P',
desc: 'Quotes the data as a PowerShell String' do
desc: 'Quotes the data as a PowerShell string' do
require 'ronin/support/encoding/powershell'
@method_calls << :powershell_string
end

option :ruby, short: '-R',
desc: 'Quotes the data as a Ruby String' do
desc: 'Quotes the data as a Ruby string' do
require 'ronin/support/encoding/ruby'
@method_calls << :ruby_string
end
Expand Down
12 changes: 6 additions & 6 deletions lib/ronin/cli/commands/unescape.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ module Commands
# -u, --uri URI unescapes the data
# --http HTTP unescapes the data
# -j, --js JavaScript unescapes the data
# -S, --shell Unescapes the data as a Shell String
# -P, --powershell Unescapes the data as a PowerShell String
# -R, --ruby Unescapes the data as a Ruby String
# -S, --shell Unescapes the data as a Shell string
# -P, --powershell Unescapes the data as a PowerShell string
# -R, --ruby Unescapes the data as a Ruby string
# -Q, --quoted-printable Unescapes the data as Quoted Printable
# -x, --xml XML unescapes the data
# -h, --help Print help information
Expand Down Expand Up @@ -89,13 +89,13 @@ class Unescape < StringMethodsCommand
end

option :shell, short: '-S',
desc: 'Unescapes the data as a Shell String' do
desc: 'Unescapes the data as a Shell string' do
require 'ronin/support/encoding/shell'
@method_calls << :shell_unescape
end

option :powershell, short: '-P',
desc: 'Unescapes the data as a PowerShell String' do
desc: 'Unescapes the data as a PowerShell string' do
require 'ronin/support/encoding/powershell'
@method_calls << :powershell_unescape
end
Expand All @@ -107,7 +107,7 @@ class Unescape < StringMethodsCommand
end

option :ruby, short: '-R',
desc: 'Unescapes the data as a Ruby String' do
desc: 'Unescapes the data as a Ruby string' do
require 'ronin/support/encoding/ruby'
@method_calls << :ruby_unescape
end
Expand Down
16 changes: 8 additions & 8 deletions lib/ronin/cli/commands/unquote.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ module Commands
# -n, --keep-newlines Preserves newlines at the end of each line
# -X, --hex Unquotes the Hex string
# -c, --c Unquotes the C string
# -j, --js Unquotes the JavaScript String
# -S, --shell Unquotes the Shell String
# -P, --powershell Unquotes the PowerShell String
# -R, --ruby Unquotes the Ruby String
# -j, --js Unquotes the JavaScript string
# -S, --shell Unquotes the Shell string
# -P, --powershell Unquotes the PowerShell string
# -R, --ruby Unquotes the Ruby string
# -h, --help Print help information
#
# ## Arguments
Expand All @@ -61,25 +61,25 @@ class Unquote < StringMethodsCommand
end

option :js, short: '-j',
desc: 'Unquotes the JavaScript String' do
desc: 'Unquotes the JavaScript string' do
require 'ronin/support/encoding/js'
@method_calls << :js_unquote
end

option :shell, short: '-S',
desc: 'Unquotes the Shell String' do
desc: 'Unquotes the Shell string' do
require 'ronin/support/encoding/shell'
@method_calls << :shell_unquote
end

option :powershell, short: '-P',
desc: 'Unquotes the PowerShell String' do
desc: 'Unquotes the PowerShell string' do
require 'ronin/support/encoding/powershell'
@method_calls << :powershell_unquote
end

option :ruby, short: '-R',
desc: 'Unquotes the Ruby String' do
desc: 'Unquotes the Ruby string' do
require 'ronin/support/encoding/ruby'
@method_calls << :ruby_unquote
end
Expand Down
6 changes: 3 additions & 3 deletions man/ronin-decode.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@ Decodes each character of the given data from a variety of formats.
: JavaScript decodes the data.

`-S`, `--shell`
: Decodes the data as a Shell String.
: Decodes the data as a Shell string.

`-P`, `--powershell`
: Decodes the data as a PowerShell String.
: Decodes the data as a PowerShell string.

`--punycode`
: Decodes the data as Punycode.
Expand All @@ -96,4 +96,4 @@ Postmodern <[email protected]>

## SEE ALSO

[ronin-encode](ronin-encode.1.md)
[ronin-encode](ronin-encode.1.md)
6 changes: 3 additions & 3 deletions man/ronin-encode.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@ Encodes each character of the given data into a variety of formats.
: JavaScript encodes the data.

`-S`, `--shell`
: Encodes the data as a Shell String.
: Encodes the data as a Shell string.

`-P`, `--powershell`
: Encodes the data as a PowerShell String.
: Encodes the data as a PowerShell string.

`--punycode`
: Encodes the data as Punycode.
Expand All @@ -82,7 +82,7 @@ Encodes each character of the given data into a variety of formats.
: uuencodes the data.

`-R`, `--ruby`
: Encodes the data as a Ruby String.
: Encodes the data as a Ruby string.

`-x`, `--xml`
: XML encodes the data.
Expand Down
8 changes: 4 additions & 4 deletions man/ronin-escape.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,16 +51,16 @@ Escapes each special character for a variety of encodings.
: JavaScript escapes the data.

`-S`, `--shell`
: Escapes the data as a Shell String.
: Escapes the data as a Shell string.

`-P`, `--powershell`
: Escapes the data as a PowerShell String.
: Escapes the data as a PowerShell string.

`-Q`, `--quoted-printable`
: Escapes the data as Quoted Printable.

`-R`, `--ruby`
: Escapes the data as a Ruby String.
: Escapes the data as a Ruby string.

`-x`, `--xml`
: XML escapes the data.
Expand All @@ -74,4 +74,4 @@ Postmodern <[email protected]>

## SEE ALSO

[ronin-unescape](ronin-unescape.1.md)
[ronin-unescape](ronin-unescape.1.md)
10 changes: 5 additions & 5 deletions man/ronin-quote.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,16 @@ Produces quoted a string for a variety of programming languages.
: Quotes the data as a C string.

`-j`, `--js`
: quotes the data as a JavaScript string.
: Quotes the data as a JavaScript string.

`-S`, `--shell`
: Quotes the data as a Shell String.
: Quotes the data as a Shell string.

`-P`, `--powershell`
: Quotes the data as a PowerShell String.
: Quotes the data as a PowerShell string.

`-R`, `--ruby`
: Quotes the data as a Ruby String.
: Quotes the data as a Ruby string.

`-h`, `--help`
: Print help information.
Expand All @@ -59,4 +59,4 @@ Postmodern <[email protected]>

## SEE ALSO

[ronin-unquote](ronin-unquote.1.md)
[ronin-unquote](ronin-unquote.1.md)
8 changes: 4 additions & 4 deletions man/ronin-unescape.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,16 +51,16 @@ Unescapes each escaped character from a variety of encodings.
: JavaScript unescapes the data.

`-S`, `--shell`
: Unescapes the data as a Shell String.
: Unescapes the data as a Shell string.

`-P`, `--powershell`
: Unescapes the data as a PowerShell String.
: Unescapes the data as a PowerShell string.

`-Q`, `--quoted-printable`
: Unescapes the data as Quoted Printable.

`-R`, `--ruby`
: Unescapes the data as a Ruby String.
: Unescapes the data as a Ruby string.

`-x`, `--xml`
: XML unescapes the data.
Expand All @@ -74,4 +74,4 @@ Postmodern <[email protected]>

## SEE ALSO

[ronin-escape](ronin-escape.1.md)
[ronin-escape](ronin-escape.1.md)
8 changes: 4 additions & 4 deletions man/ronin-unquote.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,16 @@ Unquotes a double/single quoted string.
: Unquotes the C string.

`-j`, `--js`
: Unquotes the JavaScript String.
: Unquotes the JavaScript string.

`-S`, `--shell`
: Unquotes the Shell string.

`-P`, `--powershell`
: Unquotes the PowerShell String.
: Unquotes the PowerShell string.

`-R`, `--ruby`
: Unquotes the Ruby String.
: Unquotes the Ruby string.

`-h`, `--help`
: Print help information.
Expand All @@ -59,4 +59,4 @@ Postmodern <[email protected]>

## SEE ALSO

[ronin-quote](ronin-quote.1.md)
[ronin-quote](ronin-quote.1.md)

0 comments on commit 5456da6

Please sign in to comment.