Mercurial > hgrepos > FreeBSD > ports > sysutils > local-bsdtools
changeset 420:bf0d63c8e682
Begin fzfs-copy-tree: man page structure done
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Mon, 18 Sep 2023 09:43:12 +0200 |
| parents | 8c7f686ef66f |
| children | a571a30bcf8a |
| files | docs/conf.py docs/man/index.rst docs/man/man8/fzfs-copy-tree.rst docs/man/man8/fzfs-create-tree.rst docs/man/man8/fzfs.rst docs/man/man8/local-bsdtools.rst pkg-plist |
| diffstat | 7 files changed, 78 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/conf.py Sun Sep 17 18:07:07 2023 +0200 +++ b/docs/conf.py Mon Sep 18 09:43:12 2023 +0200 @@ -102,7 +102,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-create-tree", "fzfs-create-tree", "Create a ZFS dataset tree based on an existing tree", [author], 8), + ("man/man8/fzfs-copy-tree", "fzfs-copy-tree", "Copy a ZFS dataset tree based on an existing tree", [author], 8), + ("man/man8/fzfs-create-tree", "fzfs-create-tree", "Create a ZFS dataset tree structure based on an existing tree", [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/index.rst Sun Sep 17 18:07:07 2023 +0200 +++ b/docs/man/index.rst Mon Sep 18 09:43:12 2023 +0200 @@ -27,6 +27,7 @@ man8/ftjail-snapshot-tmpl man8/ftjail-umount-tmpl man8/fzfs + man8/fzfs-copy-tree man8/fzfs-create-tree man8/fzfs-mount man8/fzfs-umount
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/man/man8/fzfs-copy-tree.rst Mon Sep 18 09:43:12 2023 +0200 @@ -0,0 +1,67 @@ +.. -*- coding: utf-8; indent-tabs-mode: nil; -*- + +fzfs-copy-tree +============== + +.. program:: fzfs copy-tree + + +Synopsis +-------- + +**fzfs copy-tree** [**-A**] [**-M** `mountpoint`] [**-n**] [**-p**] [**-u**] `source-dataset` `dest-dataset` + +Description +----------- + +Copy the ZFS filesystem structure and contents that is rooted at +`source-dataset` to the destination rooted at `dest-dataset`. + +The content of the filesystems is copied also. + +`dest-dataset` must not exist already. + +By default `canmount` is also copied. But this can be modified with +options :option:`-A` and :option:`-p`. + + +Options +------- + +.. option:: -A + + Unconditionally set the ZFS property `canmount=noauto` for all + created datasets in the destination tree. This option overwrites + option :option:`-p`. + +.. option:: -M mountpoint + + Set the `mountpoint` property for the root `dest-dataset` to `mountpoint`. + All children will be set to inherit it. + +.. option:: -n + + Dry-run. Do not really create and copy datasets but show what would + be done. + +.. option:: -p + + Copy the `canmount` property only from the source to the root + destination dataset This will be overwritten by the option + :option:`-A`. + +.. option:: -u + + Do not mount the copied datasets. + + +Environment +----------- + +All environment variables that affect :command:`zfs` are effective also. + + +See Also +-------- + +:manpage:`fzfs(8)`, :manpage:`fzfs-create-tree(8)`
--- a/docs/man/man8/fzfs-create-tree.rst Sun Sep 17 18:07:07 2023 +0200 +++ b/docs/man/man8/fzfs-create-tree.rst Mon Sep 18 09:43:12 2023 +0200 @@ -69,4 +69,4 @@ See Also -------- -:manpage:`fzfs(8)` +:manpage:`fzfs(8)`, :manpage:`fzfs-copy-tree(8)`
--- a/docs/man/man8/fzfs.rst Sun Sep 17 18:07:07 2023 +0200 +++ b/docs/man/man8/fzfs.rst Mon Sep 18 09:43:12 2023 +0200 @@ -35,6 +35,11 @@ Subcommands ----------- +:manpage:`fzfs-copy-tree(8)` + + Recursively copy a ZFS dataset tree based while copying some + important properties also + :manpage:`fzfs-create-tree(8)` Recursively create a ZFS dataset tree based on an existing tree while
--- a/docs/man/man8/local-bsdtools.rst Sun Sep 17 18:07:07 2023 +0200 +++ b/docs/man/man8/local-bsdtools.rst Mon Sep 18 09:43:12 2023 +0200 @@ -67,6 +67,7 @@ - :manpage:`fpkg(8)` - :manpage:`fzfs(8)` + * :manpage:`fzfs-copy-tree(8)` * :manpage:`fzfs-create-tree(8)` * :manpage:`fzfs-mount(8)` * :manpage:`fzfs-umount(8)`
--- a/pkg-plist Sun Sep 17 18:07:07 2023 +0200 +++ b/pkg-plist Mon Sep 18 09:43:12 2023 +0200 @@ -31,6 +31,7 @@ %%DOCS%%man/man8/ftjail-snapshot-tmpl.8.gz %%DOCS%%man/man8/ftjail-umount-tmpl.8.gz %%DOCS%%man/man8/fzfs.8.gz +%%DOCS%%man/man8/fzfs-copy-tree.8.gz %%DOCS%%man/man8/fzfs-create-tree.8.gz %%DOCS%%man/man8/fzfs-mount.8.gz %%DOCS%%man/man8/fzfs-umount.8.gz
