From 3472b584456ebfac48dc72a9edfcc657f3bd7059 Mon Sep 17 00:00:00 2001 From: Postmodern Date: Sun, 3 Dec 2023 20:06:49 -0800 Subject: [PATCH] Updated to `kramdown-man` 1.0.0 (closes #20). --- Gemfile | 2 +- man/ronin-repos-install.1.md | 20 ++++++++++---------- man/ronin-repos-list.1.md | 16 ++++++++-------- man/ronin-repos-new.1.md | 8 ++++---- man/ronin-repos-purge.1.md | 16 ++++++++-------- man/ronin-repos-remove.1.md | 16 ++++++++-------- man/ronin-repos-show.1.md | 16 ++++++++-------- man/ronin-repos-update.1.md | 20 ++++++++++---------- man/ronin-repos.1.md | 12 ++++++------ 9 files changed, 63 insertions(+), 63 deletions(-) diff --git a/Gemfile b/Gemfile index 4fabf00..bc638bd 100644 --- a/Gemfile +++ b/Gemfile @@ -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' diff --git a/man/ronin-repos-install.1.md b/man/ronin-repos-install.1.md index 3be07b2..127e5db 100644 --- a/man/ronin-repos-install.1.md +++ b/man/ronin-repos-install.1.md @@ -11,37 +11,37 @@ 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 @@ -49,4 +49,4 @@ Postmodern ## 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) \ No newline at end of file diff --git a/man/ronin-repos-list.1.md b/man/ronin-repos-list.1.md index 8b4c5a6..87b640f 100644 --- a/man/ronin-repos-list.1.md +++ b/man/ronin-repos-list.1.md @@ -11,29 +11,29 @@ 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 @@ -41,4 +41,4 @@ Postmodern ## 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) \ No newline at end of file diff --git a/man/ronin-repos-new.1.md b/man/ronin-repos-new.1.md index 126a3b1..d33d939 100644 --- a/man/ronin-repos-new.1.md +++ b/man/ronin-repos-new.1.md @@ -11,15 +11,15 @@ 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 @@ -27,4 +27,4 @@ Postmodern ## 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) \ No newline at end of file diff --git a/man/ronin-repos-purge.1.md b/man/ronin-repos-purge.1.md index 0260da7..ec6b48b 100644 --- a/man/ronin-repos-purge.1.md +++ b/man/ronin-repos-purge.1.md @@ -11,29 +11,29 @@ 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 @@ -41,4 +41,4 @@ Postmodern ## 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) \ No newline at end of file diff --git a/man/ronin-repos-remove.1.md b/man/ronin-repos-remove.1.md index ef87f39..657df0e 100644 --- a/man/ronin-repos-remove.1.md +++ b/man/ronin-repos-remove.1.md @@ -11,31 +11,31 @@ 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 @@ -43,4 +43,4 @@ Postmodern ## 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) \ No newline at end of file diff --git a/man/ronin-repos-show.1.md b/man/ronin-repos-show.1.md index deb8d89..82e6944 100644 --- a/man/ronin-repos-show.1.md +++ b/man/ronin-repos-show.1.md @@ -11,29 +11,29 @@ 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 @@ -41,4 +41,4 @@ Postmodern ## 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) \ No newline at end of file diff --git a/man/ronin-repos-update.1.md b/man/ronin-repos-update.1.md index 2656bf2..ccac5fb 100644 --- a/man/ronin-repos-update.1.md +++ b/man/ronin-repos-update.1.md @@ -11,37 +11,37 @@ 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 @@ -49,4 +49,4 @@ Postmodern ## 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) \ No newline at end of file diff --git a/man/ronin-repos.1.md b/man/ronin-repos.1.md index f1d265c..abe7b82 100644 --- a/man/ronin-repos.1.md +++ b/man/ronin-repos.1.md @@ -12,21 +12,21 @@ 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 @@ -34,4 +34,4 @@ Postmodern ## 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) \ No newline at end of file