changeset 295:11e6e3442df0

Manual page for "ftjail snapshot-tmpl"
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 18 Sep 2022 16:25:18 +0200
parents c2e2fed957ed
children e64c726c4bd0
files docs/conf.py docs/man/index8.rst docs/man/man8/ftjail-snapshot-tmpl.rst pkg-plist
diffstat 4 files changed, 36 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/docs/conf.py	Sun Sep 18 15:32:22 2022 +0200
+++ b/docs/conf.py	Sun Sep 18 16:25:18 2022 +0200
@@ -73,7 +73,8 @@
 man_pages = [
     ("man/man8/local-bsdtools", "local-bsdtools", 'FreeBSD specific administration helper tools v%s' % release, [author], 8),
     ("man/man8/ftjail", "ftjail", "Management helper for thin jails", [author], 8),
-    ("man/man8/ftjail-copy-skel", "ftjail-copy-skel", "Recursively copy skeleton contents", [author], 8),        
+    ("man/man8/ftjail-copy-skel", "ftjail-copy-skel", "Recursively copy skeleton contents", [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/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),
--- a/docs/man/index8.rst	Sun Sep 18 15:32:22 2022 +0200
+++ b/docs/man/index8.rst	Sun Sep 18 16:25:18 2022 +0200
@@ -1,17 +1,17 @@
 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
 
-.. local-bsdtools documentation master file, created by
-   sphinx-quickstart on Sat Sep 17 21:32:09 2022.
-
-
 Collection of Manual Pages
 ==========================
 
+System Administration Tools
+---------------------------
+
 .. toctree::
 
    man8/local-bsdtools
    man8/ftjail
    man8/ftjail-copy-skel
+   man8/ftjail-snapshot-tmpl
    man8/fzfs
    man8/fzfs-mount
    man8/fzfs-umount
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man/man8/ftjail-snapshot-tmpl.rst	Sun Sep 18 16:25:18 2022 +0200
@@ -0,0 +1,29 @@
+.. -*- coding: utf-8; indent-tabs-mode: nil; -*-
+
+ftjail-snapshot-tmpl
+====================
+
+Synopsis
+--------
+
+**ftjail snapshot-tmpl** `dataset-ro-base` `dataset-skeleton-rw` `snapshot-name`
+
+
+Description
+-----------
+
+Recursively create ZFS snapshots of `dataset-ro-base` and
+`dataset-skeleton-rw` and all its children. The snapshot has the snapshot
+name `snapshot-name` and must not exist already.
+
+
+Environment
+-----------
+
+All environment variables that affect :command:`zfs` are effective also.
+
+
+See Also
+--------
+
+:manpage:`ftjail(8)`
--- a/pkg-plist	Sun Sep 18 15:32:22 2022 +0200
+++ b/pkg-plist	Sun Sep 18 16:25:18 2022 +0200
@@ -9,6 +9,7 @@
 %%DOCS%%man/man8/local-bsdtools.8.gz
 %%DOCS%%man/man8/ftjail.8.gz
 %%DOCS%%man/man8/ftjail-copy-skel.8.gz
+%%DOCS%%man/man8/ftjail-snapshot-tmpl.8.gz
 %%DOCS%%man/man8/fzfs.8.gz
 %%DOCS%%man/man8/fzfs-mount.8.gz
 %%DOCS%%man/man8/fzfs-umount.8.gz