ronin-encode.1 in ronin-2.1.0.rc1

- old
+ new
@@ -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)
\ No newline at end of file
+.BR ronin\-decode (1)