ronin 2.0.5 → 2.1.0

data/man/ronin-netcat.1

@@ -1,110 +1,84 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-netcat 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-netcat \- A netcat clone command
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin netcat\fR \[lB]\fIoptions\fP\[rB] \[lB]\fB--tcp\fR \[or] \fB--udp\fR \[or] \fB--ssl\fR \[or] \fB--tls\fR\[rB] \[lC]\fIHOST\fP \fIPORT\fP \[or] \fB-l\fR \[lB]\fIHOST\fP\[rB] \fIPORT\fP \[or] \fB--unix\fR \fIPATH\fP\[rC]
-.LP
+.PP
+\fBronin netcat\fR \[lB]\fIoptions\fP\[rB] \[lB]\fB\-\-tcp\fR \[or] \fB\-\-udp\fR \[or] \fB\-\-ssl\fR \[or] \fB\-\-tls\fR\[rB] \[lC]\fIHOST\fP \fIPORT\fP \[or] \fB\-l\fR \[lB]\fIHOST\fP\[rB] \fIPORT\fP \[or] \fB\-\-unix\fR \fIPATH\fP\[rC]
 .SH DESCRIPTION
-.LP
 .PP
 Connects to or listens on a TCP\[sl]UDP\[sl]SSL\[sl]TLS\[sl]UNIX socket\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fIHOST\fP
 The remote hostname or IP address to connect to or the local hostname or IP
 address to listen on\.
-.LP
 .TP
 \fIPORT\fP
 The remote port to connect to or the local port to listen on\.
-.LP
 .TP
 \fIPATH\fP
 The path to the UNIX socket to connect to or listen on\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-v\fR, \fB--verbose\fR
+\fB\-v\fR, \fB\-\-verbose\fR
 Enables verbose output\.
-.LP
 .TP
-\fB--tcp\fR
+\fB\-\-tcp\fR
 Uses the TCP protocol\.
-.LP
 .TP
-\fB--udp\fR
+\fB\-\-udp\fR
 Uses the UDP protocol\.
-.LP
 .TP
-\fB-U\fR, \fB--unix\fR \fIPATH\fP
+\fB\-U\fR, \fB\-\-unix\fR \fIPATH\fP
 Uses the UNIX socket protocol and connects to or listens on the given \fIPATH\fP\.
-.LP
 .TP
-\fB-l\fR, \fB--listen\fR
+\fB\-l\fR, \fB\-\-listen\fR
 Listens for incoming connections\.
-.LP
 .TP
-\fB-s\fR, \fB--source\fR \fIHOST\fP
+\fB\-s\fR, \fB\-\-source\fR \fIHOST\fP
 Source address to bind to\.
-.LP
 .TP
-\fB-p\fR, \fB--source-port\fR \fIPORT\fP
+\fB\-p\fR, \fB\-\-source\-port\fR \fIPORT\fP
 Source port to bind to\.
-.LP
 .TP
-\fB-b\fR, \fB--buffer-size\fR \fIINT\fP
+\fB\-b\fR, \fB\-\-buffer\-size\fR \fIINT\fP
 Buffer size to use\. Defaults to 4096 if not given\.
-.LP
 .TP
-\fB-x\fR, \fB--hexdump\fR
+\fB\-x\fR, \fB\-\-hexdump\fR
 Hexdumps each message that is received\.
-.LP
 .TP
-\fB--ssl\fR
+\fB\-\-ssl\fR
 Enables SSL mode\.
-.LP
 .TP
-\fB--tls\fR
+\fB\-\-tls\fR
 Enables TLS mode\.
-.LP
 .TP
-\fB--ssl-version\fR \fB1\fR\[or]\fB1.1\fR\[or]\fB1.2\fR
+\fB\-\-ssl\-version\fR \fB1\fR\[or]\fB1\.1\fR\[or]\fB1\.2\fR
 Specifies the required SSL version\.
-.LP
 .TP
-\fB--ssl-cert\fR \fIFILE\fP
+\fB\-\-ssl\-cert\fR \fIFILE\fP
 Specifies the SSL certificate file\.
-.LP
 .TP
-\fB--ssl-key\fR \fIFILE\fP
+\fB\-\-ssl\-key\fR \fIFILE\fP
 Specifies the SSL key file\.
-.LP
 .TP
-\fB--ssl-verify\fR \fBnone\fR\[or]\fBpeer\fR\[or]\fBfail-if-no-peer-cert\fR\[or]\fBclient-once\fR\[or]\fBtrue\fR\[or]\fBfalse\fR
+\fB\-\-ssl\-verify\fR \fBnone\fR\[or]\fBpeer\fR\[or]\fBfail\-if\-no\-peer\-cert\fR\[or]\fBclient\-once\fR\[or]\fBtrue\fR\[or]\fBfalse\fR
 SSL verification mode\.
-.LP
 .TP
-\fB--ssl-ca-bundle\fR \fIPATH\fP
+\fB\-\-ssl\-ca\-bundle\fR \fIPATH\fP
 Path to the file or directory of CA certificates\.
-.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\-hexdump(1) ronin\-http(1)
+.BR ronin\-hexdump (1)
+.BR ronin\-http (1)

data/man/ronin-netcat.1.md

@@ -1,5 +1,9 @@
 # ronin-netcat 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-netcat - A netcat clone command
+
 ## SYNOPSIS
 
 `ronin netcat` [*options*] [`--tcp` \| `--udp` \| `--ssl` \| `--tls`] {*HOST* *PORT* \| `-l` [*HOST*] *PORT* \| `--unix` *PATH*}
@@ -11,67 +15,67 @@ Connects to or listens on a TCP/UDP/SSL/TLS/UNIX socket.
 ## ARGUMENTS
 
 *HOST*
-  The remote hostname or IP address to connect to or the local hostname or IP
+: The remote hostname or IP address to connect to or the local hostname or IP
   address to listen on.
 
 *PORT*
-  The remote port to connect to or the local port to listen on.
+: The remote port to connect to or the local port to listen on.
 
 *PATH*
-  The path to the UNIX socket to connect to or listen on.
+: The path to the UNIX socket to connect to or listen on.
 
 ## OPTIONS
 
 `-v`, `--verbose`
-  Enables verbose output.
+: Enables verbose output.
 
 `--tcp`
-  Uses the TCP protocol.
+: Uses the TCP protocol.
 
 `--udp`
-  Uses the UDP protocol.
+: Uses the UDP protocol.
 
 `-U`, `--unix` *PATH*
-  Uses the UNIX socket protocol and connects to or listens on the given *PATH*.
+: Uses the UNIX socket protocol and connects to or listens on the given *PATH*.
 
 `-l`, `--listen`
-  Listens for incoming connections.
+: Listens for incoming connections.
 
 `-s`, `--source` *HOST*
-  Source address to bind to.
+: Source address to bind to.
 
 `-p`, `--source-port` *PORT*
-  Source port to bind to.
+: Source port to bind to.
 
 `-b`, `--buffer-size` *INT*
-  Buffer size to use. Defaults to 4096 if not given.
+: Buffer size to use. Defaults to 4096 if not given.
 
 `-x`, `--hexdump`
-  Hexdumps each message that is received.
+: Hexdumps each message that is received.
 
 `--ssl`
-  Enables SSL mode.
+: Enables SSL mode.
 
 `--tls`
-  Enables TLS mode.
+: Enables TLS mode.
 
 `--ssl-version` `1`\|`1.1`\|`1.2`
-  Specifies the required SSL version.
+: Specifies the required SSL version.
 
 `--ssl-cert` *FILE*
-  Specifies the SSL certificate file.
+: Specifies the SSL certificate file.
 
 `--ssl-key` *FILE*
-  Specifies the SSL key file.
+: Specifies the SSL key file.
 
 `--ssl-verify` `none`\|`peer`\|`fail-if-no-peer-cert`\|`client-once`\|`true`\|`false`
-  SSL verification mode.
+: SSL verification mode.
 
 `--ssl-ca-bundle` *PATH*
-  Path to the file or directory of CA certificates.
+: Path to the file or directory of CA certificates.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
 
 ## AUTHOR
 
@@ -79,4 +83,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-hexdump(1) ronin-http(1)
+[ronin-hexdump](ronin-hexdump.1.md) [ronin-http](ronin-http.1.md)

data/man/ronin-new-dns-proxy.1

@@ -0,0 +1,45 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-new-dns-proxy.1 "2023-02-01" Ronin "User Manuals"
+.SH SYNOPSIS
+.PP
+\fBronin new dns\-proxy\fR \[lB]\fIoptions\fP\[rB] \fIPATH\fP
+.SH DESCRIPTION
+.PP
+Creates a new \fBronin\-dns\-proxy\fR script\.
+.PP
+See https:\[sl]\[sl]github\.com\[sl]ronin\-rb\[sl]ronin\-dns\-proxy\[sh]readme
+.SH ARGUMENTS
+.TP
+\fIPATH\fP
+The path to the new script file\.
+.SH OPTIONS
+.TP
+\fB\-H\fR, \fB\-\-host\fR \fIIP\fP
+The IP to listen on\. Defaults to \fB127\.0\.0\.1\fR if not specified\.
+.TP
+\fB\-p\fR, \fB\-\-port\fR \fIPORT\fP
+The port number to listen on\. Defaults to \fB2345\fR if not specified\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help information
+.SH EXAMPLES
+.PP
+Generate a new \fBronin\-dns\-proxy\fR script:
+.PP
+.RS 4
+.EX
+\[Do] ronin new dns\-proxy proxy\.rb
+.EE
+.RE
+.PP
+See https:\[sl]\[sl]github\.com\[sl]ronin\-rb\[sl]ronin\-dns\-proxy\[sh]examples for more
+\fBronin\-dns\-proxy\fR examples\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.SH SEE ALSO
+.PP
+.BR ronin\-new\-script (1)

data/man/ronin-new-dns-proxy.1.md

@@ -0,0 +1,44 @@
+# ronin-new-dns-proxy.1 "2023-02-01" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin new dns-proxy` [*options*] *PATH*
+
+## DESCRIPTION
+
+Creates a new `ronin-dns-proxy` script.
+
+See https://github.com/ronin-rb/ronin-dns-proxy#readme
+
+## ARGUMENTS
+
+*PATH*
+: The path to the new script file.
+
+## OPTIONS
+
+`-H`, `--host` *IP*
+: The IP to listen on. Defaults to `127.0.0.1` if not specified.
+
+`-p`, `--port` *PORT*
+: The port number to listen on. Defaults to `2345` if not specified.
+
+`-h`, `--help`
+: Print help information
+
+## EXAMPLES
+
+Generate a new `ronin-dns-proxy` script:
+
+    $ ronin new dns-proxy proxy.rb
+
+See https://github.com/ronin-rb/ronin-dns-proxy#examples for more
+`ronin-dns-proxy` examples.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+[ronin-new-script](ronin-new-script.1.md)

data/man/ronin-new-project.1

@@ -1,84 +1,71 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-new-project 1 "2023-02-01" Ronin "User Manuals"
-.LP
 .SH SYNOPSIS
-.LP
-.HP
+.PP
 \fBronin new project\fR \[lB]\fIoptions\fP\[rB] \fIPATH\fP
-.LP
 .SH DESCRIPTION
-.LP
 .PP
 Creates a new Ruby project directory\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fIPATH\fP
 The path to the new project directory\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB--git\fR
+\fB\-\-git\fR
 Initializes a git repo\.
-.LP
 .TP
-\fB--ruby-version\fR \fIVERSION\fP
+\fB\-\-ruby\-version\fR \fIVERSION\fP
 The desired ruby version for the project\. Defaults to the current \fBruby\fR
 version if not specified\.
-.LP
 .TP
-\fB--rakefile\fR
+\fB\-\-rakefile\fR
 Creates a \fBRakefile\fR\.
-.LP
 .TP
-\fB--dockerfile\fR
+\fB\-\-dockerfile\fR
 Adds a \fBDockerfile\fR to the new project\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information
-.LP
 .SH EXAMPLES
-.LP
 .PP
 Generate a new Ruby project:
-.LP
-.nf
-ronin new project path\[sl]to\[sl]dir
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin new project path\[sl]to\[sl]dir
+.EE
+.RE
 .PP
 Set the desired ruby version for the project:
-.LP
-.nf
-ronin new project \-\-ruby\-version 3\.2\.0 path\[sl]to\[sl]dir
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin new project \-\-ruby\-version 3\.2\.0 path\[sl]to\[sl]dir
+.EE
+.RE
 .PP
 Add a \fBRakefile\fR to the project for defining automated tasks:
-.LP
-.nf
-ronin new project \-\-rakefile path\[sl]to\[sl]dir
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin new project \-\-rakefile path\[sl]to\[sl]dir
+.EE
+.RE
 .PP
 Add a \fBDockerfile\fR to the project:
-.LP
-.nf
-ronin new project \-\-dockerfile path\[sl]to\[sl]dir
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin new project \-\-dockerfile path\[sl]to\[sl]dir
+.EE
+.RE
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-new\-script(1)
+.BR ronin\-new\-script (1)

data/man/ronin-new-project.1.md

@@ -11,43 +11,43 @@ Creates a new Ruby project directory.
 ## ARGUMENTS
 
 *PATH*
-	The path to the new project directory.
+: The path to the new project directory.
 
 ## OPTIONS
 
 `--git`
-  Initializes a git repo.
+: Initializes a git repo.
 
 `--ruby-version` *VERSION*
-  The desired ruby version for the project. Defaults to the current `ruby`
+: The desired ruby version for the project. Defaults to the current `ruby`
   version if not specified.
 
 `--rakefile`
-  Creates a `Rakefile`.
+: Creates a `Rakefile`.
 
 `--dockerfile`
-  Adds a `Dockerfile` to the new project.
+: Adds a `Dockerfile` to the new project.
 
 `-h`, `--help`
-  Print help information
+: Print help information
 
 ## EXAMPLES
 
 Generate a new Ruby project:
 
-    ronin new project path/to/dir
+    $ ronin new project path/to/dir
 
 Set the desired ruby version for the project:
 
-    ronin new project --ruby-version 3.2.0 path/to/dir
+    $ ronin new project --ruby-version 3.2.0 path/to/dir
 
 Add a `Rakefile` to the project for defining automated tasks:
 
-    ronin new project --rakefile path/to/dir
+    $ ronin new project --rakefile path/to/dir
 
 Add a `Dockerfile` to the project:
 
-    ronin new project --dockerfile path/to/dir
+    $ ronin new project --dockerfile path/to/dir
 
 ## AUTHOR
 
@@ -55,4 +55,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-new-script(1)
+[ronin-new-script](ronin-new-script.1.md)

data/man/ronin-new-script.1

@@ -1,46 +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-new-script 1 "2023-02-01" Ronin "User Manuals"
-.LP
 .SH SYNOPSIS
-.LP
-.HP
+.PP
 \fBronin new script\fR \[lB]\fIoptions\fP\[rB] \fIPATH\fP
-.LP
 .SH DESCRIPTION
-.LP
 .PP
 Creates a new standalone Ruby script\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fIPATH\fP
 The path to the new script file\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information
-.LP
 .SH EXAMPLES
-.LP
 .PP
 Generate a new Ruby script:
-.LP
-.nf
-ronin new script file\.rb
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin new script file\.rb
+.EE
+.RE
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-new\-project(1)
+.BR ronin\-new\-project (1)

data/man/ronin-new-script.1.md

@@ -11,18 +11,18 @@ Creates a new standalone Ruby script.
 ## ARGUMENTS
 
 *PATH*
-	The path to the new script file.
+: The path to the new script file.
 
 ## OPTIONS
 
 `-h`, `--help`
-  Print help information
+: Print help information
 
 ## EXAMPLES
 
 Generate a new Ruby script:
 
-    ronin new script file.rb
+    $ ronin new script file.rb
 
 ## AUTHOR
 
@@ -30,4 +30,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-new-project(1)
+[ronin-new-project](ronin-new-project.1.md)