diff options
| author | Danilo M. <danix@danix.xyz> | 2026-07-05 20:48:38 +0200 |
|---|---|---|
| committer | Danilo M. <danix@danix.xyz> | 2026-07-05 20:48:38 +0200 |
| commit | 3fbce3d0192593ad3f6dd2dcd7da74686b1fa91e (patch) | |
| tree | de464472aa7cd414f1f4d030e7f80d28b83cdf24 /CLAUDE.md | |
| parent | b873c5f2394fed0750c35a239d34ce531d3efcdf (diff) | |
| download | mkhintfile-3fbce3d0192593ad3f6dd2dcd7da74686b1fa91e.tar.gz mkhintfile-3fbce3d0192593ad3f6dd2dcd7da74686b1fa91e.zip | |
docs: document man page install and compact --help
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Diffstat (limited to 'CLAUDE.md')
| -rw-r--r-- | CLAUDE.md | 8 |
1 files changed, 8 insertions, 0 deletions
@@ -169,4 +169,12 @@ When adding new features, add a corresponding test case to `tests/mkhint_test.sh ```bash sudo cp mkhint /usr/local/bin/mkhint sudo cp mkhint.bash-completion /etc/bash-completion.d/mkhint +sudo cp mkhint.1.gz /usr/local/man/man1/mkhint.1.gz ``` + +Man page source is `mkhint.1.md`; the committed `mkhint.1.gz` is rebuilt with +`pandoc mkhint.1.md -s -t man -o mkhint.1 && gzip -9 -n -f mkhint.1`. Option +names are `\--`-escaped in the source so pandoc's man output renders the +double-dash flags. `--help` is a compact summary that points at `man mkhint`; +the full reference (usage examples, configuration, exit codes) lives in the +man page. |