ronin 2.0.4 → 2.1.0.rc1

data/man/ronin-cert-gen.1

@@ -1,153 +1,132 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-cert-gen 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-cert\-gen \- Generates a new X509 certificate
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin cert-gen\fR \[lB]\fIoptions\fP\[rB]
-.LP
+.PP
+\fBronin cert\-gen\fR \[lB]\fIoptions\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
 Generates a new X509 certificate\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB--version\fR \fINUM\fP
+\fB\-\-version\fR \fINUM\fP
 The certificate version number Defaults to \fB2\fR if not given\.
-.LP
 .TP
-\fB--serial\fR \fINUM\fP
+\fB\-\-serial\fR \fINUM\fP
 The certificate serial number Defaults to \fB0\fR if not given\.
-.LP
 .TP
-\fB--not-before\fR \fITIME\fP
+\fB\-\-not\-before\fR \fITIME\fP
 When the certificate becomes valid\. Defaults to the current time\.
-.LP
 .TP
-\fB--not-after\fR \fITIME\fP
+\fB\-\-not\-after\fR \fITIME\fP
 When the certificate becomes no longer valid\. Defaults to one year from now\.
-.LP
 .TP
-\fB-c\fR, \fB--common-name\fR \fIDOMAIN\fP
+\fB\-c\fR, \fB\-\-common\-name\fR \fIDOMAIN\fP
 The Common Name (CN) for the certificate\.
-.LP
 .TP
-\fB-A\fR, \fB--subject-alt-name\fR \fIHOST\fP\[or]\fIIP\fP
+\fB\-A\fR, \fB\-\-subject\-alt\-name\fR \fIHOST\fP\[or]\fIIP\fP
 Adds HOST or IP to \fBsubjectAltName\fR\.
-.LP
 .TP
-\fB-O\fR, \fB--organization\fR \fINAME\fP
+\fB\-O\fR, \fB\-\-organization\fR \fINAME\fP
 The Organization (O) for the certificate\.
-.LP
 .TP
-\fB-U\fR, \fB--organizational-unit\fR \fINAME\fP
+\fB\-U\fR, \fB\-\-organizational\-unit\fR \fINAME\fP
 The Organizational Unit (OU)\.
-.LP
 .TP
-\fB-L\fR, \fB--locality\fR \fINAME\fP
+\fB\-L\fR, \fB\-\-locality\fR \fINAME\fP
 The locality for the certificate\.
-.LP
 .TP
-\fB-S\fR, \fB--state\fR \fIXX\fP
+\fB\-S\fR, \fB\-\-state\fR \fIXX\fP
 The two\-letter State (ST) code for the certificate\.
-.LP
 .TP
-\fB-C\fR, \fB--country\fR \fIXX\fP
+\fB\-C\fR, \fB\-\-country\fR \fIXX\fP
 The two\-letter Country (C) code for the certificate\.
-.LP
-.HP
-\fB-t\fR, \fB--key-type\fR rsa\[or]ec\`
+.TP
+\fB\-t\fR, \fB\-\-key\-type \fRrsa\fB\e\[or]\fRdsa\fB\e\[or]\fRec\`
 The signing key type\.
-.LP
 .TP
-\fB--generate-key\fR \fIPATH\fP
-Generates and saves a random key\. Defaults to \fBkey.pem\fR if not given\.
-.LP
+\fB\-\-generate\-key\fR \fIPATH\fP
+Generates and saves a random key\. Defaults to \fBkey\.pem\fR if not given\.
 .TP
-\fB-k\fR, \fB--key-file\fR \fIFILE\fP
+\fB\-k\fR, \fB\-\-key\-file\fR \fIFILE\fP
 Loads the signing key from the \fIFILE\fP\.
-.LP
 .TP
-\fB-H\fR, \fB--signing-hash\fR \fBsha256\fR\[or]\fBsha1\fR\[or]\fBmd5\fR
+\fB\-H\fR, \fB\-\-signing\-hash\fR \fBsha256\fR\[or]\fBsha1\fR\[or]\fBmd5\fR
 The hash algorithm to use for signing\. Defaults to \fBsha256\fR if not given\.
-.LP
 .TP
-\fB--ca-key\fR \fIFILE\fP
+\fB\-\-ca\-key\fR \fIFILE\fP
 The Certificate Authority (CA) key\.
-.LP
 .TP
-\fB--ca-cert\fR \fIFILE\fP
+\fB\-\-ca\-cert\fR \fIFILE\fP
 The Certificate Authority (CA) certificate\.
-.LP
 .TP
-\fB--ca\fR
+\fB\-\-ca\fR
 Generates a CA certificate\.
-.LP
 .TP
-\fB-o\fR, \fB--output\fR \fIFILE\fP
-The output file to save the generated certificate to\. Defaults to \fBcert.crt\fR
+\fB\-o\fR, \fB\-\-output\fR \fIFILE\fP
+The output file to save the generated certificate to\. Defaults to \fBcert\.crt\fR
 if not given\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information\.
-.LP
 .SH EXAMPLES
-.LP
 .PP
-Generates self\-signed certificate in \fBcert.crt\fR and a new private key in \fBkey.pem\fR:
-.LP
-.nf
-    ronin cert\-gen \-c test\.com \-O \[dq]Test Co\[dq] \-U \[dq]Test Dept\[dq] \e
-                   \-L \[dq]Test City\[dq] \-S NY \-C US
-.fi
-.LP
+Generates self\-signed certificate in \fBcert\.crt\fR and a new private key in \fBkey\.pem\fR:
+.PP
+.RS 4
+.EX
+\[Do] ronin cert\-gen \-c test\.com \-O \[dq]Test Co\[dq] \-U \[dq]Test Dept\[dq] \e
+                 \-L \[dq]Test City\[dq] \-S NY \-C US
+.EE
+.RE
 .PP
-Generates a new self\-signed certificate for \fBtest.com\fR in \fBcert.crt\fR using the private key in
-\fBprivate.key\fR:
-.LP
-.nf
-    ronin cert\-gen \-c test\.com \-O \[dq]Test Co\[dq] \-U \[dq]Test Dept\[dq] \e
-                   \-L \[dq]Test City\[dq] \-S NY \-C US \e
-                   \-\-key\-file private\.key
-.fi
-.LP
+Generates a new self\-signed certificate for \fBtest\.com\fR in \fBcert\.crt\fR using the private key in
+\fBprivate\.key\fR:
 .PP
-Generates a new self\-signed certificate with a alternative name \fBwww.test.com\fR:
-.LP
-.nf
-    ronin cert\-gen \-c test\.com \-A www\.test\.com \-O \[dq]Test Co\[dq] \-U \[dq]Test Dept\[dq] \e
-                   \-L \[dq]Test City\[dq] \-S NY \-C US
-.fi
-.LP
+.RS 4
+.EX
+\[Do] ronin cert\-gen \-c test\.com \-O \[dq]Test Co\[dq] \-U \[dq]Test Dept\[dq] \e
+                 \-L \[dq]Test City\[dq] \-S NY \-C US \e
+                 \-\-key\-file private\.key
+.EE
+.RE
+.PP
+Generates a new self\-signed certificate with a alternative name \fBwww\.test\.com\fR:
+.PP
+.RS 4
+.EX
+\[Do] ronin cert\-gen \-c test\.com \-A www\.test\.com \-O \[dq]Test Co\[dq] \-U \[dq]Test Dept\[dq] \e
+                 \-L \[dq]Test City\[dq] \-S NY \-C US
+.EE
+.RE
 .PP
 Generates a new CA certificate which can sign other certificates:
-.LP
-.nf
-    ronin cert\-gen \-\-ca \-c \[dq]Test CA\[dq] \-O \[dq]Test Co\[dq] \-U \[dq]Test Dept\[dq] \e
-                   \-L \[dq]Test City\[dq] \-S NY \-C US
-.fi
-.LP
 .PP
-Generates a new sub\-certificate using the CA certificate \fBca.crt\fR and signing key \fBca.key\fR:
-.LP
-.nf
-    ronin cert\-gen \-c test\.com \-O \[dq]Test Co\[dq] \-U \[dq]Test Dept\[dq] \e
-                   \-L \[dq]Test City\[dq] \-S NY \-C US \e
-                   \-\-ca\-key ca\.key \-\-ca\-cert ca\.crt
-.fi
-.LP
+.RS 4
+.EX
+\[Do] ronin cert\-gen \-\-ca \-c \[dq]Test CA\[dq] \-O \[dq]Test Co\[dq] \-U \[dq]Test Dept\[dq] \e
+                 \-L \[dq]Test City\[dq] \-S NY \-C US
+.EE
+.RE
+.PP
+Generates a new sub\-certificate using the CA certificate \fBca\.crt\fR and signing key \fBca\.key\fR:
+.PP
+.RS 4
+.EX
+\[Do] ronin cert\-gen \-c test\.com \-O \[dq]Test Co\[dq] \-U \[dq]Test Dept\[dq] \e
+                 \-L \[dq]Test City\[dq] \-S NY \-C US \e
+                 \-\-ca\-key ca\.key \-\-ca\-cert ca\.crt
+.EE
+.RE
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-cert\-grab(1) ronin\-cert\-dump(1)
+.BR ronin\-cert\-grab (1)
+.BR ronin\-cert\-dump (1)

data/man/ronin-cert-gen.1.md

@@ -1,5 +1,9 @@
 # ronin-cert-gen 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-cert-gen - Generates a new X509 certificate
+
 ## SYNOPSIS
 
 `ronin cert-gen` [*options*]
@@ -11,95 +15,95 @@ Generates a new X509 certificate.
 ## OPTIONS
 
 `--version` *NUM*
-  The certificate version number Defaults to `2` if not given.
+: The certificate version number Defaults to `2` if not given.
 
 `--serial` *NUM*
-  The certificate serial number Defaults to `0` if not given.
+: The certificate serial number Defaults to `0` if not given.
 
 `--not-before` *TIME*
-  When the certificate becomes valid. Defaults to the current time.
+: When the certificate becomes valid. Defaults to the current time.
 
 `--not-after` *TIME*
-  When the certificate becomes no longer valid. Defaults to one year from now.
+: When the certificate becomes no longer valid. Defaults to one year from now.
 
 `-c`, `--common-name` *DOMAIN*
-  The Common Name (CN) for the certificate.
+: The Common Name (CN) for the certificate.
 
 `-A`, `--subject-alt-name` *HOST*\|*IP*
-  Adds HOST or IP to `subjectAltName`.
+: Adds HOST or IP to `subjectAltName`.
 
 `-O`, `--organization` *NAME*
-  The Organization (O) for the certificate.
+: The Organization (O) for the certificate.
 
 `-U`, `--organizational-unit` *NAME*
-  The Organizational Unit (OU).
+: The Organizational Unit (OU).
 
 `-L`, `--locality` *NAME*
-  The locality for the certificate.
+: The locality for the certificate.
 
 `-S`, `--state` *XX*
-  The two-letter State (ST) code for the certificate.
+: The two-letter State (ST) code for the certificate.
 
 `-C`, `--country` *XX*
-  The two-letter Country (C) code for the certificate.
+: The two-letter Country (C) code for the certificate.
 
-`-t`, `--key-type` rsa|ec`
-  The signing key type.
+`-t`, `--key-type `rsa`\|`dsa`\|`ec`
+: The signing key type.
 
 `--generate-key` *PATH*
-  Generates and saves a random key. Defaults to `key.pem` if not given.
+: Generates and saves a random key. Defaults to `key.pem` if not given.
 
 `-k`, `--key-file` *FILE*
-  Loads the signing key from the *FILE*.
+: Loads the signing key from the *FILE*.
 
 `-H`, `--signing-hash` `sha256`\|`sha1`\|`md5`
-  The hash algorithm to use for signing. Defaults to `sha256` if not given.
+: The hash algorithm to use for signing. Defaults to `sha256` if not given.
 
 `--ca-key` *FILE*
-  The Certificate Authority (CA) key.
+: The Certificate Authority (CA) key.
 
 `--ca-cert` *FILE*
-  The Certificate Authority (CA) certificate.
+: The Certificate Authority (CA) certificate.
 
 `--ca`
-  Generates a CA certificate.
+: Generates a CA certificate.
 
 `-o`, `--output` *FILE*
-  The output file to save the generated certificate to. Defaults to `cert.crt`
+: The output file to save the generated certificate to. Defaults to `cert.crt`
   if not given.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
 
 ## EXAMPLES
 
 Generates self-signed certificate in `cert.crt` and a new private key in `key.pem`:
 
-        ronin cert-gen -c test.com -O "Test Co" -U "Test Dept" \
-                       -L "Test City" -S NY -C US
+    $ ronin cert-gen -c test.com -O "Test Co" -U "Test Dept" \
+                     -L "Test City" -S NY -C US
 
 Generates a new self-signed certificate for `test.com` in `cert.crt` using the private key in
 `private.key`:
 
-        ronin cert-gen -c test.com -O "Test Co" -U "Test Dept" \
-                       -L "Test City" -S NY -C US \
-                       --key-file private.key
+    $ ronin cert-gen -c test.com -O "Test Co" -U "Test Dept" \
+                     -L "Test City" -S NY -C US \
+                     --key-file private.key
 
 Generates a new self-signed certificate with a alternative name `www.test.com`:
 
-        ronin cert-gen -c test.com -A www.test.com -O "Test Co" -U "Test Dept" \
-                       -L "Test City" -S NY -C US
+    $ ronin cert-gen -c test.com -A www.test.com -O "Test Co" -U "Test Dept" \
+                     -L "Test City" -S NY -C US
 
 Generates a new CA certificate which can sign other certificates:
 
-        ronin cert-gen --ca -c "Test CA" -O "Test Co" -U "Test Dept" \
-                       -L "Test City" -S NY -C US
+    $ ronin cert-gen --ca -c "Test CA" -O "Test Co" -U "Test Dept" \
+                     -L "Test City" -S NY -C US
 
 Generates a new sub-certificate using the CA certificate `ca.crt` and signing key `ca.key`:
 
-        ronin cert-gen -c test.com -O "Test Co" -U "Test Dept" \
-                       -L "Test City" -S NY -C US \
-                       --ca-key ca.key --ca-cert ca.crt
+    $ ronin cert-gen -c test.com -O "Test Co" -U "Test Dept" \
+                     -L "Test City" -S NY -C US \
+                     --ca-key ca.key --ca-cert ca.crt
 
 ## AUTHOR
 
@@ -107,4 +111,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-cert-grab(1) ronin-cert-dump(1)
+[ronin-cert-grab](ronin-cert-grab.1.md) [ronin-cert-dump](ronin-cert-dump.1.md)

data/man/ronin-cert-grab.1

@@ -1,68 +1,60 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-cert-grab 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-cert\-grab \- Downloads SSL\[sl]TLS certificates
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin cert-grab\fR \[lB]\fIoptions\fP\[rB] \[lC]\fIHOST\fP:\fIPORT\fP \[or] \fIURL\fP\[rC] \.\.\.
-.LP
+.PP
+\fBronin cert\-grab\fR \[lB]\fIoptions\fP\[rB] \[lC]\fIHOST\fP:\fIPORT\fP \[or] \fIURL\fP\[rC] \.\.\.
 .SH DESCRIPTION
-.LP
 .PP
-Downloads SSL\[sl]TLS certificates for a SSL\[sl]TLS TCP or \fBhttps://\fR URL\.
-.LP
+Downloads SSL\[sl]TLS certificates for a SSL\[sl]TLS TCP or \fBhttps:\[sl]\[sl]\fR URL\.
 .SH ARGUMENTS
-.LP
 .TP
 \fIHOST\fP:\fIPORT\fP
 A remote TCP service to retrieve the SSL\[sl]TLS certificate from and print\.
-.LP
 .TP
 \fIURL\fP
 An URL to retrieve the SSL\[sl]TLS certificate from and print\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-f\fR, \fB--file\fR \fIFILE\fP
+\fB\-f\fR, \fB\-\-file\fR \fIFILE\fP
 Optional file to read target values from\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information\.
-.LP
 .SH EXAMPLES
-.LP
 .PP
 Downloads the SSL\[sl]TLS certificate for a SSL\[sl]TLS service:
-.LP
-.nf
-    ronin cert\-grab github\.com:443
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin cert\-grab github\.com:443
+.EE
+.RE
 .PP
 Downloads the SSL\[sl]TLS certificate running on the IP and port:
-.LP
-.nf
-    ronin cert\-grab 93\.184\.216\.34:443
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin cert\-grab 93\.184\.216\.34:443
+.EE
+.RE
 .PP
 Downloads the SSL\[sl]TLS certificate used by the URL:
-.LP
-.nf
-    ronin cert\-grab https:\[sl]\[sl]github\.com\[sl]
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin cert\-grab https:\[sl]\[sl]github\.com\[sl]
+.EE
+.RE
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-cert\-dump(1) ronin\-cert\-gen(1)
+.BR ronin\-cert\-dump (1)
+.BR ronin\-cert\-gen (1)

data/man/ronin-cert-grab.1.md

@@ -1,5 +1,9 @@
 # ronin-cert-grab 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-cert-grab - Downloads SSL/TLS certificates
+
 ## SYNOPSIS
 
 `ronin cert-grab` [*options*] {*HOST*:*PORT* \| *URL*} ...
@@ -11,32 +15,32 @@ Downloads SSL/TLS certificates for a SSL/TLS TCP or `https://` URL.
 ## ARGUMENTS
 
 *HOST*:*PORT*
-  A remote TCP service to retrieve the SSL/TLS certificate from and print.
+: A remote TCP service to retrieve the SSL/TLS certificate from and print.
 
 *URL*
-  An URL to retrieve the SSL/TLS certificate from and print.
+: An URL to retrieve the SSL/TLS certificate from and print.
 
 ## OPTIONS
 
 `-f`, `--file` *FILE*
-  Optional file to read target values from.
+: Optional file to read target values from.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
 
 ## EXAMPLES
 
 Downloads the SSL/TLS certificate for a SSL/TLS service:
 
-        ronin cert-grab github.com:443
+    $ ronin cert-grab github.com:443
 
 Downloads the SSL/TLS certificate running on the IP and port:
 
-        ronin cert-grab 93.184.216.34:443
+    $ ronin cert-grab 93.184.216.34:443
 
 Downloads the SSL/TLS certificate used by the URL:
 
-        ronin cert-grab https://github.com/
+    $ ronin cert-grab https://github.com/
 
 ## AUTHOR
 
@@ -44,4 +48,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-cert-dump(1) ronin-cert-gen(1)
+[ronin-cert-dump](ronin-cert-dump.1.md) [ronin-cert-gen](ronin-cert-gen.1.md)

data/man/ronin-completion.1

@@ -0,0 +1,78 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-completion 1 "2024-01-01" Ronin "User Manuals"
+.SH NAME
+.PP
+ronin\-completion \- Manages shell completion rules for \fBronin\-repos\fR
+.SH SYNOPSIS
+.PP
+\fBronin\-repos completion\fR \[lB]\fIoptions\fP\[rB]
+.SH DESCRIPTION
+.PP
+The \fBronin completion\fR command can print, install, or uninstall shell
+completion rules for the \fBronin\fR command and all other \fBronin\-*\fR commands\.
+.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\-repos\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 completion \-\-print\fR
+Prints all shell completion rules instead of installing them\.
+.TP
+\fBronin completion \-\-install\fR
+Installs all shell completion rules for \fBronin\fR and the other \fBronin\-*\fR
+commands\.
+.TP
+\fBronin\-repos completion \-\-uninstall\fR
+Uninstalls all shell completion rules for \fBronin\fR and the other \fBronin\-*\fR
+commands\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME

data/man/ronin-completion.1.md

@@ -0,0 +1,80 @@
+# ronin-completion 1 "2024-01-01" Ronin "User Manuals"
+
+## NAME
+
+ronin-completion - Manages shell completion rules for `ronin-repos`
+
+## SYNOPSIS
+
+`ronin-repos completion` [*options*]
+
+## DESCRIPTION
+
+The `ronin completion` command can print, install, or uninstall shell
+completion rules for the `ronin` command and all other `ronin-*` commands.
+
+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-repos` 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 completion --print`
+: Prints all shell completion rules instead of installing them.
+
+`ronin completion --install`
+: Installs all shell completion rules for `ronin` and the other `ronin-*`
+  commands.
+
+`ronin-repos completion --uninstall`
+: Uninstalls all shell completion rules for `ronin` and the other `ronin-*`
+  commands.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+