new: added man page generator

Cargo.toml

@@ -4,7 +4,7 @@ members = [".", "crate/encstr"]
 [workspace.package]
 repository = "https://github.com/pamburus/hl"
 authors = ["Pavel Ivanov <mr.pavel.ivanov@gmail.com>"]
-version = "0.29.5-alpha.1"
+version = "0.29.5-alpha.2"
 edition = "2021"
 license = "MIT"
 
@@ -41,6 +41,7 @@ chrono = { version = "0.4", default-features = false, features = [
 chrono-tz = { version = "0", features = ["serde"] }
 clap = { version = "4", features = ["wrap_help", "derive", "env", "string"] }
 clap_complete = "4"
+clap_mangen = "0"
 closure = "0"
 collection_macros = "0"
 config = "0"

Makefile

@@ -22,11 +22,22 @@ build-release: contrib-build
 	@cargo build --release --locked
 .PHONY: build-release
 
-## Install binary
-install: contrib-build
+## Install binary and man pages
+install: contrib-build install-man-pages
 	@cargo install --path . --locked
 .PHONY: install
 
+## Install man pages
+install-man-pages: ~/share/man/man1/hl.1
+	@echo $$(tput setaf 3)NOTE:$$(tput sgr0) ensure $$(tput setaf 2)~/share/man$$(tput sgr0) is added to $$(tput setaf 2)MANPATH$$(tput sgr0) environment variable
+.PHONY: install-man-pages
+
+~/share/man/man1/hl.1: contrib-build | ~/share/man/man1
+	@HL_CONFIG= cargo run --release --locked -- --man-page >$@
+
+~/share/man/man1:
+	@mkdir -p $@
+
 ## Install versioned binary
 install-versioned: contrib-build
 	@cargo install --path . --locked

README.md

@@ -513,6 +513,7 @@ Advanced Options:
       --max-message-size <SIZE>     Maximum message size [env: HL_MAX_MESSAGE_SIZE=] [default: "64 MiB"]
   -C, --concurrency <N>             Number of processing threads [env: HL_CONCURRENCY=]
       --shell-completions <SHELL>   Print shell auto-completion script and exit [possible values: bash, elvish, fish, powershell, zsh]
+      --man-page                    Print man page and exit
       --list-themes                 Print available themes and exit
       --dump-index                  Print debug index metadata (in --sort mode) and exit
       --debug                       Print debug error messages that can help with troubleshooting

build/ci/coverage.sh

@@ -46,6 +46,7 @@ function test() {
     ${MAIN_EXECUTABLE:?} --config=etc/defaults/config-k8s.yaml > /dev/null
     ${MAIN_EXECUTABLE:?} --config=etc/defaults/config-ecs.yaml > /dev/null
     ${MAIN_EXECUTABLE:?} --shell-completions bash > /dev/null
+    ${MAIN_EXECUTABLE:?} --man-page > /dev/null
     ${MAIN_EXECUTABLE:?} --list-themes > /dev/null
     echo "" | ${MAIN_EXECUTABLE:?} --concurrency 4 > /dev/null
 } 

src/cli.rs

@@ -385,9 +385,18 @@ pub struct Opt {
     pub concurrency: Option<usize>,
 
     /// Print shell auto-completion script and exit.
-    #[arg(long, value_parser = value_parser!(Shell), value_name = "SHELL", help_heading = heading::ADVANCED)]
+    #[arg(
+        long,
+        value_parser = value_parser!(Shell),
+        value_name = "SHELL",
+        help_heading = heading::ADVANCED,
+    )]
     pub shell_completions: Option<Shell>,
 
+    /// Print man page and exit.
+    #[arg(long, help_heading = heading::ADVANCED)]
+    pub man_page: bool,
+
     /// Print available themes and exit.
     #[arg(long, help_heading = heading::ADVANCED)]
     pub list_themes: bool,

src/main.rs

@@ -46,6 +46,12 @@ fn run() -> Result<()> {
         return Ok(());
     }
 
+    if opt.man_page {
+        let man = clap_mangen::Man::new(cli::Opt::command());
+        man.render(&mut stdout())?;
+        return Ok(());
+    }
+
     let color_supported = if stdout().is_terminal() {
         if let Err(err) = hl::enable_ansi_support() {
             eprintln!("failed to enable ansi support: {}", err);