changeset 301:376c9f97b1cc

Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 18 Sep 2022 18:49:13 +0200
parents 901b0e3c0dab
children f6e5c54ddd48
files docs/conf.py docs/man/man8/ftjail.rst docs/man/man8/fzfs.rst
diffstat 3 files changed, 23 insertions(+), 13 deletions(-) [+]
line wrap: on
line diff
--- a/docs/conf.py	Sun Sep 18 18:38:12 2022 +0200
+++ b/docs/conf.py	Sun Sep 18 18:49:13 2022 +0200
@@ -74,15 +74,15 @@
     ("man/man8/local-bsdtools", "local-bsdtools", 'FreeBSD administration helper tools v%s' % release, [author], 8),
     ("man/man8/ftjail", "ftjail", "Management of Thin Jails", [author], 8),
     ("man/man8/ftjail-copy-skel", "ftjail-copy-skel", "Recursively copy skeleton contents", [author], 8),
-    ("man/man8/ftjail-datasets-tmpl", "ftjail-datasets-tmpl", "Create ZFS datasets for a new Thin Jail base and skeleton", [author], 8),
-    ("man/man8/ftjail-interlink-tmpl", "ftjail-interlink-tmpl", "Create proper symlinks for \"skeleton\" style thin jails", [author], 8),
-    ("man/man8/ftjail-mount-tmpl", "ftjail-mount-tmpl", "Mount a Thin Jail template with its base and skeleton properly", [author], 8),    
+    ("man/man8/ftjail-datasets-tmpl", "ftjail-datasets-tmpl", "Create ZFS datasets for new Thin Jails using base and skeleton", [author], 8),
+    ("man/man8/ftjail-interlink-tmpl", "ftjail-interlink-tmpl", "Create proper symlinks for \"skeleton\" style Thin Jails", [author], 8),
+    ("man/man8/ftjail-mount-tmpl", "ftjail-mount-tmpl", "Canonically mount the RO base and the RW skeleton of a Thin Jail", [author], 8),    
 ("man/man8/ftjail-populate", "ftjail-populate", "Populate a prepared directory structure with the contents of a FreeBSD base system", [author], 8),
-    ("man/man8/ftjail-snapshot-tmpl", "ftjail-snapshot-tmpl", "Recursively create ZFS dataset-snapshots of the RO base and the RW skeleton datasets", [author], 8),
-    ("man/man8/ftjail-umount-tmpl", "ftjail-umount-tmpl", "Recursively unmount base and skeleton ZFS datasets", [author], 8),
+    ("man/man8/ftjail-snapshot-tmpl", "ftjail-snapshot-tmpl", "Recursively create ZFS snapshots of the RO base datasets and the RW skeleton datasets", [author], 8),
+    ("man/man8/ftjail-umount-tmpl", "ftjail-umount-tmpl", "Unmount mounted Thin Jail template datasets", [author], 8),
     ("man/man8/fzfs", "fzfs", "A ZFS management helper tool", [author], 8),
-    ("man/man8/fzfs-mount", "fzfs-mount", "Mount ZFS datasets recursively", [author], 8),
-    ("man/man8/fzfs-umount", "fzfs-umount", "Unmount ZFS datasets recursively", [author], 8),
+    ("man/man8/fzfs-mount", "fzfs-mount", "Recursively mount a ZFS dataset and its children", [author], 8),
+    ("man/man8/fzfs-umount", "fzfs-umount", "Recursively unmount a ZFS datasets and its children", [author], 8),
 ]
 
 
--- a/docs/man/man8/ftjail.rst	Sun Sep 18 18:38:12 2022 +0200
+++ b/docs/man/man8/ftjail.rst	Sun Sep 18 18:49:13 2022 +0200
@@ -23,27 +23,29 @@
 
 :manpage:`ftjail-datasets-tmpl(8)`
 
-    Create the ZFS template datasets
+    Create ZFS template datasets for new Thin Jails using base and skeleton
 
 :manpage:`ftjail-mount-tmpl(8)`
 
-    Canonically mount the RO base and the RW skeleton
+    Canonically mount the RO base and the RW skeleton of a Thin Jail
 
 :manpage:`ftjail-umount-tmpl(8)`
 
-    Unmount mounted template datasets
+    Unmount mounted Thin Jail template datasets
 
 :manpage:`ftjail-interlink-tmpl(8)`
 
-    Create symbolic links between the RO base and the RW skeleton
+    Create proper symlinks for "skeleton" style Thin Jails
 
 :manpage:`ftjail-populate(8)`
 
-    Populate a mounted base and skeleton
+    Populate a prepared directory structure with the contents of a
+    FreeBSD base system
 
 :manpage:`ftjail-snapshot-tmpl(8)`
 
-    Create a ZFS snapshot for base and skeleton
+    Recursively create ZFS snapshots of the RO base datasets and the RW
+    skeleton datasets
 
 :manpage:`ftjail-copy-skel(8)`
 
--- a/docs/man/man8/fzfs.rst	Sun Sep 18 18:38:12 2022 +0200
+++ b/docs/man/man8/fzfs.rst	Sun Sep 18 18:49:13 2022 +0200
@@ -11,6 +11,14 @@
 **fzfs subcommand**
 
 
+Description
+-----------
+
+Helper for ZFS management:
+
+- recursively mount and unmount a ZFS dataset tree
+
+
 Subcommands
 -----------