ronin-web 1.0.2 → 2.0.0.rc1

data/man/ronin-web-completion.1

@@ -0,0 +1,76 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-web-completion 1 "2024-01-01" Ronin Web "User Manuals"
+.SH NAME
+.PP
+ronin\-web\-completion \- Manages shell completion rules for \fBronin\-web\fR
+.SH SYNOPSIS
+.PP
+\fBronin\-web completion\fR \[lB]\fIoptions\fP\[rB]
+.SH DESCRIPTION
+.PP
+The \fBronin\-web completion\fR command can print, install, or uninstall shell
+completion rules for the \fBronin\-web\fR command\.
+.PP
+Supports installing completion rules for Bash or Zsh shells\.
+Completion rules for the Fish shell is currently not supported\.
+.SS ZSH SUPPORT
+.PP
+Zsh users will have to add the following lines to their \fB\[ti]\[sl]\.zshrc\fR file in
+order to enable Zsh\[cq]s Bash completion compatibility layer:
+.PP
+.RS 4
+.EX
+autoload \-Uz \[pl]X compinit && compinit
+autoload \-Uz \[pl]X bashcompinit && bashcompinit
+.EE
+.RE
+.SH OPTIONS
+.TP
+\fB\-\-print\fR
+Prints the shell completion file\.
+.TP
+\fB\-\-install\fR
+Installs the shell completion file\.
+.TP
+\fB\-\-uninstall\fR
+Uninstalls the shell completion file\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Prints help information\.
+.SH ENVIRONMENT
+.TP
+\fIPREFIX\fP
+Specifies the root prefix for the file system\.
+.TP
+\fIHOME\fP
+Specifies the home directory of the user\. Ronin will search for the
+\fB\[ti]\[sl]\.cache\[sl]ronin\-web\fR cache directory within the home directory\.
+.TP
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Specifies the data directory to use\. Defaults to \fB\[Do]HOME\[sl]\.local\[sl]share\fR\.
+.SH FILES
+.TP
+\fB\[ti]\[sl]\.local\[sl]share\[sl]bash\-completion\[sl]completions\[sl]\fR
+The user\-local installation directory for Bash completion files\.
+.TP
+\fB\[sl]usr\[sl]local\[sl]share\[sl]bash\-completion\[sl]completions\[sl]\fR
+The system\-wide installation directory for Bash completions files\.
+.TP
+\fB\[sl]usr\[sl]local\[sl]share\[sl]zsh\[sl]site\-functions\[sl]\fR
+The installation directory for Zsh completion files\.
+.SH EXAMPLES
+.TP
+\fBronin\-web completion \-\-print\fR
+Prints the shell completion rules instead of installing them\.
+.TP
+\fBronin\-web completion \-\-install\fR
+Installs the shell completion rules for \fBronin\-web\fR\.
+.TP
+\fBronin\-web completion \-\-uninstall\fR
+Uninstalls the shell completion rules for \fBronin\-web\fR\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME

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

@@ -0,0 +1,78 @@
+# ronin-web-completion 1 "2024-01-01" Ronin Web "User Manuals"
+
+## NAME
+
+ronin-web-completion - Manages shell completion rules for `ronin-web`
+
+## SYNOPSIS
+
+`ronin-web completion` [*options*]
+
+## DESCRIPTION
+
+The `ronin-web completion` command can print, install, or uninstall shell
+completion rules for the `ronin-web` command.
+
+Supports installing completion rules for Bash or Zsh shells.
+Completion rules for the Fish shell is currently not supported.
+
+### ZSH SUPPORT
+
+Zsh users will have to add the following lines to their `~/.zshrc` file in
+order to enable Zsh's Bash completion compatibility layer:
+
+    autoload -Uz +X compinit && compinit
+    autoload -Uz +X bashcompinit && bashcompinit
+
+## OPTIONS
+
+`--print`
+: Prints the shell completion file.
+
+`--install`
+: Installs the shell completion file.
+
+`--uninstall`
+: Uninstalls the shell completion file.
+
+`-h`, `--help`
+: Prints help information.
+
+## ENVIRONMENT
+
+*PREFIX*
+: Specifies the root prefix for the file system.
+
+*HOME*
+: Specifies the home directory of the user. Ronin will search for the
+  `~/.cache/ronin-web` cache directory within the home directory.
+
+*XDG_DATA_HOME*
+: Specifies the data directory to use. Defaults to `$HOME/.local/share`.
+
+## FILES
+
+`~/.local/share/bash-completion/completions/`
+: The user-local installation directory for Bash completion files.
+
+`/usr/local/share/bash-completion/completions/`
+: The system-wide installation directory for Bash completions files.
+
+`/usr/local/share/zsh/site-functions/`
+: The installation directory for Zsh completion files.
+
+## EXAMPLES
+
+`ronin-web completion --print`
+: Prints the shell completion rules instead of installing them.
+
+`ronin-web completion --install`
+: Installs the shell completion rules for `ronin-web`.
+
+`ronin-web completion --uninstall`
+: Uninstalls the shell completion rules for `ronin-web`.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+

data/man/ronin-web-diff.1

@@ -1,41 +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-web-diff 1 "2022-01-01" Ronin Web "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-web\-diff \- Diffs two web pages
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin-web-diff\fR \[lB]\fIoptions\fP\[rB] \[lC]\fIURL\fP \[or] \fIFILE\fP\[rC] \[lC]\fIURL\fP \[or] \fIFILE\fP\[rC]
-.LP
+.PP
+\fBronin\-web diff\fR \[lB]\fIoptions\fP\[rB] \[lC]\fIURL\fP \[or] \fIFILE\fP\[rC] \[lC]\fIURL\fP \[or] \fIFILE\fP\[rC]
 .SH DESCRIPTION
-.LP
 .PP
-Diffs two separate webpages and prints the HTML nodes which change changed\.
-.LP
+Diffs two separate HTML or XML pages and prints the HTML\[sl]XML nodes which were changed\.
 .SH ARGUMENTS
-.LP
 .TP
 \fIURL\fP
-A \fBhttps://\fR or \fBhttp://\fR URL of the web page to diff\.
-.LP
+A \fBhttps:\[sl]\[sl]\fR or \fBhttp:\[sl]\[sl]\fR URL of the web page to diff\.
 .TP
 \fIFILE\fP
-A path to the local HTML file to diff\.
-.LP
+A path to the local HTML or XML file to diff\.
 .SH OPTIONS
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information
-.LP
+.TP
+\fB\-f\fR, \fB\-\-format\fR \fBhtml\fR\[or]\fBxml\fR
+Pass the format of the URL or files\. Supported formats are \fBhtml\fR and \fBxml\fR\. (Default: \fBhtml\fR)
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-web\-html(1)
+.BR ronin\-web\-html (1)

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

@@ -1,25 +1,32 @@
 # ronin-web-diff 1 "2022-01-01" Ronin Web "User Manuals"
 
+## NAME
+
+ronin-web-diff - Diffs two web pages
+
 ## SYNOPSIS
 
-`ronin-web-diff` [*options*] {*URL* \| *FILE*} {*URL* \| *FILE*}
+`ronin-web diff` [*options*] {*URL* \| *FILE*} {*URL* \| *FILE*}
 
 ## DESCRIPTION
 
-Diffs two separate webpages and prints the HTML nodes which change changed.
+Diffs two separate HTML or XML pages and prints the HTML/XML nodes which were changed.
 
 ## ARGUMENTS
 
 *URL*
-  A `https://` or `http://` URL of the web page to diff.
+: A `https://` or `http://` URL of the web page to diff.
 
 *FILE*
-  A path to the local HTML file to diff.
+: A path to the local HTML or XML file to diff.
 
 ## OPTIONS
 
 `-h`, `--help`
-  Print help information
+: Print help information
+
+`-f`, `--format` `html`|`xml`
+: Pass the format of the URL or files. Supported formats are `html` and `xml`. (Default: `html`)
 
 ## AUTHOR
 
@@ -27,4 +34,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-web-html(1)
+[ronin-web-html](ronin-web-html.1.md)

data/man/ronin-web-html.1

@@ -1,89 +1,73 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-web-html 1 "2022-01-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-web\-html \- Performs XPath\[sl]CSS\-path queries on a URL or HTML file
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin-web html\fR \[lB]\fIoptions\fP\[rB] \[lC]\fIURL\fP \[or] \fIFILE\fP\[rC] \[lB]\fIXPATH\fP \[or] \fICSS\-path\fP\[rB]
-.LP
+.PP
+\fBronin\-web html\fR \[lB]\fIoptions\fP\[rB] \[lC]\fIURL\fP \[or] \fIFILE\fP\[rC] \[lB]\fIXPATH\fP \[or] \fICSS\-path\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
 Performs XPath\[sl]CSS\-path queries on a URL or HTML file\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fIURL\fP
-The \fBhttp://\fR or \fBhttps://\fR URL to fetch and parse\.
-.LP
+The \fBhttp:\[sl]\[sl]\fR or \fBhttps:\[sl]\[sl]\fR URL to fetch and parse\.
 .TP
 \fIFILE\fP
 The local HTML file to parse\.
-.LP
 .TP
 \fIXPATH\fP
 The XPath query expression\.
-.LP
 .TP
 \fICSS\-path\fP
 The CSS\-path query expression\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-X\fR, \fB--xpath\fR \fIXPATH\fP
+\fB\-X\fR, \fB\-\-xpath\fR \fIXPATH\fP
 The XPath query to perform\.
-.LP
 .TP
-\fB-C\fR, \fB--css-path\fR \fICSS\-path\fP
+\fB\-C\fR, \fB\-\-css\-path\fR \fICSS\-path\fP
 The CSS\-path query to perform\.
-.LP
 .TP
-\fB-M\fR, \fB--meta-tags\fR
-Searches for all \fB<meta ...>\fR tags\.
-.LP
+\fB\-t\fR, \fB\-\-text\fR
+Prints the inner\-text of the matching elements\.
 .TP
-\fB-l\fR, \fB--links\fR
-Searches for all \fB<a href="...">\fR URLs\.
-.LP
+\fB\-M\fR, \fB\-\-meta\-tags\fR
+Searches for all \fB<meta \.\.\.>\fR tags\.
 .TP
-\fB-S\fR, \fB--style\fR
+\fB\-l\fR, \fB\-\-links\fR
+Searches for all \fB<a href\[eq]\[dq]\.\.\.\[dq]>\fR URLs\.
+.TP
+\fB\-S\fR, \fB\-\-style\fR
 Dumps all \fB<style>\fR tags\.
-.LP
 .TP
-\fB-s\fR, \fB--stylesheet-urls\fR
-Searches for all \fB<link type="text/css" href="..."/>\fR URLs\.
-.LP
+\fB\-s\fR, \fB\-\-stylesheet\-urls\fR
+Searches for all \fB<link type\[eq]\[dq]text\[sl]css\[dq] href\[eq]\[dq]\.\.\.\[dq]\[sl]>\fR URLs\.
 .TP
-\fB-J\fR, \fB--javascript\fR
+\fB\-J\fR, \fB\-\-javascript\fR
 Dumps all javascript source code\.
-.LP
 .TP
-\fB-j\fR, \fB--javascript-urls\fR
-Searches for all \fB<script src="...">\fR URLs\.
-.LP
+\fB\-j\fR, \fB\-\-javascript\-urls\fR
+Searches for all \fB<script src\[eq]\[dq]\.\.\.\[dq]>\fR URLs\.
 .TP
-\fB-f\fR, \fB--form-urls\fR
-Searches for all \fB<form action="...">\fR URLS\.
-.LP
+\fB\-f\fR, \fB\-\-form\-urls\fR
+Searches for all \fB<form action\[eq]\[dq]\.\.\.\[dq]>\fR URLS\.
 .TP
-\fB-u\fR, \fB--urls\fR
+\fB\-u\fR, \fB\-\-urls\fR
 Dumps all URLs in the page\.
-.LP
 .TP
-\fB-F\fR, \fB--first\fR
+\fB\-F\fR, \fB\-\-first\fR
 Only print the first match\.
-.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
+.PP
+.BR ronin\-web\-xml (1)

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

@@ -1,5 +1,9 @@
 # ronin-web-html 1 "2022-01-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-web-html - Performs XPath/CSS-path queries on a URL or HTML file
+
 ## SYNOPSIS
 
 `ronin-web html` [*options*] {*URL* \| *FILE*} [*XPATH* \| *CSS-path*]
@@ -11,56 +15,62 @@ Performs XPath/CSS-path queries on a URL or HTML file.
 ## ARGUMENTS
 
 *URL*
-  The `http://` or `https://` URL to fetch and parse.
+: The `http://` or `https://` URL to fetch and parse.
 
 *FILE*
-  The local HTML file to parse.
+: The local HTML file to parse.
 
 *XPATH*
-  The XPath query expression.
+: The XPath query expression.
 
 *CSS-path*
-  The CSS-path query expression.
+: The CSS-path query expression.
 
 ## OPTIONS
 
 `-X`, `--xpath` *XPATH*
-  The XPath query to perform.
-  
+: The XPath query to perform.
+
 `-C`, `--css-path` *CSS-path*
-  The CSS-path query to perform.
+: The CSS-path query to perform.
+
+`-t`, `--text`
+: Prints the inner-text of the matching elements.
 
 `-M`, `--meta-tags`
-  Searches for all `<meta ...>` tags.
+: Searches for all `<meta ...>` tags.
 
 `-l`, `--links`
-  Searches for all `<a href="...">` URLs.
+: Searches for all `<a href="...">` URLs.
 
 `-S`, `--style`
-  Dumps all `<style>` tags.
+: Dumps all `<style>` tags.
 
 `-s`, `--stylesheet-urls`
-  Searches for all `<link type="text/css" href="..."/>` URLs.
+: Searches for all `<link type="text/css" href="..."/>` URLs.
 
 `-J`, `--javascript`
-  Dumps all javascript source code.
+: Dumps all javascript source code.
 
 `-j`, `--javascript-urls`
-  Searches for all `<script src="...">` URLs.
+: Searches for all `<script src="...">` URLs.
 
 `-f`, `--form-urls`
-  Searches for all `<form action="...">` URLS.
+: Searches for all `<form action="...">` URLS.
 
 `-u`, `--urls`
-  Dumps all URLs in the page.
+: Dumps all URLs in the page.
 
 `-F`, `--first`
-  Only print the first match.
+: Only print the first match.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
 
 ## AUTHOR
 
 Postmodern <postmodern.mod3@gmail.com>
 
+## SEE ALSO
+
+[ronin-web-xml](ronin-web-xml.1.md)

data/man/ronin-web-irb.1

@@ -1,31 +1,24 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-web-irb 1 "May 2022" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-web\-irb \- Starts an interactive Ruby shell with ronin\-web loaded
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin-web irb\fR \[lB]\fIoptions\fP\[rB]
-.LP
+.PP
+\fBronin\-web irb\fR \[lB]\fIoptions\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
-Starts an interactive Ruby shell with \fBronin/web\fR loaded\.
-.LP
+Starts an interactive Ruby shell with \fBronin\[sl]web\fR loaded\.
 .SH OPTIONS
-.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(1)
+.BR ronin\-web (1)

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

@@ -1,5 +1,9 @@
 # ronin-web-irb 1 "May 2022" Ronin "User Manuals"
 
+## NAME
+
+ronin-web-irb - Starts an interactive Ruby shell with ronin-web loaded
+
 ## SYNOPSIS
 
 `ronin-web irb` [*options*]
@@ -11,7 +15,7 @@ Starts an interactive Ruby shell with `ronin/web` loaded.
 ## OPTIONS
 
 `-h`, `--help`
-  Print help information
+: Print help information
 
 ## AUTHOR
 
@@ -19,4 +23,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-web(1)
+[ronin-web](ronin-web.1.md)

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

@@ -0,0 +1,39 @@
+# ronin-web-new-app 1 "May 2022" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin-web new app` [*options*] [*DIR*]
+
+## DESCRIPTION
+
+Generates a new `ronin-web-server` based web app.
+
+## ARGUMENTS
+
+*DIR*
+: The project directory to create.
+
+## OPTIONS
+
+`--port` *PORT*
+: The port the app 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](ronin-web-new-nokogiri.1.md) [ronin-web-new-server](ronin-web-new-server.1.md) [ronin-web-new-spider](ronin-web-new-spider.1.md)

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

@@ -1,41 +1,30 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" 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
+.PP
+\fBronin\-web new nokogiri\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIFILE\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
-Generates a new nokogiri Ruby script\.
-.LP
+Generates a new nokogiri Ruby script for parsing HTML\[sl]XML\.
 .SH ARGUMENTS
-.LP
 .TP
 \fIFILE\fP
 The file to create\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-U\fR, \fB--url\fR \fIURL\fP
+\fB\-U\fR, \fB\-\-url\fR \fIURL\fP
 Optional URL for the script\.
-.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\-new\-server(1) ronin\-web\-new\-spider(1) ronin\-web\-new\-webapp(1)
+.BR ronin\-web\-new\-server (1)
+.BR ronin\-web\-new\-spider (1)
+.BR ronin\-web\-new\-app (1)

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

@@ -6,20 +6,20 @@
 
 ## DESCRIPTION
 
-Generates a new nokogiri Ruby script.
+Generates a new nokogiri Ruby script for parsing HTML/XML.
 
 ## ARGUMENTS
 
 *FILE*
-  The file to create.
+: The file to create.
 
 ## OPTIONS
 
 `-U`, `--url` *URL*
-  Optional URL for the script.
+: Optional URL for the script.
 
 `-h`, `--help`
-  Print help information
+: Print help information
 
 ## AUTHOR
 
@@ -27,4 +27,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-web-new-server(1) ronin-web-new-spider(1) ronin-web-new-webapp(1)
+[ronin-web-new-server](ronin-web-new-server.1.md) [ronin-web-new-spider](ronin-web-new-spider.1.md) [ronin-web-new-app](ronin-web-new-app.1.md)