ronin-db 0.1.3 → 0.2.0

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

@@ -0,0 +1,73 @@
+# ronin-db-passwords 1 "2023-01-02" Ronin DB "User Manuals"
+
+## NAME
+
+ronin-db-passwords - Manages all passwords in the database
+
+## SYNOPSIS
+
+`ronin-db passwords` [*options*]
+
+## DESCRIPTION
+
+Manages passwords.
+
+## 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.
+
+`--add` *PASSWORD*
+: Adds the *PASSWORD* to the database.
+
+`--import` *FILE*
+: Imports the Passwords from the given *FILE*.
+
+`--delete` *VALUE*
+: Deletes a Password value from the database.
+
+`--delete-all`
+: Deletes every Password from the database.
+
+`-u`, `--for-user` *USER*
+: Searches for Passwords associated with the user name.
+
+`-e`, `--with-email` *EMAIL*
+: Searches for Passwords that are associated with the email address.
+
+## 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-people.1

@@ -0,0 +1,96 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-db-people 1 "2023-02-01" Ronin DB "User Manuals"
+.SH NAME
+.PP
+ronin\-db\-people \- Queries people in the database
+.SH SYNOPSIS
+.PP
+\fBronin\-db people\fR \[lB]\fIoptions\fP\[rB]
+.SH DESCRIPTION
+.PP
+Queries people\.
+.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\-a\fR, \fB\-\-for\-address\fR \fIADDRESS\fP
+Searches for all People associated with the street address\.
+.TP
+\fB\-c\fR, \fB\-\-for\-city\fR \fICITY\fP
+Searches for all People associated with the city\.
+.TP
+\fB\-s\fR, \fB\-\-for\-state\fR \fISTATE\fP
+Searches for all People associated with the State\.
+.TP
+\fB\-p\fR, \fB\-\-for\-province\fR \fIPROVINCE\fP
+Searches for all People associated with the Province\.
+.TP
+\fB\-z\fR, \fB\-\-for\-zipcode\fR \fIZIPCODE\fP
+Searches for all People associated with the zipcode\.
+.TP
+\fB\-C\fR, \fB\-\-for\-country\fR \fICOUNTRY\fP
+Searches for all People associated with the Country\.
+.TP
+\fB\-P\fR, \fB\-\-with\-prefix\fR \fIPREIFX\fP
+Searches for all People with the given prefix\.
+.TP
+\fB\-f\fR, \fB\-\-with\-first\-name\fR \fINAME\fP
+Searches for all People with the first name\.
+.TP
+\fB\-m\fR, \fB\-\-with\-middle\-name\fR \fINAME\fP
+Searches for all People with the middle name\.
+.TP
+\fB\-M\fR, \fB\-\-with\-middle\-initial\fR \fIINITIAL\fP
+Searches for all People with the middle name\.
+.TP
+\fB\-l\fR, \fB\-\-with\-last\-name\fR \fINAME\fP
+Searches for all People with the last name\.
+.TP
+\fB\-S\fR, \fB\-\-with\-suffix\fR \fISUFFIX\fP
+Searches for all People with the given suffix\.
+.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-people.1.md

@@ -0,0 +1,94 @@
+# ronin-db-people 1 "2023-02-01" Ronin DB "User Manuals"
+
+## NAME
+
+ronin-db-people - Queries people in the database
+
+## SYNOPSIS
+
+`ronin-db people` [*options*]
+
+## DESCRIPTION
+
+Queries people.
+
+## 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.
+
+`-a`, `--for-address` *ADDRESS*
+: Searches for all People associated with the street address.
+
+`-c`, `--for-city` *CITY*
+: Searches for all People associated with the city.
+
+`-s`, `--for-state` *STATE*
+: Searches for all People associated with the State.
+
+`-p`, `--for-province` *PROVINCE*
+: Searches for all People associated with the Province.
+
+`-z`, `--for-zipcode` *ZIPCODE*
+: Searches for all People associated with the zipcode.
+
+`-C`, `--for-country` *COUNTRY*
+: Searches for all People associated with the Country.
+
+`-P`, `--with-prefix` *PREIFX*
+: Searches for all People with the given prefix.
+
+`-f`, `--with-first-name` *NAME*
+: Searches for all People with the first name.
+
+`-m`, `--with-middle-name` *NAME*
+: Searches for all People with the middle name.
+
+`-M`, `--with-middle-initial` *INITIAL*
+: Searches for all People with the middle name.
+
+`-l`, `--with-last-name` *NAME*
+: Searches for all People with the last name.
+
+`-S`, `--with-suffix` *SUFFIX*
+: Searches for all People with the given suffix.
+
+`-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-phone-numbers.1

@@ -0,0 +1,93 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-db-phone-numbers 1 "2023-02-01" Ronin DB "User Manuals"
+.SH NAME
+.PP
+ronin\-db\-phone\-numbers \- Manages phone numbers in the database
+.SH SYNOPSIS
+.PP
+\fBronin\-db phone\-numbers\fR \[lB]\fIoptions\fP\[rB]
+.SH DESCRIPTION
+.PP
+Manages PhoneNumbers\.
+.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 \fIVALUE\fP
+Adds the phone number to the database\.
+.TP
+\fB\-\-import\fR \fIFILE\fP
+Imports the phone numbers from the given \fIFILE\fP\.
+.TP
+\fB\-\-delete\fR \fIVALUE\fP
+Deletes the phone number from the database\.
+.TP
+\fB\-\-delete\-all\fR
+Deletes every phone number from the database\.
+.TP
+\fB\-P\fR, \fB\-\-for\-person\fR \fIFULL\[ru]NAME\fP
+Searches for phone numbers associated with the person\[cq]s full name\.
+.TP
+\fB\-O\fR, \fB\-\-for\-organization\fR \fINAME\fP
+Searches for phone numbers associated with the organization\[cq]s name\.
+.TP
+\fB\-c\fR, \fB\-\-with\-country\-code\fR \fINUM\fP
+Searches for phone numbers with the matching 1\-3 digit country code\.
+.TP
+\fB\-a\fR, \fB\-\-with\-area\-code\fR \fINUM\fP
+Searches for phone numbers with the matching 3 digit area code\.
+.TP
+\fB\-p\fR, \fB\-\-with\-prefix\fR \fINUM\fP
+Searches for phone numbers with the matching 3 digit prefix number\.
+.TP
+\fB\-l\fR, \fB\-\-with\-line\-number\fR \fINUM\fP
+Searches for phone numbers with the matching 4 digit line number\.
+.TP
+\fB\-S\fR, \fB\-\-similar\-to\fR \fIPHONE\[ru]NUMBER\fP
+Searches for phone numbers that are similar to the given \fIPHONE\[ru]NUMBER\fP\.
+.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-phone-numbers.1.md

@@ -0,0 +1,91 @@
+# ronin-db-phone-numbers 1 "2023-02-01" Ronin DB "User Manuals"
+
+## NAME
+
+ronin-db-phone-numbers - Manages phone numbers in the database
+
+## SYNOPSIS
+
+`ronin-db phone-numbers` [*options*]
+
+## DESCRIPTION
+
+Manages PhoneNumbers.
+
+## 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.
+
+`--add` *VALUE*
+: Adds the phone number to the database.
+
+`--import` *FILE*
+: Imports the phone numbers from the given *FILE*.
+
+`--delete` *VALUE*
+: Deletes the phone number from the database.
+
+`--delete-all`
+: Deletes every phone number from the database.
+
+`-P`, `--for-person` *FULL_NAME*
+: Searches for phone numbers associated with the person's full name.
+
+`-O`, `--for-organization` *NAME*
+: Searches for phone numbers associated with the organization's name.
+
+`-c`, `--with-country-code` *NUM*
+: Searches for phone numbers with the matching 1-3 digit country code.
+
+`-a`, `--with-area-code` *NUM*
+: Searches for phone numbers with the matching 3 digit area code.
+
+`-p`, `--with-prefix` *NUM*
+: Searches for phone numbers with the matching 3 digit prefix number.
+
+`-l`, `--with-line-number` *NUM*
+: Searches for phone numbers with the matching 4 digit line number.
+
+`-S`, `--similar-to` *PHONE_NUMBER*
+: Searches for phone numbers that are similar to the given *PHONE_NUMBER*.
+
+`-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-ports.1

@@ -0,0 +1,87 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-db-ports 1 "2023-02-01" Ronin DB "User Manuals"
+.SH NAME
+.PP
+ronin\-db\-ports \- Manages port numbers in the database
+.SH SYNOPSIS
+.PP
+\fBronin\-db ports\fR \[lB]\fIoptions\fP\[rB]
+.SH DESCRIPTION
+.PP
+Manages Ports\.
+.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 \fIVALUE\fP
+Adds the URL to the database\.
+.TP
+\fB\-\-import\fR \fIFILE\fP
+Imports the URLs from the given \fIFILE\fP\.
+.TP
+\fB\-\-delete\fR \fIVALUE\fP
+Deletes the URL from the database\.
+.TP
+\fB\-\-delete\-all\fR
+Deletes every URL from the database\.
+.TP
+\fB\-\-named\fR \fINAME\fP
+Searches for all Ports that contain \fINAME\fP in it\[cq]s name\.
+.TP
+\fB\-N\fR, \fB\-\-numer\fR \fIPORT\fP
+Searches for all Ports 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 Ports that are associated with the protocol\.
+.TP
+\fB\-S\fR, \fB\-\-with\-service\fR \fISERVICE\fP
+Searches for all Ports that are associated with the service\.
+.TP
+\fB\-I\fR, \fB\-\-with\-ip\fR \fIIP\fP
+Searches for all Ports 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-ports.1.md

@@ -0,0 +1,85 @@
+# ronin-db-ports 1 "2023-02-01" Ronin DB "User Manuals"
+
+## NAME
+
+ronin-db-ports - Manages port numbers in the database
+
+## SYNOPSIS
+
+`ronin-db ports` [*options*]
+
+## DESCRIPTION
+
+Manages Ports.
+
+## 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.
+
+`--add` *VALUE*
+: Adds the URL to the database.
+
+`--import` *FILE*
+: Imports the URLs from the given *FILE*.
+
+`--delete` *VALUE*
+: Deletes the URL from the database.
+
+`--delete-all`
+: Deletes every URL from the database.
+
+`--named` *NAME*
+: Searches for all Ports that contain *NAME* in it's name.
+
+`-N`, `--numer` *PORT*
+: Searches for all Ports that are associated with the port number.
+
+`-P`, `--with-protocol` [`tcp`\|`udp`]
+: Searches for all Ports that are associated with the protocol.
+
+`-S`, `--with-service` *SERVICE*
+: Searches for all Ports that are associated with the service.
+
+`-I`, `--with-ip` *IP*
+: Searches for all Ports 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-remove.1

@@ -1,62 +1,49 @@
-.\" Generated by kramdown-man 0.1.9
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-remove 1 "2023-02-01" Ronin DB "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-db\-remove \- Removes a database from the configuration file
 .SH SYNOPSIS
-.LP
 .PP
-\fBronin-db remove\fR \[lB]\fIoptions\fP\[rB] \fINAME\fP
-.LP
+\fBronin\-db remove\fR \[lB]\fIoptions\fP\[rB] \fINAME\fP
 .SH DESCRIPTION
-.LP
 .PP
-Removes a database entry from the \fB~/.config/ronin-db/database.yml\fR
+Removes a database entry from the \fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
 configuration file\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fINAME\fP
 The database entry to remove\.
-.LP
 .SH OPTIONS
-.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\-list(1) ronin\-db\-edit(1)
+.BR ronin\-db (1)
+.BR ronin\-db\-add (1)
+.BR ronin\-db\-list (1)
+.BR ronin\-db\-edit (1)