man/ronin-db-add.1.md in ronin-db-0.1.0-java vs man/ronin-db-add.1.md in ronin-db-0.1.1

- old
+ new

@@ -1,14 +1,15 @@ -# ronin-db-add 1 "2022-01-01" Ronin DB "User Manuals" +# ronin-db-add 1 "2023-02-01" Ronin DB "User Manuals" ## SYNOPSIS `ronin-db add` [*options*] *NAME* [*URI*] ## DESCRIPTION -Lists entries in the `~/.config/ronin-db/database.yml` configuration file. +Adds a pre-existing database to the `~/.config/ronin-db/database.yml` +configuration file. ## ARGUMENTS *NAME* The name of the database to add. @@ -50,22 +51,41 @@ may be given instead. `-h`, `--help` Print help information. -## FILES +## EXAMPLES -*~/.config/ronin-db/database.yml* - The `ronin-db` database(s) configuration file. +Add a sqlite3 database file: + $ ronin-db add other_db --sqlite3 path/to/db.sqlite3 + +Add a PostgeSQL database: + + $ ronin-db add other_db --postgres --host example.com --port 5432 --username ronin --password s3r3t --database ronin_db + +Add a MySQL database: + + $ ronin-db add other_db --mysql2 --host example.com --port 3306 --username ronin --password s3r3t --database ronin_db + ## ENVIRONMENT -HOME - Specifies the home directory of the user. Ronin will search for the - *~/.config/ronin-db* cache directory within the home directory. +*HOME* + Alternate location for the user's home directory. -XDG_CONFIG_HOME - Specifies the cache directory to use. Defaults to *$HOME/.config*. +*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>