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>.fishOne 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_pathknows, from the generator itself. Deprecated, seeaot::ShellShell with auto-generated completion script available.
Constants§
- SHELLS
- The shells completions are written for.
Functions§
- completion_
path - Where each shell’s completion for
namegoes undershare/. - 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.