mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2024-11-17 10:01:01 +03:00
870fc32fc9
Most subcommands got their own manpages (e.g. create). Some related commands grouped into a single manpage and symlinks created (e.g. set, get, and inherit). I did this when topics were either too short to warrant their own file or so interrelated that a user would want to refer between commands in the same file. Corrected .Sx internal references to .Xr cross refs; lots of .Sx references from when text was all in zfs.8 needed to be changed to .Xr zfs-$SUBCOMMAND 8 cross references. Divided subcommand list in zfs(8) into sections of related functionality. This required writing new descriptions for some commands. Preserved ".Os Linux", `.Os` macro parsing behavior differs between mandoc from the "BSD" mandoc package (available on Ubuntu) and man from Ubuntu's man-db package, which calls groff to format the manpages. Groff handles the `.Os` macro differently and wrongly, defaulting it to "BSD" in `/usr/share/groff/*/tmac/mdoc/doc-common`, instead of getting the default from `uname`. A future set of changes will introduce build-time preprocessing of manpages for platform-specific documentation and can insert the correct operating system name. Added SEE ALSO sections, the newly-divided zfs-*.8 subcommand man pages needed their own SEE ALSO sections pointing to related subcommands and, in some cases, documentation from other packages (e.g. zfs-share.8). Reviewed-by: Matt Ahrens <matt@delphix.com> Reviewed-by: Kjeld Schouten <kjeld@schouten-lebbing.nl> Reviewed-by: Sean Eric Fagan <sef@ixsystems.com> Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Ross Williams <ross@ross-williams.net> Closes #9559
187 lines
5.1 KiB
Groff
187 lines
5.1 KiB
Groff
.\"
|
|
.\" CDDL HEADER START
|
|
.\"
|
|
.\" The contents of this file are subject to the terms of the
|
|
.\" Common Development and Distribution License (the "License").
|
|
.\" You may not use this file except in compliance with the License.
|
|
.\"
|
|
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
|
|
.\" or http://www.opensolaris.org/os/licensing.
|
|
.\" See the License for the specific language governing permissions
|
|
.\" and limitations under the License.
|
|
.\"
|
|
.\" When distributing Covered Code, include this CDDL HEADER in each
|
|
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
|
|
.\" If applicable, add the following below this CDDL HEADER, with the
|
|
.\" fields enclosed by brackets "[]" replaced with your own identifying
|
|
.\" information: Portions Copyright [yyyy] [name of copyright owner]
|
|
.\"
|
|
.\" 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.
|
|
.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
|
|
.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
|
|
.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
|
|
.\" Copyright (c) 2014 Integros [integros.com]
|
|
.\" Copyright 2019 Richard Laager. All rights reserved.
|
|
.\" Copyright 2018 Nexenta Systems, Inc.
|
|
.\" Copyright 2019 Joyent, Inc.
|
|
.\"
|
|
.Dd June 30, 2019
|
|
.Dt ZFS-USERSPACE 8
|
|
.Os Linux
|
|
.Sh NAME
|
|
.Nm zfs Ns Pf - Cm userspace
|
|
.Nd Displays space consumed by, and quotas on, each user or group in the specified filesystem or snapshot.
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Cm userspace
|
|
.Op Fl Hinp
|
|
.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
|
|
.Oo Fl s Ar field Oc Ns ...
|
|
.Oo Fl S Ar field Oc Ns ...
|
|
.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
|
|
.Ar filesystem Ns | Ns Ar snapshot
|
|
.Nm
|
|
.Cm groupspace
|
|
.Op Fl Hinp
|
|
.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
|
|
.Oo Fl s Ar field Oc Ns ...
|
|
.Oo Fl S Ar field Oc Ns ...
|
|
.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
|
|
.Ar filesystem Ns | Ns Ar snapshot
|
|
.Nm
|
|
.Cm projectspace
|
|
.Op Fl Hp
|
|
.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
|
|
.Oo Fl s Ar field Oc Ns ...
|
|
.Oo Fl S Ar field Oc Ns ...
|
|
.Ar filesystem Ns | Ns Ar snapshot
|
|
.Sh DESCRIPTION
|
|
.Bl -tag -width ""
|
|
.It Xo
|
|
.Nm
|
|
.Cm userspace
|
|
.Op Fl Hinp
|
|
.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
|
|
.Oo Fl s Ar field Oc Ns ...
|
|
.Oo Fl S Ar field Oc Ns ...
|
|
.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
|
|
.Ar filesystem Ns | Ns Ar snapshot
|
|
.Xc
|
|
Displays space consumed by, and quotas on, each user in the specified filesystem
|
|
or snapshot.
|
|
This corresponds to the
|
|
.Sy userused@ Ns Em user ,
|
|
.Sy userobjused@ Ns Em user ,
|
|
.Sy userquota@ Ns Em user,
|
|
and
|
|
.Sy userobjquota@ Ns Em user
|
|
properties.
|
|
.Bl -tag -width "-H"
|
|
.It Fl H
|
|
Do not print headers, use tab-delimited output.
|
|
.It Fl S Ar field
|
|
Sort by this field in reverse order.
|
|
See
|
|
.Fl s .
|
|
.It Fl i
|
|
Translate SID to POSIX ID.
|
|
The POSIX ID may be ephemeral if no mapping exists.
|
|
Normal POSIX interfaces
|
|
.Po for example,
|
|
.Xr stat 2 ,
|
|
.Nm ls Fl l
|
|
.Pc
|
|
perform this translation, so the
|
|
.Fl i
|
|
option allows the output from
|
|
.Nm zfs Cm userspace
|
|
to be compared directly with those utilities.
|
|
However,
|
|
.Fl i
|
|
may lead to confusion if some files were created by an SMB user before a
|
|
SMB-to-POSIX name mapping was established.
|
|
In such a case, some files will be owned by the SMB entity and some by the POSIX
|
|
entity.
|
|
However, the
|
|
.Fl i
|
|
option will report that the POSIX entity has the total usage and quota for both.
|
|
.It Fl n
|
|
Print numeric ID instead of user/group name.
|
|
.It Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
|
|
Display only the specified fields from the following set:
|
|
.Sy type ,
|
|
.Sy name ,
|
|
.Sy used ,
|
|
.Sy quota .
|
|
The default is to display all fields.
|
|
.It Fl p
|
|
Use exact
|
|
.Pq parsable
|
|
numeric output.
|
|
.It Fl s Ar field
|
|
Sort output by this field.
|
|
The
|
|
.Fl s
|
|
and
|
|
.Fl S
|
|
flags may be specified multiple times to sort first by one field, then by
|
|
another.
|
|
The default is
|
|
.Fl s Sy type Fl s Sy name .
|
|
.It Fl t Ar type Ns Oo , Ns Ar type Oc Ns ...
|
|
Print only the specified types from the following set:
|
|
.Sy all ,
|
|
.Sy posixuser ,
|
|
.Sy smbuser ,
|
|
.Sy posixgroup ,
|
|
.Sy smbgroup .
|
|
The default is
|
|
.Fl t Sy posixuser Ns \&, Ns Sy smbuser .
|
|
The default can be changed to include group types.
|
|
.El
|
|
.It Xo
|
|
.Nm
|
|
.Cm groupspace
|
|
.Op Fl Hinp
|
|
.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
|
|
.Oo Fl s Ar field Oc Ns ...
|
|
.Oo Fl S Ar field Oc Ns ...
|
|
.Oo Fl t Ar type Ns Oo , Ns Ar type Oc Ns ... Oc
|
|
.Ar filesystem Ns | Ns Ar snapshot
|
|
.Xc
|
|
Displays space consumed by, and quotas on, each group in the specified
|
|
filesystem or snapshot.
|
|
This subcommand is identical to
|
|
.Cm userspace ,
|
|
except that the default types to display are
|
|
.Fl t Sy posixgroup Ns \&, Ns Sy smbgroup .
|
|
.It Xo
|
|
.Nm
|
|
.Cm projectspace
|
|
.Op Fl Hp
|
|
.Oo Fl o Ar field Ns Oo , Ns Ar field Oc Ns ... Oc
|
|
.Oo Fl s Ar field Oc Ns ...
|
|
.Oo Fl S Ar field Oc Ns ...
|
|
.Ar filesystem Ns | Ns Ar snapshot
|
|
.Xc
|
|
Displays space consumed by, and quotas on, each project in the specified
|
|
filesystem or snapshot. This subcommand is identical to
|
|
.Cm userspace ,
|
|
except that the project identifier is numeral, not name. So need neither
|
|
the option
|
|
.Sy -i
|
|
for SID to POSIX ID nor
|
|
.Sy -n
|
|
for numeric ID, nor
|
|
.Sy -t
|
|
for types.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr zfs-set 8 ,
|
|
.Xr zfsprops 8
|