Skip to content

Properly format NAME subsection of zfs/zpool subcommands #11086

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from Oct 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions man/man8/zfs-allow.8
Original file line number Diff line number Diff line change
Expand Up @@ -34,57 +34,57 @@
.Dt ZFS-ALLOW 8
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm allow
.Nm zfs-allow
.Nd Delegates ZFS administration permission for the file systems to non-privileged users.
.Sh SYNOPSIS
.Nm
.Nm zfs
.Cm allow
.Op Fl dglu
.Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
.Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
.Ar setname Oc Ns ...
.Ar filesystem Ns | Ns Ar volume
.Nm
.Nm zfs
.Cm allow
.Op Fl dl
.Fl e Ns | Ns Sy everyone
.Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
.Ar setname Oc Ns ...
.Ar filesystem Ns | Ns Ar volume
.Nm
.Nm zfs
.Cm allow
.Fl c
.Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
.Ar setname Oc Ns ...
.Ar filesystem Ns | Ns Ar volume
.Nm
.Nm zfs
.Cm allow
.Fl s No @ Ns Ar setname
.Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
.Ar setname Oc Ns ...
.Ar filesystem Ns | Ns Ar volume
.Nm
.Nm zfs
.Cm unallow
.Op Fl dglru
.Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
.Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
.Ar setname Oc Ns ... Oc
.Ar filesystem Ns | Ns Ar volume
.Nm
.Nm zfs
.Cm unallow
.Op Fl dlr
.Fl e Ns | Ns Sy everyone
.Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
.Ar setname Oc Ns ... Oc
.Ar filesystem Ns | Ns Ar volume
.Nm
.Nm zfs
.Cm unallow
.Op Fl r
.Fl c
.Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
.Ar setname Oc Ns ... Oc
.Ar filesystem Ns | Ns Ar volume
.Nm
.Nm zfs
.Cm unallow
.Op Fl r
.Fl s No @ Ns Ar setname
Expand All @@ -94,7 +94,7 @@
.Sh DESCRIPTION
.Bl -tag -width ""
.It Xo
.Nm
.Nm zfs
.Cm allow
.Ar filesystem Ns | Ns Ar volume
.Xc
Expand All @@ -116,7 +116,7 @@ These permissions cannot be delegated because the Linux
.Xr mount 8
command restricts modifications of the global namespace to the root user.
.It Xo
.Nm
.Nm zfs
.Cm allow
.Op Fl dglu
.Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
Expand All @@ -125,7 +125,7 @@ command restricts modifications of the global namespace to the root user.
.Ar filesystem Ns | Ns Ar volume
.Xc
.It Xo
.Nm
.Nm zfs
.Cm allow
.Op Fl dl
.Fl e Ns | Ns Sy everyone
Expand Down Expand Up @@ -271,7 +271,7 @@ xattr property
zoned property
.Ed
.It Xo
.Nm
.Nm zfs
.Cm allow
.Fl c
.Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
Expand All @@ -285,7 +285,7 @@ These permissions are granted
.Pq locally
to the creator of any newly-created descendent file system.
.It Xo
.Nm
.Nm zfs
.Cm allow
.Fl s No @ Ns Ar setname
.Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
Expand All @@ -302,7 +302,7 @@ name must begin with
.Sy @ ,
and can be no more than 64 characters long.
.It Xo
.Nm
.Nm zfs
.Cm unallow
.Op Fl dglru
.Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
Expand All @@ -311,7 +311,7 @@ and can be no more than 64 characters long.
.Ar filesystem Ns | Ns Ar volume
.Xc
.It Xo
.Nm
.Nm zfs
.Cm unallow
.Op Fl dlr
.Fl e Ns | Ns Sy everyone
Expand All @@ -320,7 +320,7 @@ and can be no more than 64 characters long.
.Ar filesystem Ns | Ns Ar volume
.Xc
.It Xo
.Nm
.Nm zfs
.Cm unallow
.Op Fl r
.Fl c
Expand Down Expand Up @@ -358,7 +358,7 @@ options.
Recursively remove the permissions from this file system and all descendents.
.El
.It Xo
.Nm
.Nm zfs
.Cm unallow
.Op Fl r
.Fl s No @ Ns Ar setname
Expand Down
4 changes: 2 additions & 2 deletions man/man8/zfs-bookmark.8
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@
.Dt ZFS-BOOKMARK 8 SMM
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm bookmark
.Nm zfs-bookmark
.Nd Creates a bookmark of the given snapshot.
.Sh SYNOPSIS
.Sh DESCRIPTION
.Bl -tag -width ""
.It Xo
.Nm
.Nm zfs
.Cm bookmark
.Ar snapshot Ns | Ns Ar bookmark newbookmark
.Xc
Expand Down
6 changes: 3 additions & 3 deletions man/man8/zfs-clone.8
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,18 @@
.Dt ZFS-CLONE 8
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm clone
.Nm zfs-clone
.Nd Creates a clone of the given snapshot.
.Sh SYNOPSIS
.Nm
.Nm zfs
.Cm clone
.Op Fl p
.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
.Ar snapshot Ar filesystem Ns | Ns Ar volume
.Sh DESCRIPTION
.Bl -tag -width ""
.It Xo
.Nm
.Nm zfs
.Cm clone
.Op Fl p
.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
Expand Down
8 changes: 4 additions & 4 deletions man/man8/zfs-create.8
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@
.Dt ZFS-CREATE 8
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm create
.Nm zfs-create
.Nd Creates a new ZFS file system.
.Sh SYNOPSIS
.Nm zfs
.Cm create
.Op Fl Pnpv
.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
.Ar filesystem
.Nm
.Nm zfs
.Cm create
.Op Fl ps
.Op Fl b Ar blocksize
Expand All @@ -51,7 +51,7 @@
.Sh DESCRIPTION
.Bl -tag -width ""
.It Xo
.Nm
.Nm zfs
.Cm create
.Op Fl Pnpv
.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
Expand Down Expand Up @@ -126,7 +126,7 @@ option.
Print verbose information about the created dataset.
.El
.It Xo
.Nm
.Nm zfs
.Cm create
.Op Fl ps
.Op Fl b Ar blocksize
Expand Down
14 changes: 7 additions & 7 deletions man/man8/zfs-destroy.8
Original file line number Diff line number Diff line change
Expand Up @@ -34,25 +34,25 @@
.Dt ZFS-DESTROY 8
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm destroy
.Nm zfs-destroy
.Nd Destroys the given dataset(s), snapshot(s), or bookmark.
.Sh SYNOPSIS
.Nm
.Nm zfs
.Cm destroy
.Op Fl Rfnprv
.Ar filesystem Ns | Ns Ar volume
.Nm
.Nm zfs
.Cm destroy
.Op Fl Rdnprv
.Ar filesystem Ns | Ns Ar volume Ns @ Ns Ar snap Ns
.Oo % Ns Ar snap Ns Oo , Ns Ar snap Ns Oo % Ns Ar snap Oc Oc Oc Ns ...
.Nm
.Nm zfs
.Cm destroy
.Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
.Sh DESCRIPTION
.Bl -tag -width ""
.It Xo
.Nm
.Nm zfs
.Cm destroy
.Op Fl Rfnprv
.Ar filesystem Ns | Ns Ar volume
Expand Down Expand Up @@ -96,7 +96,7 @@ or the
options, as they can destroy large portions of a pool and cause unexpected
behavior for mounted file systems in use.
.It Xo
.Nm
.Nm zfs
.Cm destroy
.Op Fl Rdnprv
.Ar filesystem Ns | Ns Ar volume Ns @ Ns Ar snap Ns
Expand Down Expand Up @@ -167,7 +167,7 @@ options, as they can destroy large portions of a pool and cause unexpected
behavior for mounted file systems in use.
.El
.It Xo
.Nm
.Nm zfs
.Cm destroy
.Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
.Xc
Expand Down
6 changes: 3 additions & 3 deletions man/man8/zfs-diff.8
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@
.Dt ZFS-DIFF 8
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm diff
.Nm zfs-diff
.Nd Display the difference between two snapshots of a given filesystem.
.Sh SYNOPSIS
.Nm
.Nm zfs
.Cm diff
.Op Fl FHt
.Ar snapshot Ar snapshot Ns | Ns Ar filesystem
.Sh DESCRIPTION
.Bl -tag -width ""
.It Xo
.Nm
.Nm zfs
.Cm diff
.Op Fl FHt
.Ar snapshot Ar snapshot Ns | Ns Ar filesystem
Expand Down
14 changes: 7 additions & 7 deletions man/man8/zfs-hold.8
Original file line number Diff line number Diff line change
Expand Up @@ -34,25 +34,25 @@
.Dt ZFS-HOLD 8
.Os
.Sh NAME
.Nm zfs Ns Pf - Cm hold
.Nm zfs-hold
.Nd Hold a snapshot to prevent it being removed with the zfs destroy command.
.Sh SYNOPSIS
.Nm
.Nm zfs
.Cm hold
.Op Fl r
.Ar tag Ar snapshot Ns ...
.Nm
.Nm zfs
.Cm holds
.Op Fl rH
.Ar snapshot Ns ...
.Nm
.Nm zfs
.Cm release
.Op Fl r
.Ar tag Ar snapshot Ns ...
.Sh DESCRIPTION
.Bl -tag -width ""
.It Xo
.Nm
.Nm zfs
.Cm hold
.Op Fl r
.Ar tag Ar snapshot Ns ...
Expand All @@ -73,7 +73,7 @@ Specifies that a hold with the given tag is applied recursively to the snapshots
of all descendent file systems.
.El
.It Xo
.Nm
.Nm zfs
.Cm holds
.Op Fl rH
.Ar snapshot Ns ...
Expand All @@ -87,7 +87,7 @@ listing the holds on the named snapshot.
Do not print headers, use tab-delimited output.
.El
.It Xo
.Nm
.Nm zfs
.Cm release
.Op Fl r
.Ar tag Ar snapshot Ns ...
Expand Down
10 changes: 5 additions & 5 deletions man/man8/zfs-jail.8
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
.Dt ZFS-JAIL 8
.Os FreeBSD
.Sh NAME
.Nm zfs Ns Pf - Cm jail
.Nm zfs-jail
.Nd Attaches and detaches ZFS filesystems from FreeBSD jails.
.No A Tn ZFS
dataset can be attached to a jail by using the
Expand Down Expand Up @@ -72,16 +72,16 @@ After a dataset is attached to a jail and the jailed property is set, a jailed
file system cannot be mounted outside the jail, since the jail administrator
might have set the mount point to an unacceptable value.
.Sh SYNOPSIS
.Nm
.Nm zfs
.Cm jail
.Ar jailid Ns | Ns Ar jailname filesystem
.Nm
.Nm zfs
.Cm unjail
.Ar jailid Ns | Ns Ar jailname filesystem
.Sh DESCRIPTION
.Bl -tag -width ""
.It Xo
.Nm
.Nm zfs
.Cm jail
.Ar jailid filesystem
.Xc
Expand All @@ -104,7 +104,7 @@ See
.Xr jail 8
for more information on managing jails and configuring the parameters above.
.It Xo
.Nm
.Nm zfs
.Cm unjail
.Ar jailid filesystem
.Xc
Expand Down
Loading