ronin-db 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (43) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ruby.yml +14 -0
  3. data/.rubocop.yml +16 -0
  4. data/ChangeLog.md +9 -1
  5. data/Gemfile +7 -3
  6. data/Rakefile +2 -3
  7. data/bin/ronin-db +6 -7
  8. data/lib/ronin/db/cli/command.rb +3 -0
  9. data/lib/ronin/db/cli/commands/asn.rb +1 -1
  10. data/lib/ronin/db/cli/commands/migrate.rb +1 -1
  11. data/lib/ronin/db/cli/commands/urls.rb +6 -6
  12. data/lib/ronin/db/cli/resources_command.rb +0 -2
  13. data/lib/ronin/db/cli/uri_methods.rb +8 -3
  14. data/lib/ronin/db/cli.rb +5 -0
  15. data/lib/ronin/db/config_file.rb +2 -1
  16. data/lib/ronin/db/version.rb +1 -1
  17. data/lib/ronin/db.rb +3 -0
  18. data/man/ronin-db-add.1 +43 -12
  19. data/man/ronin-db-add.1.md +30 -10
  20. data/man/ronin-db-asn.1 +25 -1
  21. data/man/ronin-db-asn.1.md +20 -1
  22. data/man/ronin-db-creds.1 +20 -14
  23. data/man/ronin-db-creds.1.md +19 -14
  24. data/man/ronin-db-edit.1 +19 -12
  25. data/man/ronin-db-edit.1.md +15 -10
  26. data/man/ronin-db-emails.1 +21 -15
  27. data/man/ronin-db-emails.1.md +20 -15
  28. data/man/ronin-db-hosts.1 +18 -12
  29. data/man/ronin-db-hosts.1.md +17 -12
  30. data/man/ronin-db-ips.1 +21 -15
  31. data/man/ronin-db-ips.1.md +20 -15
  32. data/man/ronin-db-irb.1 +19 -12
  33. data/man/ronin-db-irb.1.md +15 -10
  34. data/man/ronin-db-list.1 +19 -12
  35. data/man/ronin-db-list.1.md +15 -10
  36. data/man/ronin-db-migrate.1 +25 -1
  37. data/man/ronin-db-migrate.1.md +20 -1
  38. data/man/ronin-db-remove.1 +19 -12
  39. data/man/ronin-db-remove.1.md +15 -10
  40. data/man/ronin-db-urls.1 +21 -15
  41. data/man/ronin-db-urls.1.md +20 -15
  42. data/ronin-db.gemspec +4 -3
  43. metadata +3 -2
data/man/ronin-db-edit.1.md CHANGED
@@ -1,4 +1,4 @@
1
- # ronin-db-edit 1 "2022-01-01" Ronin DB "User Manuals"
1
+ # ronin-db-edit 1 "2023-02-01" Ronin DB "User Manuals"
2
2
 
3
3
  ## SYNOPSIS
4
4
 
@@ -13,19 +13,24 @@ Manually edits the `~/.config/ronin-db/database.yml` configuration file.
13
13
  `-h`, `--help`
14
14
  Print help information.
15
15
 
16
- ## FILES
16
+ ## ENVIRONMENT
17
17
 
18
- *~/.config/ronin-db/database.yml*
19
- The `ronin-db` database(s) configuration file.
18
+ *HOME*
19
+ Alternate location for the user's home directory.
20
20
 
21
- ## ENVIRONMENT
21
+ *XDG_CONFIG_HOME*
22
+ Alternate location for the `~/.config` directory.
23
+
24
+ *XDG_DATA_HOME*
25
+ Alternate location for the `~/.local/share` directory.
26
+
27
+ ## FILES
22
28
 
23
- HOME
24
- Specifies the home directory of the user. Ronin will search for the
25
- *~/.config/ronin-db* cache directory within the home directory.
29
+ `~/.local/share/ronin-db/database.sqlite3`
30
+ The default sqlite3 database file.
26
31
 
27
- XDG_CONFIG_HOME
28
- Specifies the cache directory to use. Defaults to *$HOME/.config*.
32
+ `~/.config/ronin-db/database.yml`
33
+ Optional database configuration.
29
34
 
30
35
  ## AUTHOR
31
36
 
data/man/ronin-db-emails.1 CHANGED
@@ -1,6 +1,6 @@
1
1
  .\" Generated by kramdown-man 0.1.8
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
- .TH ronin-db-emails 1 "April 2012" Ronin "User Manuals"
3
+ .TH ronin-db-emails 1 "2023-02-01" Ronin "User Manuals"
4
4
  .LP
5
5
  .SH SYNOPSIS
6
6
  .LP
@@ -28,20 +28,20 @@ The explicit database URI to connect to
28
28
  Enable verbose output\.
29
29
  .LP
30
30
  .TP
31
- \fB--add\fR \fIUSER\fP:\fIPASSWORD\fP
32
- Adds the \fIUSER\fP and \fIPASSWORD\fP to the database\.
31
+ \fB--add\fR \fIVALUE\fP
32
+ Adds the email address to the database\.
33
33
  .LP
34
34
  .TP
35
35
  \fB--import\fR \fIFILE\fP
36
- Imports the credentials from the given \fIFILE\fP\.
36
+ Imports the email addresses from the given \fIFILE\fP\.
37
37
  .LP
38
38
  .TP
39
39
  \fB--delete\fR \fIVALUE\fP
40
- Deletes a value from the database\.
40
+ Deletes the email address from the database\.
41
41
  .LP
42
42
  .TP
43
43
  \fB--delete-all\fR
44
- Deletes every value from the database\.
44
+ Deletes every email address from the database\.
45
45
  .LP
46
46
  .TP
47
47
  \fB-H\fR, \fB--with-host\fR \fIHOST\fP
@@ -55,23 +55,29 @@ Searches for email addresses associated with the IP address\.
55
55
  \fB-u\fR, \fB--with-users\fR \fINAME\fP \[lB]\.\.\.\[rB]
56
56
  Searches for email addresses associated with the user NAME(s)\.
57
57
  .LP
58
- .SH FILES
58
+ .SH ENVIRONMENT
59
+ .LP
60
+ .TP
61
+ \fIHOME\fP
62
+ Alternate location for the user\[cq]s home directory\.
59
63
  .LP
60
64
  .TP
61
- \fI\[ti]\[sl]\.ronin\[sl]\fP
62
- Ronin configuration directory\.
65
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
66
+ Alternate location for the \fB~/.config\fR directory\.
63
67
  .LP
64
68
  .TP
65
- \fI\[ti]\[sl]\.ronin\[sl]database\.log\fP
66
- Database log\.
69
+ \fIXDG\[ru]DATA\[ru]HOME\fP
70
+ Alternate location for the \fB~/.local/share\fR directory\.
71
+ .LP
72
+ .SH FILES
67
73
  .LP
68
74
  .TP
69
- \fI\[ti]\[sl]\.ronin\[sl]database\.sqlite3\fP
70
- The default sqlite3 Database file\.
75
+ \fB~/.local/share/ronin-db/database.sqlite3\fR
76
+ The default sqlite3 database file\.
71
77
  .LP
72
78
  .TP
73
- \fI\[ti]\[sl]\.ronin\[sl]database\.yml\fP
74
- Optional Database configuration\.
79
+ \fB~/.config/ronin-db/database.yml\fR
80
+ Optional database configuration\.
75
81
  .LP
76
82
  .SH AUTHOR
77
83
  .LP
data/man/ronin-db-emails.1.md CHANGED
@@ -1,4 +1,4 @@
1
- # ronin-db-emails 1 "April 2012" Ronin "User Manuals"
1
+ # ronin-db-emails 1 "2023-02-01" Ronin "User Manuals"
2
2
 
3
3
  ## SYNOPSIS
4
4
 
@@ -20,17 +20,17 @@ Manages email addresses.
20
20
  `-v`, `--verbose`
21
21
  Enable verbose output.
22
22
 
23
- `--add` *USER*:*PASSWORD*
24
- Adds the *USER* and *PASSWORD* to the database.
23
+ `--add` *VALUE*
24
+ Adds the email address to the database.
25
25
 
26
26
  `--import` *FILE*
27
- Imports the credentials from the given *FILE*.
27
+ Imports the email addresses from the given *FILE*.
28
28
 
29
29
  `--delete` *VALUE*
30
- Deletes a value from the database.
30
+ Deletes the email address from the database.
31
31
 
32
32
  `--delete-all`
33
- Deletes every value from the database.
33
+ Deletes every email address from the database.
34
34
 
35
35
  `-H`, `--with-host` *HOST*
36
36
  Searches for email addresses associated with the *HOST*.
@@ -41,19 +41,24 @@ Manages email addresses.
41
41
  `-u`, `--with-users` *NAME* [...]
42
42
  Searches for email addresses associated with the user NAME(s).
43
43
 
44
- ## FILES
44
+ ## ENVIRONMENT
45
+
46
+ *HOME*
47
+ Alternate location for the user's home directory.
45
48
 
46
- *~/.ronin/*
47
- Ronin configuration directory.
49
+ *XDG_CONFIG_HOME*
50
+ Alternate location for the `~/.config` directory.
48
51
 
49
- *~/.ronin/database.log*
50
- Database log.
52
+ *XDG_DATA_HOME*
53
+ Alternate location for the `~/.local/share` directory.
54
+
55
+ ## FILES
51
56
 
52
- *~/.ronin/database.sqlite3*
53
- The default sqlite3 Database file.
57
+ `~/.local/share/ronin-db/database.sqlite3`
58
+ The default sqlite3 database file.
54
59
 
55
- *~/.ronin/database.yml*
56
- Optional Database configuration.
60
+ `~/.config/ronin-db/database.yml`
61
+ Optional database configuration.
57
62
 
58
63
  ## AUTHOR
59
64
 
data/man/ronin-db-hosts.1 CHANGED
@@ -1,6 +1,6 @@
1
1
  .\" Generated by kramdown-man 0.1.8
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
- .TH ronin-db-hosts 1 "April 2012" Ronin "User Manuals"
3
+ .TH ronin-db-hosts 1 "2023-02-01" Ronin "User Manuals"
4
4
  .LP
5
5
  .SH SYNOPSIS
6
6
  .LP
@@ -28,8 +28,8 @@ The explicit database URI to connect to
28
28
  Enable verbose output\.
29
29
  .LP
30
30
  .TP
31
- \fB--add\fR \fIUSER\fP:\fIPASSWORD\fP
32
- Adds the \fIUSER\fP and \fIPASSWORD\fP to the database\.
31
+ \fB--add\fR \fIVALUE\fP
32
+ Adds the hostname to the database\.
33
33
  .LP
34
34
  .TP
35
35
  \fB--import\fR \fIFILE\fP
@@ -59,23 +59,29 @@ Searches for HostNames belonging to the DOMAIN (\fBco.uk\fR)\.
59
59
  \fB-T\fR, \fB--tld\fR \fITLD\fP
60
60
  Searches for HostNames with the Top\-Level\-Domain (TLD) (\fBru\fR)\.
61
61
  .LP
62
- .SH FILES
62
+ .SH ENVIRONMENT
63
+ .LP
64
+ .TP
65
+ \fIHOME\fP
66
+ Alternate location for the user\[cq]s home directory\.
63
67
  .LP
64
68
  .TP
65
- \fI\[ti]\[sl]\.ronin\[sl]\fP
66
- Ronin configuration directory\.
69
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
70
+ Alternate location for the \fB~/.config\fR directory\.
67
71
  .LP
68
72
  .TP
69
- \fI\[ti]\[sl]\.ronin\[sl]database\.log\fP
70
- Database log\.
73
+ \fIXDG\[ru]DATA\[ru]HOME\fP
74
+ Alternate location for the \fB~/.local/share\fR directory\.
75
+ .LP
76
+ .SH FILES
71
77
  .LP
72
78
  .TP
73
- \fI\[ti]\[sl]\.ronin\[sl]database\.sqlite3\fP
74
- The default sqlite3 Database file\.
79
+ \fB~/.local/share/ronin-db/database.sqlite3\fR
80
+ The default sqlite3 database file\.
75
81
  .LP
76
82
  .TP
77
- \fI\[ti]\[sl]\.ronin\[sl]database\.yml\fP
78
- Optional Database configuration\.
83
+ \fB~/.config/ronin-db/database.yml\fR
84
+ Optional database configuration\.
79
85
  .LP
80
86
  .SH AUTHOR
81
87
  .LP
data/man/ronin-db-hosts.1.md CHANGED
@@ -1,4 +1,4 @@
1
- # ronin-db-hosts 1 "April 2012" Ronin "User Manuals"
1
+ # ronin-db-hosts 1 "2023-02-01" Ronin "User Manuals"
2
2
 
3
3
  ## SYNOPSIS
4
4
 
@@ -20,8 +20,8 @@ Manages host names.
20
20
  `-v`, `--verbose`
21
21
  Enable verbose output.
22
22
 
23
- `--add` *USER*:*PASSWORD*
24
- Adds the *USER* and *PASSWORD* to the database.
23
+ `--add` *VALUE*
24
+ Adds the hostname to the database.
25
25
 
26
26
  `--import` *FILE*
27
27
  Imports the credentials from the given *FILE*.
@@ -44,19 +44,24 @@ Manages host names.
44
44
  `-T`, `--tld` *TLD*
45
45
  Searches for HostNames with the Top-Level-Domain (TLD) (`ru`).
46
46
 
47
- ## FILES
47
+ ## ENVIRONMENT
48
+
49
+ *HOME*
50
+ Alternate location for the user's home directory.
48
51
 
49
- *~/.ronin/*
50
- Ronin configuration directory.
52
+ *XDG_CONFIG_HOME*
53
+ Alternate location for the `~/.config` directory.
51
54
 
52
- *~/.ronin/database.log*
53
- Database log.
55
+ *XDG_DATA_HOME*
56
+ Alternate location for the `~/.local/share` directory.
57
+
58
+ ## FILES
54
59
 
55
- *~/.ronin/database.sqlite3*
56
- The default sqlite3 Database file.
60
+ `~/.local/share/ronin-db/database.sqlite3`
61
+ The default sqlite3 database file.
57
62
 
58
- *~/.ronin/database.yml*
59
- Optional Database configuration.
63
+ `~/.config/ronin-db/database.yml`
64
+ Optional database configuration.
60
65
 
61
66
  ## AUTHOR
62
67
 
data/man/ronin-db-ips.1 CHANGED
@@ -1,6 +1,6 @@
1
1
  .\" Generated by kramdown-man 0.1.8
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
- .TH ronin-db-ips 1 "April 2012" Ronin "User Manuals"
3
+ .TH ronin-db-ips 1 "2023-02-01" Ronin "User Manuals"
4
4
  .LP
5
5
  .SH SYNOPSIS
6
6
  .LP
@@ -28,20 +28,20 @@ The explicit database URI to connect to
28
28
  Enable verbose output\.
29
29
  .LP
30
30
  .TP
31
- \fB--add\fR \fIUSER\fP:\fIPASSWORD\fP
32
- Adds the \fIUSER\fP and \fIPASSWORD\fP to the database\.
31
+ \fB--add\fR \fIVALUE\fP
32
+ Adds the IP address to the database\.
33
33
  .LP
34
34
  .TP
35
35
  \fB--import\fR \fIFILE\fP
36
- Imports the credentials from the given \fIFILE\fP\.
36
+ Imports the IP addresses from the given \fIFILE\fP\.
37
37
  .LP
38
38
  .TP
39
39
  \fB--delete\fR \fIVALUE\fP
40
- Deletes a value from the database\.
40
+ Deletes a IP address from the database\.
41
41
  .LP
42
42
  .TP
43
43
  \fB--delete-all\fR
44
- Deletes every value from the database\.
44
+ Deletes every IP address from the database\.
45
45
  .LP
46
46
  .TP
47
47
  \fB-4\fR, \fB--v4\fR
@@ -63,23 +63,29 @@ Searches for IP addresses associated with the MAC address\.
63
63
  \fB-I\fR, \fB--with-host\fR \fIHOST\fP
64
64
  Searches for IP addresses associated with the \fIHOST\fP\.
65
65
  .LP
66
- .SH FILES
66
+ .SH ENVIRONMENT
67
+ .LP
68
+ .TP
69
+ \fIHOME\fP
70
+ Alternate location for the user\[cq]s home directory\.
67
71
  .LP
68
72
  .TP
69
- \fI\[ti]\[sl]\.ronin\[sl]\fP
70
- Ronin configuration directory\.
73
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
74
+ Alternate location for the \fB~/.config\fR directory\.
71
75
  .LP
72
76
  .TP
73
- \fI\[ti]\[sl]\.ronin\[sl]database\.log\fP
74
- Database log\.
77
+ \fIXDG\[ru]DATA\[ru]HOME\fP
78
+ Alternate location for the \fB~/.local/share\fR directory\.
79
+ .LP
80
+ .SH FILES
75
81
  .LP
76
82
  .TP
77
- \fI\[ti]\[sl]\.ronin\[sl]database\.sqlite3\fP
78
- The default sqlite3 Database file\.
83
+ \fB~/.local/share/ronin-db/database.sqlite3\fR
84
+ The default sqlite3 database file\.
79
85
  .LP
80
86
  .TP
81
- \fI\[ti]\[sl]\.ronin\[sl]database\.yml\fP
82
- Optional Database configuration\.
87
+ \fB~/.config/ronin-db/database.yml\fR
88
+ Optional database configuration\.
83
89
  .LP
84
90
  .SH AUTHOR
85
91
  .LP
data/man/ronin-db-ips.1.md CHANGED
@@ -1,4 +1,4 @@
1
- # ronin-db-ips 1 "April 2012" Ronin "User Manuals"
1
+ # ronin-db-ips 1 "2023-02-01" Ronin "User Manuals"
2
2
 
3
3
  ## SYNOPSIS
4
4
 
@@ -20,17 +20,17 @@ Manages IP addresses.
20
20
  `-v`, `--verbose`
21
21
  Enable verbose output.
22
22
 
23
- `--add` *USER*:*PASSWORD*
24
- Adds the *USER* and *PASSWORD* to the database.
23
+ `--add` *VALUE*
24
+ Adds the IP address to the database.
25
25
 
26
26
  `--import` *FILE*
27
- Imports the credentials from the given *FILE*.
27
+ Imports the IP addresses from the given *FILE*.
28
28
 
29
29
  `--delete` *VALUE*
30
- Deletes a value from the database.
30
+ Deletes a IP address from the database.
31
31
 
32
32
  `--delete-all`
33
- Deletes every value from the database.
33
+ Deletes every IP address from the database.
34
34
 
35
35
  `-4`, `--v4`
36
36
  Searches for IPv4 addresses.
@@ -47,19 +47,24 @@ Manages IP addresses.
47
47
  `-I`, `--with-host` *HOST*
48
48
  Searches for IP addresses associated with the *HOST*.
49
49
 
50
- ## FILES
50
+ ## ENVIRONMENT
51
+
52
+ *HOME*
53
+ Alternate location for the user's home directory.
51
54
 
52
- *~/.ronin/*
53
- Ronin configuration directory.
55
+ *XDG_CONFIG_HOME*
56
+ Alternate location for the `~/.config` directory.
54
57
 
55
- *~/.ronin/database.log*
56
- Database log.
58
+ *XDG_DATA_HOME*
59
+ Alternate location for the `~/.local/share` directory.
60
+
61
+ ## FILES
57
62
 
58
- *~/.ronin/database.sqlite3*
59
- The default sqlite3 Database file.
63
+ `~/.local/share/ronin-db/database.sqlite3`
64
+ The default sqlite3 database file.
60
65
 
61
- *~/.ronin/database.yml*
62
- Optional Database configuration.
66
+ `~/.config/ronin-db/database.yml`
67
+ Optional database configuration.
63
68
 
64
69
  ## AUTHOR
65
70
 
data/man/ronin-db-irb.1 CHANGED
@@ -1,6 +1,6 @@
1
1
  .\" Generated by kramdown-man 0.1.8
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
- .TH ronin-db-irb 1 "2022-01-01" Ronin DB "User Manuals"
3
+ .TH ronin-db-irb 1 "2023-02-01" Ronin DB "User Manuals"
4
4
  .LP
5
5
  .SH SYNOPSIS
6
6
  .LP
@@ -31,22 +31,29 @@ Causes the Ruby shell to not connect to a database on startup\.
31
31
  \fB-h\fR, \fB--help\fR
32
32
  Print help information\.
33
33
  .LP
34
- .SH FILES
34
+ .SH ENVIRONMENT
35
35
  .LP
36
36
  .TP
37
- \fI\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fP
38
- The \fBronin-db\fR database(s) configuration file\.
37
+ \fIHOME\fP
38
+ Alternate location for the user\[cq]s home directory\.
39
39
  .LP
40
- .SH ENVIRONMENT
40
+ .TP
41
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
42
+ Alternate location for the \fB~/.config\fR directory\.
41
43
  .LP
42
- .PP
43
- HOME
44
- Specifies the home directory of the user\. Ronin will search for the
45
- \fI\[ti]\[sl]\.config\[sl]ronin\-db\fP cache directory within the home directory\.
44
+ .TP
45
+ \fIXDG\[ru]DATA\[ru]HOME\fP
46
+ Alternate location for the \fB~/.local/share\fR directory\.
46
47
  .LP
47
- .PP
48
- XDG\[ru]CONFIG\[ru]HOME
49
- Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.config\fP\.
48
+ .SH FILES
49
+ .LP
50
+ .TP
51
+ \fB~/.local/share/ronin-db/database.sqlite3\fR
52
+ The default sqlite3 database file\.
53
+ .LP
54
+ .TP
55
+ \fB~/.config/ronin-db/database.yml\fR
56
+ Optional database configuration\.
50
57
  .LP
51
58
  .SH AUTHOR
52
59
  .LP
data/man/ronin-db-irb.1.md CHANGED
@@ -1,4 +1,4 @@
1
- # ronin-db-irb 1 "2022-01-01" Ronin DB "User Manuals"
1
+ # ronin-db-irb 1 "2023-02-01" Ronin DB "User Manuals"
2
2
 
3
3
  ## SYNOPSIS
4
4
 
@@ -23,19 +23,24 @@ Connects to a database and start an interactive Ruby shell.
23
23
  `-h`, `--help`
24
24
  Print help information.
25
25
 
26
- ## FILES
26
+ ## ENVIRONMENT
27
27
 
28
- *~/.config/ronin-db/database.yml*
29
- The `ronin-db` database(s) configuration file.
28
+ *HOME*
29
+ Alternate location for the user's home directory.
30
30
 
31
- ## ENVIRONMENT
31
+ *XDG_CONFIG_HOME*
32
+ Alternate location for the `~/.config` directory.
33
+
34
+ *XDG_DATA_HOME*
35
+ Alternate location for the `~/.local/share` directory.
36
+
37
+ ## FILES
32
38
 
33
- HOME
34
- Specifies the home directory of the user. Ronin will search for the
35
- *~/.config/ronin-db* cache directory within the home directory.
39
+ `~/.local/share/ronin-db/database.sqlite3`
40
+ The default sqlite3 database file.
36
41
 
37
- XDG_CONFIG_HOME
38
- Specifies the cache directory to use. Defaults to *$HOME/.config*.
42
+ `~/.config/ronin-db/database.yml`
43
+ Optional database configuration.
39
44
 
40
45
  ## AUTHOR
41
46
 
data/man/ronin-db-list.1 CHANGED
@@ -1,6 +1,6 @@
1
1
  .\" Generated by kramdown-man 0.1.8
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
- .TH ronin-db-list 1 "2022-01-01" Ronin DB "User Manuals"
3
+ .TH ronin-db-list 1 "2023-02-01" Ronin DB "User Manuals"
4
4
  .LP
5
5
  .SH SYNOPSIS
6
6
  .LP
@@ -28,22 +28,29 @@ Enables verbose output\.
28
28
  \fB-h\fR, \fB--help\fR
29
29
  Print help information\.
30
30
  .LP
31
- .SH FILES
31
+ .SH ENVIRONMENT
32
32
  .LP
33
33
  .TP
34
- \fI\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fP
35
- The \fBronin-db\fR database(s) configuration file\.
34
+ \fIHOME\fP
35
+ Alternate location for the user\[cq]s home directory\.
36
36
  .LP
37
- .SH ENVIRONMENT
37
+ .TP
38
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
39
+ Alternate location for the \fB~/.config\fR directory\.
38
40
  .LP
39
- .PP
40
- HOME
41
- Specifies the home directory of the user\. Ronin will search for the
42
- \fI\[ti]\[sl]\.config\[sl]ronin\-db\fP cache directory within the home directory\.
41
+ .TP
42
+ \fIXDG\[ru]DATA\[ru]HOME\fP
43
+ Alternate location for the \fB~/.local/share\fR directory\.
43
44
  .LP
44
- .PP
45
- XDG\[ru]CONFIG\[ru]HOME
46
- Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.config\fP\.
45
+ .SH FILES
46
+ .LP
47
+ .TP
48
+ \fB~/.local/share/ronin-db/database.sqlite3\fR
49
+ The default sqlite3 database file\.
50
+ .LP
51
+ .TP
52
+ \fB~/.config/ronin-db/database.yml\fR
53
+ Optional database configuration\.
47
54
  .LP
48
55
  .SH AUTHOR
49
56
  .LP
data/man/ronin-db-list.1.md CHANGED
@@ -1,4 +1,4 @@
1
- # ronin-db-list 1 "2022-01-01" Ronin DB "User Manuals"
1
+ # ronin-db-list 1 "2023-02-01" Ronin DB "User Manuals"
2
2
 
3
3
  ## SYNOPSIS
4
4
 
@@ -21,19 +21,24 @@ Lists entries in the `~/.config/ronin-db/database.yml` configuration file.
21
21
  `-h`, `--help`
22
22
  Print help information.
23
23
 
24
- ## FILES
24
+ ## ENVIRONMENT
25
25
 
26
- *~/.config/ronin-db/database.yml*
27
- The `ronin-db` database(s) configuration file.
26
+ *HOME*
27
+ Alternate location for the user's home directory.
28
28
 
29
- ## ENVIRONMENT
29
+ *XDG_CONFIG_HOME*
30
+ Alternate location for the `~/.config` directory.
31
+
32
+ *XDG_DATA_HOME*
33
+ Alternate location for the `~/.local/share` directory.
34
+
35
+ ## FILES
30
36
 
31
- HOME
32
- Specifies the home directory of the user. Ronin will search for the
33
- *~/.config/ronin-db* cache directory within the home directory.
37
+ `~/.local/share/ronin-db/database.sqlite3`
38
+ The default sqlite3 database file.
34
39
 
35
- XDG_CONFIG_HOME
36
- Specifies the cache directory to use. Defaults to *$HOME/.config*.
40
+ `~/.config/ronin-db/database.yml`
41
+ Optional database configuration.
37
42
 
38
43
  ## AUTHOR
39
44
 
data/man/ronin-db-migrate.1 CHANGED
@@ -1,6 +1,6 @@
1
1
  .\" Generated by kramdown-man 0.1.8
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
- .TH ronin-db-migrate 1 "2022-01-01" Ronin DB "User Manuals"
3
+ .TH ronin-db-migrate 1 "2023-02-01" Ronin DB "User Manuals"
4
4
  .LP
5
5
  .SH SYNOPSIS
6
6
  .LP
@@ -31,6 +31,30 @@ Causes the Ruby shell to not connect to a database on startup\.
31
31
  \fB-h\fR, \fB--help\fR
32
32
  Print help information\.
33
33
  .LP
34
+ .SH ENVIRONMENT
35
+ .LP
36
+ .TP
37
+ \fIHOME\fP
38
+ Alternate location for the user\[cq]s home directory\.
39
+ .LP
40
+ .TP
41
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
42
+ Alternate location for the \fB~/.config\fR directory\.
43
+ .LP
44
+ .TP
45
+ \fIXDG\[ru]DATA\[ru]HOME\fP
46
+ Alternate location for the \fB~/.local/share\fR directory\.
47
+ .LP
48
+ .SH FILES
49
+ .LP
50
+ .TP
51
+ \fB~/.local/share/ronin-db/database.sqlite3\fR
52
+ The default sqlite3 database file\.
53
+ .LP
54
+ .TP
55
+ \fB~/.config/ronin-db/database.yml\fR
56
+ Optional database configuration\.
57
+ .LP
34
58
  .SH AUTHOR
35
59
  .LP
36
60
  .PP
data/man/ronin-db-migrate.1.md CHANGED
@@ -1,4 +1,4 @@
1
- # ronin-db-migrate 1 "2022-01-01" Ronin DB "User Manuals"
1
+ # ronin-db-migrate 1 "2023-02-01" Ronin DB "User Manuals"
2
2
 
3
3
  ## SYNOPSIS
4
4
 
@@ -23,6 +23,25 @@ Runs database migrations.
23
23
  `-h`, `--help`
24
24
  Print help information.
25
25
 
26
+ ## ENVIRONMENT
27
+
28
+ *HOME*
29
+ Alternate location for the user's home directory.
30
+
31
+ *XDG_CONFIG_HOME*
32
+ Alternate location for the `~/.config` directory.
33
+
34
+ *XDG_DATA_HOME*
35
+ Alternate location for the `~/.local/share` directory.
36
+
37
+ ## FILES
38
+
39
+ `~/.local/share/ronin-db/database.sqlite3`
40
+ The default sqlite3 database file.
41
+
42
+ `~/.config/ronin-db/database.yml`
43
+ Optional database configuration.
44
+
26
45
  ## AUTHOR
27
46
 
28
47
  Postmodern <postmodern.mod3@gmail.com>