ronin-db 0.1.3 → 0.2.0.rc1

data/man/ronin-db-list.1

@@ -1,65 +1,51 @@
-.\" Generated by kramdown-man 0.1.9
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-list 1 "2023-02-01" Ronin DB "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-db\-list \- List the configured database(s)
 .SH SYNOPSIS
-.LP
 .PP
-\fBronin-db list\fR \[lB]\fIoptions\fP\[rB] \[lB]\fINAME\fP\[rB]
-.LP
+\fBronin\-db list\fR \[lB]\fIoptions\fP\[rB] \[lB]\fINAME\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
-Lists entries in the \fB~/.config/ronin-db/database.yml\fR configuration file\.
-.LP
+Lists entries in the \fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR configuration file\.
 .SH ARGUMENTS
-.LP
 .TP
 \fINAME\fP
 The optional database name to print configuration information for\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-v\fR, \fB--verbose\fR
+\fB\-v\fR, \fB\-\-verbose\fR
 Enables verbose output\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information\.
-.LP
 .SH ENVIRONMENT
-.LP
 .TP
 \fIHOME\fP
 Alternate location for the user\[cq]s home directory\.
-.LP
 .TP
 \fIXDG\[ru]CONFIG\[ru]HOME\fP
-Alternate location for the \fB~/.config\fR directory\.
-.LP
+Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
 .TP
 \fIXDG\[ru]DATA\[ru]HOME\fP
-Alternate location for the \fB~/.local/share\fR directory\.
-.LP
+Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
 .SH FILES
-.LP
 .TP
-\fB~/.local/share/ronin-db/database.sqlite3\fR
+\fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
 The default sqlite3 database file\.
-.LP
 .TP
-\fB~/.config/ronin-db/database.yml\fR
+\fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
 Optional database configuration\.
-.LP
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-db(1) ronin\-db\-add(1) ronin\-db\-edit(1) ronin\-db\-remove(1)
+.BR ronin\-db (1)
+.BR ronin\-db\-add (1)
+.BR ronin\-db\-edit (1)
+.BR ronin\-db\-remove (1)

data/man/ronin-db-list.1.md

@@ -1,5 +1,9 @@
 # ronin-db-list 1 "2023-02-01" Ronin DB "User Manuals"
 
+## NAME
+
+ronin-db-list - List the configured database(s)
+
 ## SYNOPSIS
 
 `ronin-db list` [*options*] [*NAME*]
@@ -11,34 +15,34 @@ Lists entries in the `~/.config/ronin-db/database.yml` configuration file.
 ## ARGUMENTS
 
 *NAME*
-  The optional database name to print configuration information for.
+: The optional database name to print configuration information for.
 
 ## OPTIONS
 
 `-v`, `--verbose`
-  Enables verbose output.
+: Enables verbose output.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
 
 ## ENVIRONMENT
 
 *HOME*
-  Alternate location for the user's home directory.
+: Alternate location for the user's home directory.
 
 *XDG_CONFIG_HOME*
-  Alternate location for the `~/.config` directory.
+: Alternate location for the `~/.config` directory.
 
 *XDG_DATA_HOME*
-  Alternate location for the `~/.local/share` directory.
+: Alternate location for the `~/.local/share` directory.
 
 ## FILES
 
 `~/.local/share/ronin-db/database.sqlite3`
-  The default sqlite3 database file.
+: The default sqlite3 database file.
 
 `~/.config/ronin-db/database.yml`
-  Optional database configuration.
+: Optional database configuration.
 
 ## AUTHOR
 
@@ -46,4 +50,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-db(1) ronin-db-add(1) ronin-db-edit(1) ronin-db-remove(1)
+[ronin-db](ronin-db.1.md) [ronin-db-add](ronin-db-add.1.md) [ronin-db-edit](ronin-db-edit.1.md) [ronin-db-remove](ronin-db-remove.1.md)

data/man/ronin-db-migrate.1

@@ -1,77 +1,64 @@
-.\" Generated by kramdown-man 0.1.9
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-migrate 1 "2023-02-01" Ronin DB "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-db\-migrate \- Runs database migrations
 .SH SYNOPSIS
-.LP
 .PP
-\fBronin-db migrate\fR \[lB]\fIoptions\fP\[rB]
-.LP
+\fBronin\-db migrate\fR \[lB]\fIoptions\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
 Runs database migrations\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB--db\fR \fINAME\fP
+\fB\-\-db\fR \fINAME\fP
 The database to connect to\. Will connect to the \fBdefault\fR database if not
 specified\.
-.LP
 .TP
-\fB--db-uri\fR \fIURI\fP
+\fB\-\-db\-uri\fR \fIURI\fP
 The database URI to connect to\.
-.LP
+.RS
 .RS
 .IP \(bu 2
-\fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
+\fBsqlite3\fP: \fBsqlite3:relative\[sl]path\.db\fR or \fBsqlite3:\[sl]\[sl]\[sl]absolute\[sl]path\.db\fR
 .IP \(bu 2
-\fBmysql\fP: \fBmysql://user:password@host/database\fR
+\fBmysql\fP: \fBmysql:\[sl]\[sl]user:password\[at]host\[sl]database\fR
 .IP \(bu 2
-\fBpostgres\fP: \fBpostgres://user:password@host/database\fR
+\fBpostgres\fP: \fBpostgres:\[sl]\[sl]user:password\[at]host\[sl]database\fR
 .RE
-.LP
+.RE
+.TP
+\fB\-\-db\-file\fR \fIPATH\fP
+The sqlite3 database file to use\.
 .TP
-\fB--no-connect\fR
+\fB\-\-no\-connect\fR
 Causes the Ruby shell to not connect to a database on startup\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information\.
-.LP
 .SH ENVIRONMENT
-.LP
 .TP
 \fIHOME\fP
 Alternate location for the user\[cq]s home directory\.
-.LP
 .TP
 \fIXDG\[ru]CONFIG\[ru]HOME\fP
-Alternate location for the \fB~/.config\fR directory\.
-.LP
+Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
 .TP
 \fIXDG\[ru]DATA\[ru]HOME\fP
-Alternate location for the \fB~/.local/share\fR directory\.
-.LP
+Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
 .SH FILES
-.LP
 .TP
-\fB~/.local/share/ronin-db/database.sqlite3\fR
+\fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
 The default sqlite3 database file\.
-.LP
 .TP
-\fB~/.config/ronin-db/database.yml\fR
+\fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
 Optional database configuration\.
-.LP
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-db\-add(1)
+.BR ronin\-db\-add (1)

data/man/ronin-db-migrate.1.md

@@ -1,5 +1,9 @@
 # ronin-db-migrate 1 "2023-02-01" Ronin DB "User Manuals"
 
+## NAME
+
+ronin-db-migrate - Runs database migrations
+
 ## SYNOPSIS
 
 `ronin-db migrate` [*options*]
@@ -11,40 +15,43 @@ Runs database migrations.
 ## OPTIONS
 
 `--db` *NAME*
-  The database to connect to. Will connect to the `default` database if not
+: The database to connect to. Will connect to the `default` database if not
   specified.
 
 `--db-uri` *URI*
-  The database URI to connect to.
+: The database URI to connect to.
 
   * **sqlite3**: `sqlite3:relative/path.db` or `sqlite3:///absolute/path.db`
   * **mysql**: `mysql://user:password@host/database`
   * **postgres**: `postgres://user:password@host/database`
 
+`--db-file` *PATH*
+: The sqlite3 database file to use.
+
 `--no-connect`
-  Causes the Ruby shell to not connect to a database on startup.
+: Causes the Ruby shell to not connect to a database on startup.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
 
 ## ENVIRONMENT
 
 *HOME*
-  Alternate location for the user's home directory.
+: Alternate location for the user's home directory.
 
 *XDG_CONFIG_HOME*
-  Alternate location for the `~/.config` directory.
+: Alternate location for the `~/.config` directory.
 
 *XDG_DATA_HOME*
-  Alternate location for the `~/.local/share` directory.
+: Alternate location for the `~/.local/share` directory.
 
 ## FILES
 
 `~/.local/share/ronin-db/database.sqlite3`
-  The default sqlite3 database file.
+: The default sqlite3 database file.
 
 `~/.config/ronin-db/database.yml`
-  Optional database configuration.
+: Optional database configuration.
 
 ## AUTHOR
 
@@ -52,4 +59,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-db-add(1)
+[ronin-db-add](ronin-db-add.1.md)

data/man/ronin-db-open-ports.1

@@ -0,0 +1,72 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-db-open-ports 1 "2023-02-01" Ronin DB "User Manuals"
+.SH NAME
+.PP
+ronin\-db\-open\-ports \- Queries open ports in the database
+.SH SYNOPSIS
+.PP
+\fBronin\-db open\-ports\fR \[lB]\fIoptions\fP\[rB]
+.SH DESCRIPTION
+.PP
+Queries OpenPorts\.
+.SH OPTIONS
+.TP
+\fB\-\-db\fR \fINAME\fP
+The database to connect to\. Defaults to \fBdefault\fR if not given\.
+.TP
+\fB\-\-db\-uri\fR \fIURI\fP
+The explicit database URI to connect to\.
+.RS
+.RS
+.IP \(bu 2
+\fBsqlite3\fP: \fBsqlite3:relative\[sl]path\.db\fR or \fBsqlite3:\[sl]\[sl]\[sl]absolute\[sl]path\.db\fR
+.IP \(bu 2
+\fBmysql\fP: \fBmysql:\[sl]\[sl]user:password\[at]host\[sl]database\fR
+.IP \(bu 2
+\fBpostgres\fP: \fBpostgres:\[sl]\[sl]user:password\[at]host\[sl]database\fR
+.RE
+.RE
+.TP
+\fB\-\-db\-file\fR \fIPATH\fP
+The sqlite3 database file to use\.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Enable verbose output\.
+.TP
+\fB\-p\fR, \fB\-\-with\-port\fR \fIPORT\fP
+Searches for all OpenPorts that are associated with the port number\.
+.TP
+\fB\-P\fR, \fB\-\-with\-protocol\fR \[lB]\fBtcp\fR\[or]\fBudp\fR\[rB]
+Searches for all OpenPorts that are associated with the protocol\.
+.TP
+\fB\-S\fR, \fB\-\-with\-service\fR \fISERVICE\fP
+Searches for all OpenPorts that are associated with the service\.
+.TP
+\fB\-I\fR, \fB\-\-with\-ip\fR \fIIP\fP
+Searches for all OpenPorts associated with the IP address\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help information\.
+.SH ENVIRONMENT
+.TP
+\fIHOME\fP
+Alternate location for the user\[cq]s home directory\.
+.TP
+\fIXDG\[ru]CONFIG\[ru]HOME\fP
+Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
+.TP
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
+.SH FILES
+.TP
+\fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
+The default sqlite3 database file\.
+.TP
+\fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
+Optional database configuration\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME

data/man/ronin-db-open-ports.1.md

@@ -0,0 +1,70 @@
+# ronin-db-open-ports 1 "2023-02-01" Ronin DB "User Manuals"
+
+## NAME
+
+ronin-db-open-ports - Queries open ports in the database
+
+## SYNOPSIS
+
+`ronin-db open-ports` [*options*]
+
+## DESCRIPTION
+
+Queries OpenPorts.
+
+## OPTIONS
+
+`--db` *NAME*
+: The database to connect to. Defaults to `default` if not given.
+
+`--db-uri` *URI*
+: The explicit database URI to connect to.
+
+  * **sqlite3**: `sqlite3:relative/path.db` or `sqlite3:///absolute/path.db`
+  * **mysql**: `mysql://user:password@host/database`
+  * **postgres**: `postgres://user:password@host/database`
+
+`--db-file` *PATH*
+: The sqlite3 database file to use.
+
+`-v`, `--verbose`
+: Enable verbose output.
+
+`-p`, `--with-port` *PORT*
+: Searches for all OpenPorts that are associated with the port number.
+
+`-P`, `--with-protocol` [`tcp`\|`udp`]
+: Searches for all OpenPorts that are associated with the protocol.
+
+`-S`, `--with-service` *SERVICE*
+: Searches for all OpenPorts that are associated with the service.
+
+`-I`, `--with-ip` *IP*
+: Searches for all OpenPorts associated with the IP address.
+
+`-h`, `--help`
+: Print help information.
+
+## ENVIRONMENT
+
+*HOME*
+: Alternate location for the user's home directory.
+
+*XDG_CONFIG_HOME*
+: Alternate location for the `~/.config` directory.
+
+*XDG_DATA_HOME*
+: Alternate location for the `~/.local/share` directory.
+
+## FILES
+
+`~/.local/share/ronin-db/database.sqlite3`
+: The default sqlite3 database file.
+
+`~/.config/ronin-db/database.yml`
+: Optional database configuration.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+

data/man/ronin-db-oses.1

@@ -0,0 +1,72 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-db-oses 1 "2023-02-01" Ronin DB "User Manuals"
+.SH NAME
+.PP
+ronin\-db\-oses \- Queries OSes in the database
+.SH SYNOPSIS
+.PP
+\fBronin\-db oses\fR \[lB]\fIoptions\fP\[rB]
+.SH DESCRIPTION
+.PP
+Queries OSes in the database\.
+.SH OPTIONS
+.TP
+\fB\-\-db\fR \fINAME\fP
+The database name to connect to\. Defaults to \fBdefault\fR if not given\.
+.TP
+\fB\-\-db\-uri\fR \fIURI\fP
+The explicit database URI to connect to\.
+.RS
+.RS
+.IP \(bu 2
+\fBsqlite3\fP: \fBsqlite3:relative\[sl]path\.db\fR or \fBsqlite3:\[sl]\[sl]\[sl]absolute\[sl]path\.db\fR
+.IP \(bu 2
+\fBmysql\fP: \fBmysql:\[sl]\[sl]user:password\[at]host\[sl]database\fR
+.IP \(bu 2
+\fBpostgres\fP: \fBpostgres:\[sl]\[sl]user:password\[at]host\[sl]database\fR
+.RE
+.RE
+.TP
+\fB\-\-db\-file\fR \fIPATH\fP
+The sqlite3 database file to use\.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Enables verbose output
+.TP
+\fB\-N\fR, \fB\-\-name\fR \fINAME\fP
+Searches for all OSes with the matching name\.
+.TP
+\fB\-\-named\fR \fINAME\fP
+Searches for all OSes containing the name\.
+.TP
+\fB\-F\fR, \fB\-\-flavor\fR \fBlinux\fR\[or]\fBbsd\fR
+Searches for all OSes with the matching flavor\.
+.TP
+\fB\-V\fR, \fB\-\-version\fR \fIVERSION\fP
+Searches for all OSes with the matching version\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help information\.
+.SH ENVIRONMENT
+.TP
+\fIHOME\fP
+Alternate location for the user\[cq]s home directory\.
+.TP
+\fIXDG\[ru]CONFIG\[ru]HOME\fP
+Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
+.TP
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
+.SH FILES
+.TP
+\fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
+The default sqlite3 database file\.
+.TP
+\fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
+Optional database configuration\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME

data/man/ronin-db-oses.1.md

@@ -0,0 +1,70 @@
+# ronin-db-oses 1 "2023-02-01" Ronin DB "User Manuals"
+
+## NAME
+
+ronin-db-oses - Queries OSes in the database
+
+## SYNOPSIS
+
+`ronin-db oses` [*options*]
+
+## DESCRIPTION
+
+Queries OSes in the database.
+
+## OPTIONS
+
+`--db` *NAME*
+: The database name to connect to. Defaults to `default` if not given.
+
+`--db-uri` *URI*
+: The explicit database URI to connect to.
+
+  * **sqlite3**: `sqlite3:relative/path.db` or `sqlite3:///absolute/path.db`
+  * **mysql**: `mysql://user:password@host/database`
+  * **postgres**: `postgres://user:password@host/database`
+
+`--db-file` *PATH*
+: The sqlite3 database file to use.
+
+`-v`, `--verbose`
+: Enables verbose output
+
+`-N`, `--name` *NAME*
+: Searches for all OSes with the matching name.
+
+`--named` *NAME*
+: Searches for all OSes containing the name.
+
+`-F`, `--flavor` `linux`\|`bsd`
+: Searches for all OSes with the matching flavor.
+
+`-V`, `--version` *VERSION*
+: Searches for all OSes with the matching version.
+
+`-h`, `--help`
+: Print help information.
+
+## ENVIRONMENT
+
+*HOME*
+: Alternate location for the user's home directory.
+
+*XDG_CONFIG_HOME*
+: Alternate location for the `~/.config` directory.
+
+*XDG_DATA_HOME*
+: Alternate location for the `~/.local/share` directory.
+
+## FILES
+
+`~/.local/share/ronin-db/database.sqlite3`
+: The default sqlite3 database file.
+
+`~/.config/ronin-db/database.yml`
+: Optional database configuration.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+

data/man/ronin-db-passwords.1

@@ -0,0 +1,75 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-db-passwords 1 "2023-01-02" Ronin DB "User Manuals"
+.SH NAME
+.PP
+ronin\-db\-passwords \- Manages all passwords in the database
+.SH SYNOPSIS
+.PP
+\fBronin\-db passwords\fR \[lB]\fIoptions\fP\[rB]
+.SH DESCRIPTION
+.PP
+Manages passwords\.
+.SH OPTIONS
+.TP
+\fB\-\-db\fR \fINAME\fP
+The database to connect to\. Defaults to \fBdefault\fR if not given\.
+.TP
+\fB\-\-db\-uri\fR \fIURI\fP
+The explicit database URI to connect to\.
+.RS
+.RS
+.IP \(bu 2
+\fBsqlite3\fP: \fBsqlite3:relative\[sl]path\.db\fR or \fBsqlite3:\[sl]\[sl]\[sl]absolute\[sl]path\.db\fR
+.IP \(bu 2
+\fBmysql\fP: \fBmysql:\[sl]\[sl]user:password\[at]host\[sl]database\fR
+.IP \(bu 2
+\fBpostgres\fP: \fBpostgres:\[sl]\[sl]user:password\[at]host\[sl]database\fR
+.RE
+.RE
+.TP
+\fB\-\-db\-file\fR \fIPATH\fP
+The sqlite3 database file to use\.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Enable verbose output\.
+.TP
+\fB\-\-add\fR \fIPASSWORD\fP
+Adds the \fIPASSWORD\fP to the database\.
+.TP
+\fB\-\-import\fR \fIFILE\fP
+Imports the Passwords from the given \fIFILE\fP\.
+.TP
+\fB\-\-delete\fR \fIVALUE\fP
+Deletes a Password value from the database\.
+.TP
+\fB\-\-delete\-all\fR
+Deletes every Password from the database\.
+.TP
+\fB\-u\fR, \fB\-\-for\-user\fR \fIUSER\fP
+Searches for Passwords associated with the user name\.
+.TP
+\fB\-e\fR, \fB\-\-with\-email\fR \fIEMAIL\fP
+Searches for Passwords that are associated with the email address\.
+.SH ENVIRONMENT
+.TP
+\fIHOME\fP
+Alternate location for the user\[cq]s home directory\.
+.TP
+\fIXDG\[ru]CONFIG\[ru]HOME\fP
+Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
+.TP
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
+.SH FILES
+.TP
+\fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
+The default sqlite3 database file\.
+.TP
+\fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
+Optional database configuration\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME