ronin 2.0.5 → 2.1.0

data/man/ronin-proxy.1

@@ -1,129 +1,103 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-proxy 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-proxy \- Starts a TCP\[sl]UDP\[sl]SSL\[sl]TLS intercept proxy server
 .SH SYNOPSIS
-.LP
-.HP
+.PP
 \fBronin proxy\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIPROXY\[ru]HOST\fP:\[rB]\fIPROXY\[ru]PORT\fP \fIUPSTREAM\[ru]HOST\fP:\fIUPSTREAM\[ru]PORT\fP
-.LP
 .SH DESCRIPTION
-.LP
 .PP
 Starts a TCP\[sl]UDP\[sl]SSL\[sl]TLS proxy server\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fIPROXY\[ru]HOST\fP
 The local host to listen on\.
-.LP
 .TP
 \fIPROXY\[ru]PORT\fP
 The local port to bind to\.
-.LP
 .TP
 \fIUPSTREAM\[ru]HOST\fP
 The upstream host to proxy data to\.
-.LP
 .TP
 \fIUPSTREAM\[ru]PORT\fP
 The upstream port to proxy data to\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-t\fR, \fB--tcp\fR
+\fB\-t\fR, \fB\-\-tcp\fR
 Enables or disables TCP mode\.
-.LP
 .TP
-\fB-S\fR, \fB--ssl\fR
+\fB\-S\fR, \fB\-\-ssl\fR
 Enables or disables SSL mode\.
-.LP
 .TP
-\fB-T\fR, \fB--tls\fR
+\fB\-T\fR, \fB\-\-tls\fR
 Enables or disables TLS mode\.
-.LP
 .TP
-\fB-u\fR, \fB--udp\fR
+\fB\-u\fR, \fB\-\-udp\fR
 Enables or disables UDP mode\.
-.LP
 .TP
-\fB-x\fR, \fB--[no-]hexdump\fR
+\fB\-x\fR, \fB\-\-\[lB]no\-\[rB]hexdump\fR
 Enables or disables hexdump mode\.
-.LP
 .TP
-\fB-r\fR, \fB--rewrite\fR \fI\[sl]REGEXP\[sl]:STRING\fP
+\fB\-r\fR, \fB\-\-rewrite\fR \fI\[sl]REGEXP\[sl]:STRING\fP
 Replace REGEXP with STRING in every message\.
-.LP
 .TP
-\fB--rewrite-client\fR \fI\[sl]REGEXP\[sl]:STRING\fP
+\fB\-\-rewrite\-client\fR \fI\[sl]REGEXP\[sl]:STRING\fP
 Replace REGEXP with STRING in every client message\.
-.LP
 .TP
-\fB--rewrite-server\fR \fI\[sl]REGEXP\[sl]:STRING\fP
+\fB\-\-rewrite\-server\fR \fI\[sl]REGEXP\[sl]:STRING\fP
 Replace REGEXP with STRING in every server message\.
-.LP
 .TP
-\fB-i\fR, \fB--ignore\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-i\fR, \fB\-\-ignore\fR \fI\[sl]REGEXP\[sl]\fP
 Ignore messages matching the REGEXP\.
-.LP
 .TP
-\fB--ignore-client\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-\-ignore\-client\fR \fI\[sl]REGEXP\[sl]\fP
 Ignore messages from the client matching the REGEXP\.
-.LP
 .TP
-\fB--ignore-server\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-\-ignore\-server\fR \fI\[sl]REGEXP\[sl]\fP
 Ignore messages from the server matching the REGEXP\.
-.LP
 .TP
-\fB-C\fR, \fB--close\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-C\fR, \fB\-\-close\fR \fI\[sl]REGEXP\[sl]\fP
 Closes the connection if the client or server sends a message matching
 the REGEXP\.
-.LP
 .TP
-\fB--close-client\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-\-close\-client\fR \fI\[sl]REGEXP\[sl]\fP
 Closes the connection if the client sends a message matching the REGEXP\.
-.LP
 .TP
-\fB--close-server\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-\-close\-server\fR \fI\[sl]REGEXP\[sl]\fP
 Closes the connection if the server sends a message matching the REGEXP\.
-.LP
 .TP
-\fB-R\fR, \fB--reset\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-R\fR, \fB\-\-reset\fR \fI\[sl]REGEXP\[sl]\fP
 Reset the connection if the client or server sends a message matching
 the REGEXP\.
-.LP
 .TP
-\fB--reset-client\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-\-reset\-client\fR \fI\[sl]REGEXP\[sl]\fP
 Reset the connection if the client sends a message matching the REGEXP\.
-.LP
 .TP
-\fB--reset-server\fR \fI\[sl]REGEXP\[sl]\fP
+\fB\-\-reset\-server\fR \fI\[sl]REGEXP\[sl]\fP
 Reset the connection if the server sends a message matching the REGEXP\.
-.LP
 .SH EXAMPLES
-.LP
 .PP
 Starts a TCP proxy listening on \fBlocalhost\fR port 8080 that forwards all data
-to \fBgoogle.com\fR port 80:
-.LP
-.nf
-    ronin proxy 8080 google\.com:80
-.fi
-.LP
+to \fBgoogle\.com\fR port 80:
+.PP
+.RS 4
+.EX
+\[Do] ronin proxy 8080 google\.com:80
+.EE
+.RE
+.PP
+Starts a UDP proxy listening on \fB0\.8\.0\.0\fR port 53 that forwards all data to
+\fB8\.8\.8\.8\fR port 53:
 .PP
-Starts a UDP proxy listening on \fB0.8.0.0\fR port 53 that forwards all data to
-\fB8.8.8.8\fR port 53:
-.LP
-.nf
-    sudo ronin proxy \-\-udp \-\-hexdump 0\.0\.0\.0:53 8\.8\.8\.8:53
-.fi
-.LP
+.RS 4
+.EX
+\[Do] sudo ronin proxy \-\-udp \-\-hexdump 0\.0\.0\.0:53 8\.8\.8\.8:53
+.EE
+.RE
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP

data/man/ronin-proxy.1.md

@@ -1,5 +1,9 @@
 # ronin-proxy 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-proxy - Starts a TCP/UDP/SSL/TLS intercept proxy server
+
 ## SYNOPSIS
 
 `ronin proxy` [*options*] [*PROXY_HOST*:]*PROXY_PORT* *UPSTREAM_HOST*:*UPSTREAM_PORT*
@@ -11,83 +15,83 @@ Starts a TCP/UDP/SSL/TLS proxy server.
 ## ARGUMENTS
 
 *PROXY_HOST*
-	The local host to listen on.
+: The local host to listen on.
 
 *PROXY_PORT*
-  The local port to bind to.
+: The local port to bind to.
 
 *UPSTREAM_HOST*
-  The upstream host to proxy data to.
+: The upstream host to proxy data to.
 
 *UPSTREAM_PORT*
-  The upstream port to proxy data to.
+: The upstream port to proxy data to.
 
 ## OPTIONS
 
 `-t`, `--tcp`
-	Enables or disables TCP mode.
+: Enables or disables TCP mode.
 
 `-S`, `--ssl`
-  Enables or disables SSL mode.
+: Enables or disables SSL mode.
 
 `-T`, `--tls`
-  Enables or disables TLS mode.
+: Enables or disables TLS mode.
 
 `-u`, `--udp`
-	Enables or disables UDP mode.
+: Enables or disables UDP mode.
 
 `-x`, `--[no-]hexdump`
-	Enables or disables hexdump mode.
+: Enables or disables hexdump mode.
 
 `-r`, `--rewrite` */REGEXP/:STRING*
-	Replace REGEXP with STRING in every message.
+: Replace REGEXP with STRING in every message.
 
 `--rewrite-client` */REGEXP/:STRING*
-	Replace REGEXP with STRING in every client message.
+: Replace REGEXP with STRING in every client message.
 
 `--rewrite-server` */REGEXP/:STRING*
-	Replace REGEXP with STRING in every server message.
+: Replace REGEXP with STRING in every server message.
 
 `-i`, `--ignore` */REGEXP/*
-	Ignore messages matching the REGEXP.
+: Ignore messages matching the REGEXP.
 
 `--ignore-client` */REGEXP/*
-	Ignore messages from the client matching the REGEXP.
+: Ignore messages from the client matching the REGEXP.
 
 `--ignore-server` */REGEXP/*
-	Ignore messages from the server matching the REGEXP.
+: Ignore messages from the server matching the REGEXP.
 
 `-C`, `--close` */REGEXP/*
-	Closes the connection if the client or server sends a message matching
-	the REGEXP.
+: Closes the connection if the client or server sends a message matching
+  the REGEXP.
 
 `--close-client` */REGEXP/*
-	Closes the connection if the client sends a message matching the REGEXP.
+: Closes the connection if the client sends a message matching the REGEXP.
 
 `--close-server` */REGEXP/*
-	Closes the connection if the server sends a message matching the REGEXP.
+: Closes the connection if the server sends a message matching the REGEXP.
 
 `-R`, `--reset` */REGEXP/*
-	Reset the connection if the client or server sends a message matching
-	the REGEXP.
+: Reset the connection if the client or server sends a message matching
+  the REGEXP.
 
 `--reset-client` */REGEXP/*
-	Reset the connection if the client sends a message matching the REGEXP.
+: Reset the connection if the client sends a message matching the REGEXP.
 
 `--reset-server` */REGEXP/*
-	Reset the connection if the server sends a message matching the REGEXP.
+: Reset the connection if the server sends a message matching the REGEXP.
 
 ## EXAMPLES
 
 Starts a TCP proxy listening on `localhost` port 8080 that forwards all data
 to `google.com` port 80:
 
-        ronin proxy 8080 google.com:80
+    $ ronin proxy 8080 google.com:80
 
 Starts a UDP proxy listening on `0.8.0.0` port 53 that forwards all data to
 `8.8.8.8` port 53:
 
-        sudo ronin proxy --udp --hexdump 0.0.0.0:53 8.8.8.8:53
+    $ sudo ronin proxy --udp --hexdump 0.0.0.0:53 8.8.8.8:53
 
 ## AUTHOR
 

data/man/ronin-public-suffix-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-public-suffix-list 1 "2023-02-1" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-public\-suffix\-list \- Updates and parses the public suffix list file
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin public-suffix-list\fR \[lB]\fIoptions\fP\[rB]
-.LP
+.PP
+\fBronin public\-suffix\-list\fR \[lB]\fIoptions\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
 Updates and parses the public suffix 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 public suffix list file\.
-.LP
 .TP
-\fB-U\fR, \fB--url\fR \fIURL\fP
+\fB\-U\fR, \fB\-\-url\fR \fIURL\fP
 The URL to the public suffix list\. Defaults to
-\fBhttps://publicsuffix.org/list/public_suffix_list.dat\fR\.
-.LP
+\fBhttps:\[sl]\[sl]publicsuffix\.org\[sl]list\[sl]public\[ru]suffix\[ru]list\.dat\fR\.
 .TP
-\fB-p\fR, \fB--path\fR \fIFILE\fP
+\fB\-p\fR, \fB\-\-path\fR \fIFILE\fP
 The Path to the public suffix list file\. Defaults to
-\fB~/.cache/ronin/ronin-support/public_suffix_list.dat\fR if not given\.
-.LP
+\fB\[ti]\[sl]\.cache\[sl]ronin\[sl]ronin\-support\[sl]public\[ru]suffix\[ru]list\.dat\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/public_suffix_list.dat\fR
+\fB\[ti]\[sl]\.cache\[sl]ronin\[sl]ronin\-support\[sl]public\[ru]suffix\[ru]list\.dat\fR
 The location of the downloaded public suffix list\.
-.LP
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-tld\-list(1)
+.BR ronin\-tld\-list (1)

data/man/ronin-public-suffix-list.1.md

@@ -1,5 +1,9 @@
 # ronin-public-suffix-list 1 "2023-02-1" Ronin "User Manuals"
 
+## NAME
+
+ronin-public-suffix-list - Updates and parses the public suffix list file
+
 ## SYNOPSIS
 
 `ronin public-suffix-list` [*options*]
@@ -11,34 +15,34 @@ Updates and parses the public suffix list file.
 ## OPTIONS
 
 `-v`, `--verbose`
-  Enables verbose output.
+: Enables verbose output.
 
 `-u`, `--update`
-  Updates the public suffix list file.
+: Updates the public suffix list file.
 
 `-U`, `--url` *URL*
-  The URL to the public suffix list. Defaults to
+: The URL to the public suffix list. Defaults to
   `https://publicsuffix.org/list/public_suffix_list.dat`.
 
 `-p`, `--path` *FILE*
-  The Path to the public suffix list file. Defaults to
+: The Path to the public suffix list file. Defaults to
   `~/.cache/ronin/ronin-support/public_suffix_list.dat` 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/public_suffix_list.dat`
-  The location of the downloaded public suffix list.
+: The location of the downloaded public suffix list.
 
 ## AUTHOR
 
@@ -46,4 +50,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-tld-list(1)
+[ronin-tld-list](ronin-tld-list.1.md)

data/man/ronin-quote.1

@@ -1,78 +1,59 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-quote 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-quote \- Produces quoted a string for a variety of programming languages
 .SH SYNOPSIS
-.LP
-.HP
+.PP
 \fBronin quote\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIFILE\fP \.\.\.\[rB]
-.LP
 .SH DESCRIPTION
-.LP
 .PP
 Produces quoted a string for a variety of programming languages\.
-.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 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-X\fR, \fB--hex\fR
+\fB\-X\fR, \fB\-\-hex\fR
 Quotes the data as a Hex string\.
-.LP
 .TP
-\fB-c\fR, \fB--c\fR
+\fB\-c\fR, \fB\-\-c\fR
 Quotes the data as a C string\.
-.LP
 .TP
-\fB-j\fR, \fB--js\fR
+\fB\-j\fR, \fB\-\-js\fR
 quotes the data as a JavaScript string\.
-.LP
 .TP
-\fB-S\fR, \fB--shell\fR
+\fB\-S\fR, \fB\-\-shell\fR
 Quotes the data as a Shell String\.
-.LP
 .TP
-\fB-P\fR, \fB--powershell\fR
+\fB\-P\fR, \fB\-\-powershell\fR
 Quotes the data as a PowerShell String\.
-.LP
 .TP
-\fB-R\fR, \fB--ruby\fR
+\fB\-R\fR, \fB\-\-ruby\fR
 Quotes the data as a Ruby String\.
-.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\-unquote(1)
+.BR ronin\-unquote (1)

data/man/ronin-quote.1.md

@@ -1,5 +1,9 @@
 # ronin-quote 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-quote - Produces quoted a string for a variety of programming languages
+
 ## SYNOPSIS
 
 `ronin quote` [*options*] [*FILE* ...]
@@ -11,43 +15,43 @@ Produces quoted a string for a variety of programming languages.
 ## 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 separately.
+: Process each line separately.
 
 `-n`, `--keep-newlines`
-  Preserves newlines at the end of each line.
+: Preserves newlines at the end of each line.
 
 `-X`, `--hex`
-  Quotes the data as a Hex string.
+: Quotes the data as a Hex string.
 
 `-c`, `--c`
-  Quotes the data as a C string.
+: Quotes the data as a C string.
 
 `-j`, `--js`
-  quotes the data as a JavaScript string.
+: quotes the data as a JavaScript string.
 
 `-S`, `--shell`
-  Quotes the data as a Shell String.
+: Quotes the data as a Shell String.
 
 `-P`, `--powershell`
-  Quotes the data as a PowerShell String.
+: Quotes the data as a PowerShell String.
 
 `-R`, `--ruby`
-  Quotes the data as a Ruby String.
+: Quotes the data as a Ruby String.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
 
 ## AUTHOR
 
@@ -55,4 +59,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-unquote(1)
+[ronin-unquote](ronin-unquote.1.md)