diff --git a/doc/dwarfs.md b/doc/dwarfs.md index 92911f3d..ac6cd11a 100644 --- a/doc/dwarfs.md +++ b/doc/dwarfs.md @@ -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: diff --git a/doc/dwarfsck.md b/doc/dwarfsck.md index 7a530463..d941a417 100644 --- a/doc/dwarfsck.md +++ b/doc/dwarfsck.md @@ -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. diff --git a/doc/dwarfsextract.md b/doc/dwarfsextract.md index a826753b..b829c559 100644 --- a/doc/dwarfsextract.md +++ b/doc/dwarfsextract.md @@ -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. diff --git a/doc/mkdwarfs.md b/doc/mkdwarfs.md index 61d35607..d82b1952 100644 --- a/doc/mkdwarfs.md +++ b/doc/mkdwarfs.md @@ -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