ronin-web 0.3.0.rc1 → 1.0.0.beta2

data/man/ronin-web-new-nokogiri.1

@@ -0,0 +1,41 @@
+.\" Generated by kramdown-man 0.1.8
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-web-new-nokogiri 1 "May 2022" Ronin "User Manuals"
+.LP
+.SH SYNOPSIS
+.LP
+.HP
+\fBronin-web new nokogiri\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIFILE\fP\[rB]
+.LP
+.SH DESCRIPTION
+.LP
+.PP
+Generates a new nokogiri Ruby script\.
+.LP
+.SH ARGUMENTS
+.LP
+.TP
+\fIFILE\fP
+The file to create\.
+.LP
+.SH OPTIONS
+.LP
+.TP
+\fB-U\fR, \fB--url\fR \fIURL\fP
+Optional URL for the script\.
+.LP
+.TP
+\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\-new\-server(1) ronin\-web\-new\-spider(1) ronin\-web\-new\-webapp(1)

data/man/ronin-web-new-nokogiri.1.md

@@ -0,0 +1,30 @@
+# ronin-web-new-nokogiri 1 "May 2022" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin-web new nokogiri` [*options*] [*FILE*]
+
+## DESCRIPTION
+
+Generates a new nokogiri Ruby script.
+
+## ARGUMENTS
+
+*FILE*
+  The file to create.
+
+## OPTIONS
+
+`-U`, `--url` *URL*
+  Optional URL for the script.
+
+`-h`, `--help`
+  Print help information
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+ronin-web-new-server(1) ronin-web-new-spider(1) ronin-web-new-webapp(1)

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

@@ -0,0 +1,45 @@
+.\" Generated by kramdown-man 0.1.8
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-web-new-server 1 "May 2022" Ronin "User Manuals"
+.LP
+.SH SYNOPSIS
+.LP
+.HP
+\fBronin-web new server\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIFILE\fP\[rB]
+.LP
+.SH DESCRIPTION
+.LP
+.PP
+Generates a new \fBronin-web-server\fR script\.
+.LP
+.SH ARGUMENTS
+.LP
+.TP
+\fIFILE\fP
+The file to create\.
+.LP
+.SH OPTIONS
+.LP
+.TP
+\fB-H\fR, \fB--host\fR \fIHOST\fP\[or]\fIIP\fP
+Optional host or IP interface to listen on\. Defaults to \fB0.0.0.0\fR\.
+.LP
+.TP
+\fB-p\fR, \fB--port\fR \fIPORT\fP
+Optional port to listen on\. Defaults to \fB8000\fR\.
+.LP
+.TP
+\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\-new\-nokogiri(1) ronin\-web\-new\-spider(1) ronin\-web\-new\-webapp(1)

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

@@ -0,0 +1,33 @@
+# ronin-web-new-server 1 "May 2022" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin-web new server` [*options*] [*FILE*]
+
+## DESCRIPTION
+
+Generates a new `ronin-web-server` script.
+
+## ARGUMENTS
+
+*FILE*
+  The file to create.
+
+## OPTIONS
+
+`-H`, `--host` *HOST*\|*IP*
+  Optional host or IP interface to listen on. Defaults to `0.0.0.0`.
+
+`-p`, `--port` *PORT*
+  Optional port to listen on. Defaults to `8000`.
+
+`-h`, `--help`
+  Print help information
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+ronin-web-new-nokogiri(1) ronin-web-new-spider(1) ronin-web-new-webapp(1)

data/man/ronin-web-new-spider.1

@@ -0,0 +1,173 @@
+.\" Generated by kramdown-man 0.1.8
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-web-new-spider 1 "May 2022" Ronin "User Manuals"
+.LP
+.SH SYNOPSIS
+.LP
+.HP
+\fBronin-web new spider\fR \[lB]\fIoptions\fP\[rB] \[lC]\fB--host\fR\[lB]\fB=\fR\fIHOST\fP\[rB] \[or] \fB--domain\fR\[lB]\fB=\fR\fIDOMAIN\fP\[rB] \[or] \fB--site\fR\[lB]\fB=\fR\fIURL\fP\[rB]\[rC] \[lB]\fIFILE\fP\[rB]
+.LP
+.SH DESCRIPTION
+.LP
+.PP
+Generates a new spider Ruby script\.
+.LP
+.SH ARGUMENTS
+.LP
+.TP
+\fIFILE\fP
+The file to create\.
+.LP
+.SH OPTIONS
+.LP
+.HP
+\fB--host\fR\[lB]\fB=\fR\fIHOST\fP\[rB]
+Spiders a host\.
+.LP
+.HP
+\fB--domain\fR\[lB]\fB=\fR\fIDOMAIN\fP\[rB]
+Spiders a domain\.
+.LP
+.HP
+\fB--site\fR\[lB]\fB=\fR\fIURL\fP\[rB]
+Spiders a site\.
+.LP
+.TP
+\fB--every-link\fR
+Adds a callback for every link\.
+.LP
+.TP
+\fB--every-url\fR
+Adds a callback for every URL\.
+.LP
+.TP
+\fB--every-failed-url\fR
+Adds a callback for every failed URL\.
+.LP
+.TP
+\fB--every-url-like\fR \fB/\fR\fIREGEXP\fP\fB/\fR
+Adds a callback for every URL that matches the regexp\.
+.LP
+.TP
+\fB--all-headers\fR
+Adds a callback for all HTTP Headers\.
+.LP
+.TP
+\fB--every-page\fR
+Adds a callback for every page\.
+.LP
+.TP
+\fB--every-ok-page\fR
+Adds a callback for every HTTP 200 page\.
+.LP
+.TP
+\fB--every-redirect-page\fR
+Adds a callback for every redirect page\.
+.LP
+.TP
+\fB--every-timedout-page\fR
+Adds a callback for every timedout page\.
+.LP
+.TP
+\fB--every-bad-request-page\fR
+Adds a callback for every bad request page\.
+.LP
+.TP
+\fB--every-unauthorized-page\fR
+Adds a callback for every unauthorized page\.
+.LP
+.TP
+\fB--every-forbidden-page\fR
+Adds a callback for every forbidden page\.
+.LP
+.TP
+\fB--every-missing-page\fR
+Adds a callback for every missing page\.
+.LP
+.TP
+\fB--every-internal-server-error-page\fR
+Adds a callback for every internal server error page\.
+.LP
+.TP
+\fB--every-txt-page\fR
+Adds a callback for every TXT page\.
+.LP
+.TP
+\fB--every-html-page\fR
+Adds a callback for every HTML page\.
+.LP
+.TP
+\fB--every-xml-page\fR
+Adds a callback for every XML page\.
+.LP
+.TP
+\fB--every-xsl-page\fR
+Adds a callback for every XSL page\.
+.LP
+.TP
+\fB--every-javascript-page\fR
+Adds a callback for every JavaScript page\.
+.LP
+.TP
+\fB--every-css-page\fR
+Adds a callback for every CSS page\.
+.LP
+.TP
+\fB--every-rss-page\fR
+Adds a callback for every RSS page\.
+.LP
+.TP
+\fB--every-atom-page\fR
+Adds a callback for every Atom page\.
+.LP
+.TP
+\fB--every-ms-word-page\fR
+Adds a callback for every MS Wod page\.
+.LP
+.TP
+\fB--every-pdf-page\fR
+Adds a callback for every PDF page\.
+.LP
+.TP
+\fB--every-zip-page\fR
+Adds a callback for every ZIP page\.
+.LP
+.TP
+\fB--every-doc\fR
+Adds a callback for every HTML\[sl]XML document\.
+.LP
+.TP
+\fB--every-html-doc\fR
+Adds a callback for every HTML document\.
+.LP
+.TP
+\fB--every-xml-doc\fR
+Adds a callback for every XML document\.
+.LP
+.TP
+\fB--every-xsl-doc\fR
+Adds a callback for every XSL document\.
+.LP
+.TP
+\fB--every-rss-doc\fR
+Adds a callback for every RSS document\.
+.LP
+.TP
+\fB--every-atom-doc\fR
+Adds a callback for every Atom document\.
+.LP
+.TP
+\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\-new\-nokogiri(1) ronin\-web\-new\-server(1) ronin\-web\-new\-webapp(1)

data/man/ronin-web-new-spider.1.md

@@ -0,0 +1,129 @@
+# ronin-web-new-spider 1 "May 2022" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin-web new spider` [*options*] {`--host`[`=`*HOST*] \| `--domain`[`=`*DOMAIN*] \| `--site`[`=`*URL*]} [*FILE*]
+
+## DESCRIPTION
+
+Generates a new spider Ruby script.
+
+## ARGUMENTS
+
+*FILE*
+  The file to create.
+
+## OPTIONS
+
+`--host`[`=`*HOST*]
+  Spiders a host.
+
+`--domain`[`=`*DOMAIN*]
+  Spiders a domain.
+
+`--site`[`=`*URL*]
+  Spiders a site.
+
+`--every-link`
+  Adds a callback for every link.
+
+`--every-url`
+  Adds a callback for every URL.
+
+`--every-failed-url`
+  Adds a callback for every failed URL.
+
+`--every-url-like` `/`*REGEXP*`/`
+  Adds a callback for every URL that matches the regexp.
+
+`--all-headers`
+  Adds a callback for all HTTP Headers.
+
+`--every-page`
+  Adds a callback for every page.
+
+`--every-ok-page`
+  Adds a callback for every HTTP 200 page.
+
+`--every-redirect-page`
+  Adds a callback for every redirect page.
+
+`--every-timedout-page`
+  Adds a callback for every timedout page.
+
+`--every-bad-request-page`
+  Adds a callback for every bad request page.
+
+`--every-unauthorized-page`
+  Adds a callback for every unauthorized page.
+
+`--every-forbidden-page`
+  Adds a callback for every forbidden page.
+
+`--every-missing-page`
+  Adds a callback for every missing page.
+
+`--every-internal-server-error-page`
+  Adds a callback for every internal server error page.
+
+`--every-txt-page`
+  Adds a callback for every TXT page.
+
+`--every-html-page`
+  Adds a callback for every HTML page.
+
+`--every-xml-page`
+  Adds a callback for every XML page.
+
+`--every-xsl-page`
+  Adds a callback for every XSL page.
+
+`--every-javascript-page`
+  Adds a callback for every JavaScript page.
+
+`--every-css-page`
+  Adds a callback for every CSS page.
+
+`--every-rss-page`
+  Adds a callback for every RSS page.
+
+`--every-atom-page`
+  Adds a callback for every Atom page.
+
+`--every-ms-word-page`
+  Adds a callback for every MS Wod page.
+
+`--every-pdf-page`
+  Adds a callback for every PDF page.
+
+`--every-zip-page`
+  Adds a callback for every ZIP page.
+
+`--every-doc`
+  Adds a callback for every HTML/XML document.
+
+`--every-html-doc`
+  Adds a callback for every HTML document.
+
+`--every-xml-doc`
+  Adds a callback for every XML document.
+
+`--every-xsl-doc`
+  Adds a callback for every XSL document.
+
+`--every-rss-doc`
+  Adds a callback for every RSS document.
+
+`--every-atom-doc`
+  Adds a callback for every Atom document.
+
+`-h`, `--help`
+  Print help information
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+ronin-web-new-nokogiri(1) ronin-web-new-server(1) ronin-web-new-webapp(1)

data/man/ronin-web-new-webapp.1

@@ -0,0 +1,53 @@
+.\" Generated by kramdown-man 0.1.8
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-web-new-webapp 1 "May 2022" Ronin "User Manuals"
+.LP
+.SH SYNOPSIS
+.LP
+.HP
+\fBronin-web new webapp\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIDIR\fP\[rB]
+.LP
+.SH DESCRIPTION
+.LP
+.PP
+Generates a new \fBronin-web-server\fR based webapp\.
+.LP
+.SH ARGUMENTS
+.LP
+.TP
+\fIDIR\fP
+The project directory to create\.
+.LP
+.SH OPTIONS
+.LP
+.TP
+\fB--port\fR \fIPORT\fP
+The port the webpp will listen on by default\. Defaults to \fB3000\fR\.
+.LP
+.TP
+\fB--ruby-version\fR \fIVERSION\fP
+The desired ruby version for the project Defaults to the current ruby version\.
+.LP
+.TP
+\fB--git\fR
+Initializes a git repo\.
+.LP
+.TP
+\fB-D\fR, \fB--dockerfile\fR
+Adds a \fBDockerfile\fR and a \fBdocker-compose.yml\fR file to the new project\.
+.LP
+.TP
+\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\-new\-nokogiri(1) ronin\-web\-new\-server(1) ronin\-web\-new\-spider(1)

data/man/ronin-web-new-webapp.1.md

@@ -0,0 +1,39 @@
+# ronin-web-new-webapp 1 "May 2022" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin-web new webapp` [*options*] [*DIR*]
+
+## DESCRIPTION
+
+Generates a new `ronin-web-server` based webapp.
+
+## ARGUMENTS
+
+*DIR*
+  The project directory to create.
+
+## OPTIONS
+
+`--port` *PORT*
+  The port the webpp will listen on by default. Defaults to `3000`.
+
+`--ruby-version` *VERSION*
+  The desired ruby version for the project Defaults to the current ruby version.
+
+`--git`
+  Initializes a git repo.
+
+`-D`, `--dockerfile`
+  Adds a `Dockerfile` and a `docker-compose.yml` file to the new project.
+
+`-h`, `--help`
+  Print help information
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+ronin-web-new-nokogiri(1) ronin-web-new-server(1) ronin-web-new-spider(1)

data/man/ronin-web-new.1

@@ -0,0 +1,59 @@
+.\" Generated by kramdown-man 0.1.8
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-web-new 1 "May 2022" Ronin "User Manuals"
+.LP
+.SH SYNOPSIS
+.LP
+.HP
+\fBronin-web new\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP\[rB]
+.LP
+.SH DESCRIPTION
+.LP
+.PP
+Creates a new web server, spider, or nokogiri script\.
+.LP
+.SH ARGUMENTS
+.LP
+.TP
+\fICOMMAND\fP
+The optional command to get detailed new information on\.
+.LP
+.SH OPTIONS
+.LP
+.TP
+\fB-h\fR, \fB--help\fR
+Print help information
+.LP
+.SH COMMANDS
+.LP
+.TP
+\fInokogiri\fP
+Generates a new \fBnokogiri\fR Ruby script\.
+.LP
+.TP
+\fIserver\fP
+Generates a new \fBronin-web-server\fR Ruby script\.
+.LP
+.TP
+\fIspider\fP
+Generates a new \fBronin-web-spider\fR Ruby script\.
+.LP
+.TP
+\fIwebapp\fP
+Generate a new \fBronin-web-server\fR based webapp\.
+.LP
+.TP
+\fIhelp\fP
+Lists available \fBronin new\fR commands\.
+.LP
+.SH AUTHOR
+.LP
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.LP
+.SH SEE ALSO
+.LP
+.PP
+ronin\-web\-new\-nokogiri(1) ronin\-web\-new\-server(1) ronin\-web\-new\-spider(1) ronin\-web\-new\-webapp(1)

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

@@ -0,0 +1,44 @@
+# ronin-web-new 1 "May 2022" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin-web new` [*options*] [*COMMAND*]
+
+## DESCRIPTION
+
+Creates a new web server, spider, or nokogiri script.
+
+## ARGUMENTS
+
+*COMMAND*
+	The optional command to get detailed new information on.
+
+## OPTIONS
+
+`-h`, `--help`
+  Print help information
+
+## COMMANDS
+
+*nokogiri*
+  Generates a new `nokogiri` Ruby script.
+
+*server*
+  Generates a new `ronin-web-server` Ruby script.
+
+*spider*
+  Generates a new `ronin-web-spider` Ruby script.
+
+*webapp*
+  Generate a new `ronin-web-server` based webapp.
+
+*help*
+  Lists available `ronin new` commands.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+ronin-web-new-nokogiri(1) ronin-web-new-server(1) ronin-web-new-spider(1) ronin-web-new-webapp(1)

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

@@ -0,0 +1,63 @@
+.\" Generated by kramdown-man 0.1.8
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-web-proxy 1 "2022-01-01" Ronin "User Manuals"
+.LP
+.SH SYNOPSIS
+.LP
+.HP
+\fBronin-web proxy\fR \[lB]\fIoptions\fP\[rB] \[lB]\fB--host\fR \fIHOST\fP\[rB] \[lB]\fB--port\fR \fIPORT\fP\[rB]
+.LP
+.SH DESCRIPTION
+.LP
+.PP
+Starts a HTTP proxy server\.
+.LP
+.SH OPTIONS
+.LP
+.TP
+\fB-H\fR, \fB--host\fR \fIHOST\fP
+The host that the proxy server will listen on\. Defaults to \fBlocalhost\fR\.
+.LP
+.TP
+\fB-p\fR, \fB--port\fR \fIPORT\fP
+The port that the proxy server will listen on\. Default to \fB8080\fR\.
+.LP
+.TP
+\fB-b\fR, \fB--show-body\fR
+Controls whether to display the request\[sl]response bodies or not\.
+.LP
+.HP
+\fB--rewrite-requests\fR \[lC]\fISTRING\fP:\fIREPLACE\fP\[or]\[sl]\fIREGEXP\fP\[sl]:\fIREPLACE\fP\[rC]
+Rewrites all request bodies by replacing the \fISTRING\fP or \fIREGEXP\fP with the
+given \fIREPLACE\fP string\.
+.LP
+.HP
+\fB--rewrite-responses\fR \[lC]\fISTRING\fP:\fIREPLACE\fP\[or]\[sl]\fIREGEXP\fP\[sl]:\fIREPLACE\fP\[rC]
+Rewrites all response bodies by replacing the \fISTRING\fP or \fIREGEXP\fP with the
+given \fIREPLACE\fP string\.
+.LP
+.TP
+\fB-h\fR, \fB--help\fR
+prints help information\.
+.LP
+.SH EXAMPLES
+.LP
+.TP
+\fBsudo ronin-web proxy --host 0.0.0.0 --port 80\fR
+Listen on the external interface on port 80\.
+.LP
+.TP
+\fBronin-web proxy --rewrite-responses https:http\fR
+Replace every occurrence of \fBhttps\fR with \fBhttp\fR in the response bodies\.
+.LP
+.SH AUTHOR
+.LP
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.LP
+.SH SEE ALSO
+.LP
+.PP
+ronin\-web\-server(1)