mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2026-05-31 11:14:09 +03:00
Lint most manpages
Reviewed-by: Richard Laager <rlaager@wiktel.com> Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Reviewed-by: Tony Nguyen <tony.nguyen@delphix.com> Reviewed-by: Ryan Moeller <ryan@iXsystems.com> Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Closes #12129
This commit is contained in:
наб
+94
-108
@@ -18,7 +18,6 @@
|
||||
.\"
|
||||
.\" CDDL HEADER END
|
||||
.\"
|
||||
.\"
|
||||
.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
|
||||
.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
|
||||
.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
|
||||
@@ -30,67 +29,69 @@
|
||||
.\" Copyright 2018 Nexenta Systems, Inc.
|
||||
.\" Copyright 2019 Joyent, Inc.
|
||||
.\"
|
||||
.Dd June 30, 2019
|
||||
.Dd May 27, 2021
|
||||
.Dt ZFS-ALLOW 8
|
||||
.Os
|
||||
.
|
||||
.Sh NAME
|
||||
.Nm zfs-allow
|
||||
.Nd Delegates ZFS administration permission for the file systems to non-privileged users.
|
||||
.Nd delegate ZFS administration permissions to unprivileged users
|
||||
.Sh SYNOPSIS
|
||||
.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 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 setname Oc Ns …
|
||||
.Ar filesystem Ns | Ns Ar volume
|
||||
.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 setname Oc Ns …
|
||||
.Ar filesystem Ns | Ns Ar volume
|
||||
.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 setname Oc Ns …
|
||||
.Ar filesystem Ns | Ns Ar volume
|
||||
.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 setname Oc Ns …
|
||||
.Ar filesystem Ns | Ns Ar volume
|
||||
.Nm zfs
|
||||
.Cm unallow
|
||||
.Op Fl dglru
|
||||
.Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
|
||||
.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 setname Oc Ns … Oc
|
||||
.Ar filesystem Ns | Ns Ar volume
|
||||
.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 setname Oc Ns … Oc
|
||||
.Ar filesystem Ns | Ns Ar volume
|
||||
.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 setname Oc Ns … Oc
|
||||
.Ar filesystem Ns | Ns Ar volume
|
||||
.Nm zfs
|
||||
.Cm unallow
|
||||
.Op Fl r
|
||||
.Fl s No @ Ns Ar setname
|
||||
.Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
|
||||
.Ar setname Oc Ns ... Oc
|
||||
.Ar setname Oc Ns … Oc
|
||||
.Ar filesystem Ns | Ns Ar volume
|
||||
.
|
||||
.Sh DESCRIPTION
|
||||
.Bl -tag -width ""
|
||||
.It Xo
|
||||
@@ -119,9 +120,9 @@ command restricts modifications of the global namespace to the root user.
|
||||
.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 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 setname Oc Ns …
|
||||
.Ar filesystem Ns | Ns Ar volume
|
||||
.Xc
|
||||
.It Xo
|
||||
@@ -130,7 +131,7 @@ command restricts modifications of the global namespace to the root user.
|
||||
.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 setname Oc Ns …
|
||||
.Ar filesystem Ns | Ns Ar volume
|
||||
.Xc
|
||||
Delegates ZFS administration permission for the file systems to non-privileged
|
||||
@@ -140,15 +141,15 @@ users.
|
||||
Allow only for the descendent file systems.
|
||||
.It Fl e Ns | Ns Sy everyone
|
||||
Specifies that the permissions be delegated to everyone.
|
||||
.It Fl g Ar group Ns Oo , Ns Ar group Oc Ns ...
|
||||
.It Fl g Ar group Ns Oo , Ns Ar group Oc Ns …
|
||||
Explicitly specify that permissions are delegated to the group.
|
||||
.It Fl l
|
||||
Allow
|
||||
.Qq locally
|
||||
only for the specified file system.
|
||||
.It Fl u Ar user Ns Oo , Ns Ar user Oc Ns ...
|
||||
.It Fl u Ar user Ns Oo , Ns Ar user Oc Ns …
|
||||
Explicitly specify that permissions are delegated to the user.
|
||||
.It Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
|
||||
.It Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns …
|
||||
Specifies to whom the permissions are delegated.
|
||||
Multiple entities can be specified as a comma-separated list.
|
||||
If neither of the
|
||||
@@ -169,7 +170,7 @@ To specify a group with the same name as a user, use the
|
||||
options.
|
||||
.It Xo
|
||||
.Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
|
||||
.Ar setname Oc Ns ...
|
||||
.Ar setname Oc Ns …
|
||||
.Xc
|
||||
The permissions to delegate.
|
||||
Multiple permissions may be specified as a comma-separated list.
|
||||
@@ -191,95 +192,80 @@ file system or volume, and all of its descendents.
|
||||
Permissions are generally the ability to use a ZFS subcommand or change a ZFS
|
||||
property.
|
||||
The following permissions are available:
|
||||
.Bd -literal
|
||||
NAME TYPE NOTES
|
||||
allow subcommand Must also have the permission that is
|
||||
being allowed
|
||||
bookmark subcommand
|
||||
clone subcommand Must also have the 'create' ability and
|
||||
'mount' ability in the origin file system
|
||||
create subcommand Must also have the 'mount' ability.
|
||||
Must also have the 'refreservation' ability to
|
||||
create a non-sparse volume.
|
||||
destroy subcommand Must also have the 'mount' ability
|
||||
diff subcommand Allows lookup of paths within a dataset
|
||||
given an object number, and the ability
|
||||
to create snapshots necessary to
|
||||
'zfs diff'.
|
||||
hold subcommand Allows adding a user hold to a snapshot
|
||||
load-key subcommand Allows loading and unloading of encryption key
|
||||
(see 'zfs load-key' and 'zfs unload-key').
|
||||
change-key subcommand Allows changing an encryption key via
|
||||
'zfs change-key'.
|
||||
mount subcommand Allows mount/umount of ZFS datasets
|
||||
promote subcommand Must also have the 'mount' and 'promote'
|
||||
ability in the origin file system
|
||||
receive subcommand Must also have the 'mount' and 'create'
|
||||
ability
|
||||
release subcommand Allows releasing a user hold which might
|
||||
destroy the snapshot
|
||||
rename subcommand Must also have the 'mount' and 'create'
|
||||
ability in the new parent
|
||||
rollback subcommand Must also have the 'mount' ability
|
||||
send subcommand
|
||||
share subcommand Allows sharing file systems over NFS
|
||||
or SMB protocols
|
||||
snapshot subcommand Must also have the 'mount' ability
|
||||
.TS
|
||||
l l l .
|
||||
NAME TYPE NOTES
|
||||
_ _ _
|
||||
allow subcommand Must also have the permission that is being allowed
|
||||
bookmark subcommand
|
||||
clone subcommand Must also have the \fBcreate\fR ability and \fBmount\fR ability in the origin file system
|
||||
create subcommand Must also have the \fBmount\fR ability. Must also have the \fBrefreservation\fR ability to create a non-sparse volume.
|
||||
destroy subcommand Must also have the \fBmount\fR ability
|
||||
diff subcommand Allows lookup of paths within a dataset given an object number, and the ability to create snapshots necessary to \fBzfs diff\fR.
|
||||
hold subcommand Allows adding a user hold to a snapshot
|
||||
load subcommand Allows loading and unloading of encryption key (see \fBzfs load-key\fR and \fBzfs unload-key\fR).
|
||||
change subcommand Allows changing an encryption key via \fBzfs change-key\fR.
|
||||
mount subcommand Allows mounting/umounting ZFS datasets
|
||||
promote subcommand Must also have the \fBmount\fR and \fBpromote\fR ability in the origin file system
|
||||
receive subcommand Must also have the \fBmount\fR and \fBcreate\fR ability
|
||||
release subcommand Allows releasing a user hold which might destroy the snapshot
|
||||
rename subcommand Must also have the \fBmount\fR and \fBcreate\fR ability in the new parent
|
||||
rollback subcommand Must also have the \fBmount\fR ability
|
||||
send subcommand
|
||||
share subcommand Allows sharing file systems over NFS or SMB protocols
|
||||
snapshot subcommand Must also have the \fBmount\fR ability
|
||||
|
||||
groupquota other Allows accessing any groupquota@...
|
||||
property
|
||||
groupused other Allows reading any groupused@... property
|
||||
userprop other Allows changing any user property
|
||||
userquota other Allows accessing any userquota@...
|
||||
property
|
||||
userused other Allows reading any userused@... property
|
||||
projectobjquota other Allows accessing any projectobjquota@...
|
||||
property
|
||||
projectquota other Allows accessing any projectquota@... property
|
||||
projectobjused other Allows reading any projectobjused@... property
|
||||
projectused other Allows reading any projectused@... property
|
||||
groupquota other Allows accessing any \fBgroupquota@\fI...\fR property
|
||||
groupused other Allows reading any \fBgroupused@\fI...\fR property
|
||||
userprop other Allows changing any user property
|
||||
userquota other Allows accessing any \fBuserquota@\fI...\fR property
|
||||
userused other Allows reading any \fBuserused@\fI...\fR property
|
||||
projectobjquota other Allows accessing any \fBprojectobjquota@\fI...\fR property
|
||||
projectquota other Allows accessing any \fBprojectquota@\fI...\fR property
|
||||
projectobjused other Allows reading any \fBprojectobjused@\fI...\fR property
|
||||
projectused other Allows reading any \fBprojectused@\fI...\fR property
|
||||
|
||||
aclinherit property
|
||||
acltype property
|
||||
atime property
|
||||
canmount property
|
||||
casesensitivity property
|
||||
checksum property
|
||||
compression property
|
||||
copies property
|
||||
devices property
|
||||
exec property
|
||||
filesystem_limit property
|
||||
mountpoint property
|
||||
nbmand property
|
||||
normalization property
|
||||
primarycache property
|
||||
quota property
|
||||
readonly property
|
||||
recordsize property
|
||||
refquota property
|
||||
refreservation property
|
||||
reservation property
|
||||
secondarycache property
|
||||
setuid property
|
||||
sharenfs property
|
||||
sharesmb property
|
||||
snapdir property
|
||||
snapshot_limit property
|
||||
utf8only property
|
||||
version property
|
||||
volblocksize property
|
||||
volsize property
|
||||
vscan property
|
||||
xattr property
|
||||
zoned property
|
||||
.Ed
|
||||
aclinherit property
|
||||
acltype property
|
||||
atime property
|
||||
canmount property
|
||||
casesensitivity property
|
||||
checksum property
|
||||
compression property
|
||||
copies property
|
||||
devices property
|
||||
exec property
|
||||
filesystem_limit property
|
||||
mountpoint property
|
||||
nbmand property
|
||||
normalization property
|
||||
primarycache property
|
||||
quota property
|
||||
readonly property
|
||||
recordsize property
|
||||
refquota property
|
||||
refreservation property
|
||||
reservation property
|
||||
secondarycache property
|
||||
setuid property
|
||||
sharenfs property
|
||||
sharesmb property
|
||||
snapdir property
|
||||
snapshot_limit property
|
||||
utf8only property
|
||||
version property
|
||||
volblocksize property
|
||||
volsize property
|
||||
vscan property
|
||||
xattr property
|
||||
zoned property
|
||||
.TE
|
||||
.It Xo
|
||||
.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 setname Oc Ns …
|
||||
.Ar filesystem Ns | Ns Ar volume
|
||||
.Xc
|
||||
Sets
|
||||
@@ -293,7 +279,7 @@ to the creator of any newly-created descendent file system.
|
||||
.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 setname Oc Ns …
|
||||
.Ar filesystem Ns | Ns Ar volume
|
||||
.Xc
|
||||
Defines or adds permissions to a permission set.
|
||||
@@ -309,9 +295,9 @@ and can be no more than 64 characters long.
|
||||
.Nm zfs
|
||||
.Cm unallow
|
||||
.Op Fl dglru
|
||||
.Ar user Ns | Ns Ar group Ns Oo , Ns Ar user Ns | Ns Ar group Oc Ns ...
|
||||
.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 setname Oc Ns … Oc
|
||||
.Ar filesystem Ns | Ns Ar volume
|
||||
.Xc
|
||||
.It Xo
|
||||
@@ -320,7 +306,7 @@ and can be no more than 64 characters long.
|
||||
.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 setname Oc Ns … Oc
|
||||
.Ar filesystem Ns | Ns Ar volume
|
||||
.Xc
|
||||
.It Xo
|
||||
@@ -329,7 +315,7 @@ and can be no more than 64 characters long.
|
||||
.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 setname Oc Ns … Oc
|
||||
.Ar filesystem Ns | Ns Ar volume
|
||||
.Xc
|
||||
Removes permissions that were granted with the
|
||||
@@ -367,7 +353,7 @@ Recursively remove the permissions from this file system and all descendents.
|
||||
.Op Fl r
|
||||
.Fl s No @ Ns Ar setname
|
||||
.Oo Ar perm Ns | Ns @ Ns Ar setname Ns Oo , Ns Ar perm Ns | Ns @ Ns
|
||||
.Ar setname Oc Ns ... Oc
|
||||
.Ar setname Oc Ns … Oc
|
||||
.Ar filesystem Ns | Ns Ar volume
|
||||
.Xc
|
||||
Removes permissions from a permission set.
|
||||
|
||||
Reference in New Issue
Block a user