Skip to main content

Module docs

Module docs 

Source
Expand description

Man pages and shell completions, generated from the clap commands the tools actually parse with, so the documentation cannot describe a flag a program does not take.

Written into a share/ directory in the layout every tarball in the family uses, which is also where Homebrew links them from:

share/man/man8/mkfs.<fs>.8             section 8: mkfs.* and fsck.*
share/man/man1/fs.<fs>.1               section 1: everything else,
share/man/man1/<repo>.1                  the repository entry point too
share/zsh/site-functions/_<name>
share/bash-completion/completions/<name>
share/fish/vendor_completions.d/<name>.fish

One page and one completion per name, the repository’s included, and a page per subcommand (fs.<fs>-ls.1, rust-fs-<fs>-doctor.1).

Enums§

Shell
The shells completion_path knows, from the generator itself. Deprecated, see aot::Shell Shell with auto-generated completion script available.

Constants§

SHELLS
The shells completions are written for.

Functions§

completion_path
Where each shell’s completion for name goes under share/.
completions
Write zsh, bash and fish completions per name. Returns the paths written.
man_pages
Write a man page per name under share/man/man<section>/, and one per subcommand beside it (fs.<fs>-ls.1), which is what the parent page’s SUBCOMMANDS list refers to. Returns the paths written.