ronin-db 0.1.0-java → 0.1.3-java

data/man/ronin-db-asn.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-db-asn 1 "April 2012" Ronin "User Manuals"
+.TH ronin-db-asn 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db asn\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION
@@ -20,8 +20,16 @@ The database name to connect to\. Defaults to \fBdefault\fR if not given\.
 .LP
 .TP
 \fB--db-uri\fR \fIURI\fP
-The explicit database URI to connect to
-(ex: \fBpostgres://user:password@host/db\fR)\.
+The explicit database URI to connect to\.
+.LP
+.RS
+.IP \(bu 2
+\fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
+.IP \(bu 2
+\fBmysql\fP: \fBmysql://user:password@host/database\fR
+.IP \(bu 2
+\fBpostgres\fP: \fBpostgres://user:password@host/database\fR
+.RE
 .LP
 .TP
 \fB-v\fR, \fB--verbose\fR
@@ -70,6 +78,30 @@ if not given\.
 \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
+.TP
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Alternate location for the \fB~/.local/share\fR directory\.
+.LP
+.SH FILES
+.LP
+.TP
+\fB~/.local/share/ronin-db/database.sqlite3\fR
+The default sqlite3 database file\.
+.LP
+.TP
+\fB~/.config/ronin-db/database.yml\fR
+Optional database configuration\.
+.LP
 .SH AUTHOR
 .LP
 .PP

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

@@ -1,4 +1,4 @@
-# ronin-db-asn 1 "April 2012" Ronin "User Manuals"
+# ronin-db-asn 1 "2023-02-01" Ronin "User Manuals"
 
 ## SYNOPSIS
 
@@ -14,8 +14,11 @@ Queries or updates Autonomous System Numbers (ASNs) in the database.
   The database name to connect to. Defaults to `default` if not given.
 
 `--db-uri` *URI*
-  The explicit database URI to connect to
-  (ex: `postgres://user:password@host/db`).
+  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`
 
 `-v`, `--verbose`
   Enables verbose output
@@ -53,6 +56,25 @@ Queries or updates Autonomous System Numbers (ASNs) in the database.
 `-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-creds.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-db-creds 1 "April 2012" Ronin "User Manuals"
+.TH ronin-db-creds 1 "2023-01-02" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db creds\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION
@@ -20,8 +20,16 @@ The database to connect to\. Defaults to \fBdefault\fR if not given\.
 .LP
 .TP
 \fB--db-uri\fR \fIURI\fP
-The explicit database URI to connect to
-(ex: \fBmysql://user:password@host/ronin\fR)\.
+The explicit database URI to connect to\.
+.LP
+.RS
+.IP \(bu 2
+\fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
+.IP \(bu 2
+\fBmysql\fP: \fBmysql://user:password@host/database\fR
+.IP \(bu 2
+\fBpostgres\fP: \fBpostgres://user:password@host/database\fR
+.RE
 .LP
 .TP
 \fB-v\fR, \fB--verbose\fR
@@ -37,37 +45,47 @@ Imports the credentials from the given \fIFILE\fP\.
 .LP
 .TP
 \fB--delete\fR \fIVALUE\fP
-Deletes a value from the database\.
+Deletes a credential value from the database\.
 .LP
 .TP
 \fB--delete-all\fR
-Deletes every value from the database\.
+Deletes every credential from the database\.
 .LP
 .TP
 \fB-u\fR, \fB--for-user\fR \fIUSER\fP
-Searches for Credentials associated with the USER\.
+Searches for credentials associated with the \fIUSER\fP\.
 .LP
 .TP
 \fB-p\fR, \fB--with-password\fR \fIPASSWORD\fP
-Searches for Credentials that have the PASSWORD\.
+Searches for credentials that have the \fIPASSWORD\fP\.
 .LP
-.SH FILES
+.TP
+\fB-h\fR, \fB--help\fR
+Print help information\.
+.LP
+.SH ENVIRONMENT
 .LP
 .TP
-\fI\[ti]\[sl]\.ronin\[sl]\fP
-Ronin configuration directory\.
+\fIHOME\fP
+Alternate location for the user\[cq]s home directory\.
 .LP
 .TP
-\fI\[ti]\[sl]\.ronin\[sl]database\.log\fP
-Database log\.
+\fIXDG\[ru]CONFIG\[ru]HOME\fP
+Alternate location for the \fB~/.config\fR directory\.
+.LP
+.TP
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Alternate location for the \fB~/.local/share\fR directory\.
+.LP
+.SH FILES
 .LP
 .TP
-\fI\[ti]\[sl]\.ronin\[sl]database\.sqlite3\fP
-The default sqlite3 Database file\.
+\fB~/.local/share/ronin-db/database.sqlite3\fR
+The default sqlite3 database file\.
 .LP
 .TP
-\fI\[ti]\[sl]\.ronin\[sl]database\.yml\fP
-Optional Database configuration\.
+\fB~/.config/ronin-db/database.yml\fR
+Optional database configuration\.
 .LP
 .SH AUTHOR
 .LP

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

@@ -1,4 +1,4 @@
-# ronin-db-creds 1 "April 2012" Ronin "User Manuals"
+# ronin-db-creds 1 "2023-01-02" Ronin "User Manuals"
 
 ## SYNOPSIS
 
@@ -14,8 +14,11 @@ Manages credentials.
   The database to connect to. Defaults to `default` if not given.
 
 `--db-uri` *URI*
-  The explicit database URI to connect to
-  (ex: `mysql://user:password@host/ronin`).
+  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`
 
 `-v`, `--verbose`
 	Enable verbose output.
@@ -27,30 +30,38 @@ Manages credentials.
   Imports the credentials from the given *FILE*.
 
 `--delete` *VALUE*
-  Deletes a value from the database.
+  Deletes a credential value from the database.
 
 `--delete-all`
-  Deletes every value from the database.
+  Deletes every credential from the database.
 
 `-u`, `--for-user` *USER*
-	Searches for Credentials associated with the USER.
+	Searches for credentials associated with the *USER*.
 
 `-p`, `--with-password` *PASSWORD*
-	Searches for Credentials that have the PASSWORD.
+	Searches for credentials that have the *PASSWORD*.
 
-## FILES
+`-h`, `--help`
+  Print help information.
+
+## ENVIRONMENT
 
-*~/.ronin/*
-	Ronin configuration directory.
+*HOME*
+  Alternate location for the user's home directory.
 
-*~/.ronin/database.log*
-	Database log.
+*XDG_CONFIG_HOME*
+  Alternate location for the `~/.config` directory.
+
+*XDG_DATA_HOME*
+  Alternate location for the `~/.local/share` directory.
+
+## FILES
 
-*~/.ronin/database.sqlite3*
-	The default sqlite3 Database file.
+`~/.local/share/ronin-db/database.sqlite3`
+  The default sqlite3 database file.
 
-*~/.ronin/database.yml*
-	Optional Database configuration.
+`~/.config/ronin-db/database.yml`
+  Optional database configuration.
 
 ## AUTHOR
 

data/man/ronin-db-edit.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-db-edit 1 "2022-01-01" Ronin DB "User Manuals"
+.TH ronin-db-edit 1 "2023-02-01" Ronin DB "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db edit\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION
@@ -18,22 +18,29 @@ Manually edits the \fB~/.config/ronin-db/database.yml\fR configuration file\.
 \fB-h\fR, \fB--help\fR
 Print help information\.
 .LP
-.SH FILES
+.SH ENVIRONMENT
 .LP
 .TP
-\fI\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fP
-The \fBronin-db\fR database(s) configuration file\.
+\fIHOME\fP
+Alternate location for the user\[cq]s home directory\.
 .LP
-.SH ENVIRONMENT
+.TP
+\fIXDG\[ru]CONFIG\[ru]HOME\fP
+Alternate location for the \fB~/.config\fR directory\.
 .LP
-.PP
-HOME
-Specifies the home directory of the user\. Ronin will search for the
-\fI\[ti]\[sl]\.config\[sl]ronin\-db\fP cache directory within the home directory\.
+.TP
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Alternate location for the \fB~/.local/share\fR directory\.
 .LP
-.PP
-XDG\[ru]CONFIG\[ru]HOME
-Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.config\fP\.
+.SH FILES
+.LP
+.TP
+\fB~/.local/share/ronin-db/database.sqlite3\fR
+The default sqlite3 database file\.
+.LP
+.TP
+\fB~/.config/ronin-db/database.yml\fR
+Optional database configuration\.
 .LP
 .SH AUTHOR
 .LP

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

@@ -1,4 +1,4 @@
-# ronin-db-edit 1 "2022-01-01" Ronin DB "User Manuals"
+# ronin-db-edit 1 "2023-02-01" Ronin DB "User Manuals"
 
 ## SYNOPSIS
 
@@ -13,19 +13,24 @@ Manually edits the `~/.config/ronin-db/database.yml` configuration file.
 `-h`, `--help`
   Print help information.
 
-## FILES
+## ENVIRONMENT
 
-*~/.config/ronin-db/database.yml*
-	The `ronin-db` database(s) configuration file.
+*HOME*
+  Alternate location for the user's home directory.
 
-## ENVIRONMENT
+*XDG_CONFIG_HOME*
+  Alternate location for the `~/.config` directory.
+
+*XDG_DATA_HOME*
+  Alternate location for the `~/.local/share` directory.
+
+## FILES
 
-HOME
-	Specifies the home directory of the user. Ronin will search for the
-	*~/.config/ronin-db* cache directory within the home directory.
+`~/.local/share/ronin-db/database.sqlite3`
+  The default sqlite3 database file.
 
-XDG_CONFIG_HOME
-  Specifies the cache directory to use. Defaults to *$HOME/.config*.
+`~/.config/ronin-db/database.yml`
+  Optional database configuration.
 
 ## AUTHOR
 

data/man/ronin-db-emails.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-db-emails 1 "April 2012" Ronin "User Manuals"
+.TH ronin-db-emails 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db emails\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION
@@ -20,28 +20,36 @@ The database to connect to\. Defaults to \fBdefault\fR if not given\.
 .LP
 .TP
 \fB--db-uri\fR \fIURI\fP
-The explicit database URI to connect to
-(ex: \fBmysql://user:password@host/ronin\fR)\.
+The explicit database URI to connect to\.
+.LP
+.RS
+.IP \(bu 2
+\fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
+.IP \(bu 2
+\fBmysql\fP: \fBmysql://user:password@host/database\fR
+.IP \(bu 2
+\fBpostgres\fP: \fBpostgres://user:password@host/database\fR
+.RE
 .LP
 .TP
 \fB-v\fR, \fB--verbose\fR
 Enable verbose output\.
 .LP
 .TP
-\fB--add\fR \fIUSER\fP:\fIPASSWORD\fP
-Adds the \fIUSER\fP and \fIPASSWORD\fP to the database\.
+\fB--add\fR \fIVALUE\fP
+Adds the email address to the database\.
 .LP
 .TP
 \fB--import\fR \fIFILE\fP
-Imports the credentials from the given \fIFILE\fP\.
+Imports the email addresses from the given \fIFILE\fP\.
 .LP
 .TP
 \fB--delete\fR \fIVALUE\fP
-Deletes a value from the database\.
+Deletes the email address from the database\.
 .LP
 .TP
 \fB--delete-all\fR
-Deletes every value from the database\.
+Deletes every email address from the database\.
 .LP
 .TP
 \fB-H\fR, \fB--with-host\fR \fIHOST\fP
@@ -51,27 +59,37 @@ Searches for email addresses associated with the \fIHOST\fP\.
 \fB-I\fR, \fB--with-ip\fR \fIIP\fP
 Searches for email addresses associated with the IP address\.
 .LP
-.HP
+.PP
 \fB-u\fR, \fB--with-users\fR \fINAME\fP \[lB]\.\.\.\[rB]
 Searches for email addresses associated with the user NAME(s)\.
 .LP
-.SH FILES
+.TP
+\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
-\fI\[ti]\[sl]\.ronin\[sl]\fP
-Ronin configuration directory\.
+\fIXDG\[ru]CONFIG\[ru]HOME\fP
+Alternate location for the \fB~/.config\fR directory\.
 .LP
 .TP
-\fI\[ti]\[sl]\.ronin\[sl]database\.log\fP
-Database log\.
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Alternate location for the \fB~/.local/share\fR directory\.
+.LP
+.SH FILES
 .LP
 .TP
-\fI\[ti]\[sl]\.ronin\[sl]database\.sqlite3\fP
-The default sqlite3 Database file\.
+\fB~/.local/share/ronin-db/database.sqlite3\fR
+The default sqlite3 database file\.
 .LP
 .TP
-\fI\[ti]\[sl]\.ronin\[sl]database\.yml\fP
-Optional Database configuration\.
+\fB~/.config/ronin-db/database.yml\fR
+Optional database configuration\.
 .LP
 .SH AUTHOR
 .LP

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

@@ -1,4 +1,4 @@
-# ronin-db-emails 1 "April 2012" Ronin "User Manuals"
+# ronin-db-emails 1 "2023-02-01" Ronin "User Manuals"
 
 ## SYNOPSIS
 
@@ -14,23 +14,26 @@ Manages email addresses.
   The database to connect to. Defaults to `default` if not given.
 
 `--db-uri` *URI*
-  The explicit database URI to connect to
-  (ex: `mysql://user:password@host/ronin`).
+  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`
 
 `-v`, `--verbose`
 	Enable verbose output.
 
-`--add` *USER*:*PASSWORD*
-  Adds the *USER* and *PASSWORD* to the database.
+`--add` *VALUE*
+  Adds the email address to the database.
 
 `--import` *FILE*
-  Imports the credentials from the given *FILE*.
+  Imports the email addresses from the given *FILE*.
 
 `--delete` *VALUE*
-  Deletes a value from the database.
+  Deletes the email address from the database.
 
 `--delete-all`
-  Deletes every value from the database.
+  Deletes every email address from the database.
 
 `-H`, `--with-host` *HOST*
 	Searches for email addresses associated with the *HOST*.
@@ -41,19 +44,27 @@ Manages email addresses.
 `-u`, `--with-users` *NAME* [...]
 	Searches for email addresses associated with the user NAME(s).
 
-## FILES
+`-h`, `--help`
+  Print help information.
+
+## ENVIRONMENT
 
-*~/.ronin/*
-	Ronin configuration directory.
+*HOME*
+  Alternate location for the user's home directory.
 
-*~/.ronin/database.log*
-	Database log.
+*XDG_CONFIG_HOME*
+  Alternate location for the `~/.config` directory.
+
+*XDG_DATA_HOME*
+  Alternate location for the `~/.local/share` directory.
+
+## FILES
 
-*~/.ronin/database.sqlite3*
-	The default sqlite3 Database file.
+`~/.local/share/ronin-db/database.sqlite3`
+  The default sqlite3 database file.
 
-*~/.ronin/database.yml*
-	Optional Database configuration.
+`~/.config/ronin-db/database.yml`
+  Optional database configuration.
 
 ## AUTHOR
 

data/man/ronin-db-hosts.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-db-hosts 1 "April 2012" Ronin "User Manuals"
+.TH ronin-db-hosts 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db hosts\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION
@@ -20,16 +20,24 @@ The database to connect to\. Defaults to \fBdefault\fR if not given\.
 .LP
 .TP
 \fB--db-uri\fR \fIURI\fP
-The explicit database URI to connect to
-(ex: \fBmysql://user:password@host/ronin\fR)\.
+The explicit database URI to connect to\.
+.LP
+.RS
+.IP \(bu 2
+\fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
+.IP \(bu 2
+\fBmysql\fP: \fBmysql://user:password@host/database\fR
+.IP \(bu 2
+\fBpostgres\fP: \fBpostgres://user:password@host/database\fR
+.RE
 .LP
 .TP
 \fB-v\fR, \fB--verbose\fR
 Enable verbose output\.
 .LP
 .TP
-\fB--add\fR \fIUSER\fP:\fIPASSWORD\fP
-Adds the \fIUSER\fP and \fIPASSWORD\fP to the database\.
+\fB--add\fR \fIVALUE\fP
+Adds the hostname to the database\.
 .LP
 .TP
 \fB--import\fR \fIFILE\fP
@@ -59,23 +67,33 @@ Searches for HostNames belonging to the DOMAIN (\fBco.uk\fR)\.
 \fB-T\fR, \fB--tld\fR \fITLD\fP
 Searches for HostNames with the Top\-Level\-Domain (TLD) (\fBru\fR)\.
 .LP
-.SH FILES
+.TP
+\fB-h\fR, \fB--help\fR
+Print help information\.
+.LP
+.SH ENVIRONMENT
 .LP
 .TP
-\fI\[ti]\[sl]\.ronin\[sl]\fP
-Ronin configuration directory\.
+\fIHOME\fP
+Alternate location for the user\[cq]s home directory\.
 .LP
 .TP
-\fI\[ti]\[sl]\.ronin\[sl]database\.log\fP
-Database log\.
+\fIXDG\[ru]CONFIG\[ru]HOME\fP
+Alternate location for the \fB~/.config\fR directory\.
+.LP
+.TP
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Alternate location for the \fB~/.local/share\fR directory\.
+.LP
+.SH FILES
 .LP
 .TP
-\fI\[ti]\[sl]\.ronin\[sl]database\.sqlite3\fP
-The default sqlite3 Database file\.
+\fB~/.local/share/ronin-db/database.sqlite3\fR
+The default sqlite3 database file\.
 .LP
 .TP
-\fI\[ti]\[sl]\.ronin\[sl]database\.yml\fP
-Optional Database configuration\.
+\fB~/.config/ronin-db/database.yml\fR
+Optional database configuration\.
 .LP
 .SH AUTHOR
 .LP