manpage
Generate roff-format man pages for xrat and all subcommands.
xrat manpage [--output <dir>]
This is a hidden command (not shown in --help) intended for use during release
packaging and local installation.
Flags
| Flag | Description | Default |
|---|---|---|
--output <dir> | Directory to write generated .1 files | . |
Behavior
Generates one man page per visible command and subcommand:
xrat.1โ root command with global flagsxrat-init.1,xrat-import.1,xrat-daemon.1, โฆ โ top-level subcommandsxrat-daemon-install.1,xrat-daemon-stop.1, โฆ โ nested subcommands
Hidden commands (e.g., daemon run-server) are excluded.
Output format is roff/troff compatible with man(1).
Example
xrat manpage --output /tmp/man
/tmp/man/xrat.1
/tmp/man/xrat-init.1
/tmp/man/xrat-import.1
/tmp/man/xrat-daemon.1
/tmp/man/xrat-daemon-install.1
...
Installing locally
mkdir -p ~/.local/share/man/man1
xrat manpage --output ~/.local/share/man/man1
mandb ~/.local/share/man # update index (may require once)
man xrat
man xrat-daemon-install
Or system-wide:
sudo xrat manpage --output /usr/local/share/man/man1
sudo mandb
Release packaging
CI generates man pages during the release workflow and includes them in release
archives under man/:
xrat manpage --output dist/man/man1/