ronin-repos 0.1.0 → 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 (52) hide show
  1. checksums.yaml +4 -4
  2. data/.document +0 -1
  3. data/.github/workflows/ruby.yml +16 -1
  4. data/.gitignore +1 -0
  5. data/.rubocop.yml +21 -0
  6. data/ChangeLog.md +28 -1
  7. data/Gemfile +11 -5
  8. data/README.md +19 -5
  9. data/Rakefile +12 -2
  10. data/bin/ronin-repos +6 -7
  11. data/data/completions/ronin-repos +139 -0
  12. data/data/completions/ronin-repos.yml +10 -0
  13. data/data/templates/repo/README.md.erb +1 -1
  14. data/gemspec.yml +11 -2
  15. data/lib/ronin/repos/cache_dir.rb +6 -7
  16. data/lib/ronin/repos/class_dir.rb +21 -14
  17. data/lib/ronin/repos/cli/command.rb +5 -3
  18. data/lib/ronin/repos/cli/commands/completion.rb +61 -0
  19. data/lib/ronin/repos/cli/commands/install.rb +7 -3
  20. data/lib/ronin/repos/cli/commands/list.rb +15 -18
  21. data/lib/ronin/repos/cli/commands/new.rb +7 -3
  22. data/lib/ronin/repos/cli/commands/purge.rb +17 -2
  23. data/lib/ronin/repos/cli/commands/remove.rb +1 -1
  24. data/lib/ronin/repos/cli/commands/show.rb +93 -0
  25. data/lib/ronin/repos/cli/commands/update.rb +2 -2
  26. data/lib/ronin/repos/cli.rb +5 -4
  27. data/lib/ronin/repos/exceptions.rb +4 -4
  28. data/lib/ronin/repos/repository.rb +33 -4
  29. data/lib/ronin/repos/root.rb +1 -1
  30. data/lib/ronin/repos/version.rb +2 -2
  31. data/lib/ronin/repos.rb +19 -5
  32. data/man/ronin-repos-completion.1 +76 -0
  33. data/man/ronin-repos-completion.1.md +78 -0
  34. data/man/ronin-repos-install.1 +27 -37
  35. data/man/ronin-repos-install.1.md +22 -15
  36. data/man/ronin-repos-list.1 +27 -33
  37. data/man/ronin-repos-list.1.md +22 -15
  38. data/man/ronin-repos-new.1 +17 -18
  39. data/man/ronin-repos-new.1.md +34 -0
  40. data/man/ronin-repos-purge.1 +26 -33
  41. data/man/ronin-repos-purge.1.md +20 -13
  42. data/man/ronin-repos-remove.1 +23 -35
  43. data/man/ronin-repos-remove.1.md +18 -14
  44. data/man/ronin-repos-show.1 +48 -0
  45. data/man/ronin-repos-show.1.md +48 -0
  46. data/man/ronin-repos-update.1 +26 -36
  47. data/man/ronin-repos-update.1.md +22 -15
  48. data/man/ronin-repos.1 +43 -31
  49. data/man/ronin-repos.1.md +35 -11
  50. data/ronin-repos.gemspec +4 -3
  51. data/scripts/setup +58 -0
  52. metadata +19 -7
data/man/ronin-repos-completion.1.md ADDED
@@ -0,0 +1,78 @@
1
+ # ronin-repos-completion 1 "2024-01-01" Ronin Repos "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-repos-completion - Manages shell completion rules for `ronin-repos`
6
+
7
+ ## SYNOPSIS
8
+
9
+ `ronin-repos completion` [*options*]
10
+
11
+ ## DESCRIPTION
12
+
13
+ The `ronin-repos completion` command can print, install, or uninstall shell
14
+ completion rules for the `ronin-repos` 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-repos` 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-repos completion --print`
67
+ : Prints the shell completion rules instead of installing them.
68
+
69
+ `ronin-repos completion --install`
70
+ : Installs the shell completion rules for `ronin-repos`.
71
+
72
+ `ronin-repos completion --uninstall`
73
+ : Uninstalls the shell completion rules for `ronin-repos`.
74
+
75
+ ## AUTHOR
76
+
77
+ Postmodern <postmodern.mod3@gmail.com>
78
+
data/man/ronin-repos-install.1 CHANGED
@@ -1,64 +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
- .TH ronin-repos-install 1 "2022-01-01" Ronin Repos "User Manuals"
4
- .LP
3
+ .TH ronin-repos-install 1 "2023-02-01" Ronin Repos "User Manuals"
4
+ .SH NAME
5
+ .PP
6
+ ronin\-repos\-install \- Installs a git repository into the cache directory
5
7
  .SH SYNOPSIS
6
- .LP
7
- .HP
8
- \fBronin-repos install\fR \[lB]\fIoptions\fP\[rB] \fIURI\fP
9
- .LP
8
+ .PP
9
+ \fBronin\-repos install\fR \[lB]\fIoptions\fP\[rB] \fIURI\fP
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
12
  Downloads a repository\.
14
- .LP
15
13
  .SH ARGUMENTS
16
- .LP
17
14
  .TP
18
15
  \fIURI\fP
19
16
  The URI to the git repository\.
20
- .LP
21
17
  .SH OPTIONS
22
- .LP
23
18
  .TP
24
- \fB-h\fR, \fB--help\fR
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
25
23
  Prints help information\.
26
- .LP
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\.
27
32
  .SH FILES
28
- .LP
29
33
  .TP
30
- \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fP
34
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fR
31
35
  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
36
  .SH EXAMPLES
45
- .LP
46
37
  .TP
47
- \fBronin-repos install https://github.com/user/repo.git\fR
38
+ \fBronin\-repos install https:\[sl]\[sl]github\.com\[sl]user\[sl]repo\.git\fR
48
39
  Installs a public repository over HTTPS\.
49
- .LP
50
40
  .TP
51
- \fBronin-repos install git@example.com:/home/secret/repo\fR
41
+ \fBronin\-repos install git\[at]example\.com:\[sl]home\[sl]secret\[sl]repo\fR
52
42
  Installs a private repository over SSH\.
53
- .LP
54
43
  .SH AUTHOR
55
- .LP
56
44
  .PP
57
45
  Postmodern
58
46
  .MT postmodern\.mod3\[at]gmail\.com
59
47
  .ME
60
- .LP
61
48
  .SH SEE ALSO
62
- .LP
63
49
  .PP
64
- ronin\-repos(1) ronin\-repos\-list(1) ronin\-repos\-remove(1) ronin\-repos\-update(1) ronin\-repos\-purge(1)
50
+ .BR ronin\-repos (1)
51
+ .BR ronin\-repos\-list (1)
52
+ .BR ronin\-repos\-remove (1)
53
+ .BR ronin\-repos\-update (1)
54
+ .BR ronin\-repos\-purge (1)
data/man/ronin-repos-install.1.md CHANGED
@@ -1,4 +1,8 @@
1
- # ronin-repos-install 1 "2022-01-01" Ronin Repos "User Manuals"
1
+ # ronin-repos-install 1 "2023-02-01" Ronin Repos "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-repos-install - Installs a git repository into the cache directory
2
6
 
3
7
  ## SYNOPSIS
4
8
 
@@ -11,34 +15,37 @@ Downloads a repository.
11
15
  ## ARGUMENTS
12
16
 
13
17
  *URI*
14
- The URI to the git repository.
18
+ : The URI to the git repository.
15
19
 
16
20
  ## OPTIONS
17
21
 
22
+ `-C`, `--cache-dir` *DIR*
23
+ : Overrides the default cache directory.
24
+
18
25
  `-h`, `--help`
19
- Prints help information.
26
+ : Prints help information.
20
27
 
21
- ## FILES
28
+ ## ENVIRONMENT
22
29
 
23
- *~/.cache/ronin-repos/*
24
- Installation directory for all repositories.
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.
25
33
 
26
- ## ENVIRONMENT
34
+ *XDG_CACHE_HOME*
35
+ : Specifies the cache directory to use. Defaults to `$HOME/.cache`.
27
36
 
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.
37
+ ## FILES
31
38
 
32
- XDG_CACHE_HOME
33
- Specifies the cache directory to use. Defaults to *$HOME/.cache*.
39
+ `~/.cache/ronin-repos/`
40
+ : Installation directory for all repositories.
34
41
 
35
42
  ## EXAMPLES
36
43
 
37
44
  `ronin-repos install https://github.com/user/repo.git`
38
- Installs a public repository over HTTPS.
45
+ : Installs a public repository over HTTPS.
39
46
 
40
47
  `ronin-repos install git@example.com:/home/secret/repo`
41
- Installs a private repository over SSH.
48
+ : Installs a private repository over SSH.
42
49
 
43
50
  ## AUTHOR
44
51
 
@@ -46,4 +53,4 @@ Postmodern <postmodern.mod3@gmail.com>
46
53
 
47
54
  ## SEE ALSO
48
55
 
49
- ronin-repos(1) ronin-repos-list(1) ronin-repos-remove(1) ronin-repos-update(1) ronin-repos-purge(1)
56
+ [ronin-repos](ronin-repos.1.md) [ronin-repos-list](ronin-repos-list.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-list.1 CHANGED
@@ -1,54 +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
- .TH ronin-repos-list 1 "2022-01-01" Ronin Repos "User Manuals"
4
- .LP
3
+ .TH ronin-repos-list 1 "2023-02-01" Ronin Repos "User Manuals"
4
+ .SH NAME
5
+ .PP
6
+ ronin\-repos\-list \- Lists all repositories in the cache directory
5
7
  .SH SYNOPSIS
6
- .LP
7
- .HP
8
- \fBronin-repos list\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIREPO\fP\[rB]
9
- .LP
8
+ .PP
9
+ \fBronin\-repos list\fR \[lB]\fIoptions\fP\[rB] \[lB]\fINAME\fP\[rB]
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
12
  Lists all downloaded repositories\.
14
- .LP
15
13
  .SH ARGUMENTS
16
- .LP
17
14
  .TP
18
- \fIREPO\fP
15
+ \fINAME\fP
19
16
  The optional repository name to only list\.
20
- .LP
21
17
  .SH OPTIONS
22
- .LP
23
18
  .TP
24
- \fB-h\fR, \fB--help\fR
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
25
23
  Prints help information\.
26
- .LP
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\.
27
32
  .SH FILES
28
- .LP
29
33
  .TP
30
- \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\fP
34
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR
31
35
  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
36
  .SH AUTHOR
45
- .LP
46
37
  .PP
47
38
  Postmodern
48
39
  .MT postmodern\.mod3\[at]gmail\.com
49
40
  .ME
50
- .LP
51
41
  .SH SEE ALSO
52
- .LP
53
42
  .PP
54
- ronin\-repos(1) ronin\-repos\-install(1) ronin\-repos\-remove(1) ronin\-repos\-update(1) ronin\-repos\-purge(1)
43
+ .BR ronin\-repos (1)
44
+ .BR ronin\-repos\-install (1)
45
+ .BR ronin\-repos\-remove (1)
46
+ .BR ronin\-repos\-show (1)
47
+ .BR ronin\-repos\-update (1)
48
+ .BR ronin\-repos\-purge (1)
data/man/ronin-repos-list.1.md CHANGED
@@ -1,8 +1,12 @@
1
- # ronin-repos-list 1 "2022-01-01" Ronin Repos "User Manuals"
1
+ # ronin-repos-list 1 "2023-02-01" Ronin Repos "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-repos-list - Lists all repositories in the cache directory
2
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,27 +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
 
22
+ `-C`, `--cache-dir` *DIR*
23
+ : Overrides the default cache directory.
24
+
18
25
  `-h`, `--help`
19
- Prints help information.
26
+ : Prints help information.
20
27
 
21
- ## FILES
28
+ ## ENVIRONMENT
22
29
 
23
- *~/.cache/ronin-repos*
24
- Installation directory for repositories.
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.
25
33
 
26
- ## ENVIRONMENT
34
+ *XDG_CACHE_HOME*
35
+ : Specifies the cache directory to use. Defaults to `$HOME/.cache`.
27
36
 
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.
37
+ ## FILES
31
38
 
32
- XDG_CACHE_HOME
33
- Specifies the cache directory to use. Defaults to *$HOME/.cache*.
39
+ `~/.cache/ronin-repos`
40
+ : Installation directory for repositories.
34
41
 
35
42
  ## AUTHOR
36
43
 
@@ -38,4 +45,4 @@ Postmodern <postmodern.mod3@gmail.com>
38
45
 
39
46
  ## SEE ALSO
40
47
 
41
- 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,37 +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
- .TH ronin-repos-new 1 "2022-01-01" Ronin Repos "User Manuals"
4
- .LP
3
+ .TH ronin-repos-new 1 "2023-02-01" Ronin Repos "User Manuals"
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-h\fR, \fB--help\fR
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
25
23
  Prints help information\.
26
- .LP
27
24
  .SH AUTHOR
28
- .LP
29
25
  .PP
30
26
  Postmodern
31
27
  .MT postmodern\.mod3\[at]gmail\.com
32
28
  .ME
33
- .LP
34
29
  .SH SEE ALSO
35
- .LP
36
30
  .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)
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 ADDED
@@ -0,0 +1,34 @@
1
+ # ronin-repos-new 1 "2023-02-01" Ronin Repos "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-repos-new - Creates a new git repository
6
+
7
+ ## SYNOPSIS
8
+
9
+ `ronin-repos new` [*options*] *PATH*
10
+
11
+ ## DESCRIPTION
12
+
13
+ Generates a new git repository.
14
+
15
+ ## ARGUMENTS
16
+
17
+ *PATH*
18
+ : The path to the new git repository directory.
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
+ ## AUTHOR
29
+
30
+ Postmodern <postmodern.mod3@gmail.com>
31
+
32
+ ## SEE ALSO
33
+
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,54 +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
- .TH ronin-repos-purge 1 "2022-01-01" Ronin Repos "User Manuals"
4
- .LP
3
+ .TH ronin-repos-purge 1 "2023-02-01" Ronin Repos "User Manuals"
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-h\fR, \fB--help\fR
15
+ \fB\-C\fR, \fB\-\-cache\-dir\fR \fIDIR\fP
16
+ Overrides the default cache directory\.
17
+ .TP
18
+ \fB\-h\fR, \fB\-\-help\fR
19
19
  Prints help information\.
20
- .LP
21
20
  .SH EXAMPLES
22
- .LP
23
21
  .TP
24
- \fBronin-repo purge\fR
22
+ \fBronin\-repo purge\fR
25
23
  Removes all installed repositories\.
26
- .LP
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\.
27
32
  .SH FILES
28
- .LP
29
33
  .TP
30
- \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fP
34
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fR
31
35
  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
36
  .SH AUTHOR
45
- .LP
46
37
  .PP
47
38
  Postmodern
48
39
  .MT postmodern\.mod3\[at]gmail\.com
49
40
  .ME
50
- .LP
51
41
  .SH SEE ALSO
52
- .LP
53
42
  .PP
54
- 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,4 +1,8 @@
1
- # ronin-repos-purge 1 "2022-01-01" Ronin Repos "User Manuals"
1
+ # ronin-repos-purge 1 "2023-02-01" Ronin Repos "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-repos-purge - Removes all git repository from the cache directory
2
6
 
3
7
  ## SYNOPSIS
4
8
 
@@ -10,27 +14,30 @@ Removes all installed repositories.
10
14
 
11
15
  ## OPTIONS
12
16
 
17
+ `-C`, `--cache-dir` *DIR*
18
+ : Overrides the default cache directory.
19
+
13
20
  `-h`, `--help`
14
- Prints help information.
21
+ : Prints help information.
15
22
 
16
23
  ## EXAMPLES
17
24
 
18
25
  `ronin-repo purge`
19
- Removes all installed repositories.
26
+ : Removes all installed repositories.
20
27
 
21
- ## FILES
28
+ ## ENVIRONMENT
22
29
 
23
- *~/.cache/ronin-repos/*
24
- Installation directory for all repositories.
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.
25
33
 
26
- ## ENVIRONMENT
34
+ *XDG_CACHE_HOME*
35
+ : Specifies the cache directory to use. Defaults to `$HOME/.cache`.
27
36
 
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.
37
+ ## FILES
31
38
 
32
- XDG_CACHE_HOME
33
- Specifies the cache directory to use. Defaults to *$HOME/.cache*.
39
+ `~/.cache/ronin-repos/`
40
+ : Installation directory for all repositories.
34
41
 
35
42
  ## AUTHOR
36
43
 
@@ -38,4 +45,4 @@ Postmodern <postmodern.mod3@gmail.com>
38
45
 
39
46
  ## SEE ALSO
40
47
 
41
- 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
- .TH ronin-repos-remove 1 "2022-01-01" Ronin Repos "User Manuals"
4
- .LP
3
+ .TH ronin-repos-remove 1 "2023-02-01" Ronin Repos "User Manuals"
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
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\-repos\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
33
  .SH FILES
34
- .LP
35
34
  .TP
36
- \fI\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fP
35
+ \fB\[ti]\[sl]\.cache\[sl]ronin\-repos\[sl]\fR
37
36
  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
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)