man
Generate Unix man pages from scoop’s clap::Command tree. Because they’re rendered from the live CLI definition, the man pages always reflect the actual --help text — no separate documentation to keep in sync.
Usage
# Print the top-level scoop.1 to stdout
scoop man
# Preview with `man -l`
scoop man | man -l -
# Write scoop.1 + scoop-<sub>.1 (one per subcommand) into a directory
scoop man /tmp/scoop-man
Arguments
| Argument | Description |
|---|---|
[DIR] | Write scoop.1 + scoop-<sub>.1 files into this directory. Omit to print the top-level page to stdout. |
Options
| Option | Description |
|---|---|
--json | Output as JSON (only meaningful with DIR) |
Packager usage
Distro packagers can wire this into their build recipe:
# In your build script
mkdir -p $PKG_DIR/usr/share/man/man1
./scoop man $PKG_DIR/usr/share/man/man1
gzip -9 $PKG_DIR/usr/share/man/man1/*.1
Hidden subcommands (activate, deactivate, resolve — internal to the shell wrapper) are intentionally not rendered: they’re not user-facing.
See also
completions— shell completion scripts (also generated fromclap::Command)