ronin-repos 0.1.1 → 0.2.0.rc1

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 (49) hide show
  1. checksums.yaml +4 -4
  2. data/.document +0 -1
  3. data/.github/workflows/ruby.yml +3 -2
  4. data/.gitignore +1 -0
  5. data/.rubocop.yml +4 -0
  6. data/ChangeLog.md +15 -0
  7. data/Gemfile +5 -3
  8. data/README.md +19 -5
  9. data/Rakefile +10 -0
  10. data/data/completions/ronin-repos +139 -0
  11. data/data/completions/ronin-repos.yml +10 -0
  12. data/gemspec.yml +11 -2
  13. data/lib/ronin/repos/cache_dir.rb +1 -1
  14. data/lib/ronin/repos/class_dir.rb +5 -4
  15. data/lib/ronin/repos/cli/command.rb +1 -1
  16. data/lib/ronin/repos/cli/commands/completion.rb +61 -0
  17. data/lib/ronin/repos/cli/commands/install.rb +2 -2
  18. data/lib/ronin/repos/cli/commands/list.rb +15 -18
  19. data/lib/ronin/repos/cli/commands/new.rb +6 -2
  20. data/lib/ronin/repos/cli/commands/purge.rb +2 -2
  21. data/lib/ronin/repos/cli/commands/remove.rb +1 -1
  22. data/lib/ronin/repos/cli/commands/show.rb +93 -0
  23. data/lib/ronin/repos/cli/commands/update.rb +2 -2
  24. data/lib/ronin/repos/cli.rb +5 -4
  25. data/lib/ronin/repos/exceptions.rb +1 -1
  26. data/lib/ronin/repos/repository.rb +30 -1
  27. data/lib/ronin/repos/root.rb +1 -1
  28. data/lib/ronin/repos/version.rb +2 -2
  29. data/lib/ronin/repos.rb +19 -5
  30. data/man/ronin-repos-completion.1 +76 -0
  31. data/man/ronin-repos-completion.1.md +78 -0
  32. data/man/ronin-repos-install.1 +18 -32
  33. data/man/ronin-repos-install.1.md +14 -10
  34. data/man/ronin-repos-list.1 +18 -28
  35. data/man/ronin-repos-list.1.md +14 -10
  36. data/man/ronin-repos-new.1 +14 -19
  37. data/man/ronin-repos-new.1.md +8 -4
  38. data/man/ronin-repos-purge.1 +17 -28
  39. data/man/ronin-repos-purge.1.md +12 -8
  40. data/man/ronin-repos-remove.1 +16 -28
  41. data/man/ronin-repos-remove.1.md +12 -8
  42. data/man/ronin-repos-show.1 +48 -0
  43. data/man/ronin-repos-show.1.md +48 -0
  44. data/man/ronin-repos-update.1 +17 -31
  45. data/man/ronin-repos-update.1.md +14 -10
  46. data/man/ronin-repos.1 +17 -31
  47. data/man/ronin-repos.1.md +16 -12
  48. data/scripts/setup +58 -0
  49. metadata +17 -7
data/man/ronin-repos-list.1.md CHANGED
@@ -1,8 +1,12 @@
1
1
  # ronin-repos-list 1 "2023-02-01" Ronin Repos "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-repos-list - Lists all repositories in the cache directory
6
+
3
7
  ## SYNOPSIS
4
8
 
5
- `ronin-repos list` [*options*] [*REPO*]
9
+ `ronin-repos list` [*options*] [*NAME*]
6
10
 
7
11
  ## DESCRIPTION
8
12
 
@@ -10,30 +14,30 @@ Lists all downloaded repositories.
10
14
 
11
15
  ## ARGUMENTS
12
16
 
13
- *REPO*
14
- The optional repository name to only list.
17
+ *NAME*
18
+ : The optional repository name to only list.
15
19
 
16
20
  ## OPTIONS
17
21
 
18
22
  `-C`, `--cache-dir` *DIR*
19
- Overrides the default cache directory.
23
+ : Overrides the default cache directory.
20
24
 
21
25
  `-h`, `--help`
22
- Prints help information.
26
+ : Prints help information.
23
27
 
24
28
  ## ENVIRONMENT
25
29
 
26
30
  *HOME*
27
- Specifies the home directory of the user. Ronin will search for the
28
- `~/.cache/ronin-repos` cache directory within the home directory.
31
+ : Specifies the home directory of the user. Ronin will search for the
32
+ `~/.cache/ronin-repos` cache directory within the home directory.
29
33
 
30
34
  *XDG_CACHE_HOME*
31
- Specifies the cache directory to use. Defaults to `$HOME/.cache`.
35
+ : Specifies the cache directory to use. Defaults to `$HOME/.cache`.
32
36
 
33
37
  ## FILES
34
38
 
35
39
  `~/.cache/ronin-repos`
36
- Installation directory for repositories.
40
+ : Installation directory for repositories.
37
41
 
38
42
  ## AUTHOR
39
43
 
@@ -41,4 +45,4 @@ Postmodern <postmodern.mod3@gmail.com>
41
45
 
42
46
  ## SEE ALSO
43
47
 
44
- ronin-repos(1) ronin-repos-install(1) ronin-repos-remove(1) ronin-repos-update(1) ronin-repos-purge(1)
48
+ [ronin-repos](ronin-repos.1.md) [ronin-repos-install](ronin-repos-install.1.md) [ronin-repos-remove](ronin-repos-remove.1.md) [ronin-repos-show](ronin-repos-show.1.md) [ronin-repos-update](ronin-repos-update.1.md) [ronin-repos-purge](ronin-repos-purge.1.md)
data/man/ronin-repos-new.1 CHANGED
@@ -1,41 +1,36 @@
1
- .\" Generated by kramdown-man 0.1.8
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
3
  .TH ronin-repos-new 1 "2023-02-01" Ronin Repos "User Manuals"
4
- .LP
4
+ .SH NAME
5
+ .PP
6
+ ronin\-repos\-new \- Creates a new git repository
5
7
  .SH SYNOPSIS
6
- .LP
7
- .HP
8
- \fBronin-repos new\fR \[lB]\fIoptions\fP\[rB] \fIPATH\fP
9
- .LP
8
+ .PP
9
+ \fBronin\-repos new\fR \[lB]\fIoptions\fP\[rB] \fIPATH\fP
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
12
  Generates a new git repository\.
14
- .LP
15
13
  .SH ARGUMENTS
16
- .LP
17
14
  .TP
18
15
  \fIPATH\fP
19
16
  The path to the new git repository directory\.
20
- .LP
21
17
  .SH OPTIONS
22
- .LP
23
18
  .TP
24
- \fB-C\fR, \fB--cache-dir\fR \fIDIR\fP
19
+ \fB\-C\fR, \fB\-\-cache\-dir\fR \fIDIR\fP
25
20
  Overrides the default cache directory\.
26
- .LP
27
21
  .TP
28
- \fB-h\fR, \fB--help\fR
22
+ \fB\-h\fR, \fB\-\-help\fR
29
23
  Prints help information\.
30
- .LP
31
24
  .SH AUTHOR
32
- .LP
33
25
  .PP
34
26
  Postmodern
35
27
  .MT postmodern\.mod3\[at]gmail\.com
36
28
  .ME
37
- .LP
38
29
  .SH SEE ALSO
39
- .LP
40
30
  .PP
41
- ronin\-repos(1) ronin\-repos\-list(1) ronin\-repos\-install(1) ronin\-repos\-remove(1) ronin\-repos\-update(1) ronin\-repos\-purge(1)
31
+ .BR ronin\-repos (1)
32
+ .BR ronin\-repos\-list (1)
33
+ .BR ronin\-repos\-install (1)
34
+ .BR ronin\-repos\-remove (1)
35
+ .BR ronin\-repos\-update (1)
36
+ .BR ronin\-repos\-purge (1)
data/man/ronin-repos-new.1.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # ronin-repos-new 1 "2023-02-01" Ronin Repos "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-repos-new - Creates a new git repository
6
+
3
7
  ## SYNOPSIS
4
8
 
5
9
  `ronin-repos new` [*options*] *PATH*
@@ -11,15 +15,15 @@ Generates a new git repository.
11
15
  ## ARGUMENTS
12
16
 
13
17
  *PATH*
14
- The path to the new git repository directory.
18
+ : The path to the new git repository directory.
15
19
 
16
20
  ## OPTIONS
17
21
 
18
22
  `-C`, `--cache-dir` *DIR*
19
- Overrides the default cache directory.
23
+ : Overrides the default cache directory.
20
24
 
21
25
  `-h`, `--help`
22
- Prints help information.
26
+ : Prints help information.
23
27
 
24
28
  ## AUTHOR
25
29
 
@@ -27,4 +31,4 @@ Postmodern <postmodern.mod3@gmail.com>
27
31
 
28
32
  ## SEE ALSO
29
33
 
30
- ronin-repos(1) ronin-repos-list(1) ronin-repos-install(1) ronin-repos-remove(1) ronin-repos-update(1) ronin-repos-purge(1)
34
+ [ronin-repos](ronin-repos.1.md) [ronin-repos-list](ronin-repos-list.1.md) [ronin-repos-install](ronin-repos-install.1.md) [ronin-repos-remove](ronin-repos-remove.1.md) [ronin-repos-update](ronin-repos-update.1.md) [ronin-repos-purge](ronin-repos-purge.1.md)
data/man/ronin-repos-purge.1 CHANGED
@@ -1,58 +1,47 @@
1
- .\" Generated by kramdown-man 0.1.8
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
3
  .TH ronin-repos-purge 1 "2023-02-01" Ronin Repos "User Manuals"
4
- .LP
4
+ .SH NAME
5
+ .PP
6
+ ronin\-repos\-purge \- Removes all git repository from the cache directory
5
7
  .SH SYNOPSIS
6
- .LP
7
- .HP
8
- \fBronin-repos purge\fR \[lB]\fIoptions\fP\[rB]
9
- .LP
8
+ .PP
9
+ \fBronin\-repos purge\fR \[lB]\fIoptions\fP\[rB]
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
12
  Removes all installed repositories\.
14
- .LP
15
13
  .SH OPTIONS
16
- .LP
17
14
  .TP
18
- \fB-C\fR, \fB--cache-dir\fR \fIDIR\fP
15
+ \fB\-C\fR, \fB\-\-cache\-dir\fR \fIDIR\fP
19
16
  Overrides the default cache directory\.
20
- .LP
21
17
  .TP
22
- \fB-h\fR, \fB--help\fR
18
+ \fB\-h\fR, \fB\-\-help\fR
23
19
  Prints help information\.
24
- .LP
25
20
  .SH EXAMPLES
26
- .LP
27
21
  .TP
28
- \fBronin-repo purge\fR
22
+ \fBronin\-repo purge\fR
29
23
  Removes all installed repositories\.
30
- .LP
31
24
  .SH ENVIRONMENT
32
- .LP
33
25
  .TP
34
26
  \fIHOME\fP
35
27
  Specifies the home directory of the user\. Ronin will search for the
36
- \fB~/.cache/ronin-repos\fR cache directory within the home directory\.
37
- .LP
28
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR cache directory within the home directory\.
38
29
  .TP
39
30
  \fIXDG\[ru]CACHE\[ru]HOME\fP
40
- Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
41
- .LP
31
+ Specifies the cache directory to use\. Defaults to \fB\[Do]HOME\[sl]\.cache\fR\.
42
32
  .SH FILES
43
- .LP
44
33
  .TP
45
- \fB~/.cache/ronin-repos/\fR
34
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fR
46
35
  Installation directory for all repositories\.
47
- .LP
48
36
  .SH AUTHOR
49
- .LP
50
37
  .PP
51
38
  Postmodern
52
39
  .MT postmodern\.mod3\[at]gmail\.com
53
40
  .ME
54
- .LP
55
41
  .SH SEE ALSO
56
- .LP
57
42
  .PP
58
- ronin\-repos(1), ronin\-repos\-install(1) ronin\-repos\-list(1) ronin\-repos\-update(1) ronin\-repos\-purge(1)
43
+ .BR ronin\-repos (1)
44
+ .BR ronin\-repos\-install (1)
45
+ .BR ronin\-repos\-list (1)
46
+ .BR ronin\-repos\-update (1)
47
+ .BR ronin\-repos\-purge (1)
data/man/ronin-repos-purge.1.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # ronin-repos-purge 1 "2023-02-01" Ronin Repos "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-repos-purge - Removes all git repository from the cache directory
6
+
3
7
  ## SYNOPSIS
4
8
 
5
9
  `ronin-repos purge` [*options*]
@@ -11,29 +15,29 @@ Removes all installed repositories.
11
15
  ## OPTIONS
12
16
 
13
17
  `-C`, `--cache-dir` *DIR*
14
- Overrides the default cache directory.
18
+ : Overrides the default cache directory.
15
19
 
16
20
  `-h`, `--help`
17
- Prints help information.
21
+ : Prints help information.
18
22
 
19
23
  ## EXAMPLES
20
24
 
21
25
  `ronin-repo purge`
22
- Removes all installed repositories.
26
+ : Removes all installed repositories.
23
27
 
24
28
  ## ENVIRONMENT
25
29
 
26
30
  *HOME*
27
- Specifies the home directory of the user. Ronin will search for the
28
- `~/.cache/ronin-repos` cache directory within the home directory.
31
+ : Specifies the home directory of the user. Ronin will search for the
32
+ `~/.cache/ronin-repos` cache directory within the home directory.
29
33
 
30
34
  *XDG_CACHE_HOME*
31
- Specifies the cache directory to use. Defaults to `$HOME/.cache`.
35
+ : Specifies the cache directory to use. Defaults to `$HOME/.cache`.
32
36
 
33
37
  ## FILES
34
38
 
35
39
  `~/.cache/ronin-repos/`
36
- Installation directory for all repositories.
40
+ : Installation directory for all repositories.
37
41
 
38
42
  ## AUTHOR
39
43
 
@@ -41,4 +45,4 @@ Postmodern <postmodern.mod3@gmail.com>
41
45
 
42
46
  ## SEE ALSO
43
47
 
44
- ronin-repos(1), ronin-repos-install(1) ronin-repos-list(1) ronin-repos-update(1) ronin-repos-purge(1)
48
+ [ronin-repos](ronin-repos.1.md) [ronin-repos-install](ronin-repos-install.1.md) [ronin-repos-list](ronin-repos-list.1.md) [ronin-repos-update](ronin-repos-update.1.md) [ronin-repos-purge](ronin-repos-purge.1.md)
data/man/ronin-repos-remove.1 CHANGED
@@ -1,60 +1,48 @@
1
- .\" Generated by kramdown-man 0.1.8
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
3
  .TH ronin-repos-remove 1 "2023-02-01" Ronin Repos "User Manuals"
4
- .LP
4
+ .SH NAME
5
+ .PP
6
+ ronin\-repos\-remove \- Deletes a repository from the cache directory
5
7
  .SH SYNOPSIS
6
- .LP
7
- .HP
8
- \fBronin-repos remove\fR \[lB]\fIoptions\fP\[rB] \fIREPO\fP
9
- .LP
8
+ .PP
9
+ \fBronin\-repos remove\fR \[lB]\fIoptions\fP\[rB] \fIREPO\fP
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
12
  Removes a repository\.
14
- .LP
15
13
  .SH ARGUMENTS
16
- .LP
17
14
  .TP
18
15
  \fIREPO\fP
19
16
  The name of the repository to remove\.
20
- .LP
21
17
  .SH OPTIONS
22
- .LP
23
18
  .TP
24
- \fB-h\fR, \fB--help\fR
19
+ \fB\-h\fR, \fB\-\-help\fR
25
20
  Prints help information\.
26
- .LP
27
21
  .SH EXAMPLES
28
- .LP
29
22
  .TP
30
- \fBronin-repo remove repo\fR
23
+ \fBronin\-repo remove repo\fR
31
24
  Removes the repository with with the name \fBrepo\fR\.
32
- .LP
33
25
  .SH ENVIRONMENT
34
- .LP
35
26
  .TP
36
27
  \fIHOME\fP
37
28
  Specifies the home directory of the user\. Ronin will search for the
38
- \fB~/.cache/ronin-repos\fR cache directory within the home directory\.
39
- .LP
29
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR cache directory within the home directory\.
40
30
  .TP
41
31
  \fIXDG\[ru]CACHE\[ru]HOME\fP
42
- Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
43
- .LP
32
+ Specifies the cache directory to use\. Defaults to \fB\[Do]HOME\[sl]\.cache\fR\.
44
33
  .SH FILES
45
- .LP
46
34
  .TP
47
- \fB~/.cache/ronin-repos/\fR
35
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fR
48
36
  Installation directory for all repositories\.
49
- .LP
50
37
  .SH AUTHOR
51
- .LP
52
38
  .PP
53
39
  Postmodern
54
40
  .MT postmodern\.mod3\[at]gmail\.com
55
41
  .ME
56
- .LP
57
42
  .SH SEE ALSO
58
- .LP
59
43
  .PP
60
- ronin\-repos(1), ronin\-repos\-install(1) ronin\-repos\-list(1) ronin\-repos\-update(1) ronin\-repos\-purge(1)
44
+ .BR ronin\-repos (1)
45
+ .BR ronin\-repos\-install (1)
46
+ .BR ronin\-repos\-list (1)
47
+ .BR ronin\-repos\-update (1)
48
+ .BR ronin\-repos\-purge (1)
data/man/ronin-repos-remove.1.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # ronin-repos-remove 1 "2023-02-01" Ronin Repos "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-repos-remove - Deletes a repository from the cache directory
6
+
3
7
  ## SYNOPSIS
4
8
 
5
9
  `ronin-repos remove` [*options*] *REPO*
@@ -11,31 +15,31 @@ Removes a repository.
11
15
  ## ARGUMENTS
12
16
 
13
17
  *REPO*
14
- The name of the repository to remove.
18
+ : The name of the repository to remove.
15
19
 
16
20
  ## OPTIONS
17
21
 
18
22
  `-h`, `--help`
19
- Prints help information.
23
+ : Prints help information.
20
24
 
21
25
  ## EXAMPLES
22
26
 
23
27
  `ronin-repo remove repo`
24
- Removes the repository with with the name `repo`.
28
+ : Removes the repository with with the name `repo`.
25
29
 
26
30
  ## ENVIRONMENT
27
31
 
28
32
  *HOME*
29
- Specifies the home directory of the user. Ronin will search for the
30
- `~/.cache/ronin-repos` cache directory within the home directory.
33
+ : Specifies the home directory of the user. Ronin will search for the
34
+ `~/.cache/ronin-repos` cache directory within the home directory.
31
35
 
32
36
  *XDG_CACHE_HOME*
33
- Specifies the cache directory to use. Defaults to `$HOME/.cache`.
37
+ : Specifies the cache directory to use. Defaults to `$HOME/.cache`.
34
38
 
35
39
  ## FILES
36
40
 
37
41
  `~/.cache/ronin-repos/`
38
- Installation directory for all repositories.
42
+ : Installation directory for all repositories.
39
43
 
40
44
  ## AUTHOR
41
45
 
@@ -43,4 +47,4 @@ Postmodern <postmodern.mod3@gmail.com>
43
47
 
44
48
  ## SEE ALSO
45
49
 
46
- ronin-repos(1), ronin-repos-install(1) ronin-repos-list(1) ronin-repos-update(1) ronin-repos-purge(1)
50
+ [ronin-repos](ronin-repos.1.md) [ronin-repos-install](ronin-repos-install.1.md) [ronin-repos-list](ronin-repos-list.1.md) [ronin-repos-update](ronin-repos-update.1.md) [ronin-repos-purge](ronin-repos-purge.1.md)
data/man/ronin-repos-show.1 ADDED
@@ -0,0 +1,48 @@
1
+ .\" Generated by kramdown-man 1.0.1
2
+ .\" https://github.com/postmodern/kramdown-man#readme
3
+ .TH ronin-repos-show 1 "2023-02-01" Ronin Repos "User Manuals"
4
+ .SH NAME
5
+ .PP
6
+ ronin\-repos\-show \- Prints information about a repository in the cache directory
7
+ .SH SYNOPSIS
8
+ .PP
9
+ \fBronin\-repos show\fR \[lB]\fIoptions\fP\[rB] \fINAME\fP
10
+ .SH DESCRIPTION
11
+ .PP
12
+ Prints information about a specific repository in the cache directory\.
13
+ .SH ARGUMENTS
14
+ .TP
15
+ \fINAME\fP
16
+ The repository name to print information about\.
17
+ .SH OPTIONS
18
+ .TP
19
+ \fB\-C\fR, \fB\-\-cache\-dir\fR \fIDIR\fP
20
+ Overrides the default cache directory\.
21
+ .TP
22
+ \fB\-h\fR, \fB\-\-help\fR
23
+ Prints help information\.
24
+ .SH ENVIRONMENT
25
+ .TP
26
+ \fIHOME\fP
27
+ Specifies the home directory of the user\. Ronin will search for the
28
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR cache directory within the home directory\.
29
+ .TP
30
+ \fIXDG\[ru]CACHE\[ru]HOME\fP
31
+ Specifies the cache directory to use\. Defaults to \fB\[Do]HOME\[sl]\.cache\fR\.
32
+ .SH FILES
33
+ .TP
34
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR
35
+ Installation directory for repositories\.
36
+ .SH AUTHOR
37
+ .PP
38
+ Postmodern
39
+ .MT postmodern\.mod3\[at]gmail\.com
40
+ .ME
41
+ .SH SEE ALSO
42
+ .PP
43
+ .BR ronin\-repos (1)
44
+ .BR ronin\-repos\-list (1)
45
+ .BR ronin\-repos\-install (1)
46
+ .BR ronin\-repos\-remove (1)
47
+ .BR ronin\-repos\-update (1)
48
+ .BR ronin\-repos\-purge (1)
data/man/ronin-repos-show.1.md ADDED
@@ -0,0 +1,48 @@
1
+ # ronin-repos-show 1 "2023-02-01" Ronin Repos "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-repos-show - Prints information about a repository in the cache directory
6
+
7
+ ## SYNOPSIS
8
+
9
+ `ronin-repos show` [*options*] *NAME*
10
+
11
+ ## DESCRIPTION
12
+
13
+ Prints information about a specific repository in the cache directory.
14
+
15
+ ## ARGUMENTS
16
+
17
+ *NAME*
18
+ : The repository name to print information about.
19
+
20
+ ## OPTIONS
21
+
22
+ `-C`, `--cache-dir` *DIR*
23
+ : Overrides the default cache directory.
24
+
25
+ `-h`, `--help`
26
+ : Prints help information.
27
+
28
+ ## ENVIRONMENT
29
+
30
+ *HOME*
31
+ : Specifies the home directory of the user. Ronin will search for the
32
+ `~/.cache/ronin-repos` cache directory within the home directory.
33
+
34
+ *XDG_CACHE_HOME*
35
+ : Specifies the cache directory to use. Defaults to `$HOME/.cache`.
36
+
37
+ ## FILES
38
+
39
+ `~/.cache/ronin-repos`
40
+ : Installation directory for repositories.
41
+
42
+ ## AUTHOR
43
+
44
+ Postmodern <postmodern.mod3@gmail.com>
45
+
46
+ ## SEE ALSO
47
+
48
+ [ronin-repos](ronin-repos.1.md) [ronin-repos-list](ronin-repos-list.1.md) [ronin-repos-install](ronin-repos-install.1.md) [ronin-repos-remove](ronin-repos-remove.1.md) [ronin-repos-update](ronin-repos-update.1.md) [ronin-repos-purge](ronin-repos-purge.1.md)
data/man/ronin-repos-update.1 CHANGED
@@ -1,68 +1,54 @@
1
- .\" Generated by kramdown-man 0.1.8
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
3
  .TH ronin-repos-update 1 "2023-02-01" Ronin Repos "User Manuals"
4
- .LP
4
+ .SH NAME
5
+ .PP
6
+ ronin\-repos\-update \- Updates all or one repository from the cache directory
5
7
  .SH SYNOPSIS
6
- .LP
7
- .HP
8
- \fBronin-repos update\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIREPO\fP\[rB]
9
- .LP
8
+ .PP
9
+ \fBronin\-repos update\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIREPO\fP\[rB]
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
12
  Updates all repositories or just one\.
14
- .LP
15
13
  .SH ARGUMENTS
16
- .LP
17
14
  .TP
18
15
  \fIREPO\fP
19
16
  The optional repository name to only update\.
20
- .LP
21
17
  .SH OPTIONS
22
- .LP
23
18
  .TP
24
- \fB-C\fR, \fB--cache-dir\fR \fIDIR\fP
19
+ \fB\-C\fR, \fB\-\-cache\-dir\fR \fIDIR\fP
25
20
  Overrides the default cache directory\.
26
- .LP
27
21
  .TP
28
- \fB-h\fR, \fB--help\fR
22
+ \fB\-h\fR, \fB\-\-help\fR
29
23
  Prints help information\.
30
- .LP
31
24
  .SH EXAMPLES
32
- .LP
33
25
  .TP
34
- \fBronin-repos update\fR
26
+ \fBronin\-repos update\fR
35
27
  Updates all installed repositories\.
36
- .LP
37
28
  .TP
38
29
  \fBronin update repo\fR
39
30
  Updates the specific repository named \fBrepo\fR\.
40
- .LP
41
31
  .SH ENVIRONMENT
42
- .LP
43
32
  .TP
44
33
  \fIHOME\fP
45
34
  Specifies the home directory of the user\. Ronin will search for the
46
- \fB~/.cache/ronin-repos\fR cache directory within the home directory\.
47
- .LP
35
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR cache directory within the home directory\.
48
36
  .TP
49
37
  \fIXDG\[ru]CACHE\[ru]HOME\fP
50
- Specifies the cache directory to use\. Defaults to \fB$HOME/.cache\fR\.
51
- .LP
38
+ Specifies the cache directory to use\. Defaults to \fB\[Do]HOME\[sl]\.cache\fR\.
52
39
  .SH FILES
53
- .LP
54
40
  .TP
55
- \fB~/.cache/ronin-repos/\fR
41
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fR
56
42
  Installation directory for all repositories\.
57
- .LP
58
43
  .SH AUTHOR
59
- .LP
60
44
  .PP
61
45
  Postmodern
62
46
  .MT postmodern\.mod3\[at]gmail\.com
63
47
  .ME
64
- .LP
65
48
  .SH SEE ALSO
66
- .LP
67
49
  .PP
68
- ronin\-repos(1) ronin\-repos\-repos\-install(1) ronin\-repos\-list(1) ronin\-repos\-remove(1) ronin\-repos\-purge(1)
50
+ .BR ronin\-repos (1)
51
+ .BR ronin\-repos\-repos\-install (1)
52
+ .BR ronin\-repos\-list (1)
53
+ .BR ronin\-repos\-remove (1)
54
+ .BR ronin\-repos\-purge (1)
data/man/ronin-repos-update.1.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # ronin-repos-update 1 "2023-02-01" Ronin Repos "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-repos-update - Updates all or one repository from the cache directory
6
+
3
7
  ## SYNOPSIS
4
8
 
5
9
  `ronin-repos update` [*options*] [*REPO*]
@@ -11,37 +15,37 @@ Updates all repositories or just one.
11
15
  ## ARGUMENTS
12
16
 
13
17
  *REPO*
14
- The optional repository name to only update.
18
+ : The optional repository name to only update.
15
19
 
16
20
  ## OPTIONS
17
21
 
18
22
  `-C`, `--cache-dir` *DIR*
19
- Overrides the default cache directory.
23
+ : Overrides the default cache directory.
20
24
 
21
25
  `-h`, `--help`
22
- Prints help information.
26
+ : Prints help information.
23
27
 
24
28
  ## EXAMPLES
25
29
 
26
30
  `ronin-repos update`
27
- Updates all installed repositories.
31
+ : Updates all installed repositories.
28
32
 
29
33
  `ronin update repo`
30
- Updates the specific repository named `repo`.
34
+ : Updates the specific repository named `repo`.
31
35
 
32
36
  ## ENVIRONMENT
33
37
 
34
38
  *HOME*
35
- Specifies the home directory of the user. Ronin will search for the
36
- `~/.cache/ronin-repos` cache directory within the home directory.
39
+ : Specifies the home directory of the user. Ronin will search for the
40
+ `~/.cache/ronin-repos` cache directory within the home directory.
37
41
 
38
42
  *XDG_CACHE_HOME*
39
- Specifies the cache directory to use. Defaults to `$HOME/.cache`.
43
+ : Specifies the cache directory to use. Defaults to `$HOME/.cache`.
40
44
 
41
45
  ## FILES
42
46
 
43
47
  `~/.cache/ronin-repos/`
44
- Installation directory for all repositories.
48
+ : Installation directory for all repositories.
45
49
 
46
50
  ## AUTHOR
47
51
 
@@ -49,4 +53,4 @@ Postmodern <postmodern.mod3@gmail.com>
49
53
 
50
54
  ## SEE ALSO
51
55
 
52
- ronin-repos(1) ronin-repos-repos-install(1) ronin-repos-list(1) ronin-repos-remove(1) ronin-repos-purge(1)
56
+ [ronin-repos](ronin-repos.1.md) [ronin-repos-repos-install](ronin-repos-repos-install.1.md) [ronin-repos-list](ronin-repos-list.1.md) [ronin-repos-remove](ronin-repos-remove.1.md) [ronin-repos-purge](ronin-repos-purge.1.md)