ronin-web 1.0.2 → 2.0.0.rc1

data/man/ronin-web-reverse-proxy.1.md

@@ -1,42 +1,48 @@
-# ronin-web-proxy 1 "2022-01-01" Ronin "User Manuals"
+# ronin-web-reverse-proxy 1 "2022-01-01" Ronin "User Manuals"
+
+## NAME
+
+ronin-web-reverse-proxy - Starts a HTTP proxy server
 
 ## SYNOPSIS
 
-`ronin-web proxy` [*options*] [`--host` *HOST*] [`--port` *PORT*]
+`ronin-web reverse-proxy` [*options*] [`--host` *HOST*] [`--port` *PORT*]
 
 ## DESCRIPTION
 
-Starts a HTTP proxy server.
+Starts a HTTP reverse proxy server.
 
 ## OPTIONS
 
 `-H`, `--host` *HOST*
-  The host that the proxy server will listen on. Defaults to `localhost`.
+: The host that the proxy server will listen on. Defaults to `localhost`.
 
 `-p`, `--port` *PORT*
-  The port that the proxy server will listen on. Default to `8080`.
+: The port that the proxy server will listen on. Default to `8080`.
 
 `-b`, `--show-body`
-  Controls whether to display the request/response bodies or not.
+: Controls whether to display the request/response bodies or not.
 
 `--rewrite-requests` {*STRING*:*REPLACE*|/*REGEXP*/:*REPLACE*}
-  Rewrites all request bodies by replacing the *STRING* or *REGEXP* with the
+: Rewrites all request bodies by replacing the *STRING* or *REGEXP* with the
   given *REPLACE* string.
 
 `--rewrite-responses` {*STRING*:*REPLACE*|/*REGEXP*/:*REPLACE*}
-  Rewrites all response bodies by replacing the *STRING* or *REGEXP* with the
+: Rewrites all response bodies by replacing the *STRING* or *REGEXP* with the
   given *REPLACE* string.
 
 `-h`, `--help`
-  prints help information.
+: prints help information.
 
 ## EXAMPLES
 
-`sudo ronin-web proxy --host 0.0.0.0 --port 80`
-  Listen on the external interface on port 80.
+Listen on the external interface on port 80:
+
+    $ sudo ronin-web reverse-proxy --host 0.0.0.0 --port 80
+
+Replace every occurrence of `https` with `http` in the response bodies:
 
-`ronin-web proxy --rewrite-responses https:http`
-  Replace every occurrence of `https` with `http` in the response bodies.
+    $ ronin-web reverse-proxy --rewrite-responses https:http
 
 ## AUTHOR
 
@@ -44,4 +50,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-web-server(1)
+[ronin-web-server](ronin-web-server.1.md)

data/man/ronin-web-screenshot.1

@@ -0,0 +1,56 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-web-screenshot 1 "2023-05-01" Ronin Web "User Manuals"
+.SH NAME
+.PP
+ronin\-web\-screenshot \- Screenshots one or more URLs
+.SH SYNOPSIS
+.PP
+\fBronin\-web\-screenshot\fR \[lB]\fIoptions\fP\[rB] \[lC]\fIURL\fP \[lB]\.\.\.\[rB] \[or] \fB\-\-file\fR \fIFILE\fP\[rC]
+.SH DESCRIPTION
+.PP
+Screenshots one or more URLs\.
+.SH ARGUMENTS
+.TP
+\fIURL\fP
+A \fBhttps:\[sl]\[sl]\fR or \fBhttp:\[sl]\[sl]\fR URL of the web page to diff\.
+.SH OPTIONS
+.TP
+\fB\-B\fR, \fB\-\-browser\fR \fINAME\fP\[or]\fIPATH\fP
+The browser name or path to execute\.
+.TP
+\fB\-W\fR, \fB\-\-width\fR \fIWIDTH\fP
+Sets the width of the browser viewport\. Defaults to \fB1024\fR if not given\.
+\.
+\fB\-H\fR, \fB\-\-height\fR \fIHEIGHT\fP
+.RS
+.PP
+Sets the height of the browser viewport\. Defaults to \fB768\fR if not given\.
+.RE
+.TP
+\fB\-f\fR, \fB\-\-file\fR \fIFILE\fP
+Input file to read URLs from\.
+.TP
+\fB\-F\fR, \fB\-\-format\fR \fBpng\fR\[or]\fBjpg\fR
+Screenshot image file format to use\. Defaults to \fBpng\fR if not given\.
+.TP
+\fB\-d\fR, \fB\-\-directory\fR \fIDIR\fP
+Directory to save images to\. Defaults to the current working directory if not
+given\.
+.TP
+\fB\-f\fR, \fB\-\-full\fR
+Screenshots the full page\.
+.TP
+\fB\-C\fR, \fB\-\-css\-path\fR \fICSSPath\fP
+The CSSpath selector to screenshot\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help information
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.SH SEE ALSO
+.PP
+.BR ronin\-web\-browser (1)

data/man/ronin-web-screenshot.1.md

@@ -0,0 +1,56 @@
+# ronin-web-screenshot 1 "2023-05-01" Ronin Web "User Manuals"
+
+## NAME
+
+ronin-web-screenshot - Screenshots one or more URLs
+
+## SYNOPSIS
+
+`ronin-web-screenshot` [*options*] {*URL* [...] \| `--file` *FILE*}
+
+## DESCRIPTION
+
+Screenshots one or more URLs.
+
+## ARGUMENTS
+
+*URL*
+: A `https://` or `http://` URL of the web page to diff.
+
+## OPTIONS
+
+`-B`, `--browser` *NAME*\|*PATH*
+: The browser name or path to execute.
+
+`-W`, `--width` *WIDTH*
+: Sets the width of the browser viewport. Defaults to `1024` if not given.
+  .
+`-H`, `--height` *HEIGHT*
+: Sets the height of the browser viewport. Defaults to `768` if not given.
+
+`-f`, `--file` *FILE*
+: Input file to read URLs from.
+
+`-F`, `--format` `png`\|`jpg`
+: Screenshot image file format to use. Defaults to `png` if not given.
+
+`-d`, `--directory` *DIR*
+: Directory to save images to. Defaults to the current working directory if not
+  given.
+
+`-f`, `--full`
+: Screenshots the full page.
+
+`-C`, `--css-path` *CSSPath*
+: The CSSpath selector to screenshot.
+
+`-h`, `--help`
+: Print help information
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+[ronin-web-browser](ronin-web-browser.1.md)

data/man/ronin-web-server.1

@@ -1,59 +1,45 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-web-server 1 "2022-01-01" Ronin Web "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-web\-server \- Starts a web server
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin-web-server\fR \[lB]\fIoptions\fP\[rB]
-.LP
+.PP
+\fBronin\-web\-server\fR \[lB]\fIoptions\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
 Starts a web server\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-H\fR, \fB--host\fR \fIHOST\fP
+\fB\-H\fR, \fB\-\-host\fR \fIHOST\fP
 Host name or IP to bind to\. Defaults to \fBlocalhost\fR\.
-.LP
 .TP
-\fB-p\fR, \fB--port\fR \fIPORT\fP
+\fB\-p\fR, \fB\-\-port\fR \fIPORT\fP
 Port number to listen on\. Defaults to \fB8000\fR\.
-.LP
 .TP
-\fB-A\fR, \fB--basic-auth\fR \fIUSER\fP:\fIPASSWORD\fP
+\fB\-A\fR, \fB\-\-basic\-auth\fR \fIUSER\fP:\fIPASSWORD\fP
 Sets up Basic\-Authentication with the given \fIUSER\fP and \fIPASSWORD\fP\.
-.LP
 .TP
-\fB-d\fR, \fB--dir\fR \[sl]\fIPATH\fP:\fIDIR\fP
+\fB\-d\fR, \fB\-\-dir\fR \[sl]\fIPATH\fP:\fIDIR\fP
 Mounts a directory to the given \fIPATH\fP\.
-.LP
 .TP
-\fB-f\fR, \fB--file\fR \[sl]\fIPATH\fP:\fIFILE\fP
+\fB\-f\fR, \fB\-\-file\fR \[sl]\fIPATH\fP:\fIFILE\fP
 Mounts a file to the given \fIPATH\fP\.
-.LP
 .TP
-\fB-r\fR, \fB--root\fR \fIDIR\fP
+\fB\-r\fR, \fB\-\-root\fR \fIDIR\fP
 Root directory to serve\.
-.LP
 .TP
-\fB-R\fR, \fB--redirect\fR \[sl]\fIPATH\fP:\fIURL\fP
+\fB\-R\fR, \fB\-\-redirect\fR \[sl]\fIPATH\fP:\fIURL\fP
 Registers a \fB302 Found\fR redirect at the given \fIPATH\fP
-.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\-web\-proxy(1)
+.BR ronin\-web\-proxy (1)

data/man/ronin-web-server.1.md

@@ -1,5 +1,9 @@
 # ronin-web-server 1 "2022-01-01" Ronin Web "User Manuals"
 
+## NAME
+
+ronin-web-server - Starts a web server
+
 ## SYNOPSIS
 
 `ronin-web-server` [*options*]
@@ -11,28 +15,28 @@ Starts a web server.
 ## OPTIONS
 
 `-H`, `--host` *HOST*
-  Host name or IP to bind to. Defaults to `localhost`.
+: Host name or IP to bind to. Defaults to `localhost`.
 
 `-p`, `--port` *PORT*
-  Port number to listen on. Defaults to `8000`.
+: Port number to listen on. Defaults to `8000`.
 
 `-A`, `--basic-auth` *USER*:*PASSWORD*
-  Sets up Basic-Authentication with the given *USER* and *PASSWORD*.
+: Sets up Basic-Authentication with the given *USER* and *PASSWORD*.
 
 `-d`, `--dir` /*PATH*:*DIR*
-  Mounts a directory to the given *PATH*.
+: Mounts a directory to the given *PATH*.
 
 `-f`, `--file` /*PATH*:*FILE*
-  Mounts a file to the given *PATH*.
+: Mounts a file to the given *PATH*.
 
 `-r`, `--root` *DIR*
-  Root directory to serve.
+: Root directory to serve.
 
 `-R`, `--redirect` /*PATH*:*URL*
-  Registers a `302 Found` redirect at the given *PATH*
+: Registers a `302 Found` redirect at the given *PATH*
 
 `-h`, `--help`
-  Print help information
+: Print help information
 
 ## AUTHOR
 
@@ -40,4 +44,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-web-proxy(1)
+[ronin-web-proxy](ronin-web-proxy.1.md)

data/man/ronin-web-session-cookie.1

@@ -0,0 +1,38 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-web-session-cookie 1 "2023-03-01" Ronin "User Manuals"
+.SH NAME
+.PP
+ronin\-web\-session\-cookie \- Parses and deserializes various session cookie formats
+.SH SYNOPSIS
+.PP
+\fBronin\-web session\-cookie\fR \[lB]\fIoptions\fP\[rB] \[lC]\fIURL\fP \[or] \fISTRING\fP\[rC]
+.SH DESCRIPTION
+.PP
+Parses and deserializes various session cookie formats\. Currently supports
+Python Django (JSON and Pickle), JSON Web Token (JWT), and Ruby Rack session
+cookies\.
+.SH ARGUMENTS
+.TP
+\fIURL\fP
+The \fBhttp:\[sl]\[sl]\fR or \fBhttps:\[sl]\[sl]\fR URL to request and extract the session cookie
+from\.
+.TP
+\fISTRING\fP
+The session cookie string to parse\.
+.SH OPTIONS
+.TP
+\fB\-F\fR, \fB\-\-format\fR \[lB]\fBruby\fR \[or] \fBjson\fR \[or] \fByaml\fR\[rB]
+The format to print the session cookie params\. Defaults to \fBruby\fR if not
+given\.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Enables verbose output\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help information\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME

data/man/ronin-web-session-cookie.1.md

@@ -0,0 +1,41 @@
+# ronin-web-session-cookie 1 "2023-03-01" Ronin "User Manuals"
+
+## NAME
+
+ronin-web-session-cookie - Parses and deserializes various session cookie formats
+
+## SYNOPSIS
+
+`ronin-web session-cookie` [*options*] {*URL* \| *STRING*}
+
+## DESCRIPTION
+
+Parses and deserializes various session cookie formats. Currently supports
+Python Django (JSON and Pickle), JSON Web Token (JWT), and Ruby Rack session
+cookies.
+
+## ARGUMENTS
+
+*URL*
+: The `http://` or `https://` URL to request and extract the session cookie
+  from.
+
+*STRING*
+: The session cookie string to parse.
+
+## OPTIONS
+
+`-F`, `--format` [`ruby` \| `json` \| `yaml`]
+: The format to print the session cookie params. Defaults to `ruby` if not
+  given.
+
+`-v`, `--verbose`
+: Enables verbose output.
+
+`-h`, `--help`
+: Print help information.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+