changeset 323:e98bc7f40803

Man: Document the global options "-h" and "-V" in all affected manual pages
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 27 Nov 2022 20:42:37 +0100
parents 08d67640721b
children 6bdf954ad93e
files docs/man/man8/fjail.rst docs/man/man8/ftjail.rst docs/man/man8/fzfs.rst
diffstat 3 files changed, 36 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/docs/man/man8/fjail.rst	Sun Nov 27 20:42:11 2022 +0100
+++ b/docs/man/man8/fjail.rst	Sun Nov 27 20:42:37 2022 +0100
@@ -17,6 +17,18 @@
 Management tool for Jails: creation of ZFS dataset hierarchies, mount,
 population and configuration helpers.
 
+The following global options are implemented:
+
+.. program:: fjail
+
+.. option:: -h
+
+   Print a short usage message to stdout and exit.
+
+.. option:: -V
+
+   Print the program name and version number to stdout and exit.
+
 
 Subcommands
 -----------
--- a/docs/man/man8/ftjail.rst	Sun Nov 27 20:42:11 2022 +0100
+++ b/docs/man/man8/ftjail.rst	Sun Nov 27 20:42:37 2022 +0100
@@ -17,6 +17,18 @@
 Management tool for Thin Jails: creation of base and skeleton datasets,
 mount and population helpers.
 
+The following global options are implemented:
+
+.. program:: ftjail
+
+.. option:: -h
+
+   Print a short usage message to stdout and exit.
+
+.. option:: -V
+
+   Print the program name and version number to stdout and exit.
+
 
 Subcommands
 -----------
--- a/docs/man/man8/fzfs.rst	Sun Nov 27 20:42:11 2022 +0100
+++ b/docs/man/man8/fzfs.rst	Sun Nov 27 20:42:37 2022 +0100
@@ -18,6 +18,18 @@
 
 - recursively mount and unmount a ZFS dataset tree
 
+The following global options are implemented:  
+
+.. program:: fzfs
+
+.. option:: -h
+
+   Print a short usage message to stdout and exit.
+
+.. option:: -V
+
+   Print the program name and version number to stdout and exit.  
+
 
 Subcommands
 -----------