ronin-db 0.1.3-java → 0.2.0-java

Sign up to get free protection for your applications and to get access to all the features.
Files changed (105) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ruby.yml +1 -0
  3. data/.gitignore +1 -0
  4. data/.ruby-version +1 -1
  5. data/ChangeLog.md +30 -0
  6. data/Gemfile +6 -4
  7. data/README.md +17 -5
  8. data/Rakefile +13 -35
  9. data/data/completions/ronin-db +271 -0
  10. data/gemspec.yml +17 -2
  11. data/lib/ronin/db/cli/command.rb +1 -1
  12. data/lib/ronin/db/cli/commands/add.rb +1 -1
  13. data/lib/ronin/db/cli/commands/asn.rb +12 -2
  14. data/lib/ronin/db/cli/commands/certs.rb +322 -0
  15. data/lib/ronin/db/cli/commands/completion.rb +63 -0
  16. data/lib/ronin/db/cli/commands/creds.rb +2 -1
  17. data/lib/ronin/db/cli/commands/edit.rb +1 -1
  18. data/lib/ronin/db/cli/commands/emails.rb +22 -1
  19. data/lib/ronin/db/cli/commands/hosts.rb +2 -1
  20. data/lib/ronin/db/cli/commands/ips.rb +2 -1
  21. data/lib/ronin/db/cli/commands/irb.rb +8 -4
  22. data/lib/ronin/db/cli/commands/list.rb +1 -1
  23. data/lib/ronin/db/cli/commands/migrate.rb +12 -8
  24. data/lib/ronin/db/cli/commands/open_ports.rb +102 -0
  25. data/lib/ronin/db/cli/commands/oses.rb +95 -0
  26. data/lib/ronin/db/cli/commands/passwords.rb +83 -0
  27. data/lib/ronin/db/cli/commands/people.rb +185 -0
  28. data/lib/ronin/db/cli/commands/phone_numbers.rb +136 -0
  29. data/lib/ronin/db/cli/commands/ports.rb +103 -0
  30. data/lib/ronin/db/cli/commands/remove.rb +1 -1
  31. data/lib/ronin/db/cli/commands/services.rb +102 -0
  32. data/lib/ronin/db/cli/commands/software.rb +95 -0
  33. data/lib/ronin/db/cli/commands/street_addresses.rb +129 -0
  34. data/lib/ronin/db/cli/commands/urls.rb +2 -1
  35. data/lib/ronin/db/cli/commands/web_vulns.rb +235 -0
  36. data/lib/ronin/db/cli/database_options.rb +87 -0
  37. data/lib/ronin/db/cli/deletable.rb +85 -0
  38. data/lib/ronin/db/cli/importable.rb +108 -0
  39. data/lib/ronin/db/cli/model_command.rb +8 -6
  40. data/lib/ronin/db/cli/modifiable.rb +12 -104
  41. data/lib/ronin/db/cli/printing.rb +58 -0
  42. data/lib/ronin/db/cli/ruby_shell.rb +1 -1
  43. data/lib/ronin/db/cli/uri_methods.rb +1 -1
  44. data/lib/ronin/db/cli.rb +5 -1
  45. data/lib/ronin/db/config_file.rb +1 -1
  46. data/lib/ronin/db/exceptions.rb +1 -1
  47. data/lib/ronin/db/home.rb +1 -1
  48. data/lib/ronin/db/root.rb +1 -1
  49. data/lib/ronin/db/tasks.rb +87 -0
  50. data/lib/ronin/db/version.rb +2 -2
  51. data/lib/ronin/db.rb +15 -7
  52. data/man/ronin-db-add.1 +47 -69
  53. data/man/ronin-db-add.1.md +26 -22
  54. data/man/ronin-db-asn.1 +36 -54
  55. data/man/ronin-db-asn.1.md +29 -19
  56. data/man/ronin-db-certs.1 +108 -0
  57. data/man/ronin-db-certs.1.md +106 -0
  58. data/man/ronin-db-completion.1 +76 -0
  59. data/man/ronin-db-completion.1.md +78 -0
  60. data/man/ronin-db-creds.1 +28 -46
  61. data/man/ronin-db-creds.1.md +23 -16
  62. data/man/ronin-db-edit.1 +15 -26
  63. data/man/ronin-db-edit.1.md +11 -7
  64. data/man/ronin-db-emails.1 +36 -49
  65. data/man/ronin-db-emails.1.md +30 -17
  66. data/man/ronin-db-hosts.1 +31 -51
  67. data/man/ronin-db-hosts.1.md +25 -18
  68. data/man/ronin-db-ips.1 +31 -52
  69. data/man/ronin-db-ips.1.md +26 -19
  70. data/man/ronin-db-irb.1 +22 -35
  71. data/man/ronin-db-irb.1.md +17 -10
  72. data/man/ronin-db-list.1 +16 -30
  73. data/man/ronin-db-list.1.md +13 -9
  74. data/man/ronin-db-migrate.1 +22 -35
  75. data/man/ronin-db-migrate.1.md +17 -10
  76. data/man/ronin-db-open-ports.1 +72 -0
  77. data/man/ronin-db-open-ports.1.md +70 -0
  78. data/man/ronin-db-oses.1 +72 -0
  79. data/man/ronin-db-oses.1.md +70 -0
  80. data/man/ronin-db-passwords.1 +75 -0
  81. data/man/ronin-db-passwords.1.md +73 -0
  82. data/man/ronin-db-people.1 +96 -0
  83. data/man/ronin-db-people.1.md +94 -0
  84. data/man/ronin-db-phone-numbers.1 +93 -0
  85. data/man/ronin-db-phone-numbers.1.md +91 -0
  86. data/man/ronin-db-ports.1 +87 -0
  87. data/man/ronin-db-ports.1.md +85 -0
  88. data/man/ronin-db-remove.1 +15 -28
  89. data/man/ronin-db-remove.1.md +12 -8
  90. data/man/ronin-db-services.1 +84 -0
  91. data/man/ronin-db-services.1.md +82 -0
  92. data/man/ronin-db-software.1 +72 -0
  93. data/man/ronin-db-software.1.md +70 -0
  94. data/man/ronin-db-street-addresses.1 +81 -0
  95. data/man/ronin-db-street-addresses.1.md +79 -0
  96. data/man/ronin-db-urls.1 +37 -60
  97. data/man/ronin-db-urls.1.md +28 -21
  98. data/man/ronin-db-web-vulns.1 +87 -0
  99. data/man/ronin-db-web-vulns.1.md +85 -0
  100. data/man/ronin-db.1 +118 -0
  101. data/man/ronin-db.1.md +99 -0
  102. data/scripts/setup +58 -0
  103. metadata +70 -13
  104. data/lib/ronin/db/cli/database_command.rb +0 -71
  105. data/lib/ronin/db/cli/resources_command.rb +0 -118
@@ -1,5 +1,9 @@
1
1
  # ronin-db-remove 1 "2023-02-01" Ronin DB "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-db-remove - Removes a database from the configuration file
6
+
3
7
  ## SYNOPSIS
4
8
 
5
9
  `ronin-db remove` [*options*] *NAME*
@@ -12,31 +16,31 @@ configuration file.
12
16
  ## ARGUMENTS
13
17
 
14
18
  *NAME*
15
- The database entry to remove.
19
+ : The database entry to remove.
16
20
 
17
21
  ## OPTIONS
18
22
 
19
23
  `-h`, `--help`
20
- Print help information.
24
+ : Print help information.
21
25
 
22
26
  ## ENVIRONMENT
23
27
 
24
28
  *HOME*
25
- Alternate location for the user's home directory.
29
+ : Alternate location for the user's home directory.
26
30
 
27
31
  *XDG_CONFIG_HOME*
28
- Alternate location for the `~/.config` directory.
32
+ : Alternate location for the `~/.config` directory.
29
33
 
30
34
  *XDG_DATA_HOME*
31
- Alternate location for the `~/.local/share` directory.
35
+ : Alternate location for the `~/.local/share` directory.
32
36
 
33
37
  ## FILES
34
38
 
35
39
  `~/.local/share/ronin-db/database.sqlite3`
36
- The default sqlite3 database file.
40
+ : The default sqlite3 database file.
37
41
 
38
42
  `~/.config/ronin-db/database.yml`
39
- Optional database configuration.
43
+ : Optional database configuration.
40
44
 
41
45
  ## AUTHOR
42
46
 
@@ -44,4 +48,4 @@ Postmodern <postmodern.mod3@gmail.com>
44
48
 
45
49
  ## SEE ALSO
46
50
 
47
- ronin-db(1) ronin-db-add(1) ronin-db-list(1) ronin-db-edit(1)
51
+ [ronin-db](ronin-db.1.md) [ronin-db-add](ronin-db-add.1.md) [ronin-db-list](ronin-db-list.1.md) [ronin-db-edit](ronin-db-edit.1.md)
@@ -0,0 +1,84 @@
1
+ .\" Generated by kramdown-man 1.0.1
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-db-services 1 "2023-02-01" Ronin DB "User Manuals"
4
+ .SH NAME
5
+ .PP
6
+ ronin\-db\-services \- Manages services in the database
7
+ .SH SYNOPSIS
8
+ .PP
9
+ \fBronin\-db services\fR \[lB]\fIoptions\fP\[rB]
10
+ .SH DESCRIPTION
11
+ .PP
12
+ Manages Services\.
13
+ .SH OPTIONS
14
+ .TP
15
+ \fB\-\-db\fR \fINAME\fP
16
+ The database to connect to\. Defaults to \fBdefault\fR if not given\.
17
+ .TP
18
+ \fB\-\-db\-uri\fR \fIURI\fP
19
+ The explicit database URI to connect to\.
20
+ .RS
21
+ .RS
22
+ .IP \(bu 2
23
+ \fBsqlite3\fP: \fBsqlite3:relative\[sl]path\.db\fR or \fBsqlite3:\[sl]\[sl]\[sl]absolute\[sl]path\.db\fR
24
+ .IP \(bu 2
25
+ \fBmysql\fP: \fBmysql:\[sl]\[sl]user:password\[at]host\[sl]database\fR
26
+ .IP \(bu 2
27
+ \fBpostgres\fP: \fBpostgres:\[sl]\[sl]user:password\[at]host\[sl]database\fR
28
+ .RE
29
+ .RE
30
+ .TP
31
+ \fB\-\-db\-file\fR \fIPATH\fP
32
+ The sqlite3 database file to use\.
33
+ .TP
34
+ \fB\-v\fR, \fB\-\-verbose\fR
35
+ Enable verbose output\.
36
+ .TP
37
+ \fB\-\-add\fR \fIVALUE\fP
38
+ Adds the URL to the database\.
39
+ .TP
40
+ \fB\-\-import\fR \fIFILE\fP
41
+ Imports the URLs from the given \fIFILE\fP\.
42
+ .TP
43
+ \fB\-\-delete\fR \fIVALUE\fP
44
+ Deletes the URL from the database\.
45
+ .TP
46
+ \fB\-\-delete\-all\fR
47
+ Deletes every URL from the database\.
48
+ .TP
49
+ \fB\-\-named\fR \fINAME\fP
50
+ Searches for all Services that contain \fINAME\fP in it\[cq]s name\.
51
+ .TP
52
+ \fB\-p\fR, \fB\-\-with\-port\fR \fIPORT\fP
53
+ Searches for all Services that are associated with the port number\.
54
+ .TP
55
+ \fB\-P\fR, \fB\-\-with\-protocol\fR \[lB]\fBtcp\fR\[or]\fBudp\fR\[rB]
56
+ Searches for all Services that are associated with the protocol\.
57
+ .TP
58
+ \fB\-I\fR, \fB\-\-with\-ip\fR \fIIP\fP
59
+ Searches for all Services associated with the IP address\.
60
+ .TP
61
+ \fB\-h\fR, \fB\-\-help\fR
62
+ Print help information\.
63
+ .SH ENVIRONMENT
64
+ .TP
65
+ \fIHOME\fP
66
+ Alternate location for the user\[cq]s home directory\.
67
+ .TP
68
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
69
+ Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
70
+ .TP
71
+ \fIXDG\[ru]DATA\[ru]HOME\fP
72
+ Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
73
+ .SH FILES
74
+ .TP
75
+ \fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
76
+ The default sqlite3 database file\.
77
+ .TP
78
+ \fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
79
+ Optional database configuration\.
80
+ .SH AUTHOR
81
+ .PP
82
+ Postmodern
83
+ .MT postmodern\.mod3\[at]gmail\.com
84
+ .ME
@@ -0,0 +1,82 @@
1
+ # ronin-db-services 1 "2023-02-01" Ronin DB "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-db-services - Manages services in the database
6
+
7
+ ## SYNOPSIS
8
+
9
+ `ronin-db services` [*options*]
10
+
11
+ ## DESCRIPTION
12
+
13
+ Manages Services.
14
+
15
+ ## OPTIONS
16
+
17
+ `--db` *NAME*
18
+ : The database to connect to. Defaults to `default` if not given.
19
+
20
+ `--db-uri` *URI*
21
+ : The explicit database URI to connect to.
22
+
23
+ * **sqlite3**: `sqlite3:relative/path.db` or `sqlite3:///absolute/path.db`
24
+ * **mysql**: `mysql://user:password@host/database`
25
+ * **postgres**: `postgres://user:password@host/database`
26
+
27
+ `--db-file` *PATH*
28
+ : The sqlite3 database file to use.
29
+
30
+ `-v`, `--verbose`
31
+ : Enable verbose output.
32
+
33
+ `--add` *VALUE*
34
+ : Adds the URL to the database.
35
+
36
+ `--import` *FILE*
37
+ : Imports the URLs from the given *FILE*.
38
+
39
+ `--delete` *VALUE*
40
+ : Deletes the URL from the database.
41
+
42
+ `--delete-all`
43
+ : Deletes every URL from the database.
44
+
45
+ `--named` *NAME*
46
+ : Searches for all Services that contain *NAME* in it's name.
47
+
48
+ `-p`, `--with-port` *PORT*
49
+ : Searches for all Services that are associated with the port number.
50
+
51
+ `-P`, `--with-protocol` [`tcp`\|`udp`]
52
+ : Searches for all Services that are associated with the protocol.
53
+
54
+ `-I`, `--with-ip` *IP*
55
+ : Searches for all Services associated with the IP address.
56
+
57
+ `-h`, `--help`
58
+ : Print help information.
59
+
60
+ ## ENVIRONMENT
61
+
62
+ *HOME*
63
+ : Alternate location for the user's home directory.
64
+
65
+ *XDG_CONFIG_HOME*
66
+ : Alternate location for the `~/.config` directory.
67
+
68
+ *XDG_DATA_HOME*
69
+ : Alternate location for the `~/.local/share` directory.
70
+
71
+ ## FILES
72
+
73
+ `~/.local/share/ronin-db/database.sqlite3`
74
+ : The default sqlite3 database file.
75
+
76
+ `~/.config/ronin-db/database.yml`
77
+ : Optional database configuration.
78
+
79
+ ## AUTHOR
80
+
81
+ Postmodern <postmodern.mod3@gmail.com>
82
+
@@ -0,0 +1,72 @@
1
+ .\" Generated by kramdown-man 1.0.1
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-db-software 1 "2023-02-01" Ronin DB "User Manuals"
4
+ .SH NAME
5
+ .PP
6
+ ronin\-db\-software \- Queries software in the database
7
+ .SH SYNOPSIS
8
+ .PP
9
+ \fBronin\-db software\fR \[lB]\fIoptions\fP\[rB]
10
+ .SH DESCRIPTION
11
+ .PP
12
+ Queries Software in the database\.
13
+ .SH OPTIONS
14
+ .TP
15
+ \fB\-\-db\fR \fINAME\fP
16
+ The database name to connect to\. Defaults to \fBdefault\fR if not given\.
17
+ .TP
18
+ \fB\-\-db\-uri\fR \fIURI\fP
19
+ The explicit database URI to connect to\.
20
+ .RS
21
+ .RS
22
+ .IP \(bu 2
23
+ \fBsqlite3\fP: \fBsqlite3:relative\[sl]path\.db\fR or \fBsqlite3:\[sl]\[sl]\[sl]absolute\[sl]path\.db\fR
24
+ .IP \(bu 2
25
+ \fBmysql\fP: \fBmysql:\[sl]\[sl]user:password\[at]host\[sl]database\fR
26
+ .IP \(bu 2
27
+ \fBpostgres\fP: \fBpostgres:\[sl]\[sl]user:password\[at]host\[sl]database\fR
28
+ .RE
29
+ .RE
30
+ .TP
31
+ \fB\-\-db\-file\fR \fIPATH\fP
32
+ The sqlite3 database file to use\.
33
+ .TP
34
+ \fB\-v\fR, \fB\-\-verbose\fR
35
+ Enables verbose output
36
+ .TP
37
+ \fB\-N\fR, \fB\-\-name\fR \fINAME\fP
38
+ Searches for all Software with the matching name\.
39
+ .TP
40
+ \fB\-\-named\fR \fINAME\fP
41
+ Searches for all Software containing the name\.
42
+ .TP
43
+ \fB\-V\fR, \fB\-\-version\fR \fIVERSION\fP
44
+ Searches for all Software with the matching version\.
45
+ .TP
46
+ \fB\-\-vendor\fR \fIVENDOR\fP
47
+ Searches for all Software with the matching vendor name\.
48
+ .TP
49
+ \fB\-h\fR, \fB\-\-help\fR
50
+ Print help information\.
51
+ .SH ENVIRONMENT
52
+ .TP
53
+ \fIHOME\fP
54
+ Alternate location for the user\[cq]s home directory\.
55
+ .TP
56
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
57
+ Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
58
+ .TP
59
+ \fIXDG\[ru]DATA\[ru]HOME\fP
60
+ Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
61
+ .SH FILES
62
+ .TP
63
+ \fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
64
+ The default sqlite3 database file\.
65
+ .TP
66
+ \fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
67
+ Optional database configuration\.
68
+ .SH AUTHOR
69
+ .PP
70
+ Postmodern
71
+ .MT postmodern\.mod3\[at]gmail\.com
72
+ .ME
@@ -0,0 +1,70 @@
1
+ # ronin-db-software 1 "2023-02-01" Ronin DB "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-db-software - Queries software in the database
6
+
7
+ ## SYNOPSIS
8
+
9
+ `ronin-db software` [*options*]
10
+
11
+ ## DESCRIPTION
12
+
13
+ Queries Software in the database.
14
+
15
+ ## OPTIONS
16
+
17
+ `--db` *NAME*
18
+ : The database name to connect to. Defaults to `default` if not given.
19
+
20
+ `--db-uri` *URI*
21
+ : The explicit database URI to connect to.
22
+
23
+ * **sqlite3**: `sqlite3:relative/path.db` or `sqlite3:///absolute/path.db`
24
+ * **mysql**: `mysql://user:password@host/database`
25
+ * **postgres**: `postgres://user:password@host/database`
26
+
27
+ `--db-file` *PATH*
28
+ : The sqlite3 database file to use.
29
+
30
+ `-v`, `--verbose`
31
+ : Enables verbose output
32
+
33
+ `-N`, `--name` *NAME*
34
+ : Searches for all Software with the matching name.
35
+
36
+ `--named` *NAME*
37
+ : Searches for all Software containing the name.
38
+
39
+ `-V`, `--version` *VERSION*
40
+ : Searches for all Software with the matching version.
41
+
42
+ `--vendor` *VENDOR*
43
+ : Searches for all Software with the matching vendor name.
44
+
45
+ `-h`, `--help`
46
+ : Print help information.
47
+
48
+ ## ENVIRONMENT
49
+
50
+ *HOME*
51
+ : Alternate location for the user's home directory.
52
+
53
+ *XDG_CONFIG_HOME*
54
+ : Alternate location for the `~/.config` directory.
55
+
56
+ *XDG_DATA_HOME*
57
+ : Alternate location for the `~/.local/share` directory.
58
+
59
+ ## FILES
60
+
61
+ `~/.local/share/ronin-db/database.sqlite3`
62
+ : The default sqlite3 database file.
63
+
64
+ `~/.config/ronin-db/database.yml`
65
+ : Optional database configuration.
66
+
67
+ ## AUTHOR
68
+
69
+ Postmodern <postmodern.mod3@gmail.com>
70
+
@@ -0,0 +1,81 @@
1
+ .\" Generated by kramdown-man 1.0.1
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-db-street-addresses 1 "2023-02-01" Ronin DB "User Manuals"
4
+ .SH NAME
5
+ .PP
6
+ ronin\-db\-street\-addresses \- Queries street addresses in the database
7
+ .SH SYNOPSIS
8
+ .PP
9
+ \fBronin\-db street\-addresses\fR \[lB]\fIoptions\fP\[rB]
10
+ .SH DESCRIPTION
11
+ .PP
12
+ Queries StreetAddresses\.
13
+ .SH OPTIONS
14
+ .TP
15
+ \fB\-\-db\fR \fINAME\fP
16
+ The database to connect to\. Defaults to \fBdefault\fR if not given\.
17
+ .TP
18
+ \fB\-\-db\-uri\fR \fIURI\fP
19
+ The explicit database URI to connect to\.
20
+ .RS
21
+ .RS
22
+ .IP \(bu 2
23
+ \fBsqlite3\fP: \fBsqlite3:relative\[sl]path\.db\fR or \fBsqlite3:\[sl]\[sl]\[sl]absolute\[sl]path\.db\fR
24
+ .IP \(bu 2
25
+ \fBmysql\fP: \fBmysql:\[sl]\[sl]user:password\[at]host\[sl]database\fR
26
+ .IP \(bu 2
27
+ \fBpostgres\fP: \fBpostgres:\[sl]\[sl]user:password\[at]host\[sl]database\fR
28
+ .RE
29
+ .RE
30
+ .TP
31
+ \fB\-\-db\-file\fR \fIPATH\fP
32
+ The sqlite3 database file to use\.
33
+ .TP
34
+ \fB\-v\fR, \fB\-\-verbose\fR
35
+ Enable verbose output\.
36
+ .TP
37
+ \fB\-P\fR, \fB\-\-for\-person\fR \fIFULL\[ru]NAME\fP
38
+ Searches for street addresses associated with the person\[cq]s full name\.
39
+ .TP
40
+ \fB\-O\fR, \fB\-\-for\-organization\fR \fINAME\fP
41
+ Searches for street addresses associated with the organization\[cq]s name\.
42
+ .TP
43
+ \fB\-a\fR, \fB\-\-with\-address\fR \fIADDRESS\fP
44
+ Searches for street addresses with the matching address\.
45
+ .TP
46
+ \fB\-c\fR, \fB\-\-with\-city\fR \fICITY\fP
47
+ Searches for street addresses with the matching city\.
48
+ .TP
49
+ \fB\-s\fR, \fB\-\-with\-state\fR \fISTATE\fP
50
+ Searches for street addresses with the matching state\.
51
+ .TP
52
+ \fB\-C\fR, \fB\-\-with\-country\fR \fICOUNTRY\fP
53
+ Searches for street addresses with the matching country\.
54
+ .TP
55
+ \fB\-z\fR, \fB\-\-with\-zipcode\fR \fIZIPCODE\fP
56
+ Searches for street addresses with the matching zipcode\.
57
+ .TP
58
+ \fB\-h\fR, \fB\-\-help\fR
59
+ Print help information\.
60
+ .SH ENVIRONMENT
61
+ .TP
62
+ \fIHOME\fP
63
+ Alternate location for the user\[cq]s home directory\.
64
+ .TP
65
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
66
+ Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
67
+ .TP
68
+ \fIXDG\[ru]DATA\[ru]HOME\fP
69
+ Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
70
+ .SH FILES
71
+ .TP
72
+ \fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
73
+ The default sqlite3 database file\.
74
+ .TP
75
+ \fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
76
+ Optional database configuration\.
77
+ .SH AUTHOR
78
+ .PP
79
+ Postmodern
80
+ .MT postmodern\.mod3\[at]gmail\.com
81
+ .ME
@@ -0,0 +1,79 @@
1
+ # ronin-db-street-addresses 1 "2023-02-01" Ronin DB "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-db-street-addresses - Queries street addresses in the database
6
+
7
+ ## SYNOPSIS
8
+
9
+ `ronin-db street-addresses` [*options*]
10
+
11
+ ## DESCRIPTION
12
+
13
+ Queries StreetAddresses.
14
+
15
+ ## OPTIONS
16
+
17
+ `--db` *NAME*
18
+ : The database to connect to. Defaults to `default` if not given.
19
+
20
+ `--db-uri` *URI*
21
+ : The explicit database URI to connect to.
22
+
23
+ * **sqlite3**: `sqlite3:relative/path.db` or `sqlite3:///absolute/path.db`
24
+ * **mysql**: `mysql://user:password@host/database`
25
+ * **postgres**: `postgres://user:password@host/database`
26
+
27
+ `--db-file` *PATH*
28
+ : The sqlite3 database file to use.
29
+
30
+ `-v`, `--verbose`
31
+ : Enable verbose output.
32
+
33
+ `-P`, `--for-person` *FULL_NAME*
34
+ : Searches for street addresses associated with the person's full name.
35
+
36
+ `-O`, `--for-organization` *NAME*
37
+ : Searches for street addresses associated with the organization's name.
38
+
39
+ `-a`, `--with-address` *ADDRESS*
40
+ : Searches for street addresses with the matching address.
41
+
42
+ `-c`, `--with-city` *CITY*
43
+ : Searches for street addresses with the matching city.
44
+
45
+ `-s`, `--with-state` *STATE*
46
+ : Searches for street addresses with the matching state.
47
+
48
+ `-C`, `--with-country` *COUNTRY*
49
+ : Searches for street addresses with the matching country.
50
+
51
+ `-z`, `--with-zipcode` *ZIPCODE*
52
+ : Searches for street addresses with the matching zipcode.
53
+
54
+ `-h`, `--help`
55
+ : Print help information.
56
+
57
+ ## ENVIRONMENT
58
+
59
+ *HOME*
60
+ : Alternate location for the user's home directory.
61
+
62
+ *XDG_CONFIG_HOME*
63
+ : Alternate location for the `~/.config` directory.
64
+
65
+ *XDG_DATA_HOME*
66
+ : Alternate location for the `~/.local/share` directory.
67
+
68
+ ## FILES
69
+
70
+ `~/.local/share/ronin-db/database.sqlite3`
71
+ : The default sqlite3 database file.
72
+
73
+ `~/.config/ronin-db/database.yml`
74
+ : Optional database configuration.
75
+
76
+ ## AUTHOR
77
+
78
+ Postmodern <postmodern.mod3@gmail.com>
79
+
data/man/ronin-db-urls.1 CHANGED
@@ -1,116 +1,93 @@
1
- .\" Generated by kramdown-man 0.1.9
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
- .TH ronin-db-urls 1 "2023-02-01" Ronin "User Manuals"
4
- .LP
3
+ .TH ronin-db-urls 1 "2023-02-01" Ronin DB "User Manuals"
4
+ .SH NAME
5
+ .PP
6
+ ronin\-db\-urls \- Manages URLs in the database
5
7
  .SH SYNOPSIS
6
- .LP
7
8
  .PP
8
- \fBronin-db urls\fR \[lB]\fIoptions\fP\[rB]
9
- .LP
9
+ \fBronin\-db urls\fR \[lB]\fIoptions\fP\[rB]
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
12
  Manages URLs\.
14
- .LP
15
13
  .SH OPTIONS
16
- .LP
17
14
  .TP
18
- \fB--db\fR \fINAME\fP
15
+ \fB\-\-db\fR \fINAME\fP
19
16
  The database to connect to\. Defaults to \fBdefault\fR if not given\.
20
- .LP
21
17
  .TP
22
- \fB--db-uri\fR \fIURI\fP
18
+ \fB\-\-db\-uri\fR \fIURI\fP
23
19
  The explicit database URI to connect to\.
24
- .LP
20
+ .RS
25
21
  .RS
26
22
  .IP \(bu 2
27
- \fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
23
+ \fBsqlite3\fP: \fBsqlite3:relative\[sl]path\.db\fR or \fBsqlite3:\[sl]\[sl]\[sl]absolute\[sl]path\.db\fR
28
24
  .IP \(bu 2
29
- \fBmysql\fP: \fBmysql://user:password@host/database\fR
25
+ \fBmysql\fP: \fBmysql:\[sl]\[sl]user:password\[at]host\[sl]database\fR
30
26
  .IP \(bu 2
31
- \fBpostgres\fP: \fBpostgres://user:password@host/database\fR
27
+ \fBpostgres\fP: \fBpostgres:\[sl]\[sl]user:password\[at]host\[sl]database\fR
32
28
  .RE
33
- .LP
29
+ .RE
30
+ .TP
31
+ \fB\-\-db\-file\fR \fIPATH\fP
32
+ The sqlite3 database file to use\.
34
33
  .TP
35
- \fB-v\fR, \fB--verbose\fR
34
+ \fB\-v\fR, \fB\-\-verbose\fR
36
35
  Enable verbose output\.
37
- .LP
38
36
  .TP
39
- \fB--add\fR \fIVALUE\fP
37
+ \fB\-\-add\fR \fIVALUE\fP
40
38
  Adds the URL to the database\.
41
- .LP
42
39
  .TP
43
- \fB--import\fR \fIFILE\fP
40
+ \fB\-\-import\fR \fIFILE\fP
44
41
  Imports the URLs from the given \fIFILE\fP\.
45
- .LP
46
42
  .TP
47
- \fB--delete\fR \fIVALUE\fP
43
+ \fB\-\-delete\fR \fIVALUE\fP
48
44
  Deletes the URL from the database\.
49
- .LP
50
45
  .TP
51
- \fB--delete-all\fR
46
+ \fB\-\-delete\-all\fR
52
47
  Deletes every URL from the database\.
53
- .LP
54
48
  .TP
55
- \fB--http\fR
56
- Searches for \fBhttp://\fR URLs\.
57
- .LP
49
+ \fB\-\-http\fR
50
+ Searches for \fBhttp:\[sl]\[sl]\fR URLs\.
58
51
  .TP
59
- \fB--https\fR
60
- Searches for \fBhttps://\fR URLs\.
61
- .LP
52
+ \fB\-\-https\fR
53
+ Searches for \fBhttps:\[sl]\[sl]\fR URLs\.
62
54
  .TP
63
- \fB-H\fR, \fB--host\fR \fIHOST\fP
55
+ \fB\-H\fR, \fB\-\-host\fR \fIHOST\fP
64
56
  Searches for URLs with the given \fIHOST\fP\.
65
- .LP
66
57
  .TP
67
- \fB-p\fR, \fB--with-port\fR \fIPORT\fP
58
+ \fB\-p\fR, \fB\-\-with\-port\fR \fIPORT\fP
68
59
  Searches for URLs associated with the \fIPORT\fP\.
69
- .LP
70
60
  .TP
71
- \fB-d\fR, \fB--directory\fR \fIDIRECTORY\fP
61
+ \fB\-d\fR, \fB\-\-directory\fR \fIDIRECTORY\fP
72
62
  Searches for URLs sharing the DIRECTORY\.
73
- .LP
74
- .PP
75
- \fB-q\fR, \fB--with-query-param\fR \fINAME\fP \[lB]\.\.\.\[rB]
63
+ .TP
64
+ \fB\-q\fR, \fB\-\-with\-query\-param\fR \fINAME\fP \[lB]\.\.\.\[rB]
76
65
  Searches for URLs containing the query\-param NAME\.
77
- .LP
78
- .PP
79
- \fB-Q\fR, \fB--with-query-value\fR \fIVALUE\fP \[lB]\.\.\.\[rB]
66
+ .TP
67
+ \fB\-Q\fR, \fB\-\-with\-query\-value\fR \fIVALUE\fP \[lB]\.\.\.\[rB]
80
68
  Searches for URLs containing the query\-param VALUE\.
81
- .LP
82
69
  .TP
83
- \fB-h\fR, \fB--help\fR
70
+ \fB\-h\fR, \fB\-\-help\fR
84
71
  Print help information\.
85
- .LP
86
72
  .SH ENVIRONMENT
87
- .LP
88
73
  .TP
89
74
  \fIHOME\fP
90
75
  Alternate location for the user\[cq]s home directory\.
91
- .LP
92
76
  .TP
93
77
  \fIXDG\[ru]CONFIG\[ru]HOME\fP
94
- Alternate location for the \fB~/.config\fR directory\.
95
- .LP
78
+ Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
96
79
  .TP
97
80
  \fIXDG\[ru]DATA\[ru]HOME\fP
98
- Alternate location for the \fB~/.local/share\fR directory\.
99
- .LP
81
+ Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
100
82
  .SH FILES
101
- .LP
102
83
  .TP
103
- \fB~/.local/share/ronin-db/database.sqlite3\fR
84
+ \fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
104
85
  The default sqlite3 database file\.
105
- .LP
106
86
  .TP
107
- \fB~/.config/ronin-db/database.yml\fR
87
+ \fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
108
88
  Optional database configuration\.
109
- .LP
110
89
  .SH AUTHOR
111
- .LP
112
90
  .PP
113
91
  Postmodern
114
92
  .MT postmodern\.mod3\[at]gmail\.com
115
93
  .ME
116
- .LP