ronin-db 0.1.0.beta3-java → 0.1.2-java

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. checksums.yaml +4 -4
  2. data/.document +0 -1
  3. data/.github/workflows/ruby.yml +14 -0
  4. data/.rubocop.yml +16 -0
  5. data/ChangeLog.md +14 -1
  6. data/Gemfile +7 -3
  7. data/README.md +1 -2
  8. data/Rakefile +2 -3
  9. data/bin/ronin-db +6 -7
  10. data/gemspec.yml +4 -4
  11. data/lib/ronin/db/cli/command.rb +3 -0
  12. data/lib/ronin/db/cli/commands/asn.rb +1 -1
  13. data/lib/ronin/db/cli/commands/creds.rb +18 -18
  14. data/lib/ronin/db/cli/commands/migrate.rb +1 -1
  15. data/lib/ronin/db/cli/commands/urls.rb +6 -6
  16. data/lib/ronin/db/cli/resources_command.rb +0 -2
  17. data/lib/ronin/db/cli/uri_methods.rb +8 -3
  18. data/lib/ronin/db/cli.rb +5 -0
  19. data/lib/ronin/db/config_file.rb +2 -1
  20. data/lib/ronin/db/version.rb +1 -1
  21. data/lib/ronin/db.rb +6 -1
  22. data/man/ronin-db-add.1 +43 -12
  23. data/man/ronin-db-add.1.md +30 -10
  24. data/man/ronin-db-asn.1 +35 -3
  25. data/man/ronin-db-asn.1.md +25 -3
  26. data/man/ronin-db-creds.1 +34 -16
  27. data/man/ronin-db-creds.1.md +27 -16
  28. data/man/ronin-db-edit.1 +19 -12
  29. data/man/ronin-db-edit.1.md +15 -10
  30. data/man/ronin-db-emails.1 +35 -17
  31. data/man/ronin-db-emails.1.md +28 -17
  32. data/man/ronin-db-hosts.1 +32 -14
  33. data/man/ronin-db-hosts.1.md +25 -14
  34. data/man/ronin-db-ips.1 +35 -17
  35. data/man/ronin-db-ips.1.md +28 -17
  36. data/man/ronin-db-irb.1 +28 -12
  37. data/man/ronin-db-irb.1.md +19 -10
  38. data/man/ronin-db-list.1 +19 -12
  39. data/man/ronin-db-list.1.md +15 -10
  40. data/man/ronin-db-migrate.1 +34 -1
  41. data/man/ronin-db-migrate.1.md +24 -1
  42. data/man/ronin-db-remove.1 +19 -12
  43. data/man/ronin-db-remove.1.md +15 -10
  44. data/man/ronin-db-urls.1 +35 -17
  45. data/man/ronin-db-urls.1.md +28 -17
  46. data/ronin-db.gemspec +4 -3
  47. metadata +12 -11
data/man/ronin-db-creds.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-creds 1 "April 2012" Ronin "User Manuals"
3
+ .TH ronin-db-creds 1 "2023-01-02" Ronin "User Manuals"
4
4
  .LP
5
5
  .SH SYNOPSIS
6
6
  .LP
@@ -20,8 +20,16 @@ The database to connect to\. Defaults to \fBdefault\fR if not given\.
20
20
  .LP
21
21
  .TP
22
22
  \fB--db-uri\fR \fIURI\fP
23
- The explicit database URI to connect to
24
- (ex: \fBmysql://user:password@host/ronin\fR)\.
23
+ The explicit database URI to connect to\.
24
+ .LP
25
+ .RS
26
+ .IP \(bu 2
27
+ \fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
28
+ .IP \(bu 2
29
+ \fBmysql\fP: \fBmysql://user:password@host/database\fR
30
+ .IP \(bu 2
31
+ \fBpostgres\fP: \fBpostgres://user:password@host/database\fR
32
+ .RE
25
33
  .LP
26
34
  .TP
27
35
  \fB-v\fR, \fB--verbose\fR
@@ -37,37 +45,47 @@ Imports the credentials from the given \fIFILE\fP\.
37
45
  .LP
38
46
  .TP
39
47
  \fB--delete\fR \fIVALUE\fP
40
- Deletes a value from the database\.
48
+ Deletes a credential value from the database\.
41
49
  .LP
42
50
  .TP
43
51
  \fB--delete-all\fR
44
- Deletes every value from the database\.
52
+ Deletes every credential from the database\.
45
53
  .LP
46
54
  .TP
47
55
  \fB-u\fR, \fB--for-user\fR \fIUSER\fP
48
- Searches for Credentials associated with the USER\.
56
+ Searches for credentials associated with the \fIUSER\fP\.
49
57
  .LP
50
58
  .TP
51
59
  \fB-p\fR, \fB--with-password\fR \fIPASSWORD\fP
52
- Searches for Credentials that have the PASSWORD\.
60
+ Searches for credentials that have the \fIPASSWORD\fP\.
53
61
  .LP
54
- .SH FILES
62
+ .TP
63
+ \fB-h\fR, \fB--help\fR
64
+ Print help information\.
65
+ .LP
66
+ .SH ENVIRONMENT
55
67
  .LP
56
68
  .TP
57
- \fI\[ti]\[sl]\.ronin\[sl]\fP
58
- Ronin configuration directory\.
69
+ \fIHOME\fP
70
+ Alternate location for the user\[cq]s home directory\.
59
71
  .LP
60
72
  .TP
61
- \fI\[ti]\[sl]\.ronin\[sl]database\.log\fP
62
- Database log\.
73
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
74
+ Alternate location for the \fB~/.config\fR directory\.
75
+ .LP
76
+ .TP
77
+ \fIXDG\[ru]DATA\[ru]HOME\fP
78
+ Alternate location for the \fB~/.local/share\fR directory\.
79
+ .LP
80
+ .SH FILES
63
81
  .LP
64
82
  .TP
65
- \fI\[ti]\[sl]\.ronin\[sl]database\.sqlite3\fP
66
- The default sqlite3 Database file\.
83
+ \fB~/.local/share/ronin-db/database.sqlite3\fR
84
+ The default sqlite3 database file\.
67
85
  .LP
68
86
  .TP
69
- \fI\[ti]\[sl]\.ronin\[sl]database\.yml\fP
70
- Optional Database configuration\.
87
+ \fB~/.config/ronin-db/database.yml\fR
88
+ Optional database configuration\.
71
89
  .LP
72
90
  .SH AUTHOR
73
91
  .LP
data/man/ronin-db-creds.1.md CHANGED
@@ -1,4 +1,4 @@
1
- # ronin-db-creds 1 "April 2012" Ronin "User Manuals"
1
+ # ronin-db-creds 1 "2023-01-02" Ronin "User Manuals"
2
2
 
3
3
  ## SYNOPSIS
4
4
 
@@ -14,8 +14,11 @@ Manages credentials.
14
14
  The database to connect to. Defaults to `default` if not given.
15
15
 
16
16
  `--db-uri` *URI*
17
- The explicit database URI to connect to
18
- (ex: `mysql://user:password@host/ronin`).
17
+ The explicit database URI to connect to.
18
+
19
+ * **sqlite3**: `sqlite3:relative/path.db` or `sqlite3:///absolute/path.db`
20
+ * **mysql**: `mysql://user:password@host/database`
21
+ * **postgres**: `postgres://user:password@host/database`
19
22
 
20
23
  `-v`, `--verbose`
21
24
  Enable verbose output.
@@ -27,30 +30,38 @@ Manages credentials.
27
30
  Imports the credentials from the given *FILE*.
28
31
 
29
32
  `--delete` *VALUE*
30
- Deletes a value from the database.
33
+ Deletes a credential value from the database.
31
34
 
32
35
  `--delete-all`
33
- Deletes every value from the database.
36
+ Deletes every credential from the database.
34
37
 
35
38
  `-u`, `--for-user` *USER*
36
- Searches for Credentials associated with the USER.
39
+ Searches for credentials associated with the *USER*.
37
40
 
38
41
  `-p`, `--with-password` *PASSWORD*
39
- Searches for Credentials that have the PASSWORD.
42
+ Searches for credentials that have the *PASSWORD*.
40
43
 
41
- ## FILES
44
+ `-h`, `--help`
45
+ Print help information.
46
+
47
+ ## ENVIRONMENT
42
48
 
43
- *~/.ronin/*
44
- Ronin configuration directory.
49
+ *HOME*
50
+ Alternate location for the user's home directory.
45
51
 
46
- *~/.ronin/database.log*
47
- Database log.
52
+ *XDG_CONFIG_HOME*
53
+ Alternate location for the `~/.config` directory.
54
+
55
+ *XDG_DATA_HOME*
56
+ Alternate location for the `~/.local/share` directory.
57
+
58
+ ## FILES
48
59
 
49
- *~/.ronin/database.sqlite3*
50
- The default sqlite3 Database file.
60
+ `~/.local/share/ronin-db/database.sqlite3`
61
+ The default sqlite3 database file.
51
62
 
52
- *~/.ronin/database.yml*
53
- Optional Database configuration.
63
+ `~/.config/ronin-db/database.yml`
64
+ Optional database configuration.
54
65
 
55
66
  ## AUTHOR
56
67
 
data/man/ronin-db-edit.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-edit 1 "2022-01-01" Ronin DB "User Manuals"
3
+ .TH ronin-db-edit 1 "2023-02-01" Ronin DB "User Manuals"
4
4
  .LP
5
5
  .SH SYNOPSIS
6
6
  .LP
@@ -18,22 +18,29 @@ Manually edits the \fB~/.config/ronin-db/database.yml\fR configuration file\.
18
18
  \fB-h\fR, \fB--help\fR
19
19
  Print help information\.
20
20
  .LP
21
- .SH FILES
21
+ .SH ENVIRONMENT
22
22
  .LP
23
23
  .TP
24
- \fI\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fP
25
- The \fBronin-db\fR database(s) configuration file\.
24
+ \fIHOME\fP
25
+ Alternate location for the user\[cq]s home directory\.
26
26
  .LP
27
- .SH ENVIRONMENT
27
+ .TP
28
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
29
+ Alternate location for the \fB~/.config\fR directory\.
28
30
  .LP
29
- .PP
30
- HOME
31
- Specifies the home directory of the user\. Ronin will search for the
32
- \fI\[ti]\[sl]\.config\[sl]ronin\-db\fP cache directory within the home directory\.
31
+ .TP
32
+ \fIXDG\[ru]DATA\[ru]HOME\fP
33
+ Alternate location for the \fB~/.local/share\fR directory\.
33
34
  .LP
34
- .PP
35
- XDG\[ru]CONFIG\[ru]HOME
36
- Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.config\fP\.
35
+ .SH FILES
36
+ .LP
37
+ .TP
38
+ \fB~/.local/share/ronin-db/database.sqlite3\fR
39
+ The default sqlite3 database file\.
40
+ .LP
41
+ .TP
42
+ \fB~/.config/ronin-db/database.yml\fR
43
+ Optional database configuration\.
37
44
  .LP
38
45
  .SH AUTHOR
39
46
  .LP
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
@@ -20,28 +20,36 @@ The database to connect to\. Defaults to \fBdefault\fR if not given\.
20
20
  .LP
21
21
  .TP
22
22
  \fB--db-uri\fR \fIURI\fP
23
- The explicit database URI to connect to
24
- (ex: \fBmysql://user:password@host/ronin\fR)\.
23
+ The explicit database URI to connect to\.
24
+ .LP
25
+ .RS
26
+ .IP \(bu 2
27
+ \fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
28
+ .IP \(bu 2
29
+ \fBmysql\fP: \fBmysql://user:password@host/database\fR
30
+ .IP \(bu 2
31
+ \fBpostgres\fP: \fBpostgres://user:password@host/database\fR
32
+ .RE
25
33
  .LP
26
34
  .TP
27
35
  \fB-v\fR, \fB--verbose\fR
28
36
  Enable verbose output\.
29
37
  .LP
30
38
  .TP
31
- \fB--add\fR \fIUSER\fP:\fIPASSWORD\fP
32
- Adds the \fIUSER\fP and \fIPASSWORD\fP to the database\.
39
+ \fB--add\fR \fIVALUE\fP
40
+ Adds the email address to the database\.
33
41
  .LP
34
42
  .TP
35
43
  \fB--import\fR \fIFILE\fP
36
- Imports the credentials from the given \fIFILE\fP\.
44
+ Imports the email addresses from the given \fIFILE\fP\.
37
45
  .LP
38
46
  .TP
39
47
  \fB--delete\fR \fIVALUE\fP
40
- Deletes a value from the database\.
48
+ Deletes the email address from the database\.
41
49
  .LP
42
50
  .TP
43
51
  \fB--delete-all\fR
44
- Deletes every value from the database\.
52
+ Deletes every email address from the database\.
45
53
  .LP
46
54
  .TP
47
55
  \fB-H\fR, \fB--with-host\fR \fIHOST\fP
@@ -55,23 +63,33 @@ Searches for email addresses associated with the IP address\.
55
63
  \fB-u\fR, \fB--with-users\fR \fINAME\fP \[lB]\.\.\.\[rB]
56
64
  Searches for email addresses associated with the user NAME(s)\.
57
65
  .LP
58
- .SH FILES
66
+ .TP
67
+ \fB-h\fR, \fB--help\fR
68
+ Print help information\.
69
+ .LP
70
+ .SH ENVIRONMENT
59
71
  .LP
60
72
  .TP
61
- \fI\[ti]\[sl]\.ronin\[sl]\fP
62
- Ronin configuration directory\.
73
+ \fIHOME\fP
74
+ Alternate location for the user\[cq]s home directory\.
63
75
  .LP
64
76
  .TP
65
- \fI\[ti]\[sl]\.ronin\[sl]database\.log\fP
66
- Database log\.
77
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
78
+ Alternate location for the \fB~/.config\fR directory\.
79
+ .LP
80
+ .TP
81
+ \fIXDG\[ru]DATA\[ru]HOME\fP
82
+ Alternate location for the \fB~/.local/share\fR directory\.
83
+ .LP
84
+ .SH FILES
67
85
  .LP
68
86
  .TP
69
- \fI\[ti]\[sl]\.ronin\[sl]database\.sqlite3\fP
70
- The default sqlite3 Database file\.
87
+ \fB~/.local/share/ronin-db/database.sqlite3\fR
88
+ The default sqlite3 database file\.
71
89
  .LP
72
90
  .TP
73
- \fI\[ti]\[sl]\.ronin\[sl]database\.yml\fP
74
- Optional Database configuration\.
91
+ \fB~/.config/ronin-db/database.yml\fR
92
+ Optional database configuration\.
75
93
  .LP
76
94
  .SH AUTHOR
77
95
  .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
 
@@ -14,23 +14,26 @@ Manages email addresses.
14
14
  The database to connect to. Defaults to `default` if not given.
15
15
 
16
16
  `--db-uri` *URI*
17
- The explicit database URI to connect to
18
- (ex: `mysql://user:password@host/ronin`).
17
+ The explicit database URI to connect to.
18
+
19
+ * **sqlite3**: `sqlite3:relative/path.db` or `sqlite3:///absolute/path.db`
20
+ * **mysql**: `mysql://user:password@host/database`
21
+ * **postgres**: `postgres://user:password@host/database`
19
22
 
20
23
  `-v`, `--verbose`
21
24
  Enable verbose output.
22
25
 
23
- `--add` *USER*:*PASSWORD*
24
- Adds the *USER* and *PASSWORD* to the database.
26
+ `--add` *VALUE*
27
+ Adds the email address to the database.
25
28
 
26
29
  `--import` *FILE*
27
- Imports the credentials from the given *FILE*.
30
+ Imports the email addresses from the given *FILE*.
28
31
 
29
32
  `--delete` *VALUE*
30
- Deletes a value from the database.
33
+ Deletes the email address from the database.
31
34
 
32
35
  `--delete-all`
33
- Deletes every value from the database.
36
+ Deletes every email address from the database.
34
37
 
35
38
  `-H`, `--with-host` *HOST*
36
39
  Searches for email addresses associated with the *HOST*.
@@ -41,19 +44,27 @@ Manages email addresses.
41
44
  `-u`, `--with-users` *NAME* [...]
42
45
  Searches for email addresses associated with the user NAME(s).
43
46
 
44
- ## FILES
47
+ `-h`, `--help`
48
+ Print help information.
49
+
50
+ ## ENVIRONMENT
45
51
 
46
- *~/.ronin/*
47
- Ronin configuration directory.
52
+ *HOME*
53
+ Alternate location for the user's home directory.
48
54
 
49
- *~/.ronin/database.log*
50
- Database log.
55
+ *XDG_CONFIG_HOME*
56
+ Alternate location for the `~/.config` directory.
57
+
58
+ *XDG_DATA_HOME*
59
+ Alternate location for the `~/.local/share` directory.
60
+
61
+ ## FILES
51
62
 
52
- *~/.ronin/database.sqlite3*
53
- The default sqlite3 Database file.
63
+ `~/.local/share/ronin-db/database.sqlite3`
64
+ The default sqlite3 database file.
54
65
 
55
- *~/.ronin/database.yml*
56
- Optional Database configuration.
66
+ `~/.config/ronin-db/database.yml`
67
+ Optional database configuration.
57
68
 
58
69
  ## AUTHOR
59
70
 
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
@@ -20,16 +20,24 @@ The database to connect to\. Defaults to \fBdefault\fR if not given\.
20
20
  .LP
21
21
  .TP
22
22
  \fB--db-uri\fR \fIURI\fP
23
- The explicit database URI to connect to
24
- (ex: \fBmysql://user:password@host/ronin\fR)\.
23
+ The explicit database URI to connect to\.
24
+ .LP
25
+ .RS
26
+ .IP \(bu 2
27
+ \fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
28
+ .IP \(bu 2
29
+ \fBmysql\fP: \fBmysql://user:password@host/database\fR
30
+ .IP \(bu 2
31
+ \fBpostgres\fP: \fBpostgres://user:password@host/database\fR
32
+ .RE
25
33
  .LP
26
34
  .TP
27
35
  \fB-v\fR, \fB--verbose\fR
28
36
  Enable verbose output\.
29
37
  .LP
30
38
  .TP
31
- \fB--add\fR \fIUSER\fP:\fIPASSWORD\fP
32
- Adds the \fIUSER\fP and \fIPASSWORD\fP to the database\.
39
+ \fB--add\fR \fIVALUE\fP
40
+ Adds the hostname to the database\.
33
41
  .LP
34
42
  .TP
35
43
  \fB--import\fR \fIFILE\fP
@@ -59,23 +67,33 @@ Searches for HostNames belonging to the DOMAIN (\fBco.uk\fR)\.
59
67
  \fB-T\fR, \fB--tld\fR \fITLD\fP
60
68
  Searches for HostNames with the Top\-Level\-Domain (TLD) (\fBru\fR)\.
61
69
  .LP
62
- .SH FILES
70
+ .TP
71
+ \fB-h\fR, \fB--help\fR
72
+ Print help information\.
73
+ .LP
74
+ .SH ENVIRONMENT
63
75
  .LP
64
76
  .TP
65
- \fI\[ti]\[sl]\.ronin\[sl]\fP
66
- Ronin configuration directory\.
77
+ \fIHOME\fP
78
+ Alternate location for the user\[cq]s home directory\.
67
79
  .LP
68
80
  .TP
69
- \fI\[ti]\[sl]\.ronin\[sl]database\.log\fP
70
- Database log\.
81
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
82
+ Alternate location for the \fB~/.config\fR directory\.
83
+ .LP
84
+ .TP
85
+ \fIXDG\[ru]DATA\[ru]HOME\fP
86
+ Alternate location for the \fB~/.local/share\fR directory\.
87
+ .LP
88
+ .SH FILES
71
89
  .LP
72
90
  .TP
73
- \fI\[ti]\[sl]\.ronin\[sl]database\.sqlite3\fP
74
- The default sqlite3 Database file\.
91
+ \fB~/.local/share/ronin-db/database.sqlite3\fR
92
+ The default sqlite3 database file\.
75
93
  .LP
76
94
  .TP
77
- \fI\[ti]\[sl]\.ronin\[sl]database\.yml\fP
78
- Optional Database configuration\.
95
+ \fB~/.config/ronin-db/database.yml\fR
96
+ Optional database configuration\.
79
97
  .LP
80
98
  .SH AUTHOR
81
99
  .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
 
@@ -14,14 +14,17 @@ Manages host names.
14
14
  The database to connect to. Defaults to `default` if not given.
15
15
 
16
16
  `--db-uri` *URI*
17
- The explicit database URI to connect to
18
- (ex: `mysql://user:password@host/ronin`).
17
+ The explicit database URI to connect to.
18
+
19
+ * **sqlite3**: `sqlite3:relative/path.db` or `sqlite3:///absolute/path.db`
20
+ * **mysql**: `mysql://user:password@host/database`
21
+ * **postgres**: `postgres://user:password@host/database`
19
22
 
20
23
  `-v`, `--verbose`
21
24
  Enable verbose output.
22
25
 
23
- `--add` *USER*:*PASSWORD*
24
- Adds the *USER* and *PASSWORD* to the database.
26
+ `--add` *VALUE*
27
+ Adds the hostname to the database.
25
28
 
26
29
  `--import` *FILE*
27
30
  Imports the credentials from the given *FILE*.
@@ -44,19 +47,27 @@ Manages host names.
44
47
  `-T`, `--tld` *TLD*
45
48
  Searches for HostNames with the Top-Level-Domain (TLD) (`ru`).
46
49
 
47
- ## FILES
50
+ `-h`, `--help`
51
+ Print help information.
52
+
53
+ ## ENVIRONMENT
48
54
 
49
- *~/.ronin/*
50
- Ronin configuration directory.
55
+ *HOME*
56
+ Alternate location for the user's home directory.
51
57
 
52
- *~/.ronin/database.log*
53
- Database log.
58
+ *XDG_CONFIG_HOME*
59
+ Alternate location for the `~/.config` directory.
60
+
61
+ *XDG_DATA_HOME*
62
+ Alternate location for the `~/.local/share` directory.
63
+
64
+ ## FILES
54
65
 
55
- *~/.ronin/database.sqlite3*
56
- The default sqlite3 Database file.
66
+ `~/.local/share/ronin-db/database.sqlite3`
67
+ The default sqlite3 database file.
57
68
 
58
- *~/.ronin/database.yml*
59
- Optional Database configuration.
69
+ `~/.config/ronin-db/database.yml`
70
+ Optional database configuration.
60
71
 
61
72
  ## AUTHOR
62
73
 
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
@@ -20,28 +20,36 @@ The database to connect to\. Defaults to \fBdefault\fR if not given\.
20
20
  .LP
21
21
  .TP
22
22
  \fB--db-uri\fR \fIURI\fP
23
- The explicit database URI to connect to
24
- (ex: \fBmysql://user:password@host/ronin\fR)\.
23
+ The explicit database URI to connect to\.
24
+ .LP
25
+ .RS
26
+ .IP \(bu 2
27
+ \fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
28
+ .IP \(bu 2
29
+ \fBmysql\fP: \fBmysql://user:password@host/database\fR
30
+ .IP \(bu 2
31
+ \fBpostgres\fP: \fBpostgres://user:password@host/database\fR
32
+ .RE
25
33
  .LP
26
34
  .TP
27
35
  \fB-v\fR, \fB--verbose\fR
28
36
  Enable verbose output\.
29
37
  .LP
30
38
  .TP
31
- \fB--add\fR \fIUSER\fP:\fIPASSWORD\fP
32
- Adds the \fIUSER\fP and \fIPASSWORD\fP to the database\.
39
+ \fB--add\fR \fIVALUE\fP
40
+ Adds the IP address to the database\.
33
41
  .LP
34
42
  .TP
35
43
  \fB--import\fR \fIFILE\fP
36
- Imports the credentials from the given \fIFILE\fP\.
44
+ Imports the IP addresses from the given \fIFILE\fP\.
37
45
  .LP
38
46
  .TP
39
47
  \fB--delete\fR \fIVALUE\fP
40
- Deletes a value from the database\.
48
+ Deletes a IP address from the database\.
41
49
  .LP
42
50
  .TP
43
51
  \fB--delete-all\fR
44
- Deletes every value from the database\.
52
+ Deletes every IP address from the database\.
45
53
  .LP
46
54
  .TP
47
55
  \fB-4\fR, \fB--v4\fR
@@ -63,23 +71,33 @@ Searches for IP addresses associated with the MAC address\.
63
71
  \fB-I\fR, \fB--with-host\fR \fIHOST\fP
64
72
  Searches for IP addresses associated with the \fIHOST\fP\.
65
73
  .LP
66
- .SH FILES
74
+ .TP
75
+ \fB-h\fR, \fB--help\fR
76
+ Print help information\.
77
+ .LP
78
+ .SH ENVIRONMENT
67
79
  .LP
68
80
  .TP
69
- \fI\[ti]\[sl]\.ronin\[sl]\fP
70
- Ronin configuration directory\.
81
+ \fIHOME\fP
82
+ Alternate location for the user\[cq]s home directory\.
71
83
  .LP
72
84
  .TP
73
- \fI\[ti]\[sl]\.ronin\[sl]database\.log\fP
74
- Database log\.
85
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
86
+ Alternate location for the \fB~/.config\fR directory\.
87
+ .LP
88
+ .TP
89
+ \fIXDG\[ru]DATA\[ru]HOME\fP
90
+ Alternate location for the \fB~/.local/share\fR directory\.
91
+ .LP
92
+ .SH FILES
75
93
  .LP
76
94
  .TP
77
- \fI\[ti]\[sl]\.ronin\[sl]database\.sqlite3\fP
78
- The default sqlite3 Database file\.
95
+ \fB~/.local/share/ronin-db/database.sqlite3\fR
96
+ The default sqlite3 database file\.
79
97
  .LP
80
98
  .TP
81
- \fI\[ti]\[sl]\.ronin\[sl]database\.yml\fP
82
- Optional Database configuration\.
99
+ \fB~/.config/ronin-db/database.yml\fR
100
+ Optional database configuration\.
83
101
  .LP
84
102
  .SH AUTHOR
85
103
  .LP