ronin-repos 0.1.0.beta1

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 (61) hide show
  1. checksums.yaml +7 -0
  2. data/.document +5 -0
  3. data/.github/workflows/ruby.yml +27 -0
  4. data/.gitignore +13 -0
  5. data/.rspec +1 -0
  6. data/.ruby-version +1 -0
  7. data/.yardopts +1 -0
  8. data/COPYING.txt +165 -0
  9. data/ChangeLog.md +7 -0
  10. data/Gemfile +32 -0
  11. data/README.md +159 -0
  12. data/Rakefile +34 -0
  13. data/bin/ronin-repos +35 -0
  14. data/data/templates/repo/README.md.erb +11 -0
  15. data/gemspec.yml +36 -0
  16. data/lib/ronin/repos/cache_dir.rb +267 -0
  17. data/lib/ronin/repos/class_dir.rb +150 -0
  18. data/lib/ronin/repos/cli/command.rb +63 -0
  19. data/lib/ronin/repos/cli/commands/install.rb +71 -0
  20. data/lib/ronin/repos/cli/commands/list.rb +80 -0
  21. data/lib/ronin/repos/cli/commands/new.rb +83 -0
  22. data/lib/ronin/repos/cli/commands/purge.rb +39 -0
  23. data/lib/ronin/repos/cli/commands/remove.rb +71 -0
  24. data/lib/ronin/repos/cli/commands/update.rb +91 -0
  25. data/lib/ronin/repos/cli.rb +45 -0
  26. data/lib/ronin/repos/exceptions.rb +33 -0
  27. data/lib/ronin/repos/repository.rb +343 -0
  28. data/lib/ronin/repos/root.rb +26 -0
  29. data/lib/ronin/repos/version.rb +24 -0
  30. data/lib/ronin/repos.rb +81 -0
  31. data/man/ronin-repos-install.1 +64 -0
  32. data/man/ronin-repos-install.1.md +49 -0
  33. data/man/ronin-repos-list.1 +54 -0
  34. data/man/ronin-repos-list.1.md +41 -0
  35. data/man/ronin-repos-new.1 +37 -0
  36. data/man/ronin-repos-purge.1 +54 -0
  37. data/man/ronin-repos-purge.1.md +41 -0
  38. data/man/ronin-repos-remove.1 +60 -0
  39. data/man/ronin-repos-remove.1.md +46 -0
  40. data/man/ronin-repos-update.1 +64 -0
  41. data/man/ronin-repos-update.1.md +49 -0
  42. data/man/ronin-repos.1 +49 -0
  43. data/man/ronin-repos.1.md +37 -0
  44. data/ronin-repos.gemspec +62 -0
  45. data/spec/cache_dir_spec.rb +272 -0
  46. data/spec/class_dir_spec.rb +97 -0
  47. data/spec/fixtures/cache/repo1/dir/file1.txt +0 -0
  48. data/spec/fixtures/cache/repo1/file1.txt +0 -0
  49. data/spec/fixtures/cache/repo1/file2.txt +0 -0
  50. data/spec/fixtures/cache/repo2/dir/file1.txt +0 -0
  51. data/spec/fixtures/cache/repo2/dir/file2.txt +0 -0
  52. data/spec/fixtures/cache/repo2/file1.txt +0 -0
  53. data/spec/fixtures/cache/repo2/file2.txt +0 -0
  54. data/spec/fixtures/cache/repo2/only-exists-in-repo2.txt +0 -0
  55. data/spec/fixtures/class_dir/file1.rb +0 -0
  56. data/spec/fixtures/class_dir/file2.rb +0 -0
  57. data/spec/fixtures/class_dir/only_in_class_dir.rb +0 -0
  58. data/spec/repos_spec.rb +67 -0
  59. data/spec/repository_spec.rb +415 -0
  60. data/spec/spec_helper.rb +6 -0
  61. metadata +143 -0
data/lib/ronin/repos.rb ADDED
@@ -0,0 +1,81 @@
1
+ # frozen_string_literal: true
2
+ #
3
+ # Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
4
+ #
5
+ # ronin-repos is free software: you can redistribute it and/or modify
6
+ # it under the terms of the GNU Lesser General Public License as published
7
+ # by the Free Software Foundation, either version 3 of the License, or
8
+ # (at your option) any later version.
9
+ #
10
+ # ronin-repos is distributed in the hope that it will be useful,
11
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
12
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
+ # GNU Lesser General Public License for more details.
14
+ #
15
+ # You should have received a copy of the GNU Lesser General Public License
16
+ # along with ronin-repos. If not, see <https://www.gnu.org/licenses/>.
17
+ #
18
+
19
+ require 'ronin/repos/cache_dir'
20
+
21
+ module Ronin
22
+ #
23
+ # Top-level methods for accessing repositories.
24
+ #
25
+ # @api public
26
+ #
27
+ module Repos
28
+ @@cache_dir = CacheDir.new
29
+
30
+ #
31
+ # Finds the first matching file.
32
+ #
33
+ # @param [String] path
34
+ # The relative path of the file.
35
+ #
36
+ # @return [String, nil]
37
+ # The absolute path of the matching file or `nil` if no matching file
38
+ # could be found.
39
+ #
40
+ # @example
41
+ # repos.find_file("wordlists/wordlist.txt")
42
+ # # => "/home/user/.cache/ronin-repos/foo-repo/wordlists/wordlist.txt"
43
+ #
44
+ def self.find_file(path)
45
+ @@cache_dir.find_file(path)
46
+ end
47
+
48
+ #
49
+ # Finds all files in all repos that matches the glob pattern
50
+ #
51
+ # @param [String] pattern
52
+ # The file glob pattern to search for.
53
+ #
54
+ # @return [Array<String>]
55
+ # The absolute paths to the files that match the glob pattern.
56
+ #
57
+ # @example
58
+ # repos.glob("wordlists/*.txt")
59
+ # # => ["/home/user/.cache/ronin-repos/foo-repo/wordlists/cities.txt",
60
+ # # "/home/user/.cache/ronin-repos/foo-repo/wordlists/states.txt",
61
+ # # "/home/user/.cache/ronin-repos/bar-repo/wordlists/bands.txt",
62
+ # # "/home/user/.cache/ronin-repos/bar-repo/wordlists/beers.txt"]
63
+ #
64
+ def self.glob(pattern,&block)
65
+ @@cache_dir.glob(pattern,&block)
66
+ end
67
+
68
+ #
69
+ # Lists all files across all installed repos.
70
+ #
71
+ # @param [String] pattern
72
+ # The glob pattern to use to list specific files.
73
+ #
74
+ # @return [Set<String>]
75
+ # The matching files within all repositories.
76
+ #
77
+ def self.list_files(pattern='{**/}*.*')
78
+ @@cache_dir.list_files(pattern)
79
+ end
80
+ end
81
+ end
data/man/ronin-repos-install.1 ADDED
@@ -0,0 +1,64 @@
1
+ .\" Generated by kramdown-man 0.1.8
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-repos-install 1 "2022-01-01" Ronin Repos "User Manuals"
4
+ .LP
5
+ .SH SYNOPSIS
6
+ .LP
7
+ .HP
8
+ \fBronin-repos install\fR \[lB]\fIoptions\fP\[rB] \fIURI\fP
9
+ .LP
10
+ .SH DESCRIPTION
11
+ .LP
12
+ .PP
13
+ Downloads a repository\.
14
+ .LP
15
+ .SH ARGUMENTS
16
+ .LP
17
+ .TP
18
+ \fIURI\fP
19
+ The URI to the git repository\.
20
+ .LP
21
+ .SH OPTIONS
22
+ .LP
23
+ .TP
24
+ \fB-h\fR, \fB--help\fR
25
+ Prints help information\.
26
+ .LP
27
+ .SH FILES
28
+ .LP
29
+ .TP
30
+ \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fP
31
+ Installation directory for all repositories\.
32
+ .LP
33
+ .SH ENVIRONMENT
34
+ .LP
35
+ .PP
36
+ HOME
37
+ Specifies the home directory of the user\. Ronin will search for the
38
+ \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
39
+ .LP
40
+ .PP
41
+ XDG\[ru]CACHE\[ru]HOME
42
+ Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
43
+ .LP
44
+ .SH EXAMPLES
45
+ .LP
46
+ .TP
47
+ \fBronin-repos install https://github.com/user/repo.git\fR
48
+ Installs a public repository over HTTPS\.
49
+ .LP
50
+ .TP
51
+ \fBronin-repos install git@example.com:/home/secret/repo\fR
52
+ Installs a private repository over SSH\.
53
+ .LP
54
+ .SH AUTHOR
55
+ .LP
56
+ .PP
57
+ Postmodern
58
+ .MT postmodern\.mod3\[at]gmail\.com
59
+ .ME
60
+ .LP
61
+ .SH SEE ALSO
62
+ .LP
63
+ .PP
64
+ ronin\-repos(1) ronin\-repos\-list(1) ronin\-repos\-remove(1) ronin\-repos\-update(1) ronin\-repos\-purge(1)
data/man/ronin-repos-install.1.md ADDED
@@ -0,0 +1,49 @@
1
+ # ronin-repos-install 1 "2022-01-01" Ronin Repos "User Manuals"
2
+
3
+ ## SYNOPSIS
4
+
5
+ `ronin-repos install` [*options*] *URI*
6
+
7
+ ## DESCRIPTION
8
+
9
+ Downloads a repository.
10
+
11
+ ## ARGUMENTS
12
+
13
+ *URI*
14
+ The URI to the git repository.
15
+
16
+ ## OPTIONS
17
+
18
+ `-h`, `--help`
19
+ Prints help information.
20
+
21
+ ## FILES
22
+
23
+ *~/.cache/ronin-repos/*
24
+ Installation directory for all repositories.
25
+
26
+ ## ENVIRONMENT
27
+
28
+ HOME
29
+ Specifies the home directory of the user. Ronin will search for the
30
+ *~/.cache/ronin-repos* cache directory within the home directory.
31
+
32
+ XDG_CACHE_HOME
33
+ Specifies the cache directory to use. Defaults to *$HOME/.cache*.
34
+
35
+ ## EXAMPLES
36
+
37
+ `ronin-repos install https://github.com/user/repo.git`
38
+ Installs a public repository over HTTPS.
39
+
40
+ `ronin-repos install git@example.com:/home/secret/repo`
41
+ Installs a private repository over SSH.
42
+
43
+ ## AUTHOR
44
+
45
+ Postmodern <postmodern.mod3@gmail.com>
46
+
47
+ ## SEE ALSO
48
+
49
+ ronin-repos(1) ronin-repos-list(1) ronin-repos-remove(1) ronin-repos-update(1) ronin-repos-purge(1)
data/man/ronin-repos-list.1 ADDED
@@ -0,0 +1,54 @@
1
+ .\" Generated by kramdown-man 0.1.8
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-repos-list 1 "2022-01-01" Ronin Repos "User Manuals"
4
+ .LP
5
+ .SH SYNOPSIS
6
+ .LP
7
+ .HP
8
+ \fBronin-repos list\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIREPO\fP\[rB]
9
+ .LP
10
+ .SH DESCRIPTION
11
+ .LP
12
+ .PP
13
+ Lists all downloaded repositories\.
14
+ .LP
15
+ .SH ARGUMENTS
16
+ .LP
17
+ .TP
18
+ \fIREPO\fP
19
+ The optional repository name to only list\.
20
+ .LP
21
+ .SH OPTIONS
22
+ .LP
23
+ .TP
24
+ \fB-h\fR, \fB--help\fR
25
+ Prints help information\.
26
+ .LP
27
+ .SH FILES
28
+ .LP
29
+ .TP
30
+ \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP
31
+ Installation directory for repositories\.
32
+ .LP
33
+ .SH ENVIRONMENT
34
+ .LP
35
+ .PP
36
+ HOME
37
+ Specifies the home directory of the user\. Ronin will search for the
38
+ \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
39
+ .LP
40
+ .PP
41
+ XDG\[ru]CACHE\[ru]HOME
42
+ Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
43
+ .LP
44
+ .SH AUTHOR
45
+ .LP
46
+ .PP
47
+ Postmodern
48
+ .MT postmodern\.mod3\[at]gmail\.com
49
+ .ME
50
+ .LP
51
+ .SH SEE ALSO
52
+ .LP
53
+ .PP
54
+ ronin\-repos(1) ronin\-repos\-install(1) ronin\-repos\-remove(1) ronin\-repos\-update(1) ronin\-repos\-purge(1)
data/man/ronin-repos-list.1.md ADDED
@@ -0,0 +1,41 @@
1
+ # ronin-repos-list 1 "2022-01-01" Ronin Repos "User Manuals"
2
+
3
+ ## SYNOPSIS
4
+
5
+ `ronin-repos list` [*options*] [*REPO*]
6
+
7
+ ## DESCRIPTION
8
+
9
+ Lists all downloaded repositories.
10
+
11
+ ## ARGUMENTS
12
+
13
+ *REPO*
14
+ The optional repository name to only list.
15
+
16
+ ## OPTIONS
17
+
18
+ `-h`, `--help`
19
+ Prints help information.
20
+
21
+ ## FILES
22
+
23
+ *~/.cache/ronin-repos*
24
+ Installation directory for repositories.
25
+
26
+ ## ENVIRONMENT
27
+
28
+ HOME
29
+ Specifies the home directory of the user. Ronin will search for the
30
+ *~/.cache/ronin-repos* cache directory within the home directory.
31
+
32
+ XDG_CACHE_HOME
33
+ Specifies the cache directory to use. Defaults to *$HOME/.cache*.
34
+
35
+ ## AUTHOR
36
+
37
+ Postmodern <postmodern.mod3@gmail.com>
38
+
39
+ ## SEE ALSO
40
+
41
+ ronin-repos(1) ronin-repos-install(1) ronin-repos-remove(1) ronin-repos-update(1) ronin-repos-purge(1)
data/man/ronin-repos-new.1 ADDED
@@ -0,0 +1,37 @@
1
+ .\" Generated by kramdown-man 0.1.8
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-repos-new 1 "2022-01-01" Ronin Repos "User Manuals"
4
+ .LP
5
+ .SH SYNOPSIS
6
+ .LP
7
+ .HP
8
+ \fBronin-repos new\fR \[lB]\fIoptions\fP\[rB] \fIPATH\fP
9
+ .LP
10
+ .SH DESCRIPTION
11
+ .LP
12
+ .PP
13
+ Generates a new git repository\.
14
+ .LP
15
+ .SH ARGUMENTS
16
+ .LP
17
+ .TP
18
+ \fIPATH\fP
19
+ The path to the new git repository directory\.
20
+ .LP
21
+ .SH OPTIONS
22
+ .LP
23
+ .TP
24
+ \fB-h\fR, \fB--help\fR
25
+ Prints help information\.
26
+ .LP
27
+ .SH AUTHOR
28
+ .LP
29
+ .PP
30
+ Postmodern
31
+ .MT postmodern\.mod3\[at]gmail\.com
32
+ .ME
33
+ .LP
34
+ .SH SEE ALSO
35
+ .LP
36
+ .PP
37
+ ronin\-repos(1) ronin\-repos\-list(1) ronin\-repos\-install(1) ronin\-repos\-remove(1) ronin\-repos\-update(1) ronin\-repos\-purge(1)
data/man/ronin-repos-purge.1 ADDED
@@ -0,0 +1,54 @@
1
+ .\" Generated by kramdown-man 0.1.8
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-repos-purge 1 "2022-01-01" Ronin Repos "User Manuals"
4
+ .LP
5
+ .SH SYNOPSIS
6
+ .LP
7
+ .HP
8
+ \fBronin-repos purge\fR \[lB]\fIoptions\fP\[rB]
9
+ .LP
10
+ .SH DESCRIPTION
11
+ .LP
12
+ .PP
13
+ Removes all installed repositories\.
14
+ .LP
15
+ .SH OPTIONS
16
+ .LP
17
+ .TP
18
+ \fB-h\fR, \fB--help\fR
19
+ Prints help information\.
20
+ .LP
21
+ .SH EXAMPLES
22
+ .LP
23
+ .TP
24
+ \fBronin-repo purge\fR
25
+ Removes all installed repositories\.
26
+ .LP
27
+ .SH FILES
28
+ .LP
29
+ .TP
30
+ \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fP
31
+ Installation directory for all repositories\.
32
+ .LP
33
+ .SH ENVIRONMENT
34
+ .LP
35
+ .PP
36
+ HOME
37
+ Specifies the home directory of the user\. Ronin will search for the
38
+ \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
39
+ .LP
40
+ .PP
41
+ XDG\[ru]CACHE\[ru]HOME
42
+ Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
43
+ .LP
44
+ .SH AUTHOR
45
+ .LP
46
+ .PP
47
+ Postmodern
48
+ .MT postmodern\.mod3\[at]gmail\.com
49
+ .ME
50
+ .LP
51
+ .SH SEE ALSO
52
+ .LP
53
+ .PP
54
+ ronin\-repos(1), ronin\-repos\-install(1) ronin\-repos\-list(1) ronin\-repos\-update(1) ronin\-repos\-purge(1)
data/man/ronin-repos-purge.1.md ADDED
@@ -0,0 +1,41 @@
1
+ # ronin-repos-purge 1 "2022-01-01" Ronin Repos "User Manuals"
2
+
3
+ ## SYNOPSIS
4
+
5
+ `ronin-repos purge` [*options*]
6
+
7
+ ## DESCRIPTION
8
+
9
+ Removes all installed repositories.
10
+
11
+ ## OPTIONS
12
+
13
+ `-h`, `--help`
14
+ Prints help information.
15
+
16
+ ## EXAMPLES
17
+
18
+ `ronin-repo purge`
19
+ Removes all installed repositories.
20
+
21
+ ## FILES
22
+
23
+ *~/.cache/ronin-repos/*
24
+ Installation directory for all repositories.
25
+
26
+ ## ENVIRONMENT
27
+
28
+ HOME
29
+ Specifies the home directory of the user. Ronin will search for the
30
+ *~/.cache/ronin-repos* cache directory within the home directory.
31
+
32
+ XDG_CACHE_HOME
33
+ Specifies the cache directory to use. Defaults to *$HOME/.cache*.
34
+
35
+ ## AUTHOR
36
+
37
+ Postmodern <postmodern.mod3@gmail.com>
38
+
39
+ ## SEE ALSO
40
+
41
+ ronin-repos(1), ronin-repos-install(1) ronin-repos-list(1) ronin-repos-update(1) ronin-repos-purge(1)
data/man/ronin-repos-remove.1 ADDED
@@ -0,0 +1,60 @@
1
+ .\" Generated by kramdown-man 0.1.8
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-repos-remove 1 "2022-01-01" Ronin Repos "User Manuals"
4
+ .LP
5
+ .SH SYNOPSIS
6
+ .LP
7
+ .HP
8
+ \fBronin-repos remove\fR \[lB]\fIoptions\fP\[rB] \fIREPO\fP
9
+ .LP
10
+ .SH DESCRIPTION
11
+ .LP
12
+ .PP
13
+ Removes a repository\.
14
+ .LP
15
+ .SH ARGUMENTS
16
+ .LP
17
+ .TP
18
+ \fIREPO\fP
19
+ The name of the repository to remove\.
20
+ .LP
21
+ .SH OPTIONS
22
+ .LP
23
+ .TP
24
+ \fB-h\fR, \fB--help\fR
25
+ Prints help information\.
26
+ .LP
27
+ .SH EXAMPLES
28
+ .LP
29
+ .TP
30
+ \fBronin-repo remove repo\fR
31
+ Removes the repository with with the name \fBrepo\fR\.
32
+ .LP
33
+ .SH FILES
34
+ .LP
35
+ .TP
36
+ \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fP
37
+ Installation directory for all repositories\.
38
+ .LP
39
+ .SH ENVIRONMENT
40
+ .LP
41
+ .PP
42
+ HOME
43
+ Specifies the home directory of the user\. Ronin will search for the
44
+ \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
45
+ .LP
46
+ .PP
47
+ XDG\[ru]CACHE\[ru]HOME
48
+ Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
49
+ .LP
50
+ .SH AUTHOR
51
+ .LP
52
+ .PP
53
+ Postmodern
54
+ .MT postmodern\.mod3\[at]gmail\.com
55
+ .ME
56
+ .LP
57
+ .SH SEE ALSO
58
+ .LP
59
+ .PP
60
+ ronin\-repos(1), ronin\-repos\-install(1) ronin\-repos\-list(1) ronin\-repos\-update(1) ronin\-repos\-purge(1)
data/man/ronin-repos-remove.1.md ADDED
@@ -0,0 +1,46 @@
1
+ # ronin-repos-remove 1 "2022-01-01" Ronin Repos "User Manuals"
2
+
3
+ ## SYNOPSIS
4
+
5
+ `ronin-repos remove` [*options*] *REPO*
6
+
7
+ ## DESCRIPTION
8
+
9
+ Removes a repository.
10
+
11
+ ## ARGUMENTS
12
+
13
+ *REPO*
14
+ The name of the repository to remove.
15
+
16
+ ## OPTIONS
17
+
18
+ `-h`, `--help`
19
+ Prints help information.
20
+
21
+ ## EXAMPLES
22
+
23
+ `ronin-repo remove repo`
24
+ Removes the repository with with the name `repo`.
25
+
26
+ ## FILES
27
+
28
+ *~/.cache/ronin-repos/*
29
+ Installation directory for all repositories.
30
+
31
+ ## ENVIRONMENT
32
+
33
+ HOME
34
+ Specifies the home directory of the user. Ronin will search for the
35
+ *~/.cache/ronin-repos* cache directory within the home directory.
36
+
37
+ XDG_CACHE_HOME
38
+ Specifies the cache directory to use. Defaults to *$HOME/.cache*.
39
+
40
+ ## AUTHOR
41
+
42
+ Postmodern <postmodern.mod3@gmail.com>
43
+
44
+ ## SEE ALSO
45
+
46
+ ronin-repos(1), ronin-repos-install(1) ronin-repos-list(1) ronin-repos-update(1) ronin-repos-purge(1)
data/man/ronin-repos-update.1 ADDED
@@ -0,0 +1,64 @@
1
+ .\" Generated by kramdown-man 0.1.8
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-repos-update 1 "2022-01-01" Ronin Repos "User Manuals"
4
+ .LP
5
+ .SH SYNOPSIS
6
+ .LP
7
+ .HP
8
+ \fBronin-repos update\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIREPO\fP\[rB]
9
+ .LP
10
+ .SH DESCRIPTION
11
+ .LP
12
+ .PP
13
+ Updates all repositories or just one\.
14
+ .LP
15
+ .SH ARGUMENTS
16
+ .LP
17
+ .TP
18
+ \fIREPO\fP
19
+ The optional repository name to only update\.
20
+ .LP
21
+ .SH OPTIONS
22
+ .LP
23
+ .TP
24
+ \fB-h\fR, \fB--help\fR
25
+ Prints help information\.
26
+ .LP
27
+ .SH EXAMPLES
28
+ .LP
29
+ .TP
30
+ \fBronin-repos update\fR
31
+ Updates all installed repositories\.
32
+ .LP
33
+ .TP
34
+ \fBronin update repo\fR
35
+ Updates the specific repository named \fBrepo\fR\.
36
+ .LP
37
+ .SH FILES
38
+ .LP
39
+ .TP
40
+ \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fP
41
+ Installation directory for all repositories\.
42
+ .LP
43
+ .SH ENVIRONMENT
44
+ .LP
45
+ .PP
46
+ HOME
47
+ Specifies the home directory of the user\. Ronin will search for the
48
+ \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
49
+ .LP
50
+ .PP
51
+ XDG\[ru]CACHE\[ru]HOME
52
+ Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
53
+ .LP
54
+ .SH AUTHOR
55
+ .LP
56
+ .PP
57
+ Postmodern
58
+ .MT postmodern\.mod3\[at]gmail\.com
59
+ .ME
60
+ .LP
61
+ .SH SEE ALSO
62
+ .LP
63
+ .PP
64
+ ronin\-repos(1) ronin\-repos\-repos\-install(1) ronin\-repos\-list(1) ronin\-repos\-remove(1) ronin\-repos\-purge(1)
data/man/ronin-repos-update.1.md ADDED
@@ -0,0 +1,49 @@
1
+ # ronin-repos-update 1 "2022-01-01" Ronin Repos "User Manuals"
2
+
3
+ ## SYNOPSIS
4
+
5
+ `ronin-repos update` [*options*] [*REPO*]
6
+
7
+ ## DESCRIPTION
8
+
9
+ Updates all repositories or just one.
10
+
11
+ ## ARGUMENTS
12
+
13
+ *REPO*
14
+ The optional repository name to only update.
15
+
16
+ ## OPTIONS
17
+
18
+ `-h`, `--help`
19
+ Prints help information.
20
+
21
+ ## EXAMPLES
22
+
23
+ `ronin-repos update`
24
+ Updates all installed repositories.
25
+
26
+ `ronin update repo`
27
+ Updates the specific repository named `repo`.
28
+
29
+ ## FILES
30
+
31
+ *~/.cache/ronin-repos/*
32
+ Installation directory for all repositories.
33
+
34
+ ## ENVIRONMENT
35
+
36
+ HOME
37
+ Specifies the home directory of the user. Ronin will search for the
38
+ *~/.cache/ronin-repos* cache directory within the home directory.
39
+
40
+ XDG_CACHE_HOME
41
+ Specifies the cache directory to use. Defaults to *$HOME/.cache*.
42
+
43
+ ## AUTHOR
44
+
45
+ Postmodern <postmodern.mod3@gmail.com>
46
+
47
+ ## SEE ALSO
48
+
49
+ ronin-repos(1) ronin-repos-repos-install(1) ronin-repos-list(1) ronin-repos-remove(1) ronin-repos-purge(1)
data/man/ronin-repos.1 ADDED
@@ -0,0 +1,49 @@
1
+ .\" Generated by kramdown-man 0.1.8
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-repos 1 "2022-01-01" Ronin Repos "User Manuals"
4
+ .LP
5
+ .SH SYNOPSIS
6
+ .LP
7
+ .HP
8
+ \fBronin-repos\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP\[rB]
9
+ .LP
10
+ .SH DESCRIPTION
11
+ .LP
12
+ .PP
13
+ Allows downloading and managing git repositories\. \fBronin-repos\fR can install
14
+ and use any git repository containing Ruby code or other data\.
15
+ .LP
16
+ .SH OPTIONS
17
+ .LP
18
+ .TP
19
+ \fB-h\fR, \fB--help\fR
20
+ Prints help information\.
21
+ .LP
22
+ .SH FILES
23
+ .LP
24
+ .TP
25
+ \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP
26
+ Installation directory for repositories\.
27
+ .LP
28
+ .SH ENVIRONMENT
29
+ .LP
30
+ .PP
31
+ HOME
32
+ Specifies the home directory of the user\. Ronin will search for the
33
+ \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP cache directory within the home directory\.
34
+ .LP
35
+ .PP
36
+ XDG\[ru]CACHE\[ru]HOME
37
+ Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.cache\fP\.
38
+ .LP
39
+ .SH AUTHOR
40
+ .LP
41
+ .PP
42
+ Postmodern
43
+ .MT postmodern\.mod3\[at]gmail\.com
44
+ .ME
45
+ .LP
46
+ .SH SEE ALSO
47
+ .LP
48
+ .PP
49
+ ronin\-repos\-install(1) ronin\-repos\-list(1) ronin\-repos\-remove(1) ronin\-repos\-update(1) ronin\-repos\-purge(1)