ronin 2.0.4 → 2.1.0.rc1

data/man/ronin-dns.1

@@ -1,45 +1,34 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-dns 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-dns \- Performs a variety of DNS queries
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin dns\fR \[lB]\fIoptions\fP\[rB] \[lC]\fIHOST\fP \.\.\. \[or] \fB--file\fR \fIFILE\fP\[rC]
-.LP
+.PP
+\fBronin dns\fR \[lB]\fIoptions\fP\[rB] \[lC]\fIHOST\fP \.\.\. \[or] \fB\-\-file\fR \fIFILE\fP\[rC]
 .SH DESCRIPTION
-.LP
 .PP
 Queries DNS records for the given host name\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fIHOST\fP
 A host name argument to query\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-f\fR, \fB--file\fR \fIFILE\fP
+\fB\-f\fR, \fB\-\-file\fR \fIFILE\fP
 The optional file to read values from\.
-.LP
 .TP
-\fB-N\fR, \fB--nameserver\fR \fIHOST\fP\[or]\fIIP\fP
+\fB\-N\fR, \fB\-\-nameserver\fR \fIHOST\fP\[or]\fIIP\fP
 Send DNS queries to the nameserver\.
-.LP
 .TP
-\fB-t\fR, \fB--type\fR \fBA|AAAA|ANY|CNAME|HINFO|LOC|MINFO|MX|NS|PTR|SOA|SRV|TXT|WKS\fR
+\fB\-t\fR, \fB\-\-type\fR \fBA\[or]AAAA\[or]ANY\[or]CNAME\[or]HINFO\[or]LOC\[or]MINFO\[or]MX\[or]NS\[or]PTR\[or]SOA\[or]SRV\[or]TXT\[or]WKS\fR
 The type of record to query\.
-.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

data/man/ronin-dns.1.md

@@ -1,5 +1,9 @@
 # ronin-dns 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-dns - Performs a variety of DNS queries
+
 ## SYNOPSIS
 
 `ronin dns` [*options*] {*HOST* ... \| `--file` *FILE*}
@@ -11,21 +15,21 @@ Queries DNS records for the given host name.
 ## ARGUMENTS
 
 *HOST*
-  A host name argument to query.
+: A host name argument to query.
 
 ## OPTIONS
 
 `-f`, `--file` *FILE*
-  The optional file to read values from.
+: The optional file to read values from.
 
 `-N`, `--nameserver` *HOST*|*IP*
-  Send DNS queries to the nameserver.
+: Send DNS queries to the nameserver.
 
 `-t`, `--type` `A|AAAA|ANY|CNAME|HINFO|LOC|MINFO|MX|NS|PTR|SOA|SRV|TXT|WKS`
-  The type of record to query.
+: The type of record to query.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
 
 ## AUTHOR
 

data/man/ronin-email-addr.1

@@ -1,76 +1,63 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-email-addr 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-email\-addr \- Processes email addresses
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin email-addr\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIEMAIL\[ru]ADDR\fP \.\.\.\[rB]
-.LP
+.PP
+\fBronin email\-addr\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIEMAIL\[ru]ADDR\fP \.\.\.\[rB]
 .SH DESCRIPTION
-.LP
 .PP
 Processes one or more email addresses\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-f\fR, \fB--file\fR \fIFILE\fP
+\fB\-f\fR, \fB\-\-file\fR \fIFILE\fP
 Optional input file to read the email addresses from\.
-.LP
 .TP
-\fB-O\fR, \fB--obfuscate\fR
+\fB\-O\fR, \fB\-\-obfuscate\fR
 Obfuscates the given email address(es)\.
-.LP
 .TP
-\fB--enum-obfuscations\fR
+\fB\-\-enum\-obfuscations\fR
 Enumerate over every possible obfuscation of the given email address(es)\.
-.LP
 .TP
-\fB-D\fR, \fB--deobfuscate\fR
+\fB\-D\fR, \fB\-\-deobfuscate\fR
 Deobfuscates the given email address(es)\.
-.LP
 .TP
-\fB-n\fR, \fB--name\fR
+\fB\-n\fR, \fB\-\-name\fR
 Extracts the Name part of the email address(es)\.
-.LP
 .TP
-\fB-m\fR, \fB--mailbox\fR
+\fB\-m\fR, \fB\-\-mailbox\fR
 Extracts the mailbox part of the email address(es)\.
-.LP
 .TP
-\fB-d\fR, \fB--domain\fR
+\fB\-d\fR, \fB\-\-domain\fR
 Extracts the domain part of the email address(es)\.
-.LP
 .TP
-\fB-N\fR, \fB--normalize\fR
+\fB\-N\fR, \fB\-\-normalize\fR
 Normalizes the given email address(es) by removing the Name, routing,
 and mailbox tag\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information
-.LP
 .SH EXAMPLES
-.LP
 .PP
 Deobfuscates an email address:
-.LP
-.nf
-    ronin email\-addr \-\-deobfuscate \[dq]john\[lC]DOT\[rC]smith\[lC]AT\[rC]example\[lC]DOT\[rC]com\[dq]\(aq
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin email\-addr \-\-deobfuscate \[dq]john\[lC]DOT\[rC]smith\[lC]AT\[rC]example\[lC]DOT\[rC]com\[dq]\(aq
+.EE
+.RE
 .PP
 Extracts the domain name from a list of email addresses:
-.LP
-.nf
-    ronin email\-addr \-\-file emails\.txt \-\-domain
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin email\-addr \-\-file emails\.txt \-\-domain
+.EE
+.RE
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP

data/man/ronin-email-addr.1.md

@@ -1,5 +1,9 @@
 # ronin-email-addr 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-email-addr - Processes email addresses
+
 ## SYNOPSIS
 
 `ronin email-addr` [*options*] [*EMAIL_ADDR* ...]
@@ -11,42 +15,42 @@ Processes one or more email addresses.
 ## OPTIONS
 
 `-f`, `--file` *FILE*
-  Optional input file to read the email addresses from.
+: Optional input file to read the email addresses from.
 
 `-O`, `--obfuscate`
-  Obfuscates the given email address(es).
+: Obfuscates the given email address(es).
 
 `--enum-obfuscations`
-  Enumerate over every possible obfuscation of the given email address(es).
+: Enumerate over every possible obfuscation of the given email address(es).
 
 `-D`, `--deobfuscate`
-  Deobfuscates the given email address(es).
+: Deobfuscates the given email address(es).
 
 `-n`, `--name`
-  Extracts the Name part of the email address(es).
+: Extracts the Name part of the email address(es).
 
 `-m`, `--mailbox`
-  Extracts the mailbox part of the email address(es).
+: Extracts the mailbox part of the email address(es).
 
 `-d`, `--domain`
-  Extracts the domain part of the email address(es).
+: Extracts the domain part of the email address(es).
 
 `-N`, `--normalize`
-  Normalizes the given email address(es) by removing the Name, routing,
+: Normalizes the given email address(es) by removing the Name, routing,
   and mailbox tag.
 
 `-h`, `--help`
-  Print help information
+: Print help information
 
 ## EXAMPLES
 
 Deobfuscates an email address:
 
-        ronin email-addr --deobfuscate "john{DOT}smith{AT}example{DOT}com"'
+    $ ronin email-addr --deobfuscate "john{DOT}smith{AT}example{DOT}com"'
 
 Extracts the domain name from a list of email addresses:
 
-        ronin email-addr --file emails.txt --domain
+    $ ronin email-addr --file emails.txt --domain
 
 ## AUTHOR
 

data/man/ronin-encode.1

@@ -1,127 +1,157 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-encode 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-encode \- Encodes each character of data into a variety of encodings
 .SH SYNOPSIS
-.LP
-.HP
+.PP
 \fBronin encode \fR \[lB]\fIoptions\fP\[rB] \[lB]\fIFILE\fP \.\.\.\[rB]
-.LP
 .SH DESCRIPTION
-.LP
 .PP
 Encodes each character of the given data into a variety of formats\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fIFILE\fP
 The optional file to read and process\. If no \fIFILE\fP arguments are given,
 input will be read from \fBstdin\fR\.
-.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--string\fR \fISTRING\fP
+\fB\-\-string\fR \fISTRING\fP
 Optional string to process\.
-.LP
 .TP
-\fB-M\fR, \fB--multiline\fR
+\fB\-M\fR, \fB\-\-multiline\fR
 Process each line of input separately\.
-.LP
 .TP
-\fB-n\fR, \fB--keep-newlines\fR
+\fB\-n\fR, \fB\-\-keep\-newlines\fR
 Preserves newlines at the end of each line\.
-.LP
 .TP
-\fB--base16\fR
+\fB\-\-base16\fR
 Base16 encodes the data\.
-.LP
 .TP
-\fB--base32\fR
+\fB\-\-base32\fR
 Base32 encodes the data\.
-.LP
-.HP
-\fB-b\fR, \fB--base64\fR\[lB]\fB=\fR\fIstrict\fP\[or]\fIurl\fP\[rB]
+.TP
+\fB\-b\fR, \fB\-\-base64\fR\[lB]\fB\[eq]\fR\fIstrict\fP\[or]\fIurl\fP\[rB]
 Base64 encodes the data\. If the \fBstrict\fR or \fBurl\fR option value is given,
 it will enable \fBstrict\fR or \fBurl\fR Base64 encoding mode, respectively\.
-.LP
 .TP
-\fB-z\fR, \fB--zlib\fR
+\fB\-z\fR, \fB\-\-zlib\fR
 Zlib compresses the data\.
-.LP
 .TP
-\fB-g\fR, \fB--gzip\fR
+\fB\-g\fR, \fB\-\-gzip\fR
 gzip compresses the data\.
-.LP
-.HP
-\fB-c, \fR\-\-c\`
+.TP
+\fB\-c\fR, \fB\-\-c\fR
 Encodes the data as a C string\.
-.LP
 .TP
-\fB-X\fR, \fB--hex\fR
-Hex encode the data (ex: \fB414141...\fR)\.
-.LP
+\fB\-X\fR, \fB\-\-hex\fR
+Hex encode the data (ex: \fB414141\.\.\.\fR)\.
 .TP
-\fB-H\fR, \fB--html\fR
+\fB\-H\fR, \fB\-\-html\fR
 HTML encodes the data\.
-.LP
 .TP
-\fB-u\fR, \fB--uri\fR
+\fB\-u\fR, \fB\-\-uri\fR
 URI encodes the data\.
-.LP
 .TP
-\fB--http\fR
+\fB\-\-http\fR
 HTTP encodes the data\.
-.LP
 .TP
-\fB-j\fR, \fB--js\fR
+\fB\-j\fR, \fB\-\-js\fR
 JavaScript encodes the data\.
-.LP
 .TP
-\fB-S\fR, \fB--shell\fR
+\fB\-S\fR, \fB\-\-shell\fR
 Encodes the data as a Shell String\.
-.LP
 .TP
-\fB-P\fR, \fB--powershell\fR
+\fB\-P\fR, \fB\-\-powershell\fR
 Encodes the data as a PowerShell String\.
-.LP
 .TP
-\fB--punycode\fR
+\fB\-\-punycode\fR
 Encodes the data as Punycode\.
-.LP
 .TP
-\fB-Q\fR, \fB--quoted-printable\fR
+\fB\-Q\fR, \fB\-\-quoted\-printable\fR
 Decodes the data as Quoted Printable\.
-.LP
 .TP
-\fB--uuencode\fR
+\fB\-\-uuencode\fR
 uuencodes the data\.
-.LP
 .TP
-\fB-R\fR, \fB--ruby\fR
+\fB\-R\fR, \fB\-\-ruby\fR
 Encodes the data as a Ruby String\.
-.LP
 .TP
-\fB-x\fR, \fB--xml\fR
+\fB\-x\fR, \fB\-\-xml\fR
 XML encodes the data\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information\.
-.LP
+.SH EXAMPLES
+.PP
+Encode the string \fB\[dq]hello world\[dq]\fR to Base64:
+.PP
+.RS 4
+.EX
+    \[Do] ronin encode \-\-base64 \-\-string \[dq]hello world\[dq]
+    aGVsbG8gd29ybGQ\[eq]
+.EE
+.RE
+.PP
+Encode the string \fB\[dq]hello world\[dq]\fR to HTTP encoded characters:
+.PP
+.RS 4
+.EX
+    \[Do] ronin encode \-\-http \-\-string \[dq]hello world\[dq]
+    %68%65%6C%6C%6F%20%77%6F%72%6C%64
+.EE
+.RE
+.PP
+Encode the string \fB\[dq]hello world\[dq]\fR to XML encoded characters:
+.PP
+.RS 4
+.EX
+    \[Do] ronin encode \-\-xml \-\-string \[dq]hello world\[dq]
+    &\[sh]104;&\[sh]101;&\[sh]108;&\[sh]108;&\[sh]111;&\[sh]32;&\[sh]119;&\[sh]111;&\[sh]114;&\[sh]108;&\[sh]100;
+.EE
+.RE
+.PP
+Hex encodes the contents of a file:
+.PP
+.RS 4
+.EX
+    ronin encode \-\-hex \-\-file \[sl]path\[sl]to\[sl]file\.txt
+.EE
+.RE
+.PP
+Hex encodes every line of a file:
+.PP
+.RS 4
+.EX
+    ronin encode \-\-hex \-\-multiline \-\-file \[sl]path\[sl]to\[sl]file\.txt
+.EE
+.RE
+.PP
+Compresses the file\[cq]s contents using Zlib and then Base64 encodes it:
+.PP
+.RS 4
+.EX
+    ronin encode \-\-zlib \-\-base64 \-\-file hi\.txt
+.EE
+.RE
+.PP
+Encode the string \fB\[dq]hello world\[dq]\fR to a Ruby hex\-escaped string:
+.PP
+.RS 4
+.EX
+    \[Do] ronin encode \-\-ruby \-\-string \[dq]hello world\[dq]
+    \ex68\ex65\ex6C\ex6C\ex6F\ex20\ex77\ex6F\ex72\ex6C\ex64
+.EE
+.RE
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-decode(1)
+.BR ronin\-decode (1)

data/man/ronin-encode.1.md

@@ -1,5 +1,9 @@
 # ronin-encode 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-encode - Encodes each character of data into a variety of encodings
+
 ## SYNOPSIS
 
 `ronin encode ` [*options*] [*FILE* ...]
@@ -11,80 +15,114 @@ Encodes each character of the given data into a variety of formats.
 ## ARGUMENTS
 
 *FILE*
-  The optional file to read and process. If no *FILE* arguments are given,
+: The optional file to read and process. If no *FILE* arguments are given,
   input will be read from `stdin`.
 
 ## OPTIONS
 
 `-f`, `--file` *FILE*
-  Optional file to process.
+: Optional file to process.
 
 `--string` *STRING*
-  Optional string to process.
+: Optional string to process.
 
 `-M`, `--multiline`
-  Process each line of input separately.
+: Process each line of input separately.
 
 `-n`, `--keep-newlines`
-  Preserves newlines at the end of each line.
+: Preserves newlines at the end of each line.
 
 `--base16`
-  Base16 encodes the data.
+: Base16 encodes the data.
 
 `--base32`
-  Base32 encodes the data.
+: Base32 encodes the data.
 
 `-b`, `--base64`[`=`*strict*\|*url*]
-  Base64 encodes the data. If the `strict` or `url` option value is given,
+: Base64 encodes the data. If the `strict` or `url` option value is given,
   it will enable `strict` or `url` Base64 encoding mode, respectively.
 
 `-z`, `--zlib`
-  Zlib compresses the data.
+: Zlib compresses the data.
 
 `-g`, `--gzip`
-  gzip compresses the data.
+: gzip compresses the data.
 
-`-c, `--c`
-  Encodes the data as a C string.
+`-c`, `--c`
+: Encodes the data as a C string.
 
 `-X`, `--hex`
-  Hex encode the data (ex: `414141...`).
+: Hex encode the data (ex: `414141...`).
 
 `-H`, `--html`
-  HTML encodes the data.
+: HTML encodes the data.
 
 `-u`, `--uri`
-  URI encodes the data.
+: URI encodes the data.
 
 `--http`
-  HTTP encodes the data.
+: HTTP encodes the data.
 
 `-j`, `--js`
-  JavaScript encodes the data.
+: 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.
+: Encodes the data as Punycode.
 
 `-Q`, `--quoted-printable`
-  Decodes the data as Quoted Printable.
+: Decodes the data as Quoted Printable.
 
 `--uuencode`
-  uuencodes the data.
+: 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.
+: XML encodes the data.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
+
+## EXAMPLES
+
+Encode the string `"hello world"` to Base64:
+
+        $ ronin encode --base64 --string "hello world"
+        aGVsbG8gd29ybGQ=
+
+Encode the string `"hello world"` to HTTP encoded characters:
+
+        $ ronin encode --http --string "hello world"
+        %68%65%6C%6C%6F%20%77%6F%72%6C%64
+
+Encode the string `"hello world"` to XML encoded characters:
+
+        $ ronin encode --xml --string "hello world"
+        hello world
+
+Hex encodes the contents of a file:
+
+        ronin encode --hex --file /path/to/file.txt
+
+Hex encodes every line of a file:
+
+        ronin encode --hex --multiline --file /path/to/file.txt
+
+Compresses the file's contents using Zlib and then Base64 encodes it:
+
+        ronin encode --zlib --base64 --file hi.txt
+
+Encode the string `"hello world"` to a Ruby hex-escaped string:
+
+        $ ronin encode --ruby --string "hello world"
+        \x68\x65\x6C\x6C\x6F\x20\x77\x6F\x72\x6C\x64
 
 ## AUTHOR
 
@@ -92,4 +130,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-decode(1)
+[ronin-decode](ronin-decode.1.md)