Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

man

Generate Unix man pages from scuv’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 scuv.1 to stdout
scuv man

# Preview with `man -l`
scuv man | man -l -

# Write scuv.1 + scuv-<sub>.1 (one per subcommand) into a directory
scuv man /tmp/scuv-man

Arguments

ArgumentDescription
[DIR]Write scuv.1 + scuv-<sub>.1 files into this directory. Omit to print the top-level page to stdout.

Options

OptionDescription
--jsonOutput as JSON; requires DIR (without it, clap rejects the call with exit 2)

Packager usage

Distro packagers can wire this into their build recipe:

# In your build script
mkdir -p $PKG_DIR/usr/share/man/man1
./scuv 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 from clap::Command)