Generate man pages from mdBooks!
To use mdbook-man you'll first need to install it with:
$ cargo install mdbook-man
And add the following to your book.toml
:
[output.man]
The man page will be printed to standard output when running mdbook build
.
This are the available configuration parameters:
[output.man]
output-dir = "/some/path/to/a/directory" # this directory doesn't have to exist, it will be created automatically.
split-chapters = true # By default all chapters will be joined as one single man page,
# to override this set this parameter to true.
filename = "custom-book-filename.man" # override the default filename if the `output-dir` is also specified.
You can check out the Rust Programming Language book compiled as a man page here.
$ wget https://vv9k.github.io/mdbook-man/book.man
$ man -l book.man