diff docs/man/fzfs-mount.rst @ 283:1fc3b04b39fa

Build and package manual pages for fzfs, fzfs-mount and fzfs-umount. Also put some stub info into the manual page for local-bsdtools.
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 18 Sep 2022 01:31:47 +0200
parents
children 106cd5d9da7e
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man/fzfs-mount.rst	Sun Sep 18 01:31:47 2022 +0200
@@ -0,0 +1,53 @@
+.. -*- coding: utf-8; indent-tabs-mode: nil; -*-
+
+:orphan:
+
+
+fzfs-mount
+==========
+
+Synopsis
+--------
+
+**fzfs mount** [-O] [-N] [-P] [-n] [-u] **DATASET** [**MOUNTPOINT**]
+
+
+Description
+-----------
+
+Mount the ZFS dataset **DATASET** and all its children to mountpoint
+**MOUNTPOINT**.
+
+
+Options
+-------
+
+.. program:: fzfs mount
+
+.. option:: -O
+
+   Also mount datasets at mountpoints outside of their "natural"
+   and inherited mountpoints.
+
+.. option:: -N
+
+   Mount at their "natural" configured ZFS mountpoints
+   (the **MOUNTPOINT** argument is not required in this case).
+
+.. option:: -P
+
+   Do not mount the given parent **DATASET** but only its children.
+
+.. option:: -n
+
+   Do not really mount anything but show what would be mounted where.
+
+.. option:: -u
+
+   Alias of :option:`-n`
+
+
+See Also
+--------
+
+:manpage:`fzfs-umount(1)`