Expand description
The manpages, rendered from the sources the docs render from: the clap
definitions, the option, environment and key registries, the format descriptors,
examples.toml and the query and format-spec references.
The pages are rendered by gen_docs write and committed under
crates/datui-cli/man/; the_generated_docs_are_current fails while a committed
page differs. Committed, they need nothing at build time: the
references live outside this crate, which a build from crates.io could not read,
and every package, tarball and datui man takes the same files. The date is the
release’s (release-date.txt, set by scripts/bump_version.py), never the build’s,
so a page is the same however and whenever it is built.
Modules§
- roff
- Roff for the manpages: text escaped as man(7) wants it, and the Markdown of the docs turned into man macros, so a page and its web page share one source.
Structs§
- Page
- One manpage.
Constants§
- PAGES
- Every page, in the order
datui man --listand the docs list them. - RELEASE_
DATE - The date every page carries: the release’s, from
release-date.txt.
Functions§
- find
- The page
querynames:datui-config,config,config.5,keys. A name that two sections share (config) is the command’s, asmanpicks section 1 first. - render_
markdown_ index docs/reference/manual-pages.md’s list: each page, linked to its HTML.
Type Aliases§
- Read
- What a page renders from, beyond this crate: a repository file’s text, by its path from the root.