docs: update manual pages

This commit is contained in:
Marcus Holland-Moritz 2024-01-19 12:44:38 +01:00
parent f5869ddbf4
commit 0ec3af320e
4 changed files with 25 additions and 1 deletions

View File

@ -149,6 +149,12 @@ options:
monitoring enabled. Available components include `fuse`, `filesystem_v2`
and `inode_reader_v2`.
- `--man`:
If the project was built with support for built-in manual pages, this
option will show the manual page. If supported by the terminal and a
suitable pager (e.g. `less`) is found, the manual page is displayed
in the pager.
There's two particular FUSE options that you'll likely need at some
point, e.g. when trying to set up an `overlayfs` mount on top of
a DwarFS image:

View File

@ -74,9 +74,15 @@ pcmaudio/waveform
Enable logging context regardless of level. By default, context is enabled
if the level is `verbose`, `debug` or `trace`.
- `--help`:
- `-h`, `--help`:
Show program help, including option defaults.
- `--man`:
If the project was built with support for built-in manual pages, this
option will show the manual page. If supported by the terminal and a
suitable pager (e.g. `less`) is found, the manual page is displayed
in the pager.
## AUTHOR
Written by Marcus Holland-Moritz.

View File

@ -99,6 +99,12 @@ to disk:
- `-h`, `--help`:
Show program help, including option defaults.
- `--man`:
If the project was built with support for built-in manual pages, this
option will show the manual page. If supported by the terminal and a
suitable pager (e.g. `less`) is found, the manual page is displayed
in the pager.
## AUTHOR
Written by Marcus Holland-Moritz.

View File

@ -423,6 +423,12 @@ Most other options are concerned with compression tuning:
Show full usage with all options, including defaults, compression level
detail and supported compression algorithms.
- `--man`:
If the project was built with support for built-in manual pages, this
option will show the manual page. If supported by the terminal and a
suitable pager (e.g. `less`) is found, the manual page is displayed
in the pager.
## EXIT CODES
Upon successful completion, `mkdwarfs` will exit with exit code 0. If an