annotate docs/man/man8/fzfs.rst @ 380:6be930eb7490

Implement the "fzfs create-tree" command
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 20 Feb 2023 00:43:30 +0100
parents e98bc7f40803
children bf0d63c8e682
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
283
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 fzfs
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 ====
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6 Synopsis
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7 --------
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8
285
517724af7c68 Optimized manpage formatting
Franz Glasner <fzglas.hg@dom66.de>
parents: 284
diff changeset
9 **fzfs -hV**
283
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11 **fzfs subcommand**
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
12
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13
301
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
14 Description
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
15 -----------
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
16
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
17 Helper for ZFS management:
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
18
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
19 - recursively mount and unmount a ZFS dataset tree
380
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
20 - create a ZFS dataset tree stucture from a source tree
301
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
21
323
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 301
diff changeset
22 The following global options are implemented:
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 301
diff changeset
23
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 301
diff changeset
24 .. program:: fzfs
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 301
diff changeset
25
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 301
diff changeset
26 .. option:: -h
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 301
diff changeset
27
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 301
diff changeset
28 Print a short usage message to stdout and exit.
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 301
diff changeset
29
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 301
diff changeset
30 .. option:: -V
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 301
diff changeset
31
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 301
diff changeset
32 Print the program name and version number to stdout and exit.
e98bc7f40803 Man: Document the global options "-h" and "-V" in all affected manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 301
diff changeset
33
301
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
34
283
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35 Subcommands
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36 -----------
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37
380
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
38 :manpage:`fzfs-create-tree(8)`
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
39
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
40 Recursively create a ZFS dataset tree based on an existing tree while
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
41 copying some important properties also
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 323
diff changeset
42
284
106cd5d9da7e Put all manual pages into section 8 (FreeBSD System Manager's Manual)
Franz Glasner <fzglas.hg@dom66.de>
parents: 283
diff changeset
43 :manpage:`fzfs-mount(8)`
283
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
44
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
45 Recursively mount a ZFS dataset and its children
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
46
284
106cd5d9da7e Put all manual pages into section 8 (FreeBSD System Manager's Manual)
Franz Glasner <fzglas.hg@dom66.de>
parents: 283
diff changeset
47 :manpage:`fzfs-umount(8)`
283
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
48
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
49 Recursively unmount a ZFS datasets and its children