Add --man subcommand (#2041)

Cargo.toml

@@ -15,7 +15,7 @@ repository = "https://github.com/casey/just"
 rust-version = "1.63"
 
 [workspace]
-members = [".", "bin/ref-type", "bin/generate-book", "bin/update-contributors"]
+members = [".", "crates/*"]
 
 [dependencies]
 ansi_term = "0.12.0"
@@ -24,6 +24,7 @@ blake3 = { version = "1.5.0", features = ["rayon", "mmap"] }
 camino = "1.0.4"
 clap = { version = "4.0.0", features = ["env", "wrap_help"] }
 clap_complete = "4.0.0"
+clap_mangen = "0.2.20"
 ctrlc = { version = "3.1.1", features = ["termination"] }
 derivative = "2.0.0"
 dirs = "5.0.1"
@@ -64,13 +65,6 @@ path = "src/main.rs"
 name = "just"
 test = false
 
-[features]
-# No features are active by default.
-default = []
-# The `help4help2man` feature modifies the message produced by `--help`
-# so that `help2man` produces a reasonable man page.
-help4help2man = []
-
 # The public documentation is minimal and doesn't change between
 # platforms, so we only build them for linux on docs.rs to save
 # their build machines some cycles.

README.md

@@ -3158,6 +3158,14 @@ fpath=($HOMEBREW_PREFIX/share/zsh/site-functions $fpath)
 # compinit
 ```
 
+### Man Page
+
+`just` can print its own man page with `just --man`. Man pages are written in
+[`roff`](https://en.wikipedia.org/wiki/Roff_%28software%29), a venerable markup
+language and one of the first practical applications of Unix. If you have
+[`groff`](https://www.gnu.org/software/groff/) installed you can view the man
+page with  `just --man | groff -mandoc -Tascii | less`.
+
 ### Grammar
 
 A non-normative grammar of `justfile`s can be found in

completions/just.bash

@@ -30,7 +30,7 @@ _just() {
 
     case "${cmd}" in
         "$1")
-            opts="-n -f -q -u -v -d -c -e -l -s -E -h -V --check --chooser --color --command-color --yes --dry-run --dump-format --highlight --list-heading --list-prefix --no-aliases --no-deps --no-dotenv --no-highlight --justfile --quiet --set --shell --shell-arg --shell-command --clear-shell-args --unsorted --unstable --verbose --working-directory --changelog --choose --command --completions --dump --edit --evaluate --fmt --init --list --show --summary --variables --dotenv-filename --dotenv-path --help --version [ARGUMENTS]..."
+            opts="-n -f -q -u -v -d -c -e -l -s -E -h -V --check --chooser --color --command-color --yes --dry-run --dump-format --highlight --list-heading --list-prefix --no-aliases --no-deps --no-dotenv --no-highlight --justfile --quiet --set --shell --shell-arg --shell-command --clear-shell-args --unsorted --unstable --verbose --working-directory --changelog --choose --command --completions --dump --edit --evaluate --fmt --init --list --man --show --summary --variables --dotenv-filename --dotenv-path --help --version [ARGUMENTS]..."
                 if [[ ${cur} == -* ]] ; then
                     COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
                     return 0

completions/just.elvish

@@ -66,6 +66,7 @@ set edit:completion:arg-completer[just] = {|@words|
             cand --init 'Initialize new justfile in project root'
             cand -l 'List available recipes and their arguments'
             cand --list 'List available recipes and their arguments'
+            cand --man 'Print man page'
             cand --summary 'List names of available recipes'
             cand --variables 'List names of variables'
             cand -h 'Print help'

completions/just.fish

@@ -73,6 +73,7 @@ complete -c just -l evaluate -d 'Evaluate and print all variables. If a variable
 complete -c just -l fmt -d 'Format and overwrite justfile'
 complete -c just -l init -d 'Initialize new justfile in project root'
 complete -c just -s l -l list -d 'List available recipes and their arguments'
+complete -c just -l man -d 'Print man page'
 complete -c just -l summary -d 'List names of available recipes'
 complete -c just -l variables -d 'List names of variables'
 complete -c just -s h -l help -d 'Print help'

completions/just.powershell

@@ -69,6 +69,7 @@ Register-ArgumentCompleter -Native -CommandName 'just' -ScriptBlock {
             [CompletionResult]::new('--init', 'init', [CompletionResultType]::ParameterName, 'Initialize new justfile in project root')
             [CompletionResult]::new('-l', 'l', [CompletionResultType]::ParameterName, 'List available recipes and their arguments')
             [CompletionResult]::new('--list', 'list', [CompletionResultType]::ParameterName, 'List available recipes and their arguments')
+            [CompletionResult]::new('--man', 'man', [CompletionResultType]::ParameterName, 'Print man page')
             [CompletionResult]::new('--summary', 'summary', [CompletionResultType]::ParameterName, 'List names of available recipes')
             [CompletionResult]::new('--variables', 'variables', [CompletionResultType]::ParameterName, 'List names of variables')
             [CompletionResult]::new('-h', 'h', [CompletionResultType]::ParameterName, 'Print help')

completions/just.zsh

@@ -64,6 +64,7 @@ _just() {
 '--init[Initialize new justfile in project root]' \
 '-l[List available recipes and their arguments]' \
 '--list[List available recipes and their arguments]' \
+'--man[Print man page]' \
 '--summary[List names of available recipes]' \
 '--variables[List names of variables]' \
 '-h[Print help]' \

justfile

@@ -43,13 +43,7 @@ shellcheck:
   shellcheck www/install.sh
 
 man:
-  cargo build --features help4help2man
-  help2man \
-    --name 'save and run commands' \
-    --manual 'Just Manual' \
-    --no-info \
-    target/debug/just \
-    > man/just.1
+  cargo run -- --man > man/just.1
 
 view-man: man
   man man/just.1
@@ -115,10 +109,6 @@ install-dev-deps:
   cargo install cargo-watch
   cargo install mdbook mdbook-linkcheck
 
-# install system development dependencies with homebrew
-install-dev-deps-homebrew:
-  brew install help2man
-
 # everyone's favorite animate paper clip
 clippy:
   cargo clippy --all --all-targets --all-features