Skip to content

Commit 1e36af8

Browse files
author
xtouqh
authored
Properly format NAME subsection of zfs/zpool subcommands
Use proper names (i.e. zfs-allow and zpool-add) in NAME subsections of zfs/zpool subcommands instead of current "pretty-printed" ones as makewhatis utilities (or some implementations of it, namely the one from mandoc suite used in FreeBSD) look not only at the document title but also in NAME subsection, adding zfs(8)/zpool(8) to search results which is not correct. (Common sense and other utilities splitting subcommands in multiple man pages, e.g. git, do the same.) Reviewed-by: Brian Behlendorf <[email protected]> Signed-off-by: xtouqh <[email protected]> Closes #11086
1 parent eb02a4c commit 1e36af8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+251
-250
lines changed

man/man8/zfs-allow.8

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -34,57 +34,57 @@
3434
.Dt ZFS-ALLOW 8
3535
.Os
3636
.Sh NAME
37-
.Nm zfs Ns Pf - Cm allow
37+
.Nm zfs-allow
3838
.Nd Delegates ZFS administration permission for the file systems to non-privileged users.
3939
.Sh SYNOPSIS
40-
.Nm
40+
.Nm zfs
4141
.Cm allow
4242
.Op Fl dglu
4343
.Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
4444
.Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
4545
.Ar setname Oc Ns ...
4646
.Ar filesystem Ns | Ns Ar volume
47-
.Nm
47+
.Nm zfs
4848
.Cm allow
4949
.Op Fl dl
5050
.Fl e Ns | Ns Sy everyone
5151
.Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
5252
.Ar setname Oc Ns ...
5353
.Ar filesystem Ns | Ns Ar volume
54-
.Nm
54+
.Nm zfs
5555
.Cm allow
5656
.Fl c
5757
.Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
5858
.Ar setname Oc Ns ...
5959
.Ar filesystem Ns | Ns Ar volume
60-
.Nm
60+
.Nm zfs
6161
.Cm allow
6262
.Fl s No @ Ns Ar setname
6363
.Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
6464
.Ar setname Oc Ns ...
6565
.Ar filesystem Ns | Ns Ar volume
66-
.Nm
66+
.Nm zfs
6767
.Cm unallow
6868
.Op Fl dglru
6969
.Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
7070
.Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
7171
.Ar setname Oc Ns ... Oc
7272
.Ar filesystem Ns | Ns Ar volume
73-
.Nm
73+
.Nm zfs
7474
.Cm unallow
7575
.Op Fl dlr
7676
.Fl e Ns | Ns Sy everyone
7777
.Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
7878
.Ar setname Oc Ns ... Oc
7979
.Ar filesystem Ns | Ns Ar volume
80-
.Nm
80+
.Nm zfs
8181
.Cm unallow
8282
.Op Fl r
8383
.Fl c
8484
.Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
8585
.Ar setname Oc Ns ... Oc
8686
.Ar filesystem Ns | Ns Ar volume
87-
.Nm
87+
.Nm zfs
8888
.Cm unallow
8989
.Op Fl r
9090
.Fl s No @ Ns Ar setname
@@ -94,7 +94,7 @@
9494
.Sh DESCRIPTION
9595
.Bl -tag -width ""
9696
.It Xo
97-
.Nm
97+
.Nm zfs
9898
.Cm allow
9999
.Ar filesystem Ns | Ns Ar volume
100100
.Xc
@@ -116,7 +116,7 @@ These permissions cannot be delegated because the Linux
116116
.Xr mount 8
117117
command restricts modifications of the global namespace to the root user.
118118
.It Xo
119-
.Nm
119+
.Nm zfs
120120
.Cm allow
121121
.Op Fl dglu
122122
.Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
@@ -125,7 +125,7 @@ command restricts modifications of the global namespace to the root user.
125125
.Ar filesystem Ns | Ns Ar volume
126126
.Xc
127127
.It Xo
128-
.Nm
128+
.Nm zfs
129129
.Cm allow
130130
.Op Fl dl
131131
.Fl e Ns | Ns Sy everyone
@@ -271,7 +271,7 @@ xattr property
271271
zoned property
272272
.Ed
273273
.It Xo
274-
.Nm
274+
.Nm zfs
275275
.Cm allow
276276
.Fl c
277277
.Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
@@ -285,7 +285,7 @@ These permissions are granted
285285
.Pq locally
286286
to the creator of any newly-created descendent file system.
287287
.It Xo
288-
.Nm
288+
.Nm zfs
289289
.Cm allow
290290
.Fl s No @ Ns Ar setname
291291
.Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
@@ -302,7 +302,7 @@ name must begin with
302302
.Sy @ ,
303303
and can be no more than 64 characters long.
304304
.It Xo
305-
.Nm
305+
.Nm zfs
306306
.Cm unallow
307307
.Op Fl dglru
308308
.Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
@@ -311,7 +311,7 @@ and can be no more than 64 characters long.
311311
.Ar filesystem Ns | Ns Ar volume
312312
.Xc
313313
.It Xo
314-
.Nm
314+
.Nm zfs
315315
.Cm unallow
316316
.Op Fl dlr
317317
.Fl e Ns | Ns Sy everyone
@@ -320,7 +320,7 @@ and can be no more than 64 characters long.
320320
.Ar filesystem Ns | Ns Ar volume
321321
.Xc
322322
.It Xo
323-
.Nm
323+
.Nm zfs
324324
.Cm unallow
325325
.Op Fl r
326326
.Fl c
@@ -358,7 +358,7 @@ options.
358358
Recursively remove the permissions from this file system and all descendents.
359359
.El
360360
.It Xo
361-
.Nm
361+
.Nm zfs
362362
.Cm unallow
363363
.Op Fl r
364364
.Fl s No @ Ns Ar setname

man/man8/zfs-bookmark.8

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@
3535
.Dt ZFS-BOOKMARK 8 SMM
3636
.Os
3737
.Sh NAME
38-
.Nm zfs Ns Pf - Cm bookmark
38+
.Nm zfs-bookmark
3939
.Nd Creates a bookmark of the given snapshot.
4040
.Sh SYNOPSIS
4141
.Sh DESCRIPTION
4242
.Bl -tag -width ""
4343
.It Xo
44-
.Nm
44+
.Nm zfs
4545
.Cm bookmark
4646
.Ar snapshot Ns | Ns Ar bookmark newbookmark
4747
.Xc

man/man8/zfs-clone.8

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,18 +34,18 @@
3434
.Dt ZFS-CLONE 8
3535
.Os
3636
.Sh NAME
37-
.Nm zfs Ns Pf - Cm clone
37+
.Nm zfs-clone
3838
.Nd Creates a clone of the given snapshot.
3939
.Sh SYNOPSIS
40-
.Nm
40+
.Nm zfs
4141
.Cm clone
4242
.Op Fl p
4343
.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
4444
.Ar snapshot Ar filesystem Ns | Ns Ar volume
4545
.Sh DESCRIPTION
4646
.Bl -tag -width ""
4747
.It Xo
48-
.Nm
48+
.Nm zfs
4949
.Cm clone
5050
.Op Fl p
5151
.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...

man/man8/zfs-create.8

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@
3434
.Dt ZFS-CREATE 8
3535
.Os
3636
.Sh NAME
37-
.Nm zfs Ns Pf - Cm create
37+
.Nm zfs-create
3838
.Nd Creates a new ZFS file system.
3939
.Sh SYNOPSIS
4040
.Nm zfs
4141
.Cm create
4242
.Op Fl Pnpv
4343
.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
4444
.Ar filesystem
45-
.Nm
45+
.Nm zfs
4646
.Cm create
4747
.Op Fl ps
4848
.Op Fl b Ar blocksize
@@ -51,7 +51,7 @@
5151
.Sh DESCRIPTION
5252
.Bl -tag -width ""
5353
.It Xo
54-
.Nm
54+
.Nm zfs
5555
.Cm create
5656
.Op Fl Pnpv
5757
.Oo Fl o Ar property Ns = Ns Ar value Oc Ns ...
@@ -126,7 +126,7 @@ option.
126126
Print verbose information about the created dataset.
127127
.El
128128
.It Xo
129-
.Nm
129+
.Nm zfs
130130
.Cm create
131131
.Op Fl ps
132132
.Op Fl b Ar blocksize

man/man8/zfs-destroy.8

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,25 +34,25 @@
3434
.Dt ZFS-DESTROY 8
3535
.Os
3636
.Sh NAME
37-
.Nm zfs Ns Pf - Cm destroy
37+
.Nm zfs-destroy
3838
.Nd Destroys the given dataset(s), snapshot(s), or bookmark.
3939
.Sh SYNOPSIS
40-
.Nm
40+
.Nm zfs
4141
.Cm destroy
4242
.Op Fl Rfnprv
4343
.Ar filesystem Ns | Ns Ar volume
44-
.Nm
44+
.Nm zfs
4545
.Cm destroy
4646
.Op Fl Rdnprv
4747
.Ar filesystem Ns | Ns Ar volume Ns @ Ns Ar snap Ns
4848
.Oo % Ns Ar snap Ns Oo , Ns Ar snap Ns Oo % Ns Ar snap Oc Oc Oc Ns ...
49-
.Nm
49+
.Nm zfs
5050
.Cm destroy
5151
.Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
5252
.Sh DESCRIPTION
5353
.Bl -tag -width ""
5454
.It Xo
55-
.Nm
55+
.Nm zfs
5656
.Cm destroy
5757
.Op Fl Rfnprv
5858
.Ar filesystem Ns | Ns Ar volume
@@ -96,7 +96,7 @@ or the
9696
options, as they can destroy large portions of a pool and cause unexpected
9797
behavior for mounted file systems in use.
9898
.It Xo
99-
.Nm
99+
.Nm zfs
100100
.Cm destroy
101101
.Op Fl Rdnprv
102102
.Ar filesystem Ns | Ns Ar volume Ns @ Ns Ar snap Ns
@@ -167,7 +167,7 @@ options, as they can destroy large portions of a pool and cause unexpected
167167
behavior for mounted file systems in use.
168168
.El
169169
.It Xo
170-
.Nm
170+
.Nm zfs
171171
.Cm destroy
172172
.Ar filesystem Ns | Ns Ar volume Ns # Ns Ar bookmark
173173
.Xc

man/man8/zfs-diff.8

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,17 @@
3434
.Dt ZFS-DIFF 8
3535
.Os
3636
.Sh NAME
37-
.Nm zfs Ns Pf - Cm diff
37+
.Nm zfs-diff
3838
.Nd Display the difference between two snapshots of a given filesystem.
3939
.Sh SYNOPSIS
40-
.Nm
40+
.Nm zfs
4141
.Cm diff
4242
.Op Fl FHt
4343
.Ar snapshot Ar snapshot Ns | Ns Ar filesystem
4444
.Sh DESCRIPTION
4545
.Bl -tag -width ""
4646
.It Xo
47-
.Nm
47+
.Nm zfs
4848
.Cm diff
4949
.Op Fl FHt
5050
.Ar snapshot Ar snapshot Ns | Ns Ar filesystem

man/man8/zfs-hold.8

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,25 +34,25 @@
3434
.Dt ZFS-HOLD 8
3535
.Os
3636
.Sh NAME
37-
.Nm zfs Ns Pf - Cm hold
37+
.Nm zfs-hold
3838
.Nd Hold a snapshot to prevent it being removed with the zfs destroy command.
3939
.Sh SYNOPSIS
40-
.Nm
40+
.Nm zfs
4141
.Cm hold
4242
.Op Fl r
4343
.Ar tag Ar snapshot Ns ...
44-
.Nm
44+
.Nm zfs
4545
.Cm holds
4646
.Op Fl rH
4747
.Ar snapshot Ns ...
48-
.Nm
48+
.Nm zfs
4949
.Cm release
5050
.Op Fl r
5151
.Ar tag Ar snapshot Ns ...
5252
.Sh DESCRIPTION
5353
.Bl -tag -width ""
5454
.It Xo
55-
.Nm
55+
.Nm zfs
5656
.Cm hold
5757
.Op Fl r
5858
.Ar tag Ar snapshot Ns ...
@@ -73,7 +73,7 @@ Specifies that a hold with the given tag is applied recursively to the snapshots
7373
of all descendent file systems.
7474
.El
7575
.It Xo
76-
.Nm
76+
.Nm zfs
7777
.Cm holds
7878
.Op Fl rH
7979
.Ar snapshot Ns ...
@@ -87,7 +87,7 @@ listing the holds on the named snapshot.
8787
Do not print headers, use tab-delimited output.
8888
.El
8989
.It Xo
90-
.Nm
90+
.Nm zfs
9191
.Cm release
9292
.Op Fl r
9393
.Ar tag Ar snapshot Ns ...

man/man8/zfs-jail.8

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
.Dt ZFS-JAIL 8
4242
.Os FreeBSD
4343
.Sh NAME
44-
.Nm zfs Ns Pf - Cm jail
44+
.Nm zfs-jail
4545
.Nd Attaches and detaches ZFS filesystems from FreeBSD jails.
4646
.No A Tn ZFS
4747
dataset can be attached to a jail by using the
@@ -72,16 +72,16 @@ After a dataset is attached to a jail and the jailed property is set, a jailed
7272
file system cannot be mounted outside the jail, since the jail administrator
7373
might have set the mount point to an unacceptable value.
7474
.Sh SYNOPSIS
75-
.Nm
75+
.Nm zfs
7676
.Cm jail
7777
.Ar jailid Ns | Ns Ar jailname filesystem
78-
.Nm
78+
.Nm zfs
7979
.Cm unjail
8080
.Ar jailid Ns | Ns Ar jailname filesystem
8181
.Sh DESCRIPTION
8282
.Bl -tag -width ""
8383
.It Xo
84-
.Nm
84+
.Nm zfs
8585
.Cm jail
8686
.Ar jailid filesystem
8787
.Xc
@@ -104,7 +104,7 @@ See
104104
.Xr jail 8
105105
for more information on managing jails and configuring the parameters above.
106106
.It Xo
107-
.Nm
107+
.Nm zfs
108108
.Cm unjail
109109
.Ar jailid filesystem
110110
.Xc

0 commit comments

Comments
 (0)