Skip to content

Commit

Permalink
Updated to kramdown-man 1.0.0 (closes #20).
Browse files Browse the repository at this point in the history
  • Loading branch information
postmodern committed Dec 4, 2023
1 parent 721d38d commit 3472b58
Showing 9 changed files with 63 additions and 63 deletions.
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
@@ -22,7 +22,7 @@ group :development do
gem 'simplecov', '~> 0.20'

gem 'kramdown', '~> 2.0'
gem 'kramdown-man', '~> 0.1'
gem 'kramdown-man', '~> 1.0'

gem 'redcarpet', platform: :mri
gem 'yard', '~> 0.9'
20 changes: 10 additions & 10 deletions man/ronin-repos-install.1.md
Original file line number Diff line number Diff line change
@@ -11,42 +11,42 @@ Downloads a repository.
## ARGUMENTS

*URI*
The URI to the git repository.
: The URI to the git repository.

## OPTIONS

`-C`, `--cache-dir` *DIR*
Overrides the default cache directory.
: Overrides the default cache directory.

`-h`, `--help`
Prints help information.
: Prints help information.

## ENVIRONMENT

*HOME*
Specifies the home directory of the user. Ronin will search for the
`~/.cache/ronin-repos` cache directory within the home directory.
: Specifies the home directory of the user. Ronin will search for the
`~/.cache/ronin-repos` cache directory within the home directory.

*XDG_CACHE_HOME*
Specifies the cache directory to use. Defaults to `$HOME/.cache`.
: Specifies the cache directory to use. Defaults to `$HOME/.cache`.

## FILES

`~/.cache/ronin-repos/`
Installation directory for all repositories.
: Installation directory for all repositories.

## EXAMPLES

`ronin-repos install https://github.com/user/repo.git`
Installs a public repository over HTTPS.
: Installs a public repository over HTTPS.

`ronin-repos install git@example.com:/home/secret/repo`
Installs a private repository over SSH.
: Installs a private repository over SSH.

## AUTHOR

Postmodern <postmodern.mod3@gmail.com>

## SEE ALSO

ronin-repos(1) ronin-repos-list(1) ronin-repos-remove(1) ronin-repos-update(1) ronin-repos-purge(1)
[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)
16 changes: 8 additions & 8 deletions man/ronin-repos-list.1.md
Original file line number Diff line number Diff line change
@@ -11,34 +11,34 @@ Lists all downloaded repositories.
## ARGUMENTS

*NAME*
The optional repository name to only list.
: The optional repository name to only list.

## OPTIONS

`-C`, `--cache-dir` *DIR*
Overrides the default cache directory.
: Overrides the default cache directory.

`-h`, `--help`
Prints help information.
: Prints help information.

## ENVIRONMENT

*HOME*
Specifies the home directory of the user. Ronin will search for the
`~/.cache/ronin-repos` cache directory within the home directory.
: Specifies the home directory of the user. Ronin will search for the
`~/.cache/ronin-repos` cache directory within the home directory.

*XDG_CACHE_HOME*
Specifies the cache directory to use. Defaults to `$HOME/.cache`.
: Specifies the cache directory to use. Defaults to `$HOME/.cache`.

## FILES

`~/.cache/ronin-repos`
Installation directory for repositories.
: Installation directory for repositories.

## AUTHOR

Postmodern <postmodern.mod3@gmail.com>

## SEE ALSO

ronin-repos(1) ronin-repos-install(1) ronin-repos-remove(1) ronin-repos-show(1) ronin-repos-update(1) ronin-repos-purge(1)
[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)
8 changes: 4 additions & 4 deletions man/ronin-repos-new.1.md
Original file line number Diff line number Diff line change
@@ -11,20 +11,20 @@ Generates a new git repository.
## ARGUMENTS

*PATH*
The path to the new git repository directory.
: The path to the new git repository directory.

## OPTIONS

`-C`, `--cache-dir` *DIR*
Overrides the default cache directory.
: Overrides the default cache directory.

`-h`, `--help`
Prints help information.
: Prints help information.

## AUTHOR

Postmodern <postmodern.mod3@gmail.com>

## SEE ALSO

ronin-repos(1) ronin-repos-list(1) ronin-repos-install(1) ronin-repos-remove(1) ronin-repos-update(1) ronin-repos-purge(1)
[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)
16 changes: 8 additions & 8 deletions man/ronin-repos-purge.1.md
Original file line number Diff line number Diff line change
@@ -11,34 +11,34 @@ Removes all installed repositories.
## OPTIONS

`-C`, `--cache-dir` *DIR*
Overrides the default cache directory.
: Overrides the default cache directory.

`-h`, `--help`
Prints help information.
: Prints help information.

## EXAMPLES

`ronin-repo purge`
Removes all installed repositories.
: Removes all installed repositories.

## ENVIRONMENT

*HOME*
Specifies the home directory of the user. Ronin will search for the
`~/.cache/ronin-repos` cache directory within the home directory.
: Specifies the home directory of the user. Ronin will search for the
`~/.cache/ronin-repos` cache directory within the home directory.

*XDG_CACHE_HOME*
Specifies the cache directory to use. Defaults to `$HOME/.cache`.
: Specifies the cache directory to use. Defaults to `$HOME/.cache`.

## FILES

`~/.cache/ronin-repos/`
Installation directory for all repositories.
: Installation directory for all repositories.

## AUTHOR

Postmodern <postmodern.mod3@gmail.com>

## SEE ALSO

ronin-repos(1), ronin-repos-install(1) ronin-repos-list(1) ronin-repos-update(1) ronin-repos-purge(1)
[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)
16 changes: 8 additions & 8 deletions man/ronin-repos-remove.1.md
Original file line number Diff line number Diff line change
@@ -11,36 +11,36 @@ Removes a repository.
## ARGUMENTS

*REPO*
The name of the repository to remove.
: The name of the repository to remove.

## OPTIONS

`-h`, `--help`
Prints help information.
: Prints help information.

## EXAMPLES

`ronin-repo remove repo`
Removes the repository with with the name `repo`.
: Removes the repository with with the name `repo`.

## ENVIRONMENT

*HOME*
Specifies the home directory of the user. Ronin will search for the
`~/.cache/ronin-repos` cache directory within the home directory.
: Specifies the home directory of the user. Ronin will search for the
`~/.cache/ronin-repos` cache directory within the home directory.

*XDG_CACHE_HOME*
Specifies the cache directory to use. Defaults to `$HOME/.cache`.
: Specifies the cache directory to use. Defaults to `$HOME/.cache`.

## FILES

`~/.cache/ronin-repos/`
Installation directory for all repositories.
: Installation directory for all repositories.

## AUTHOR

Postmodern <postmodern.mod3@gmail.com>

## SEE ALSO

ronin-repos(1), ronin-repos-install(1) ronin-repos-list(1) ronin-repos-update(1) ronin-repos-purge(1)
[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)
16 changes: 8 additions & 8 deletions man/ronin-repos-show.1.md
Original file line number Diff line number Diff line change
@@ -11,34 +11,34 @@ Prints information about a specific repository in the cache directory.
## ARGUMENTS

*NAME*
The repository name to print information about.
: The repository name to print information about.

## OPTIONS

`-C`, `--cache-dir` *DIR*
Overrides the default cache directory.
: Overrides the default cache directory.

`-h`, `--help`
Prints help information.
: Prints help information.

## ENVIRONMENT

*HOME*
Specifies the home directory of the user. Ronin will search for the
`~/.cache/ronin-repos` cache directory within the home directory.
: Specifies the home directory of the user. Ronin will search for the
`~/.cache/ronin-repos` cache directory within the home directory.

*XDG_CACHE_HOME*
Specifies the cache directory to use. Defaults to `$HOME/.cache`.
: Specifies the cache directory to use. Defaults to `$HOME/.cache`.

## FILES

`~/.cache/ronin-repos`
Installation directory for repositories.
: Installation directory for repositories.

## AUTHOR

Postmodern <postmodern.mod3@gmail.com>

## SEE ALSO

ronin-repos(1) ronin-repos-list(1) ronin-repos-install(1) ronin-repos-remove(1) ronin-repos-update(1) ronin-repos-purge(1)
[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)
20 changes: 10 additions & 10 deletions man/ronin-repos-update.1.md
Original file line number Diff line number Diff line change
@@ -11,42 +11,42 @@ Updates all repositories or just one.
## ARGUMENTS

*REPO*
The optional repository name to only update.
: The optional repository name to only update.

## OPTIONS

`-C`, `--cache-dir` *DIR*
Overrides the default cache directory.
: Overrides the default cache directory.

`-h`, `--help`
Prints help information.
: Prints help information.

## EXAMPLES

`ronin-repos update`
Updates all installed repositories.
: Updates all installed repositories.

`ronin update repo`
Updates the specific repository named `repo`.
: Updates the specific repository named `repo`.

## ENVIRONMENT

*HOME*
Specifies the home directory of the user. Ronin will search for the
`~/.cache/ronin-repos` cache directory within the home directory.
: Specifies the home directory of the user. Ronin will search for the
`~/.cache/ronin-repos` cache directory within the home directory.

*XDG_CACHE_HOME*
Specifies the cache directory to use. Defaults to `$HOME/.cache`.
: Specifies the cache directory to use. Defaults to `$HOME/.cache`.

## FILES

`~/.cache/ronin-repos/`
Installation directory for all repositories.
: Installation directory for all repositories.

## AUTHOR

Postmodern <postmodern.mod3@gmail.com>

## SEE ALSO

ronin-repos(1) ronin-repos-repos-install(1) ronin-repos-list(1) ronin-repos-remove(1) ronin-repos-purge(1)
[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)
12 changes: 6 additions & 6 deletions man/ronin-repos.1.md
Original file line number Diff line number Diff line change
@@ -12,26 +12,26 @@ and use any git repository containing Ruby code or other data.
## OPTIONS

`-h`, `--help`
Prints help information.
: Prints help information.

## ENVIRONMENT

*HOME*
Specifies the home directory of the user. Ronin will search for the
`~/.cache/ronin-repos` cache directory within the home directory.
: Specifies the home directory of the user. Ronin will search for the
`~/.cache/ronin-repos` cache directory within the home directory.

*XDG_CACHE_HOME*
Specifies the cache directory to use. Defaults to `$HOME/.cache`.
: Specifies the cache directory to use. Defaults to `$HOME/.cache`.

## FILES

`~/.cache/ronin-repos`
Installation directory for repositories.
: Installation directory for repositories.

## AUTHOR

Postmodern <postmodern.mod3@gmail.com>

## SEE ALSO

ronin-repos-install(1) ronin-repos-list(1) ronin-repos-remove(1) ronin-repos-update(1) ronin-repos-purge(1)
[ronin-repos-install](ronin-repos-install.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)

0 comments on commit 3472b58

Please sign in to comment.