RubyGems - ronin-db - Versions diffs - 0.1.0-java → 0.1.3-java - Mend

ronin-db 0.1.0-java → 0.1.3-java

Files changed (47) hide show

checksums.yaml +4 -4
data/.document +0 -1
data/.github/workflows/ruby.yml +15 -1
data/.rubocop.yml +16 -0
data/ChangeLog.md +19 -1
data/Gemfile +7 -3
data/README.md +0 -1
data/Rakefile +2 -3
data/bin/ronin-db +6 -7
data/lib/ronin/db/cli/command.rb +3 -0
data/lib/ronin/db/cli/commands/asn.rb +1 -1
data/lib/ronin/db/cli/commands/creds.rb +18 -18
data/lib/ronin/db/cli/commands/migrate.rb +1 -1
data/lib/ronin/db/cli/commands/urls.rb +6 -6
data/lib/ronin/db/cli/resources_command.rb +0 -2
data/lib/ronin/db/cli/uri_methods.rb +8 -3
data/lib/ronin/db/cli.rb +5 -0
data/lib/ronin/db/config_file.rb +14 -8
data/lib/ronin/db/exceptions.rb +9 -0
data/lib/ronin/db/version.rb +1 -1
data/lib/ronin/db.rb +15 -1
data/man/ronin-db-add.1 +45 -14
data/man/ronin-db-add.1.md +30 -10
data/man/ronin-db-asn.1 +37 -5
data/man/ronin-db-asn.1.md +25 -3
data/man/ronin-db-creds.1 +36 -18
data/man/ronin-db-creds.1.md +27 -16
data/man/ronin-db-edit.1 +21 -14
data/man/ronin-db-edit.1.md +15 -10
data/man/ronin-db-emails.1 +38 -20
data/man/ronin-db-emails.1.md +28 -17
data/man/ronin-db-hosts.1 +34 -16
data/man/ronin-db-hosts.1.md +25 -14
data/man/ronin-db-ips.1 +37 -19
data/man/ronin-db-ips.1.md +28 -17
data/man/ronin-db-irb.1 +30 -14
data/man/ronin-db-irb.1.md +19 -10
data/man/ronin-db-list.1 +21 -14
data/man/ronin-db-list.1.md +15 -10
data/man/ronin-db-migrate.1 +36 -3
data/man/ronin-db-migrate.1.md +24 -1
data/man/ronin-db-remove.1 +21 -14
data/man/ronin-db-remove.1.md +15 -10
data/man/ronin-db-urls.1 +39 -21
data/man/ronin-db-urls.1.md +28 -17
data/ronin-db.gemspec +4 -3
metadata +4 -3

data/man/ronin-db-hosts.1.md CHANGED Viewed

@@ -1,4 +1,4 @@
-# ronin-db-hosts 1 "April 2012" Ronin "User Manuals"
+# ronin-db-hosts 1 "2023-02-01" Ronin "User Manuals"
 ## SYNOPSIS
@@ -14,14 +14,17 @@ Manages host names.
   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 hostname to the database.
 `--import` *FILE*
   Imports the credentials from the given *FILE*.
@@ -44,19 +47,27 @@ Manages host names.
 `-T`, `--tld` *TLD*
 	Searches for HostNames with the Top-Level-Domain (TLD) (`ru`).
-## 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-ips.1 CHANGED Viewed

@@ -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-ips 1 "April 2012" Ronin "User Manuals"
+.TH ronin-db-ips 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db ips\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 IP address to the database\.
 .LP
 .TP
 \fB--import\fR \fIFILE\fP
-Imports the credentials from the given \fIFILE\fP\.
+Imports the IP addresses from the given \fIFILE\fP\.
 .LP
 .TP
 \fB--delete\fR \fIVALUE\fP
-Deletes a value from the database\.
+Deletes a IP address from the database\.
 .LP
 .TP
 \fB--delete-all\fR
-Deletes every value from the database\.
+Deletes every IP address from the database\.
 .LP
 .TP
 \fB-4\fR, \fB--v4\fR
@@ -63,23 +71,33 @@ Searches for IP addresses associated with the MAC address\.
 \fB-I\fR, \fB--with-host\fR \fIHOST\fP
 Searches for IP addresses associated with the \fIHOST\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-ips.1.md CHANGED Viewed

@@ -1,4 +1,4 @@
-# ronin-db-ips 1 "April 2012" Ronin "User Manuals"
+# ronin-db-ips 1 "2023-02-01" Ronin "User Manuals"
 ## SYNOPSIS
@@ -14,23 +14,26 @@ Manages IP 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 IP address to the database.
 `--import` *FILE*
-  Imports the credentials from the given *FILE*.
+  Imports the IP addresses from the given *FILE*.
 `--delete` *VALUE*
-  Deletes a value from the database.
+  Deletes a IP address from the database.
 `--delete-all`
-  Deletes every value from the database.
+  Deletes every IP address from the database.
 `-4`, `--v4`
 	Searches for IPv4 addresses.
@@ -47,19 +50,27 @@ Manages IP addresses.
 `-I`, `--with-host` *HOST*
 	Searches for IP addresses associated with the *HOST*.
-## 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-irb.1 CHANGED Viewed

@@ -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-irb 1 "2022-01-01" Ronin DB "User Manuals"
+.TH ronin-db-irb 1 "2023-02-01" Ronin DB "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db irb\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION
@@ -23,6 +23,15 @@ specified\.
 \fB--db-uri\fR \fIURI\fP
 The 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--no-connect\fR
 Causes the Ruby shell to not connect to a database on startup\.
@@ -31,22 +40,29 @@ Causes the Ruby shell to not connect to a database on startup\.
 \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-irb.1.md CHANGED Viewed

@@ -1,4 +1,4 @@
-# ronin-db-irb 1 "2022-01-01" Ronin DB "User Manuals"
+# ronin-db-irb 1 "2023-02-01" Ronin DB "User Manuals"
 ## SYNOPSIS
@@ -17,25 +17,34 @@ Connects to a database and start an interactive Ruby shell.
 `--db-uri` *URI*
   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`
 `--no-connect`
   Causes the Ruby shell to not connect to a database on startup.
 `-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-list.1 CHANGED Viewed

@@ -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-list 1 "2022-01-01" Ronin DB "User Manuals"
+.TH ronin-db-list 1 "2023-02-01" Ronin DB "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db list\fR \[lB]\fIoptions\fP\[rB] \[lB]\fINAME\fP\[rB]
 .LP
 .SH DESCRIPTION
@@ -28,22 +28,29 @@ Enables verbose output\.
 \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-list.1.md CHANGED Viewed

@@ -1,4 +1,4 @@
-# ronin-db-list 1 "2022-01-01" Ronin DB "User Manuals"
+# ronin-db-list 1 "2023-02-01" Ronin DB "User Manuals"
 ## SYNOPSIS
@@ -21,19 +21,24 @@ Lists entries in 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-migrate.1 CHANGED Viewed

@@ -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-migrate 1 "2022-01-01" Ronin DB "User Manuals"
+.TH ronin-db-migrate 1 "2023-02-01" Ronin DB "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db migrate\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION
@@ -23,6 +23,15 @@ specified\.
 \fB--db-uri\fR \fIURI\fP
 The 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--no-connect\fR
 Causes the Ruby shell to not connect to a database on startup\.
@@ -31,6 +40,30 @@ Causes the Ruby shell to not connect to a database on startup\.
 \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-migrate.1.md CHANGED Viewed

@@ -1,4 +1,4 @@
-# ronin-db-migrate 1 "2022-01-01" Ronin DB "User Manuals"
+# ronin-db-migrate 1 "2023-02-01" Ronin DB "User Manuals"
 ## SYNOPSIS
@@ -17,12 +17,35 @@ Runs database migrations.
 `--db-uri` *URI*
   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`
 `--no-connect`
   Causes the Ruby shell to not connect to a database on startup.
 `-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 CHANGED Viewed

@@ -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-remove 1 "2022-01-01" Ronin DB "User Manuals"
+.TH ronin-db-remove 1 "2023-02-01" Ronin DB "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-db remove\fR \[lB]\fIoptions\fP\[rB] \fINAME\fP
 .LP
 .SH DESCRIPTION
@@ -25,22 +25,29 @@ The database entry to remove\.
 \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-remove.1.md CHANGED Viewed

@@ -1,4 +1,4 @@
-# ronin-db-remove 1 "2022-01-01" Ronin DB "User Manuals"
+# ronin-db-remove 1 "2023-02-01" Ronin DB "User Manuals"
 ## SYNOPSIS
@@ -19,19 +19,24 @@ 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