man/ronin-db-add.1 in ronin-db-0.1.0-java vs man/ronin-db-add.1 in ronin-db-0.1.1
- old
+ new
@@ -1,18 +1,19 @@
.\" Generated by kramdown-man 0.1.8
.\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-db-add 1 "2022-01-01" Ronin DB "User Manuals"
+.TH ronin-db-add 1 "2023-02-01" Ronin DB "User Manuals"
.LP
.SH SYNOPSIS
.LP
.HP
\fBronin-db add\fR \[lB]\fIoptions\fP\[rB] \fINAME\fP \[lB]\fIURI\fP\[rB]
.LP
.SH DESCRIPTION
.LP
.PP
-Lists entries in the \fB~/.config/ronin-db/database.yml\fR configuration file\.
+Adds a pre\-existing database to the \fB~/.config/ronin-db/database.yml\fR
+configuration file\.
.LP
.SH ARGUMENTS
.LP
.TP
\fINAME\fP
@@ -67,25 +68,55 @@
.LP
.TP
\fB-h\fR, \fB--help\fR
Print help information\.
.LP
-.SH FILES
+.SH EXAMPLES
.LP
-.TP
-\fI\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fP
-The \fBronin-db\fR database(s) configuration file\.
+.PP
+Add a sqlite3 database file:
.LP
-.SH ENVIRONMENT
+.nf
+ \[Do] ronin\-db add other\[ru]db \-\-sqlite3 path\[sl]to\[sl]db\.sqlite3
+.fi
.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\.
+Add a PostgeSQL database:
.LP
+.nf
+ \[Do] ronin\-db add other\[ru]db \-\-postgres \-\-host example\.com \-\-port 5432 \-\-username ronin \-\-password s3r3t \-\-database ronin\[ru]db
+.fi
+.LP
.PP
-XDG\[ru]CONFIG\[ru]HOME
-Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.config\fP\.
+Add a MySQL database:
+.LP
+.nf
+ \[Do] ronin\-db add other\[ru]db \-\-mysql2 \-\-host example\.com \-\-port 3306 \-\-username ronin \-\-password s3r3t \-\-database ronin\[ru]db
+.fi
+.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
Postmodern
\ No newline at end of file