.\" -*- 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_QUOTA 1"
.TH FS_QUOTA 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_quota \- Displays the quota used in the volume containing a directory or file
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBfs quota\fR [\fB\-path\fR\ <\fIdir/file\ path\fR>+] [\fB\-help\fR]
.PP
\&\fBfs q\fR [\fB\-p\fR\ <\fIdir/file\ path\fR>+] [\fB\-h\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBfs quota\fR command displays the percent of quota consumed in the
volume that contains each specified directory or file.
.PP
To display more detailed information about the volume and the partition it
resides on, use the \fBfs examine\fR and \fBfs listquota\fR commands.
.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 <dir/file path>"
Names each file or directory for which to display the quota consumed in
its parent volume. Partial pathnames are interpreted relative to the
current working directory, which is also the default value if this
argument is omitted.
.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 reports the percent of volume quota used, in the following
format:
.PP
.Vb 1
\&   <percent>% of quota used.
.Ve
.SH EXAMPLES
.IX Header "EXAMPLES"
The following command lists the percent quota used of the volume housing
the current working directory:
.PP
.Vb 2
\&   % fs quota
\&   17% of quota used.
.Ve
.PP
The following command lists the percent quota used of both the volume
housing the current working directory's parent directory and the volume
housing the directory \fI/afs/example.com/usr/smith\fR:
.PP
.Vb 3
\&   % fs quota \-path .. /afs/example.com/usr/smith
\&   43% of quota used.
\&   92% of quota used.
.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_examine\fR\|(1),
\&\fBfs_listquota\fR\|(1),
\&\fBfs_setquota\fR\|(1),
\&\fBfs_setvol\fR\|(1)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
IBM Corporation 2000. <http://www.ibm.com/> 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.