man/ronin-rot.1 in ronin-2.0.5 vs man/ronin-rot.1 in ronin-2.1.0.rc1

- old
+ new

@@ -1,79 +1,66 @@ -.\" Generated by kramdown-man 0.1.8 +.\" Generated by kramdown-man 1.0.1 .\" https://github.com/postmodern/kramdown-man#readme .TH ronin-rot 1 "2023-02-01" Ronin "User Manuals" -.LP +.SH NAME +.PP +ronin\-rot \- Rotates each character of data within an alphabet .SH SYNOPSIS -.LP -.HP +.PP \fBronin rot\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIFILE\fP \.\.\.\[rB] -.LP .SH DESCRIPTION -.LP .PP Rotates each character of data with an alphabet\. -.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-A\fR, \fB--alphabet\fR \fBABC...\fR +\fB\-A\fR, \fB\-\-alphabet\fR \fBABC\.\.\.\fR Alphabet characters to rotate characters within\. -.LP .TP -\fB-n\fR, \fB--modulo\fR \fINUM\fP +\fB\-n\fR, \fB\-\-modulo\fR \fINUM\fP Number of characters to rotate forwards or backwards\. Defaults to 13 if not given\. -.LP .TP -\fB-h\fR, \fB--help\fR +\fB\-h\fR, \fB\-\-help\fR Print help information\. -.LP .SH EXAMPLES -.LP .PP ROT\-13 encode a string: -.LP -.nf - \[Do] ronin rot \-\-string \[dq]The quick brown fox jumps over the lazy dog\[dq] -.fi -.LP .PP +.RS 4 +.EX +\[Do] ronin rot \-\-string \[dq]The quick brown fox jumps over the lazy dog\[dq] +.EE +.RE +.PP ROT encode a string with a custom rotation number: -.LP -.nf - \[Do] ronin rot \-n 3 \-\-string \[dq]The quick brown fox jumps over the lazy dog\[dq] -.fi -.LP +.PP +.RS 4 +.EX +\[Do] ronin rot \-n 3 \-\-string \[dq]The quick brown fox jumps over the lazy dog\[dq] +.EE +.RE .SH AUTHOR -.LP .PP Postmodern .MT postmodern\.mod3\[at]gmail\.com .ME -.LP .SH SEE ALSO -.LP .PP -ronin\-encode(1), ronin\-rot(1) \ No newline at end of file +.BR ronin\-encode (1) +.BR ronin\-rot (1)