annotate docs/man/man8/fzfs.rst @ 323:e98bc7f40803

Man: Document the global options "-h" and "-V" in all affected manual pages
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 27 Nov 2022 20:42:37 +0100
parents 376c9f97b1cc
children 6be930eb7490
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
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
20
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
21 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
22
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 .. 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
24
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 .. 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
26
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 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
28
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 .. 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
30
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 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
32
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
33
283
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34 Subcommands
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35 -----------
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36
284
106cd5d9da7e Put all manual pages into section 8 (FreeBSD System Manager's Manual)
Franz Glasner <fzglas.hg@dom66.de>
parents: 283
diff changeset
37 :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
38
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
39 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
40
284
106cd5d9da7e Put all manual pages into section 8 (FreeBSD System Manager's Manual)
Franz Glasner <fzglas.hg@dom66.de>
parents: 283
diff changeset
41 :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
42
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
43 Recursively unmount a ZFS datasets and its children