ronin 2.0.4 → 2.1.0.rc1

data/man/ronin-encrypt.1

@@ -1,105 +1,90 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-encrypt 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-encrypt \- Encrypts data
 .SH SYNOPSIS
-.LP
-.HP
+.PP
 \fBronin encrypt\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIFILE\fP \.\.\.\[rB]
-.LP
 .SH DESCRIPTION
-.LP
 .PP
 Encrypts data\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fIFILE\fP
 The optional file to read and encrypt\. If no \fIFILE\fP arguments are given,
 input will be read from \fBstdin\fR\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-k\fR, \fB--key\fR \fISTRING\fP
+\fB\-k\fR, \fB\-\-key\fR \fISTRING\fP
 The raw key string for the cipher\.
-.LP
 .TP
-\fB-K\fR, \fB--key-file\fR \fIFILE\fP
+\fB\-K\fR, \fB\-\-key\-file\fR \fIFILE\fP
 Reads the key string from the file\.
-.LP
 .TP
-\fB-c\fR, \fB--cipher\fR \fINAME\fP
-The cipher to encrypt with\. See \fB--list-ciphers\fR for a list of supported
-ciphers\. Default to \fBaes-256-cbc\fR if not given\.
-.LP
+\fB\-c\fR, \fB\-\-cipher\fR \fINAME\fP
+The cipher to encrypt with\. See \fB\-\-list\-ciphers\fR for a list of supported
+ciphers\. Default to \fBaes\-256\-cbc\fR if not given\.
 .TP
-\fB-P\fR, \fB--password\fR \fIPASSWORD\fP
+\fB\-P\fR, \fB\-\-password\fR \fIPASSWORD\fP
 The password to encrypt with\.
-.LP
 .TP
-\fB-H\fR, \fB--hash\fR \fBmd5\fR\[or]\fBsha1\fR\[or]\fBsha256\fR\[or]\fBsha512\fR
+\fB\-H\fR, \fB\-\-hash\fR \fBmd5\fR\[or]\fBsha1\fR\[or]\fBsha256\fR\[or]\fBsha512\fR
 The hash algorithm to use for the password\. Default to \fBsha256\fR if not given\.
-.LP
 .TP
-\fB--iv\fR \fISTRING\fP
+\fB\-\-iv\fR \fISTRING\fP
 Sets the Initial Vector (IV) value of the cipher\.
-.LP
 .TP
-\fB--padding\fR \fINUM\fP
+\fB\-\-padding\fR \fINUM\fP
 Sets the padding size, in bytes, of the encryption cipher\.
-.LP
 .TP
-\fB-b\fR, \fB--block-size\fR \fINUM\fP
+\fB\-b\fR, \fB\-\-block\-size\fR \fINUM\fP
 The size, in bytes, to read data in\. Default to \fB16384\fR if not given\.
-.LP
 .TP
-\fB--list-ciphers\fR
+\fB\-\-list\-ciphers\fR
 List the supported ciphers and exits\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information\.
-.LP
 .SH EXAMPLES
-.LP
 .PP
 Encrypt a file using AES\-256 (CBC mode) with a password:
-.LP
-.nf
-    \[Do] ronin encrypt \-\-cipher aes\-256\-cbc \-\-password \[dq]\.\.\.\[dq] file\.txt > encrypted\.bin
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin encrypt \-\-cipher aes\-256\-cbc \-\-password \[dq]\.\.\.\[dq] file\.txt > encrypted\.bin
+.EE
+.RE
 .PP
 Encrypt a file using a raw key string:
-.LP
-.nf
-    \[Do] ronin encrypt \-\-cipher aes\-256\-cbc \-\-key \[dq]12345abcdef\.\.\.\[dq] file\.txt > encrypted\.bin
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin encrypt \-\-cipher aes\-256\-cbc \-\-key \[dq]12345abcdef\.\.\.\[dq] file\.txt > encrypted\.bin
+.EE
+.RE
 .PP
 Encrypt a file using a raw key read from a file:
-.LP
-.nf
-    \[Do] ronin encrypt \-\-cipher aes\-256\-cbc \-\-key\-file key\.bin file\.txt > encrypted\.bin
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin encrypt \-\-cipher aes\-256\-cbc \-\-key\-file key\.bin file\.txt > encrypted\.bin
+.EE
+.RE
 .PP
 Specifying a custom IV (initialization vector):
-.LP
-.nf
-    \[Do] ronin encrypt \-\-cipher aes\-256\-cbc \-\-key \[dq]\.\.\.\[dq] \-\-iv \[dq]\.\.\.\[dq] file\.txt > encrypted\.bin
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin encrypt \-\-cipher aes\-256\-cbc \-\-key \[dq]\.\.\.\[dq] \-\-iv \[dq]\.\.\.\[dq] file\.txt > encrypted\.bin
+.EE
+.RE
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-decrypt(1)
+.BR ronin\-decrypt (1)

data/man/ronin-encrypt.1.md

@@ -1,5 +1,9 @@
 # ronin-encrypt 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-encrypt - Encrypts data
+
 ## SYNOPSIS
 
 `ronin encrypt` [*options*] [*FILE* ...]
@@ -11,59 +15,59 @@ Encrypts data.
 ## ARGUMENTS
 
 *FILE*
-  The optional file to read and encrypt. If no *FILE* arguments are given,
+: The optional file to read and encrypt. If no *FILE* arguments are given,
   input will be read from `stdin`.
 
 ## OPTIONS
 
 `-k`, `--key` *STRING*
-  The raw key string for the cipher.
+: The raw key string for the cipher.
 
 `-K`, `--key-file` *FILE*
-  Reads the key string from the file.
+: Reads the key string from the file.
 
 `-c`, `--cipher` *NAME*
-  The cipher to encrypt with. See `--list-ciphers` for a list of supported
+: The cipher to encrypt with. See `--list-ciphers` for a list of supported
   ciphers. Default to `aes-256-cbc` if not given.
 
 `-P`, `--password` *PASSWORD*
-  The password to encrypt with.
+: The password to encrypt with.
 
 `-H`, `--hash` `md5`\|`sha1`\|`sha256`\|`sha512`
-  The hash algorithm to use for the password. Default to `sha256` if not given.
+: The hash algorithm to use for the password. Default to `sha256` if not given.
 
 `--iv` *STRING*
-  Sets the Initial Vector (IV) value of the cipher.
+: Sets the Initial Vector (IV) value of the cipher.
 
 `--padding` *NUM*
-  Sets the padding size, in bytes, of the encryption cipher.
+: Sets the padding size, in bytes, of the encryption cipher.
 
 `-b`, `--block-size` *NUM*
-  The size, in bytes, to read data in. Default to `16384` if not given.
+: The size, in bytes, to read data in. Default to `16384` if not given.
 
 `--list-ciphers`
-  List the supported ciphers and exits.
+: List the supported ciphers and exits.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
 
 ## EXAMPLES
 
 Encrypt a file using AES-256 (CBC mode) with a password:
 
-        $ ronin encrypt --cipher aes-256-cbc --password "..." file.txt > encrypted.bin
+    $ ronin encrypt --cipher aes-256-cbc --password "..." file.txt > encrypted.bin
 
 Encrypt a file using a raw key string:
 
-        $ ronin encrypt --cipher aes-256-cbc --key "12345abcdef..." file.txt > encrypted.bin
+    $ ronin encrypt --cipher aes-256-cbc --key "12345abcdef..." file.txt > encrypted.bin
 
 Encrypt a file using a raw key read from a file:
 
-        $ ronin encrypt --cipher aes-256-cbc --key-file key.bin file.txt > encrypted.bin
+    $ ronin encrypt --cipher aes-256-cbc --key-file key.bin file.txt > encrypted.bin
 
 Specifying a custom IV (initialization vector):
 
-        $ ronin encrypt --cipher aes-256-cbc --key "..." --iv "..." file.txt > encrypted.bin
+    $ ronin encrypt --cipher aes-256-cbc --key "..." --iv "..." file.txt > encrypted.bin
 
 ## AUTHOR
 
@@ -71,4 +75,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-decrypt(1)
+[ronin-decrypt](ronin-decrypt.1.md)

data/man/ronin-entropy.1

@@ -1,43 +1,33 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-entropy 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-entropy \- Filters lines by their entropy
 .SH SYNOPSIS
-.LP
-.HP
+.PP
 \fBronin entropy\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIFILE\fP \.\.\.\[rB]
-.LP
 .SH DESCRIPTION
-.LP
 .PP
 Filters each line by it\[cq]s Shannon Entropy\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fIFILE\fP
 The optional file to read and filter\. If no \fIFILE\fP arguments are given, then
 \fBronin entropy\fR will read from standard input\.
-.LP
 .SH OPTIONS
-.LP
-.HP
-\fB-e\fR, \fB--entropy\fR DEC
-The minimum required entropy value\. If the \fB-e\fR,\fB--entropy\fR option is not
-given, it will default to \fB4.0\fR\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-e\fR, \fB\-\-entropy\fR DEC
+The minimum required entropy value\. If the \fB\-e\fR,\fB\-\-entropy\fR option is not
+given, it will default to \fB4\.0\fR\.
+.TP
+\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\-extract(1)
+.BR ronin\-extract (1)

data/man/ronin-entropy.1.md

@@ -1,5 +1,9 @@
 # ronin-entropy 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-entropy - Filters lines by their entropy
+
 ## SYNOPSIS
 
 `ronin entropy` [*options*] [*FILE* ...]
@@ -11,17 +15,17 @@ Filters each line by it's Shannon Entropy.
 ## ARGUMENTS
 
 *FILE*
-  The optional file to read and filter. If no *FILE* arguments are given, then
+: The optional file to read and filter. If no *FILE* arguments are given, then
   `ronin entropy` will read from standard input.
 
 ## OPTIONS
 
 `-e`, `--entropy` DEC
-  The minimum required entropy value. If the `-e`,`--entropy` option is not
+: The minimum required entropy value. If the `-e`,`--entropy` option is not
   given, it will default to `4.0`.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
 
 ## AUTHOR
 
@@ -29,4 +33,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-extract(1)
+[ronin-extract](ronin-extract.1.md)

data/man/ronin-escape.1

@@ -1,98 +1,74 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-escape 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-escape \- Escapes each special character for a variety of encodings
 .SH SYNOPSIS
-.LP
-.HP
+.PP
 \fBronin escape\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIFILE\fP \.\.\.\[rB]
-.LP
 .SH DESCRIPTION
-.LP
 .PP
 Escapes each special character for a variety of encodings\.
-.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 input file to read from\.
-.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 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-c\fR, \fB--c\fR
+\fB\-c\fR, \fB\-\-c\fR
 Escapes the data as a C string\.
-.LP
 .TP
-\fB-X\fR, \fB--hex\fR
+\fB\-X\fR, \fB\-\-hex\fR
 Escapes the data as a hex string (ex: \[lq]ABC\ex01\ex02\ex03\.\.\.\[rq])
-.LP
 .TP
-\fB-H\fR, \fB--html\fR
+\fB\-H\fR, \fB\-\-html\fR
 HTML escapes the data\.
-.LP
 .TP
-\fB-u\fR, \fB--uri\fR
+\fB\-u\fR, \fB\-\-uri\fR
 URI escapes the data\.
-.LP
 .TP
-\fB--http\fR
+\fB\-\-http\fR
 HTTP escapes the data\.
-.LP
 .TP
-\fB-j\fR, \fB--js\fR
+\fB\-j\fR, \fB\-\-js\fR
 JavaScript escapes the data\.
-.LP
 .TP
-\fB-S\fR, \fB--shell\fR
+\fB\-S\fR, \fB\-\-shell\fR
 Escapes the data as a Shell String\.
-.LP
 .TP
-\fB-P\fR, \fB--powershell\fR
+\fB\-P\fR, \fB\-\-powershell\fR
 Escapes the data as a PowerShell String\.
-.LP
 .TP
-\fB-Q\fR, \fB--quoted-printable\fR
+\fB\-Q\fR, \fB\-\-quoted\-printable\fR
 Escapes the data as Quoted Printable\.
-.LP
 .TP
-\fB-R\fR, \fB--ruby\fR
+\fB\-R\fR, \fB\-\-ruby\fR
 Escapes the data as a Ruby String\.
-.LP
 .TP
-\fB-x\fR, \fB--xml\fR
+\fB\-x\fR, \fB\-\-xml\fR
 XML escapes the data\.
-.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\-unescape(1)
+.BR ronin\-unescape (1)

data/man/ronin-escape.1.md

@@ -1,5 +1,9 @@
 # ronin-escape 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-escape - Escapes each special character for a variety of encodings
+
 ## SYNOPSIS
 
 `ronin escape` [*options*] [*FILE* ...]
@@ -11,58 +15,58 @@ Escapes each special character for a variety of encodings.
 ## 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 input file to read from.
+: Optional input file to read from.
 
 `--string` *STRING*
-  Optional string to process.
+: Optional string to process.
 
 `-M`, `--multiline`
-  Process each line separately.
+: Process each line separately.
 
 `-n`, `--keep-newlines`
-  Preserves newlines at the end of each line.
+: Preserves newlines at the end of each line.
 
 `-c`, `--c`
-  Escapes the data as a C string.
+: Escapes the data as a C string.
 
 `-X`, `--hex`
-  Escapes the data as a hex string (ex: "ABC\x01\x02\x03...")
+: Escapes the data as a hex string (ex: "ABC\x01\x02\x03...")
 
 `-H`, `--html`
-  HTML escapes the data.
+: HTML escapes the data.
 
 `-u`, `--uri`
-  URI escapes the data.
+: URI escapes the data.
 
 `--http`
-  HTTP escapes the data.
+: HTTP escapes the data.
 
 `-j`, `--js`
-  JavaScript escapes the data.
+: 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.
+: 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.
+: XML escapes the data.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
 
 ## AUTHOR
 
@@ -70,4 +74,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-unescape(1)
+[ronin-unescape](ronin-unescape.1.md)