ronin-db 0.1.2-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 +3 -2
  3. data/.gitignore +1 -0
  4. data/.ruby-version +1 -1
  5. data/ChangeLog.md +35 -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 +13 -8
  46. data/lib/ronin/db/exceptions.rb +10 -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 +24 -7
  52. data/man/ronin-db-add.1 +48 -70
  53. data/man/ronin-db-add.1.md +26 -22
  54. data/man/ronin-db-asn.1 +37 -55
  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 +29 -47
  61. data/man/ronin-db-creds.1.md +23 -16
  62. data/man/ronin-db-edit.1 +16 -27
  63. data/man/ronin-db-edit.1.md +11 -7
  64. data/man/ronin-db-emails.1 +37 -50
  65. data/man/ronin-db-emails.1.md +30 -17
  66. data/man/ronin-db-hosts.1 +32 -52
  67. data/man/ronin-db-hosts.1.md +25 -18
  68. data/man/ronin-db-ips.1 +32 -53
  69. data/man/ronin-db-ips.1.md +26 -19
  70. data/man/ronin-db-irb.1 +23 -36
  71. data/man/ronin-db-irb.1.md +17 -10
  72. data/man/ronin-db-list.1 +17 -31
  73. data/man/ronin-db-list.1.md +13 -9
  74. data/man/ronin-db-migrate.1 +23 -36
  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 +16 -29
  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 +38 -61
  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
@@ -0,0 +1,70 @@
1
+ # ronin-db-open-ports 1 "2023-02-01" Ronin DB "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-db-open-ports - Queries open ports in the database
6
+
7
+ ## SYNOPSIS
8
+
9
+ `ronin-db open-ports` [*options*]
10
+
11
+ ## DESCRIPTION
12
+
13
+ Queries OpenPorts.
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`, `--with-port` *PORT*
34
+ : Searches for all OpenPorts that are associated with the port number.
35
+
36
+ `-P`, `--with-protocol` [`tcp`\|`udp`]
37
+ : Searches for all OpenPorts that are associated with the protocol.
38
+
39
+ `-S`, `--with-service` *SERVICE*
40
+ : Searches for all OpenPorts that are associated with the service.
41
+
42
+ `-I`, `--with-ip` *IP*
43
+ : Searches for all OpenPorts associated with the IP address.
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,72 @@
1
+ .\" Generated by kramdown-man 1.0.1
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-db-oses 1 "2023-02-01" Ronin DB "User Manuals"
4
+ .SH NAME
5
+ .PP
6
+ ronin\-db\-oses \- Queries OSes in the database
7
+ .SH SYNOPSIS
8
+ .PP
9
+ \fBronin\-db oses\fR \[lB]\fIoptions\fP\[rB]
10
+ .SH DESCRIPTION
11
+ .PP
12
+ Queries OSes 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 OSes with the matching name\.
39
+ .TP
40
+ \fB\-\-named\fR \fINAME\fP
41
+ Searches for all OSes containing the name\.
42
+ .TP
43
+ \fB\-F\fR, \fB\-\-flavor\fR \fBlinux\fR\[or]\fBbsd\fR
44
+ Searches for all OSes with the matching flavor\.
45
+ .TP
46
+ \fB\-V\fR, \fB\-\-version\fR \fIVERSION\fP
47
+ Searches for all OSes with the matching version\.
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-oses 1 "2023-02-01" Ronin DB "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-db-oses - Queries OSes in the database
6
+
7
+ ## SYNOPSIS
8
+
9
+ `ronin-db oses` [*options*]
10
+
11
+ ## DESCRIPTION
12
+
13
+ Queries OSes 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 OSes with the matching name.
35
+
36
+ `--named` *NAME*
37
+ : Searches for all OSes containing the name.
38
+
39
+ `-F`, `--flavor` `linux`\|`bsd`
40
+ : Searches for all OSes with the matching flavor.
41
+
42
+ `-V`, `--version` *VERSION*
43
+ : Searches for all OSes with the matching version.
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,75 @@
1
+ .\" Generated by kramdown-man 1.0.1
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-db-passwords 1 "2023-01-02" Ronin DB "User Manuals"
4
+ .SH NAME
5
+ .PP
6
+ ronin\-db\-passwords \- Manages all passwords in the database
7
+ .SH SYNOPSIS
8
+ .PP
9
+ \fBronin\-db passwords\fR \[lB]\fIoptions\fP\[rB]
10
+ .SH DESCRIPTION
11
+ .PP
12
+ Manages passwords\.
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 \fIPASSWORD\fP
38
+ Adds the \fIPASSWORD\fP to the database\.
39
+ .TP
40
+ \fB\-\-import\fR \fIFILE\fP
41
+ Imports the Passwords from the given \fIFILE\fP\.
42
+ .TP
43
+ \fB\-\-delete\fR \fIVALUE\fP
44
+ Deletes a Password value from the database\.
45
+ .TP
46
+ \fB\-\-delete\-all\fR
47
+ Deletes every Password from the database\.
48
+ .TP
49
+ \fB\-u\fR, \fB\-\-for\-user\fR \fIUSER\fP
50
+ Searches for Passwords associated with the user name\.
51
+ .TP
52
+ \fB\-e\fR, \fB\-\-with\-email\fR \fIEMAIL\fP
53
+ Searches for Passwords that are associated with the email address\.
54
+ .SH ENVIRONMENT
55
+ .TP
56
+ \fIHOME\fP
57
+ Alternate location for the user\[cq]s home directory\.
58
+ .TP
59
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
60
+ Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
61
+ .TP
62
+ \fIXDG\[ru]DATA\[ru]HOME\fP
63
+ Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
64
+ .SH FILES
65
+ .TP
66
+ \fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
67
+ The default sqlite3 database file\.
68
+ .TP
69
+ \fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
70
+ Optional database configuration\.
71
+ .SH AUTHOR
72
+ .PP
73
+ Postmodern
74
+ .MT postmodern\.mod3\[at]gmail\.com
75
+ .ME
@@ -0,0 +1,73 @@
1
+ # ronin-db-passwords 1 "2023-01-02" Ronin DB "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-db-passwords - Manages all passwords in the database
6
+
7
+ ## SYNOPSIS
8
+
9
+ `ronin-db passwords` [*options*]
10
+
11
+ ## DESCRIPTION
12
+
13
+ Manages passwords.
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` *PASSWORD*
34
+ : Adds the *PASSWORD* to the database.
35
+
36
+ `--import` *FILE*
37
+ : Imports the Passwords from the given *FILE*.
38
+
39
+ `--delete` *VALUE*
40
+ : Deletes a Password value from the database.
41
+
42
+ `--delete-all`
43
+ : Deletes every Password from the database.
44
+
45
+ `-u`, `--for-user` *USER*
46
+ : Searches for Passwords associated with the user name.
47
+
48
+ `-e`, `--with-email` *EMAIL*
49
+ : Searches for Passwords that are associated with the email address.
50
+
51
+ ## ENVIRONMENT
52
+
53
+ *HOME*
54
+ : Alternate location for the user's home directory.
55
+
56
+ *XDG_CONFIG_HOME*
57
+ : Alternate location for the `~/.config` directory.
58
+
59
+ *XDG_DATA_HOME*
60
+ : Alternate location for the `~/.local/share` directory.
61
+
62
+ ## FILES
63
+
64
+ `~/.local/share/ronin-db/database.sqlite3`
65
+ : The default sqlite3 database file.
66
+
67
+ `~/.config/ronin-db/database.yml`
68
+ : Optional database configuration.
69
+
70
+ ## AUTHOR
71
+
72
+ Postmodern <postmodern.mod3@gmail.com>
73
+
@@ -0,0 +1,96 @@
1
+ .\" Generated by kramdown-man 1.0.1
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-db-people 1 "2023-02-01" Ronin DB "User Manuals"
4
+ .SH NAME
5
+ .PP
6
+ ronin\-db\-people \- Queries people in the database
7
+ .SH SYNOPSIS
8
+ .PP
9
+ \fBronin\-db people\fR \[lB]\fIoptions\fP\[rB]
10
+ .SH DESCRIPTION
11
+ .PP
12
+ Queries people\.
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\-a\fR, \fB\-\-for\-address\fR \fIADDRESS\fP
38
+ Searches for all People associated with the street address\.
39
+ .TP
40
+ \fB\-c\fR, \fB\-\-for\-city\fR \fICITY\fP
41
+ Searches for all People associated with the city\.
42
+ .TP
43
+ \fB\-s\fR, \fB\-\-for\-state\fR \fISTATE\fP
44
+ Searches for all People associated with the State\.
45
+ .TP
46
+ \fB\-p\fR, \fB\-\-for\-province\fR \fIPROVINCE\fP
47
+ Searches for all People associated with the Province\.
48
+ .TP
49
+ \fB\-z\fR, \fB\-\-for\-zipcode\fR \fIZIPCODE\fP
50
+ Searches for all People associated with the zipcode\.
51
+ .TP
52
+ \fB\-C\fR, \fB\-\-for\-country\fR \fICOUNTRY\fP
53
+ Searches for all People associated with the Country\.
54
+ .TP
55
+ \fB\-P\fR, \fB\-\-with\-prefix\fR \fIPREIFX\fP
56
+ Searches for all People with the given prefix\.
57
+ .TP
58
+ \fB\-f\fR, \fB\-\-with\-first\-name\fR \fINAME\fP
59
+ Searches for all People with the first name\.
60
+ .TP
61
+ \fB\-m\fR, \fB\-\-with\-middle\-name\fR \fINAME\fP
62
+ Searches for all People with the middle name\.
63
+ .TP
64
+ \fB\-M\fR, \fB\-\-with\-middle\-initial\fR \fIINITIAL\fP
65
+ Searches for all People with the middle name\.
66
+ .TP
67
+ \fB\-l\fR, \fB\-\-with\-last\-name\fR \fINAME\fP
68
+ Searches for all People with the last name\.
69
+ .TP
70
+ \fB\-S\fR, \fB\-\-with\-suffix\fR \fISUFFIX\fP
71
+ Searches for all People with the given suffix\.
72
+ .TP
73
+ \fB\-h\fR, \fB\-\-help\fR
74
+ Print help information\.
75
+ .SH ENVIRONMENT
76
+ .TP
77
+ \fIHOME\fP
78
+ Alternate location for the user\[cq]s home directory\.
79
+ .TP
80
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
81
+ Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
82
+ .TP
83
+ \fIXDG\[ru]DATA\[ru]HOME\fP
84
+ Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
85
+ .SH FILES
86
+ .TP
87
+ \fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
88
+ The default sqlite3 database file\.
89
+ .TP
90
+ \fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
91
+ Optional database configuration\.
92
+ .SH AUTHOR
93
+ .PP
94
+ Postmodern
95
+ .MT postmodern\.mod3\[at]gmail\.com
96
+ .ME
@@ -0,0 +1,94 @@
1
+ # ronin-db-people 1 "2023-02-01" Ronin DB "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-db-people - Queries people in the database
6
+
7
+ ## SYNOPSIS
8
+
9
+ `ronin-db people` [*options*]
10
+
11
+ ## DESCRIPTION
12
+
13
+ Queries people.
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
+ `-a`, `--for-address` *ADDRESS*
34
+ : Searches for all People associated with the street address.
35
+
36
+ `-c`, `--for-city` *CITY*
37
+ : Searches for all People associated with the city.
38
+
39
+ `-s`, `--for-state` *STATE*
40
+ : Searches for all People associated with the State.
41
+
42
+ `-p`, `--for-province` *PROVINCE*
43
+ : Searches for all People associated with the Province.
44
+
45
+ `-z`, `--for-zipcode` *ZIPCODE*
46
+ : Searches for all People associated with the zipcode.
47
+
48
+ `-C`, `--for-country` *COUNTRY*
49
+ : Searches for all People associated with the Country.
50
+
51
+ `-P`, `--with-prefix` *PREIFX*
52
+ : Searches for all People with the given prefix.
53
+
54
+ `-f`, `--with-first-name` *NAME*
55
+ : Searches for all People with the first name.
56
+
57
+ `-m`, `--with-middle-name` *NAME*
58
+ : Searches for all People with the middle name.
59
+
60
+ `-M`, `--with-middle-initial` *INITIAL*
61
+ : Searches for all People with the middle name.
62
+
63
+ `-l`, `--with-last-name` *NAME*
64
+ : Searches for all People with the last name.
65
+
66
+ `-S`, `--with-suffix` *SUFFIX*
67
+ : Searches for all People with the given suffix.
68
+
69
+ `-h`, `--help`
70
+ : Print help information.
71
+
72
+ ## ENVIRONMENT
73
+
74
+ *HOME*
75
+ : Alternate location for the user's home directory.
76
+
77
+ *XDG_CONFIG_HOME*
78
+ : Alternate location for the `~/.config` directory.
79
+
80
+ *XDG_DATA_HOME*
81
+ : Alternate location for the `~/.local/share` directory.
82
+
83
+ ## FILES
84
+
85
+ `~/.local/share/ronin-db/database.sqlite3`
86
+ : The default sqlite3 database file.
87
+
88
+ `~/.config/ronin-db/database.yml`
89
+ : Optional database configuration.
90
+
91
+ ## AUTHOR
92
+
93
+ Postmodern <postmodern.mod3@gmail.com>
94
+
@@ -0,0 +1,93 @@
1
+ .\" Generated by kramdown-man 1.0.1
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-db-phone-numbers 1 "2023-02-01" Ronin DB "User Manuals"
4
+ .SH NAME
5
+ .PP
6
+ ronin\-db\-phone\-numbers \- Manages phone numbers in the database
7
+ .SH SYNOPSIS
8
+ .PP
9
+ \fBronin\-db phone\-numbers\fR \[lB]\fIoptions\fP\[rB]
10
+ .SH DESCRIPTION
11
+ .PP
12
+ Manages PhoneNumbers\.
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 phone number to the database\.
39
+ .TP
40
+ \fB\-\-import\fR \fIFILE\fP
41
+ Imports the phone numbers from the given \fIFILE\fP\.
42
+ .TP
43
+ \fB\-\-delete\fR \fIVALUE\fP
44
+ Deletes the phone number from the database\.
45
+ .TP
46
+ \fB\-\-delete\-all\fR
47
+ Deletes every phone number from the database\.
48
+ .TP
49
+ \fB\-P\fR, \fB\-\-for\-person\fR \fIFULL\[ru]NAME\fP
50
+ Searches for phone numbers associated with the person\[cq]s full name\.
51
+ .TP
52
+ \fB\-O\fR, \fB\-\-for\-organization\fR \fINAME\fP
53
+ Searches for phone numbers associated with the organization\[cq]s name\.
54
+ .TP
55
+ \fB\-c\fR, \fB\-\-with\-country\-code\fR \fINUM\fP
56
+ Searches for phone numbers with the matching 1\-3 digit country code\.
57
+ .TP
58
+ \fB\-a\fR, \fB\-\-with\-area\-code\fR \fINUM\fP
59
+ Searches for phone numbers with the matching 3 digit area code\.
60
+ .TP
61
+ \fB\-p\fR, \fB\-\-with\-prefix\fR \fINUM\fP
62
+ Searches for phone numbers with the matching 3 digit prefix number\.
63
+ .TP
64
+ \fB\-l\fR, \fB\-\-with\-line\-number\fR \fINUM\fP
65
+ Searches for phone numbers with the matching 4 digit line number\.
66
+ .TP
67
+ \fB\-S\fR, \fB\-\-similar\-to\fR \fIPHONE\[ru]NUMBER\fP
68
+ Searches for phone numbers that are similar to the given \fIPHONE\[ru]NUMBER\fP\.
69
+ .TP
70
+ \fB\-h\fR, \fB\-\-help\fR
71
+ Print help information\.
72
+ .SH ENVIRONMENT
73
+ .TP
74
+ \fIHOME\fP
75
+ Alternate location for the user\[cq]s home directory\.
76
+ .TP
77
+ \fIXDG\[ru]CONFIG\[ru]HOME\fP
78
+ Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
79
+ .TP
80
+ \fIXDG\[ru]DATA\[ru]HOME\fP
81
+ Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
82
+ .SH FILES
83
+ .TP
84
+ \fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
85
+ The default sqlite3 database file\.
86
+ .TP
87
+ \fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
88
+ Optional database configuration\.
89
+ .SH AUTHOR
90
+ .PP
91
+ Postmodern
92
+ .MT postmodern\.mod3\[at]gmail\.com
93
+ .ME