.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "FS_LISTQUOTA 1"
.TH FS_LISTQUOTA 1 2024-03-20 OpenAFS "AFS Command Reference"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
fs_listquota \- Displays quota information for a volume
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBfs listquota\fR [\fB\-path\fR\ <\fIdir/file\ path\fR>+] [\fB\-human\fR] [\fB\-help\fR]
.PP
\&\fBfs listq\fR [\fB\-p\fR\ <\fIdir/file\ path\fR>+] [\fB\-hu\fR] [\fB\-he\fR]
.PP
\&\fBfs lq\fR [\fB\-p\fR\ <\fIdir/file\ path\fR>+] [\fB\-hu\fR] [\fB\-he\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBfs listquota\fR command displays information about the volume
containing each specified directory or file (its name, quota, and amount
of disk space used), along with an indicator of the percentage of space
used on the host partition.
.PP
To display more information about the host partition, use the \fBfs
examine\fR command.
.PP
To set volume quota, use the \fBfs setquota\fR or \fBfs setvol\fR command.
.SH CAUTIONS
.IX Header "CAUTIONS"
Currently, the maximum quota for a volume is 2 terabytes (2^41 bytes). Note
that this only affects the volume's quota; a volume may grow much larger if
the volume quota is disabled. However, volumes over 2 terabytes in size may
be impractical to move, and may have their size incorrectly reported by some
tools, such as \fBfs_listquota\fR\|(1).
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-path\fR <\fIdir/file path\fR>+" 4
.IX Item "-path
+"
Names a file or directory that resides in the volume about which to
produce output. Partial pathnames are interpreted relative to the current
working directory, which is also the default value if this argument is
omitted.
.IP \fB\-human\fR 4
.IX Item "-human"
Print space in a "human-readable" format. Instead of always printing space
in kilobytes, show disk space in kilobytes, megabytes, gigabytes,
terabytes, or petabytes, as appropriate.
.IP \fB\-help\fR 4
.IX Item "-help"
Prints the online help for this command. All other valid options are
ignored.
.SH OUTPUT
.IX Header "OUTPUT"
The output displays information about the volume that houses each
specified directory or file, in a tabular format that uses the following
headers:
.IP "Volume Name" 4
.IX Item "Volume Name"
The name of the volume.
.IP Quota 4
.IX Item "Quota"
The volume's quota in kilobytes, or the string \f(CW\*(C`no limit\*(C'\fR to indicate an
unlimited quota.
.IP Used 4
.IX Item "Used"
The amount of space used. If \fB\-human\fR is not specified, this value is in
kilobytes.
.IP "% Used" 4
.IX Item "% Used"
The percentage of the volume's quota that is used (the \f(CW\*(C`Used\*(C'\fR statistic
divided by the \f(CW\*(C`Quota\*(C'\fR statistic, times 100).
.IP Partition 4
.IX Item "Partition"
The percentage of space used on the partition that houses the
volume. Although not directly related to how much of the user's quota is
used, it is reported because a full partition can cause writing of data
back to the volume to fail even when the volume has not reached its quota.
.Sp
Note that due to limitations in the current wire protocol, OpenAFS cannot
accurately calculate this field for partitions over 2 terabytes (2^41 bytes)
in size. As a result, the percentage displayed in this field may be smaller
than reality. For example, if the partition has over 2 terabytes (2^41 bytes)
free, \fBfs listquota\fR will report the partition usage as 0%. If the partition
has less than 2 terabytes (2^41 bytes) free, but is larger than 2 terabytes
(2^41 bytes) in size, the reported partition usage will be larger than
0%, but will still be less than the actual usage.
.SH EXAMPLES
.IX Header "EXAMPLES"
The following example shows the output for the volume \f(CW\*(C`user.smith\*(C'\fR:
.PP
.Vb 3
\& % fs listquota \-path /afs/example.com/usr/smith
\& Volume Name Quota Used % Used Partition
\& user.smith 15000 5071 34% 86%
.Ve
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
The issuer must have the \f(CW\*(C`r\*(C'\fR (read) permission on the ACL of the root
directory of the volume that houses the file or directory named by the
\&\fB\-path\fR argument, and \f(CW\*(C`l\*(C'\fR (list) permission on the ACL of each
directory that precedes it in the pathname.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBfs_diskfree\fR\|(1),
\&\fBfs_examine\fR\|(1),
\&\fBfs_quota\fR\|(1),
\&\fBfs_setquota\fR\|(1),
\&\fBfs_setvol\fR\|(1)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
IBM Corporation 2000. All Rights Reserved.
.PP
This documentation is covered by the IBM Public License Version 1.0. It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.