From 3fbce3d0192593ad3f6dd2dcd7da74686b1fa91e Mon Sep 17 00:00:00 2001 From: "Danilo M." Date: Sun, 5 Jul 2026 20:48:38 +0200 Subject: docs: document man page install and compact --help Co-Authored-By: Claude Opus 4.8 --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index e055848..919618e 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,21 @@ sudo cp mkhint /usr/local/bin/mkhint sudo cp mkhint.bash-completion /etc/bash-completion.d/mkhint ``` +### Man Page + +```bash +sudo cp mkhint.1.gz /usr/local/man/man1/mkhint.1.gz +``` + +The man page is pre-built and committed. To regenerate it from source (requires +pandoc): + +```bash +pandoc mkhint.1.md -s -t man -o mkhint.1 && gzip -9 -n -f mkhint.1 +``` + +`mkhint --help` is a compact summary; the man page holds the full reference. + ### Dependencies - `wget` — for downloading archives and calculating checksums -- cgit v1.2.3