ronin-wordlists 0.1.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (60) hide show
  1. checksums.yaml +7 -0
  2. data/.document +4 -0
  3. data/.github/workflows/ruby.yml +43 -0
  4. data/.gitignore +14 -0
  5. data/.rspec +1 -0
  6. data/.rubocop.yml +18 -0
  7. data/.ruby-version +1 -0
  8. data/.yardopts +1 -0
  9. data/COPYING.txt +165 -0
  10. data/ChangeLog.md +10 -0
  11. data/Gemfile +37 -0
  12. data/README.md +180 -0
  13. data/Rakefile +45 -0
  14. data/bin/ronin-wordlists +34 -0
  15. data/data/completions/ronin-wordlists +107 -0
  16. data/data/completions/ronin-wordlists.yml +7 -0
  17. data/data/wordlists.yml +260 -0
  18. data/gemspec.yml +40 -0
  19. data/lib/ronin/wordlists/cache_dir.rb +257 -0
  20. data/lib/ronin/wordlists/cli/command.rb +40 -0
  21. data/lib/ronin/wordlists/cli/commands/completion.rb +61 -0
  22. data/lib/ronin/wordlists/cli/commands/download.rb +109 -0
  23. data/lib/ronin/wordlists/cli/commands/list.rb +79 -0
  24. data/lib/ronin/wordlists/cli/commands/purge.rb +60 -0
  25. data/lib/ronin/wordlists/cli/commands/remove.rb +74 -0
  26. data/lib/ronin/wordlists/cli/commands/search.rb +145 -0
  27. data/lib/ronin/wordlists/cli/commands/update.rb +98 -0
  28. data/lib/ronin/wordlists/cli/wordlist_dir_option.rb +64 -0
  29. data/lib/ronin/wordlists/cli/wordlist_index.rb +178 -0
  30. data/lib/ronin/wordlists/cli/wordlist_option.rb +66 -0
  31. data/lib/ronin/wordlists/cli.rb +56 -0
  32. data/lib/ronin/wordlists/exceptions.rb +47 -0
  33. data/lib/ronin/wordlists/mixin.rb +106 -0
  34. data/lib/ronin/wordlists/root.rb +28 -0
  35. data/lib/ronin/wordlists/search_paths.rb +153 -0
  36. data/lib/ronin/wordlists/version.rb +26 -0
  37. data/lib/ronin/wordlists/wordlist_dir.rb +194 -0
  38. data/lib/ronin/wordlists/wordlist_file.rb +141 -0
  39. data/lib/ronin/wordlists/wordlist_metadata.rb +43 -0
  40. data/lib/ronin/wordlists/wordlist_repo.rb +167 -0
  41. data/lib/ronin/wordlists.rb +96 -0
  42. data/man/ronin-wordlists-completion.1 +76 -0
  43. data/man/ronin-wordlists-completion.1.md +78 -0
  44. data/man/ronin-wordlists-download.1 +47 -0
  45. data/man/ronin-wordlists-download.1.md +48 -0
  46. data/man/ronin-wordlists-list.1 +42 -0
  47. data/man/ronin-wordlists-list.1.md +44 -0
  48. data/man/ronin-wordlists-purge.1 +39 -0
  49. data/man/ronin-wordlists-purge.1.md +39 -0
  50. data/man/ronin-wordlists-remove.1 +43 -0
  51. data/man/ronin-wordlists-remove.1.md +44 -0
  52. data/man/ronin-wordlists-search.1 +37 -0
  53. data/man/ronin-wordlists-search.1.md +37 -0
  54. data/man/ronin-wordlists-update.1 +43 -0
  55. data/man/ronin-wordlists-update.1.md +44 -0
  56. data/man/ronin-wordlists.1 +65 -0
  57. data/man/ronin-wordlists.1.md +64 -0
  58. data/ronin-wordlists.gemspec +62 -0
  59. data/scripts/setup +58 -0
  60. metadata +154 -0
data/man/ronin-wordlists-completion.1.md ADDED
@@ -0,0 +1,78 @@
1
+ # ronin-wordlists-completion 1 "2024-01-01" Ronin Wordlists "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-wordlists-completion - Manages shell completion rules for `ronin-wordlists`
6
+
7
+ ## SYNOPSIS
8
+
9
+ `ronin-wordlists completion` [*options*]
10
+
11
+ ## DESCRIPTION
12
+
13
+ The `ronin-wordlists completion` command can print, install, or uninstall shell
14
+ completion rules for the `ronin-wordlists` command.
15
+
16
+ Supports installing completion rules for Bash or Zsh shells.
17
+ Completion rules for the Fish shell is currently not supported.
18
+
19
+ ### ZSH SUPPORT
20
+
21
+ Zsh users will have to add the following lines to their `~/.zshrc` file in
22
+ order to enable Zsh's Bash completion compatibility layer:
23
+
24
+ autoload -Uz +X compinit && compinit
25
+ autoload -Uz +X bashcompinit && bashcompinit
26
+
27
+ ## OPTIONS
28
+
29
+ `--print`
30
+ : Prints the shell completion file.
31
+
32
+ `--install`
33
+ : Installs the shell completion file.
34
+
35
+ `--uninstall`
36
+ : Uninstalls the shell completion file.
37
+
38
+ `-h`, `--help`
39
+ : Prints help information.
40
+
41
+ ## ENVIRONMENT
42
+
43
+ *PREFIX*
44
+ : Specifies the root prefix for the file system.
45
+
46
+ *HOME*
47
+ : Specifies the home directory of the user. Ronin will search for the
48
+ `~/.cache/ronin-wordlists` cache directory within the home directory.
49
+
50
+ *XDG_DATA_HOME*
51
+ : Specifies the data directory to use. Defaults to `$HOME/.local/share`.
52
+
53
+ ## FILES
54
+
55
+ `~/.local/share/bash-completion/completions/`
56
+ : The user-local installation directory for Bash completion files.
57
+
58
+ `/usr/local/share/bash-completion/completions/`
59
+ : The system-wide installation directory for Bash completions files.
60
+
61
+ `/usr/local/share/zsh/site-functions/`
62
+ : The installation directory for Zsh completion files.
63
+
64
+ ## EXAMPLES
65
+
66
+ `ronin-wordlists completion --print`
67
+ : Prints the shell completion rules instead of installing them.
68
+
69
+ `ronin-wordlists completion --install`
70
+ : Installs the shell completion rules for `ronin-wordlists`.
71
+
72
+ `ronin-wordlists completion --uninstall`
73
+ : Uninstalls the shell completion rules for `ronin-wordlists`.
74
+
75
+ ## AUTHOR
76
+
77
+ Postmodern <postmodern.mod3@gmail.com>
78
+
data/man/ronin-wordlists-download.1 ADDED
@@ -0,0 +1,47 @@
1
+ .\" Generated by kramdown-man 1.0.1
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-wordlists-download 1 "2023-01-01" Ronin Wordlists "User Manuals"
4
+ .SH SYNOPSIS
5
+ .PP
6
+ \fBronin\-wordlists\fR \fBdownload\fR \[lB]\fIoptions\fP\[rB] \[lC]\fINAME\fP \[or] \fIURL\fP\[rC]
7
+ .SH DESCRIPTION
8
+ .PP
9
+ Downloads a wordlist into the \fBronin\-wordlist\fR\[cq]s cache directory or an
10
+ alternate directory\.
11
+ .SH ARGUMENTS
12
+ .TP
13
+ \fINAME\fP
14
+ The name of the known wordlist to install\.
15
+ .TP
16
+ \fIURL\fP
17
+ The URL of the wordlist to install\.
18
+ .SH OPTIONS
19
+ .TP
20
+ \fB\-d\fR, \fB\-\-wordlist\-dir\fR \fIDIR\fP
21
+ The alternative wordlist directory to download the wordlist file into\.
22
+ .TP
23
+ \fB\-h\fR, \fB\-\-help\fR
24
+ Prints help information\.
25
+ .SH FILES
26
+ .TP
27
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-wordlists\fR
28
+ Default installation directory for wordlists\.
29
+ .SH ENVIRONMENT
30
+ .TP
31
+ \fIHOME\fP
32
+ Specifies the home directory of the user\. Ronin will search for the
33
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-wordlists\fR cache directory within the home directory\.
34
+ .TP
35
+ \fIXDG\[ru]CACHE\[ru]HOME\fP
36
+ Specifies the cache directory to use\. Defaults to \fB\[Do]HOME\[sl]\.cache\fR\.
37
+ .SH AUTHOR
38
+ .PP
39
+ Postmodern
40
+ .MT postmodern\.mod3\[at]gmail\.com
41
+ .ME
42
+ .SH SEE ALSO
43
+ .PP
44
+ .BR ronin\-wordlists\-list (1)
45
+ .BR ronin\-wordlists\-remove (1)
46
+ .BR ronin\-wordlists\-update (1)
47
+ .BR ronin\-wordlists\-purge (1)
data/man/ronin-wordlists-download.1.md ADDED
@@ -0,0 +1,48 @@
1
+ # ronin-wordlists-download 1 "2023-01-01" Ronin Wordlists "User Manuals"
2
+
3
+ ## SYNOPSIS
4
+
5
+ `ronin-wordlists` `download` [*options*] {*NAME* \| *URL*}
6
+
7
+ ## DESCRIPTION
8
+
9
+ Downloads a wordlist into the `ronin-wordlist`'s cache directory or an
10
+ alternate directory.
11
+
12
+ ## ARGUMENTS
13
+
14
+ *NAME*
15
+ : The name of the known wordlist to install.
16
+
17
+ *URL*
18
+ : The URL of the wordlist to install.
19
+
20
+ ## OPTIONS
21
+
22
+ `-d`, `--wordlist-dir` *DIR*
23
+ : The alternative wordlist directory to download the wordlist file into.
24
+
25
+ `-h`, `--help`
26
+ : Prints help information.
27
+
28
+ ## FILES
29
+
30
+ `~/.cache/ronin-wordlists`
31
+ : Default installation directory for wordlists.
32
+
33
+ ## ENVIRONMENT
34
+
35
+ *HOME*
36
+ : Specifies the home directory of the user. Ronin will search for the
37
+ `~/.cache/ronin-wordlists` cache directory within the home directory.
38
+
39
+ *XDG_CACHE_HOME*
40
+ : Specifies the cache directory to use. Defaults to `$HOME/.cache`.
41
+
42
+ ## AUTHOR
43
+
44
+ Postmodern <postmodern.mod3@gmail.com>
45
+
46
+ ## SEE ALSO
47
+
48
+ [ronin-wordlists-list](ronin-wordlists-list.1.md) [ronin-wordlists-remove](ronin-wordlists-remove.1.md) [ronin-wordlists-update](ronin-wordlists-update.1.md) [ronin-wordlists-purge](ronin-wordlists-purge.1.md)
data/man/ronin-wordlists-list.1 ADDED
@@ -0,0 +1,42 @@
1
+ .\" Generated by kramdown-man 1.0.1
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-wordlists-list 1 "2023-01-01" Ronin Wordlists "User Manuals"
4
+ .SH SYNOPSIS
5
+ .PP
6
+ \fBronin\-wordlists\fR \fBlist\fR \[lB]\fIoptions\fP\[rB] \[lB]\fINAME\fP\[rB]
7
+ .SH DESCRIPTION
8
+ .PP
9
+ Lists the downloaded wordlists\.
10
+ .SH ARGUMENTS
11
+ .TP
12
+ \fINAME\fP
13
+ The optional name of the wordlist to search for\.
14
+ .SH OPTIONS
15
+ .TP
16
+ \fB\-d\fR, \fB\-\-wordlist\-dir\fR \fIDIR\fP
17
+ The alternative wordlist directory to search\.
18
+ .TP
19
+ \fB\-h\fR, \fB\-\-help\fR
20
+ Prints help information\.
21
+ .SH FILES
22
+ .TP
23
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-wordlists\fR
24
+ Default installation directory for wordlists\.
25
+ .SH ENVIRONMENT
26
+ .TP
27
+ \fIHOME\fP
28
+ Specifies the home directory of the user\. Ronin will search for the
29
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-wordlists\fR cache directory within the home directory\.
30
+ .TP
31
+ \fIXDG\[ru]CACHE\[ru]HOME\fP
32
+ Specifies the cache directory to use\. Defaults to \fB\[Do]HOME\[sl]\.cache\fR\.
33
+ .SH AUTHOR
34
+ .PP
35
+ Postmodern
36
+ .MT postmodern\.mod3\[at]gmail\.com
37
+ .ME
38
+ .SH SEE ALSO
39
+ .PP
40
+ .BR ronin\-wordlists\-download (1)
41
+ .BR ronin\-wordlists\-remove (1)
42
+ .BR ronin\-wordlists\-update (1)
data/man/ronin-wordlists-list.1.md ADDED
@@ -0,0 +1,44 @@
1
+ # ronin-wordlists-list 1 "2023-01-01" Ronin Wordlists "User Manuals"
2
+
3
+ ## SYNOPSIS
4
+
5
+ `ronin-wordlists` `list` [*options*] [*NAME*]
6
+
7
+ ## DESCRIPTION
8
+
9
+ Lists the downloaded wordlists.
10
+
11
+ ## ARGUMENTS
12
+
13
+ *NAME*
14
+ : The optional name of the wordlist to search for.
15
+
16
+ ## OPTIONS
17
+
18
+ `-d`, `--wordlist-dir` *DIR*
19
+ : The alternative wordlist directory to search.
20
+
21
+ `-h`, `--help`
22
+ : Prints help information.
23
+
24
+ ## FILES
25
+
26
+ `~/.cache/ronin-wordlists`
27
+ : Default installation directory for wordlists.
28
+
29
+ ## ENVIRONMENT
30
+
31
+ *HOME*
32
+ : Specifies the home directory of the user. Ronin will search for the
33
+ `~/.cache/ronin-wordlists` cache directory within the home directory.
34
+
35
+ *XDG_CACHE_HOME*
36
+ : Specifies the cache directory to use. Defaults to `$HOME/.cache`.
37
+
38
+ ## AUTHOR
39
+
40
+ Postmodern <postmodern.mod3@gmail.com>
41
+
42
+ ## SEE ALSO
43
+
44
+ [ronin-wordlists-download](ronin-wordlists-download.1.md) [ronin-wordlists-remove](ronin-wordlists-remove.1.md) [ronin-wordlists-update](ronin-wordlists-update.1.md)
data/man/ronin-wordlists-purge.1 ADDED
@@ -0,0 +1,39 @@
1
+ .\" Generated by kramdown-man 1.0.1
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-wordlists-purge 1 "2023-01-01" Ronin Wordlists "User Manuals"
4
+ .SH SYNOPSIS
5
+ .PP
6
+ \fBronin\-wordlists\fR \fBpurge\fR \[lB]\fIoptions\fP\[rB]
7
+ .SH DESCRIPTION
8
+ .PP
9
+ Deletes all downloaded wordlists\.
10
+ .SH OPTIONS
11
+ .TP
12
+ \fB\-d\fR, \fB\-\-wordlist\-dir\fR \fIDIR\fP
13
+ The alternative wordlist directory to purge\.
14
+ .TP
15
+ \fB\-h\fR, \fB\-\-help\fR
16
+ Prints help information\.
17
+ .SH FILES
18
+ .TP
19
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-wordlists\fR
20
+ Default installation directory for wordlists\.
21
+ .SH ENVIRONMENT
22
+ .TP
23
+ \fIHOME\fP
24
+ Specifies the home directory of the user\. Ronin will search for the
25
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-wordlists\fR cache directory within the home directory\.
26
+ .TP
27
+ \fIXDG\[ru]CACHE\[ru]HOME\fP
28
+ Specifies the cache directory to use\. Defaults to \fB\[Do]HOME\[sl]\.cache\fR\.
29
+ .SH AUTHOR
30
+ .PP
31
+ Postmodern
32
+ .MT postmodern\.mod3\[at]gmail\.com
33
+ .ME
34
+ .SH SEE ALSO
35
+ .PP
36
+ .BR ronin\-wordlists\-download (1)
37
+ .BR ronin\-wordlists\-remove (1)
38
+ .BR ronin\-wordlists\-update (1)
39
+ .BR ronin\-wordlists\-purge (1)
data/man/ronin-wordlists-purge.1.md ADDED
@@ -0,0 +1,39 @@
1
+ # ronin-wordlists-purge 1 "2023-01-01" Ronin Wordlists "User Manuals"
2
+
3
+ ## SYNOPSIS
4
+
5
+ `ronin-wordlists` `purge` [*options*]
6
+
7
+ ## DESCRIPTION
8
+
9
+ Deletes all downloaded wordlists.
10
+
11
+ ## OPTIONS
12
+
13
+ `-d`, `--wordlist-dir` *DIR*
14
+ : The alternative wordlist directory to purge.
15
+
16
+ `-h`, `--help`
17
+ : Prints help information.
18
+
19
+ ## FILES
20
+
21
+ `~/.cache/ronin-wordlists`
22
+ : Default installation directory for wordlists.
23
+
24
+ ## ENVIRONMENT
25
+
26
+ *HOME*
27
+ : Specifies the home directory of the user. Ronin will search for the
28
+ `~/.cache/ronin-wordlists` cache directory within the home directory.
29
+
30
+ *XDG_CACHE_HOME*
31
+ : Specifies the cache directory to use. Defaults to `$HOME/.cache`.
32
+
33
+ ## AUTHOR
34
+
35
+ Postmodern <postmodern.mod3@gmail.com>
36
+
37
+ ## SEE ALSO
38
+
39
+ [ronin-wordlists-download](ronin-wordlists-download.1.md) [ronin-wordlists-remove](ronin-wordlists-remove.1.md) [ronin-wordlists-update](ronin-wordlists-update.1.md) [ronin-wordlists-purge](ronin-wordlists-purge.1.md)
data/man/ronin-wordlists-remove.1 ADDED
@@ -0,0 +1,43 @@
1
+ .\" Generated by kramdown-man 1.0.1
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-wordlists-remove 1 "2023-01-01" Ronin Wordlists "User Manuals"
4
+ .SH SYNOPSIS
5
+ .PP
6
+ \fBronin\-wordlists\fR \fBremove\fR \[lB]\fIoptions\fP\[rB] \fINAME\fP
7
+ .SH DESCRIPTION
8
+ .PP
9
+ Removes a previously downloaded wordlist\.
10
+ .SH ARGUMENTS
11
+ .TP
12
+ \fINAME\fP
13
+ The name of the known wordlist to remove\.
14
+ .SH OPTIONS
15
+ .TP
16
+ \fB\-d\fR, \fB\-\-wordlist\-dir\fR \fIDIR\fP
17
+ The alternative wordlist directory to delete the wordlist from\.
18
+ .TP
19
+ \fB\-h\fR, \fB\-\-help\fR
20
+ Prints help information\.
21
+ .SH FILES
22
+ .TP
23
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-wordlists\fR
24
+ Default installation directory for wordlists\.
25
+ .SH ENVIRONMENT
26
+ .TP
27
+ \fIHOME\fP
28
+ Specifies the home directory of the user\. Ronin will search for the
29
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-wordlists\fR cache directory within the home directory\.
30
+ .TP
31
+ \fIXDG\[ru]CACHE\[ru]HOME\fP
32
+ Specifies the cache directory to use\. Defaults to \fB\[Do]HOME\[sl]\.cache\fR\.
33
+ .SH AUTHOR
34
+ .PP
35
+ Postmodern
36
+ .MT postmodern\.mod3\[at]gmail\.com
37
+ .ME
38
+ .SH SEE ALSO
39
+ .PP
40
+ .BR ronin\-wordlists\-download (1)
41
+ .BR ronin\-wordlists\-list (1)
42
+ .BR ronin\-wordlists\-update (1)
43
+ .BR ronin\-wordlists\-purge (1)
data/man/ronin-wordlists-remove.1.md ADDED
@@ -0,0 +1,44 @@
1
+ # ronin-wordlists-remove 1 "2023-01-01" Ronin Wordlists "User Manuals"
2
+
3
+ ## SYNOPSIS
4
+
5
+ `ronin-wordlists` `remove` [*options*] *NAME*
6
+
7
+ ## DESCRIPTION
8
+
9
+ Removes a previously downloaded wordlist.
10
+
11
+ ## ARGUMENTS
12
+
13
+ *NAME*
14
+ : The name of the known wordlist to remove.
15
+
16
+ ## OPTIONS
17
+
18
+ `-d`, `--wordlist-dir` *DIR*
19
+ : The alternative wordlist directory to delete the wordlist from.
20
+
21
+ `-h`, `--help`
22
+ : Prints help information.
23
+
24
+ ## FILES
25
+
26
+ `~/.cache/ronin-wordlists`
27
+ : Default installation directory for wordlists.
28
+
29
+ ## ENVIRONMENT
30
+
31
+ *HOME*
32
+ : Specifies the home directory of the user. Ronin will search for the
33
+ `~/.cache/ronin-wordlists` cache directory within the home directory.
34
+
35
+ *XDG_CACHE_HOME*
36
+ : Specifies the cache directory to use. Defaults to `$HOME/.cache`.
37
+
38
+ ## AUTHOR
39
+
40
+ Postmodern <postmodern.mod3@gmail.com>
41
+
42
+ ## SEE ALSO
43
+
44
+ [ronin-wordlists-download](ronin-wordlists-download.1.md) [ronin-wordlists-list](ronin-wordlists-list.1.md) [ronin-wordlists-update](ronin-wordlists-update.1.md) [ronin-wordlists-purge](ronin-wordlists-purge.1.md)
data/man/ronin-wordlists-search.1 ADDED
@@ -0,0 +1,37 @@
1
+ .\" Generated by kramdown-man 1.0.1
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-wordlists-search 1 "2023-01-01" Ronin Wordlists "User Manuals"
4
+ .SH NAME
5
+ .PP
6
+ ronin\-wordlists\-search \- Lists the search wordlists
7
+ .SH SYNOPSIS
8
+ .PP
9
+ \fBronin\-wordlists\fR \fBsearch\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIKEYWORD\fP\[rB]
10
+ .SH DESCRIPTION
11
+ .PP
12
+ Lists popular wordlists that are search for download or installation,
13
+ by the \fBronin\-wordlists download\fR or \fBronin\-wordlists install\fR commands\.
14
+ .SH ARGUMENTS
15
+ .TP
16
+ \fIKEYWORD\fP
17
+ Optional keyword to search wordlists by\.
18
+ .SH OPTIONS
19
+ .TP
20
+ \fB\-c\fR, \fB\-\-category\fR \fICATEGORY\fP
21
+ Filters wordlists by the given category name\. If the option is specified
22
+ multiple times then the wordlists belonging to all of the categories will be
23
+ displayed\.
24
+ .TP
25
+ \fB\-h\fR, \fB\-\-help\fR
26
+ Prints help information\.
27
+ .SH AUTHOR
28
+ .PP
29
+ Postmodern
30
+ .MT postmodern\.mod3\[at]gmail\.com
31
+ .ME
32
+ .SH SEE ALSO
33
+ .PP
34
+ .BR ronin\-wordlists\-download (1)
35
+ .BR ronin\-wordlists\-list (1)
36
+ .BR ronin\-wordlists\-remove (1)
37
+ .BR ronin\-wordlists\-update (1)
data/man/ronin-wordlists-search.1.md ADDED
@@ -0,0 +1,37 @@
1
+ # ronin-wordlists-search 1 "2023-01-01" Ronin Wordlists "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-wordlists-search - Lists the search wordlists
6
+
7
+ ## SYNOPSIS
8
+
9
+ `ronin-wordlists` `search` [*options*] [*KEYWORD*]
10
+
11
+ ## DESCRIPTION
12
+
13
+ Lists popular wordlists that are search for download or installation,
14
+ by the `ronin-wordlists download` or `ronin-wordlists install` commands.
15
+
16
+ ## ARGUMENTS
17
+
18
+ *KEYWORD*
19
+ : Optional keyword to search wordlists by.
20
+
21
+ ## OPTIONS
22
+
23
+ `-c`, `--category` *CATEGORY*
24
+ : Filters wordlists by the given category name. If the option is specified
25
+ multiple times then the wordlists belonging to all of the categories will be
26
+ displayed.
27
+
28
+ `-h`, `--help`
29
+ : Prints help information.
30
+
31
+ ## AUTHOR
32
+
33
+ Postmodern <postmodern.mod3@gmail.com>
34
+
35
+ ## SEE ALSO
36
+
37
+ [ronin-wordlists-download](ronin-wordlists-download.1.md) [ronin-wordlists-list](ronin-wordlists-list.1.md) [ronin-wordlists-remove](ronin-wordlists-remove.1.md) [ronin-wordlists-update](ronin-wordlists-update.1.md)
data/man/ronin-wordlists-update.1 ADDED
@@ -0,0 +1,43 @@
1
+ .\" Generated by kramdown-man 1.0.1
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-wordlists-update 1 "2023-01-01" Ronin Wordlists "User Manuals"
4
+ .SH SYNOPSIS
5
+ .PP
6
+ \fBronin\-wordlists\fR \fBupdate\fR \[lB]\fIoptions\fP\[rB] \[lB]\fINAME\fP\[rB]
7
+ .SH DESCRIPTION
8
+ .PP
9
+ Updates a previously downloaded wordlist or all downloaded wordlists\.
10
+ .SH ARGUMENTS
11
+ .TP
12
+ \fINAME\fP
13
+ The name of the known wordlist to update\.
14
+ .SH OPTIONS
15
+ .TP
16
+ \fB\-d\fR, \fB\-\-wordlist\-dir\fR \fIDIR\fP
17
+ The alternative wordlist directory to update the wordlist\.
18
+ .TP
19
+ \fB\-h\fR, \fB\-\-help\fR
20
+ Prints help information\.
21
+ .SH FILES
22
+ .TP
23
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-wordlists\fR
24
+ Default installation directory for wordlists\.
25
+ .SH ENVIRONMENT
26
+ .TP
27
+ \fIHOME\fP
28
+ Specifies the home directory of the user\. Ronin will search for the
29
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-wordlists\fR cache directory within the home directory\.
30
+ .TP
31
+ \fIXDG\[ru]CACHE\[ru]HOME\fP
32
+ Specifies the cache directory to use\. Defaults to \fB\[Do]HOME\[sl]\.cache\fR\.
33
+ .SH AUTHOR
34
+ .PP
35
+ Postmodern
36
+ .MT postmodern\.mod3\[at]gmail\.com
37
+ .ME
38
+ .SH SEE ALSO
39
+ .PP
40
+ .BR ronin\-wordlists\-download (1)
41
+ .BR ronin\-wordlists\-list (1)
42
+ .BR ronin\-wordlists\-remove (1)
43
+ .BR ronin\-wordlists\-purge (1)
data/man/ronin-wordlists-update.1.md ADDED
@@ -0,0 +1,44 @@
1
+ # ronin-wordlists-update 1 "2023-01-01" Ronin Wordlists "User Manuals"
2
+
3
+ ## SYNOPSIS
4
+
5
+ `ronin-wordlists` `update` [*options*] [*NAME*]
6
+
7
+ ## DESCRIPTION
8
+
9
+ Updates a previously downloaded wordlist or all downloaded wordlists.
10
+
11
+ ## ARGUMENTS
12
+
13
+ *NAME*
14
+ : The name of the known wordlist to update.
15
+
16
+ ## OPTIONS
17
+
18
+ `-d`, `--wordlist-dir` *DIR*
19
+ : The alternative wordlist directory to update the wordlist.
20
+
21
+ `-h`, `--help`
22
+ : Prints help information.
23
+
24
+ ## FILES
25
+
26
+ `~/.cache/ronin-wordlists`
27
+ : Default installation directory for wordlists.
28
+
29
+ ## ENVIRONMENT
30
+
31
+ *HOME*
32
+ : Specifies the home directory of the user. Ronin will search for the
33
+ `~/.cache/ronin-wordlists` cache directory within the home directory.
34
+
35
+ *XDG_CACHE_HOME*
36
+ : Specifies the cache directory to use. Defaults to `$HOME/.cache`.
37
+
38
+ ## AUTHOR
39
+
40
+ Postmodern <postmodern.mod3@gmail.com>
41
+
42
+ ## SEE ALSO
43
+
44
+ [ronin-wordlists-download](ronin-wordlists-download.1.md) [ronin-wordlists-list](ronin-wordlists-list.1.md) [ronin-wordlists-remove](ronin-wordlists-remove.1.md) [ronin-wordlists-purge](ronin-wordlists-purge.1.md)
data/man/ronin-wordlists.1 ADDED
@@ -0,0 +1,65 @@
1
+ .\" Generated by kramdown-man 1.0.1
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-wordlists 1 "2023-01-01" Ronin Wordlists "User Manuals"
4
+ .SH SYNOPSIS
5
+ .PP
6
+ \fBronin\-wordlists\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP\[rB]
7
+ .SH DESCRIPTION
8
+ .PP
9
+ Command suite that manages wordlists\.
10
+ .SH ARGUMENTS
11
+ .TP
12
+ \fICOMMAND\fP
13
+ The \fBronin\-wordlists\fR command to execute\.
14
+ .SH OPTIONS
15
+ .TP
16
+ \fB\-h\fR, \fB\-\-help\fR
17
+ Prints help information\.
18
+ .SH COMMANDS
19
+ .TP
20
+ \fBsearch\fR
21
+ Lists wordlists available for download or installation\.
22
+ .TP
23
+ \fBcompletion\fR
24
+ Manages the shell completion rules for \fBronin\-wordlists\fR\.
25
+ .TP
26
+ \fBdownload\fR
27
+ Downloads a wordlist\.
28
+ .TP
29
+ \fBlist\fR, \fBls\fR
30
+ Lists downloaded wordlists\.
31
+ .TP
32
+ \fBpurge\fR
33
+ Deletes all downloaded wordlists\.
34
+ .TP
35
+ \fBremove\fR, \fBrm\fR
36
+ Deletes a downloaded wordlist\.
37
+ .TP
38
+ \fBupdate\fR, \fBup\fR
39
+ Updates one or all downloaded wordlists\.
40
+ .SH FILES
41
+ .TP
42
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-wordlists\fR
43
+ Default installation directory for wordlists\.
44
+ .SH ENVIRONMENT
45
+ .TP
46
+ \fIHOME\fP
47
+ Specifies the home directory of the user\. Ronin will search for the
48
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-wordlists\fR cache directory within the home directory\.
49
+ .TP
50
+ \fIXDG\[ru]CACHE\[ru]HOME\fP
51
+ Specifies the cache directory to use\. Defaults to \fB\[Do]HOME\[sl]\.cache\fR\.
52
+ .SH AUTHOR
53
+ .PP
54
+ Postmodern
55
+ .MT postmodern\.mod3\[at]gmail\.com
56
+ .ME
57
+ .SH SEE ALSO
58
+ .PP
59
+ .BR ronin\-wordlists\-search (1)
60
+ .BR ronin\-wordlists\-completion (1)
61
+ .BR ronin\-wordlists\-download (1)
62
+ .BR ronin\-wordlists\-list (1)
63
+ .BR ronin\-wordlists\-remove (1)
64
+ .BR ronin\-wordlists\-update (1)
65
+ .BR ronin\-wordlists\-purge (1)