changeset 297:a452ace0175a

Manual page for "ftjail populate"
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 18 Sep 2022 16:47:52 +0200
parents e64c726c4bd0
children 41f32fdbecf3
files docs/conf.py docs/man/index8.rst docs/man/man8/ftjail-populate.rst pkg-plist sbin/ftjail
diffstat 5 files changed, 51 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/docs/conf.py	Sun Sep 18 16:34:47 2022 +0200
+++ b/docs/conf.py	Sun Sep 18 16:47:52 2022 +0200
@@ -74,6 +74,7 @@
     ("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-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/fzfs", "fzfs", "A ZFS management helper tool", [author], 8),
     ("man/man8/fzfs-mount", "fzfs-mount", "Mount ZFS datasets recursively", [author], 8),
--- a/docs/man/index8.rst	Sun Sep 18 16:34:47 2022 +0200
+++ b/docs/man/index8.rst	Sun Sep 18 16:47:52 2022 +0200
@@ -11,6 +11,7 @@
    man8/local-bsdtools
    man8/ftjail
    man8/ftjail-copy-skel
+   man8/ftjail-populate
    man8/ftjail-snapshot-tmpl
    man8/fzfs
    man8/fzfs-mount
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man/man8/ftjail-populate.rst	Sun Sep 18 16:47:52 2022 +0200
@@ -0,0 +1,47 @@
+.. -*- coding: utf-8; indent-tabs-mode: nil; -*-
+
+ftjail-populate
+===============
+
+Synopsis
+--------
+
+**ftjail populate** **-L** `directory` `path/to/base.txz`
+
+**ftjail populate** **-P** `directory` `path/to/base.txz`
+
+
+Description
+-----------
+
+Populate the directory in `directory` with a FreeBSD base system.
+The base system's archive ist in `path/to/base.txz`.
+
+The directory in `directory` must already have a proper
+directory layout.
+This can be accomplished by :manpage:`ftjail-mount-tmpl(8)`.
+
+Apply knowledge of the type and typical layout of the RW skeleton
+(e.g. handle the :file:`skeleton` symlink properly).
+
+
+Options
+-------
+
+.. program:: ftjail populate
+
+.. option:: -L
+
+   Copy dataset properties optimized for employing a :file:`skeleton`
+   subdirectory.
+
+.. option:: -P
+
+   Copy dataset properties optimized for direct mounts of skeleton
+   children over an already mounted base.
+
+
+See Also
+--------
+
+:manpage:`ftjail(8)`, :manpage:`ftjail-mount-tmpl(8)`
--- a/pkg-plist	Sun Sep 18 16:34:47 2022 +0200
+++ b/pkg-plist	Sun Sep 18 16:47:52 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-populate.8.gz
 %%DOCS%%man/man8/ftjail-snapshot-tmpl.8.gz
 %%DOCS%%man/man8/fzfs.8.gz
 %%DOCS%%man/man8/fzfs-mount.8.gz
--- a/sbin/ftjail	Sun Sep 18 16:34:47 2022 +0200
+++ b/sbin/ftjail	Sun Sep 18 16:47:52 2022 +0200
@@ -62,12 +62,7 @@
     Create symbolic links between the RO base and the RW skeleton.
     Base and skeleton must be canonically mounted already.
 
-  populate [ OPTIONS ] MOUNTPOINT BASETXZ
-
-    Populate the directory in MOUNTPOINT with the base system in BASETXZ
-
-    -L        Populate having a "skeleton" subdirectory within the mountpoint
-    -P        Populate directly into the mountpoint
+  populate -L|-P DIRECTORY BASETXZ
 
   snapshot-tmpl BASE-RO SKELETON-RW SNAPSHOT-NAME