.\" -*- 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_SETQUOTA 1"
.TH FS_SETQUOTA 1 2024-02-03 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_setquota \- Sets the quota for the volume containing a file or directory
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBfs setquota\fR [\fB\-path\fR\ <\fIdir/file\ path\fR>]
    \fB\-max\fR\ <\fImax\ quota\ in\ kbytes\fR> [\fB\-help\fR]
.PP
\&\fBfs setq\fR [\fB\-p\fR\ <\fIdir/file\ path\fR>] \fB\-m\fR\ <\fImax\ quota\fR> [\fB\-h\fR]
.PP
\&\fBfs sq\fR [\fB\-p\fR\ <\fIdir/file\ path\fR>] \fB\-m\fR\ <\fImax\ quota\fR> [\fB\-h\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBfs setquota\fR command sets the quota (maximum possible size) of the
read/write volume that contains the directory or file named by the
\&\fB\-path\fR argument.
.PP
To set the quota on multiple volumes at the same time, use the \fBfs
setvol\fR command.
.PP
To display a volume's quota, use the \fBfs examine\fR, \fBfs listquota\fR, or
\&\fBfs quota\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 the directory or file for which to set the host volume's
quota. Partial pathnames are interpreted relative to the current working
directory, which is also the default value if this argument is omitted.
.Sp
Specify the read/write path to the file or directory, to avoid the failure
that results from attempting to change a read-only volume. By convention,
the read/write path is indicated by placing a period before the cell name
at the pathname's second level (for example, \fI/afs/.example.com\fR). For
further discussion of the concept of read/write and read-only paths
through the filespace, see the \fBfs mkmount\fR reference page.
.IP "\fB\-max\fR <\fImax quota\fR>" 4
.IX Item "-max <max quota>"
Sets the maximum amount of file server disk space the volume can occupy.
The quota value should be a positive integer followed by an optional
suffix: \f(CW\*(C`K\*(C'\fR for kibibytes (1024 bytes, the default), \f(CW\*(C`M\*(C'\fR for mebibytes
(1024 kibibytes), \f(CW\*(C`G\*(C'\fR for gibibytes (1024 mebibytes), and \f(CW\*(C`T\*(C'\fR for
tebibytes (1024 gibibytes).  A value of \f(CW0\fR sets an unlimited quota, but
the size of the disk partition that houses the volume places an absolute
limit on the volume's size.
.Sp
If the \fB\-path\fR argument is omitted (to set the quota of the volume
housing the current working directory), the \fB\-max\fR switch must be
included with this argument.
.IP \fB\-help\fR 4
.IX Item "-help"
Prints the online help for this command. All other valid options are
ignored.
.SH EXAMPLES
.IX Header "EXAMPLES"
The following command imposes a maximum quota of 3000 kilobytes on the
volume that houses the \fI/afs/example.com/usr/smith\fR directory:
.PP
.Vb 1
\&   % fs setquota \-path /afs/example.com/usr/smith \-max 3000
.Ve
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
The issuer must belong to the system:administrators group.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBfs_examine\fR\|(1),
\&\fBfs_listquota\fR\|(1),
\&\fBfs_quota\fR\|(1),
\&\fBfs_mkmount\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.