ronin 2.0.5 → 2.1.0.rc1

data/man/ronin-strings.1.md

@@ -1,5 +1,9 @@
 # ronin-strings 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-strings - Prints all strings within a file/stream belonging to the given character set
+
 ## SYNOPSIS
 
 `ronin strings` [*options*] [*FILE* ...]
@@ -11,71 +15,71 @@ Prints all strings within a file/stream belonging to the given character set.
 ## ARGUMENTS
 
 *FILE*
-  The optional path to the file to scan.
+: The optional path to the file to scan.
 
 ## OPTIONS
 
 `-N`, `--numeric`
-  Searches for numeric characters (0-9).
+: Searches for numeric characters (0-9).
 
 `-O`, `--octal`
-  Searches for octal characters (0-7).
+: Searches for octal characters (0-7).
 `-X`, `--upper-hex`
-  Searches for uppercase hexadecimal (0-9, A-F).
+: Searches for uppercase hexadecimal (0-9, A-F).
 
 `-x`, `--lower-hex`
-  Searches for lowercase hexadecimal (0-9, a-f).
+: Searches for lowercase hexadecimal (0-9, a-f).
 
 `-H`, `--hex`
-  Searches for hexadecimal chars (0-9, a-f, A-F).
+: Searches for hexadecimal chars (0-9, a-f, A-F).
 
 `--upper-alpha`
-  Searches for uppercase alpha chars (A-Z).
+: Searches for uppercase alpha chars (A-Z).
 
 `--lower-alpha`
-  Searches for lowercase alpha chars (a-z).
+: Searches for lowercase alpha chars (a-z).
 
 `-A`, `--alpha`
-  Searches for alpha chars (a-z, A-Z).
+: Searches for alpha chars (a-z, A-Z).
 
 `--alpha-num`
-  Searches for alpha-numeric chars (a-z, A-Z, 0-9).
+: Searches for alpha-numeric chars (a-z, A-Z, 0-9).
 
 `-P`, `--punct`
-  Searches for punctuation chars.
+: Searches for punctuation chars.
 
 `-S`, `--symbols`
-  Searches for symbolic chars.
+: Searches for symbolic chars.
 
 `-s`, `--space`
-  Searches for all whitespace chars.
+: Searches for all whitespace chars.
 
 `-v`, `--visible`
-  Searches for all visible chars.
+: Searches for all visible chars.
 
 `-p`, `--printable`
-  Searches for all printable chars.
+: Searches for all printable chars.
 
 `-C`, `--control`
-  Searches for all control chars (\x00-\x1f, \x7f).
+: Searches for all control chars (\x00-\x1f, \x7f).
 
 `-a`, `--signed-ascii`
-  Searches for all signed ASCII chars (\x00-\x7f).
+: Searches for all signed ASCII chars (\x00-\x7f).
 
 `--ascii`
-  Searches for all ASCII chars (\x00-\xff).
+: Searches for all ASCII chars (\x00-\xff).
 
 `-c`, `--chars` *CHARS*
-  Searches for all chars in the custom char-set.
+: Searches for all chars in the custom char-set.
 
 `-i`, `--include-chars` *CHARS*
-  Include the additional chars to the char-set.
+: Include the additional chars to the char-set.
 
 `-e`, `--exclude-chars` *CHARS*
-  Exclude the additional chars from the char-set.
+: Exclude the additional chars from the char-set.
 
 `-n`, `--min-length` *LEN*
-  Minimum length of strings to print Defaults to 4.
+: Minimum length of strings to print Defaults to 4.
 
 ## AUTHOR
 
@@ -83,4 +87,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-extract(1)
+[ronin-extract](ronin-extract.1.md)

data/man/ronin-tips.1

@@ -1,35 +1,27 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-tips 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-tips \- Prints a random tip on how to use ronin
 .SH SYNOPSIS
-.LP
-.HP
+.PP
 \fBronin tips\fR \[lB]\fIoptions\fP\[rB]
-.LP
 .SH DESCRIPTION
-.LP
 .PP
 Prints a random tip for how to use \fBronin\fR\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB--list-categories\fR
+\fB\-\-list\-categories\fR
 Print all category names\.
-.LP
 .TP
-\fB-c\fR, \fB--category\fR \fICATEGORY\fP
+\fB\-c\fR, \fB\-\-category\fR \fICATEGORY\fP
 Prints a random tip from the given category\.
-.LP
 .TP
-\fB-s\fR, \fB--search\fR \fITEXT\fP
+\fB\-s\fR, \fB\-\-search\fR \fITEXT\fP
 Searches and prints all tips containing the given text\.
-.LP
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP

data/man/ronin-tips.1.md

@@ -1,5 +1,9 @@
 # ronin-tips 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-tips - Prints a random tip on how to use ronin
+
 ## SYNOPSIS
 
 `ronin tips` [*options*]
@@ -11,13 +15,13 @@ Prints a random tip for how to use `ronin`.
 ## OPTIONS
 
 `--list-categories`
-	Print all category names.
+: Print all category names.
 
 `-c`, `--category` *CATEGORY*
-	Prints a random tip from the given category.
+: Prints a random tip from the given category.
 
 `-s`, `--search` *TEXT*
-	Searches and prints all tips containing the given text.
+: Searches and prints all tips containing the given text.
 
 ## AUTHOR
 

data/man/ronin-tld-list.1

@@ -1,65 +1,49 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-tld-list 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-tld\-list \- Updates and parses the TLD list file
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin tld-list\fR \[lB]\fIoptions\fP\[rB]
-.LP
+.PP
+\fBronin tld\-list\fR \[lB]\fIoptions\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
 Updates and parses the TLD list file\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-v\fR, \fB--verbose\fR
+\fB\-v\fR, \fB\-\-verbose\fR
 Enables verbose output\.
-.LP
 .TP
-\fB-u\fR, \fB--update\fR
+\fB\-u\fR, \fB\-\-update\fR
 Updates the TLD list file\.
-.LP
 .TP
-\fB-U\fR, \fB--url\fR \fIURL\fP
+\fB\-U\fR, \fB\-\-url\fR \fIURL\fP
 The URL to the TLD list\. Defaults to
-\fBhttps://data.iana.org/TLD/tlds-alpha-by-domain.txt\fR\.
-.LP
+\fBhttps:\[sl]\[sl]data\.iana\.org\[sl]TLD\[sl]tlds\-alpha\-by\-domain\.txt\fR\.
 .TP
-\fB-p\fR, \fB--path\fR \fIFILE\fP
+\fB\-p\fR, \fB\-\-path\fR \fIFILE\fP
 The Path to the TLD list file\. Defaults to
-\fB~/.cache/ronin/ronin-support/tlds-alpha-by-domain.txt\fR if not given\.
-.LP
+\fB\[ti]\[sl]\.cache\[sl]ronin\[sl]ronin\-support\[sl]tlds\-alpha\-by\-domain\.txt\fR if not given\.
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information
-.LP
 .SH ENVIRONMENT
-.LP
 .TP
 \fIHOME\fP
 Alternate location for the user\[cq]s home directory\.
-.LP
 .TP
 \fIXDG\[ru]CONFIG\[ru]HOME\fP
-Alternate location for the \fB~/.config\fR directory\.
-.LP
+Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
 .SH FILES
-.LP
 .TP
-\fB~/.cache/ronin/ronin-support/tlds-alpha-by-domain.txt\fR
+\fB\[ti]\[sl]\.cache\[sl]ronin\[sl]ronin\-support\[sl]tlds\-alpha\-by\-domain\.txt\fR
 The location of the downloaded TLD list\.
-.LP
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-public\-suffix\-list(1)
+.BR ronin\-public\-suffix\-list (1)

data/man/ronin-tld-list.1.md

@@ -1,5 +1,9 @@
 # ronin-tld-list 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-tld-list - Updates and parses the TLD list file
+
 ## SYNOPSIS
 
 `ronin tld-list` [*options*]
@@ -11,34 +15,34 @@ Updates and parses the TLD list file.
 ## OPTIONS
 
 `-v`, `--verbose`
-  Enables verbose output.
+: Enables verbose output.
 
 `-u`, `--update`
-  Updates the TLD list file.
+: Updates the TLD list file.
 
 `-U`, `--url` *URL*
-  The URL to the TLD list. Defaults to
+: The URL to the TLD list. Defaults to
   `https://data.iana.org/TLD/tlds-alpha-by-domain.txt`.
 
 `-p`, `--path` *FILE*
-  The Path to the TLD list file. Defaults to
+: The Path to the TLD list file. Defaults to
   `~/.cache/ronin/ronin-support/tlds-alpha-by-domain.txt` if not given.
 
 `-h`, `--help`
-  Print help information
+: Print help information
 
 ## ENVIRONMENT
 
 *HOME*
-  Alternate location for the user's home directory.
+: Alternate location for the user's home directory.
 
 *XDG_CONFIG_HOME*
-  Alternate location for the `~/.config` directory.
+: Alternate location for the `~/.config` directory.
 
 ## FILES
 
 `~/.cache/ronin/ronin-support/tlds-alpha-by-domain.txt`
-  The location of the downloaded TLD list.
+: The location of the downloaded TLD list.
 
 ## AUTHOR
 
@@ -46,4 +50,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-public-suffix-list(1)
+[ronin-public-suffix-list](ronin-public-suffix-list.1.md)

data/man/ronin-typo.1

@@ -1,61 +1,47 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-typo 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-typo \- Generates typos in words
 .SH SYNOPSIS
-.LP
-.HP
+.PP
 \fBronin typo\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIWORD\fP \.\.\.\[rB]
-.LP
 .SH DESCRIPTION
-.LP
 .PP
 Generates typos in words\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fIWORD\fP
 The optional word to typo\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-f\fR, \fB--file\fR \fIFILE\fP
+\fB\-f\fR, \fB\-\-file\fR \fIFILE\fP
 Optional file to process\.
-.LP
 .TP
-\fB--omit-chars\fR
+\fB\-\-omit\-chars\fR
 Toggles whether to omit repeated characters\.
-.LP
 .TP
-\fB--repeat-chars\fR
+\fB\-\-repeat\-chars\fR
 Toggles whether to repeat single characters\.
-.LP
 .TP
-\fB--swap-chars\fR
+\fB\-\-swap\-chars\fR
 Toggles whether to swap certain common character pairs\.
-.LP
 .TP
-\fB--change-suffix\fR
+\fB\-\-change\-suffix\fR
 Toggles whether to change the suffix of words\.
-.LP
 .TP
-\fB-E\fR, \fB--enum\fR
+\fB\-E\fR, \fB\-\-enum\fR
 Enumerates over every possible typo of a word\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information\.
-.LP
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-bitflip(1) ronin\-homoglyph(1)
+.BR ronin\-bitflip (1)
+.BR ronin\-homoglyph (1)

data/man/ronin-typo.1.md

@@ -1,5 +1,9 @@
 # ronin-typo 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-typo - Generates typos in words
+
 ## SYNOPSIS
 
 `ronin typo` [*options*] [*WORD* ...]
@@ -11,30 +15,30 @@ Generates typos in words.
 ## ARGUMENTS
 
 *WORD*
-  The optional word to typo.
+: The optional word to typo.
 
 ## OPTIONS
 
 `-f`, `--file` *FILE*
-  Optional file to process.
+: Optional file to process.
 
 `--omit-chars`
-  Toggles whether to omit repeated characters.
+: Toggles whether to omit repeated characters.
 
 `--repeat-chars`
-  Toggles whether to repeat single characters.
+: Toggles whether to repeat single characters.
 
 `--swap-chars`
-  Toggles whether to swap certain common character pairs.
+: Toggles whether to swap certain common character pairs.
 
 `--change-suffix`
-  Toggles whether to change the suffix of words.
+: Toggles whether to change the suffix of words.
 
 `-E`, `--enum`
-  Enumerates over every possible typo of a word.
+: Enumerates over every possible typo of a word.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
 
 ## AUTHOR
 
@@ -42,4 +46,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-bitflip(1) ronin-homoglyph(1)
+[ronin-bitflip](ronin-bitflip.1.md) [ronin-homoglyph](ronin-homoglyph.1.md)

data/man/ronin-typosquat.1

@@ -1,69 +1,52 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-typosquat 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-typosquat \- Finds typo squatted domains
 .SH SYNOPSIS
-.LP
-.HP
+.PP
 \fBronin typosquat\fR \[lB]\fIoptions\fP\[rB] \[lB]DOMAIN \.\.\.\[rB]
-.LP
 .SH DESCRIPTION
-.LP
 .PP
 Finds typo squatted domains\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fIDOMAIN\fP
 A domain to check for typo squats\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-f\fR, \fB--file\fR \fIFILE\fP
+\fB\-f\fR, \fB\-\-file\fR \fIFILE\fP
 Optional file to read domains from\.
-.LP
 .TP
-\fB--omit-chars\fR
+\fB\-\-omit\-chars\fR
 Toggles whether to omit repeated characters\.
-.LP
 .TP
-\fB--repeat-chars\fR
+\fB\-\-repeat\-chars\fR
 Toggles whether to repeat single characters\.
-.LP
 .TP
-\fB--swap-chars\fR
+\fB\-\-swap\-chars\fR
 Toggles whether to swap certain common character pairs\.
-.LP
 .TP
-\fB--change-suffix\fR
+\fB\-\-change\-suffix\fR
 Toggles whether to change the suffix of words\.
-.LP
 .TP
-\fB-A\fR, \fB--has-addresses\fR
+\fB\-A\fR, \fB\-\-has\-addresses\fR
 Print typo squat domains with addresses\.
-.LP
 .TP
-\fB-r\fR, \fB--registered\fR
+\fB\-r\fR, \fB\-\-registered\fR
 Print typo squat domains that are already registered\.
-.LP
 .TP
-\fB-u\fR, \fB--unregistered\fR
+\fB\-u\fR, \fB\-\-unregistered\fR
 Print typo squat domains that can be registered\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information\.
-.LP
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-typo(1)
+.BR ronin\-typo (1)

data/man/ronin-typosquat.1.md

@@ -1,5 +1,9 @@
 # ronin-typosquat 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-typosquat - Finds typo squatted domains
+
 ## SYNOPSIS
 
 `ronin typosquat` [*options*] [DOMAIN ...]
@@ -11,36 +15,36 @@ Finds typo squatted domains.
 ## ARGUMENTS
 
 *DOMAIN*
-  A domain to check for typo squats.
+: A domain to check for typo squats.
 
 ## OPTIONS
 
 `-f`, `--file` *FILE*
-  Optional file to read domains from.
+: Optional file to read domains from.
 
 `--omit-chars`
-  Toggles whether to omit repeated characters.
+: Toggles whether to omit repeated characters.
 
 `--repeat-chars`
-  Toggles whether to repeat single characters.
+: Toggles whether to repeat single characters.
 
 `--swap-chars`
-  Toggles whether to swap certain common character pairs.
+: Toggles whether to swap certain common character pairs.
 
 `--change-suffix`
-  Toggles whether to change the suffix of words.
+: Toggles whether to change the suffix of words.
 
 `-A`, `--has-addresses`
-  Print typo squat domains with addresses.
+: Print typo squat domains with addresses.
 
 `-r`, `--registered`
-  Print typo squat domains that are already registered.
+: Print typo squat domains that are already registered.
 
 `-u`, `--unregistered`
-  Print typo squat domains that can be registered.
+: Print typo squat domains that can be registered.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
 
 ## AUTHOR
 
@@ -48,4 +52,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-typo(1)
+[ronin-typo](ronin-typo.1.md)

data/man/ronin-unarchive.1.md

@@ -0,0 +1,41 @@
+# ronin-unarchive 1 "2024-01-18" Ronin "User Manuals"
+
+## NAME
+
+ronin-unarchive - Unarchive the file(s).
+
+## SYNOPSIS
+
+`ronin unarchive` [*options*] *FILE* ...
+
+## DESCRIPTION
+
+Unarchive one or more `.tar` or `.zip` files.
+
+## ARGUMENTS
+
+*FILE*
+: A file to unarchive.
+
+## OPTIONS
+
+`-f`, `--format` `tar`\|`zip`
+: Explicit archive format
+
+## EXAMPLES
+
+Archive the file using tar:
+
+    $ ronin unarchive foo.tar
+
+Archive the file using explicit format:
+
+    $ ronin unarchive -f zip foo.jar
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+[ronin-archive](ronin-archive.1.md)