openafs/doc/man-pages/pod1/fs_setquota.pod
Ken Dreyer 1cc8feb6fc doc: replace hostnames with IETF example hostnames
There were several different real and made-up hostnames and company names used
throughout our documentation examples.

The IETF has reserved "example.com" and other "example" TLDs for use in
examples (RFC 2606). Replace almost all references to ABC Corporation, DEF
Corporation, and State University, as well as "abc.com", "bigcell.com",
"def.com", "def.gov", "ghi.com", "ghi.gov", "jkl.com", "mit.edu",
"stanford.edu", "state.edu", "stateu.edu", "uncc.edu", and "xyz.com".
Standardize on "Example Corporation", "Example Network", "Example
Organization" (example.com, example.net, and example.org).

The Scout documentation in the Admin Guide contains PNG images that contain
the old cell names, so I left those references until the images can be
replaced.

Change-Id: I4e44815b2d2ffe204810b7fd850842248f67c367
Reviewed-on: http://gerrit.openafs.org/6697
Reviewed-by: Jeffrey Altman <jaltman@secure-endpoints.com>
Tested-by: Jeffrey Altman <jaltman@secure-endpoints.com>
2012-02-17 20:51:58 -08:00

100 lines
3.0 KiB
Plaintext

=head1 NAME
fs_setquota - Sets the quota for the volume containing a file or directory
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<fs setquota> S<<< [B<-path> <I<dir/file path>>] >>>
S<<< B<-max> <I<max quota in kbytes>> >>> [B<-help>]
B<fs setq> S<<< [B<-p> <I<dir/file path>>] >>> S<<< B<-m> <I<max quota>> >>> [B<-h>]
B<fs sq> S<<< [B<-p> <I<dir/file path>>] >>> S<<< B<-m> <I<max quota>> >>> [B<-h>]
=for html
</div>
=head1 DESCRIPTION
The B<fs setquota> command sets the quota (maximum possible size) of the
read/write volume that contains the directory or file named by the
B<-path> argument.
To set the quota on multiple volumes at the same time, use the B<fs
setvol> command.
To display a volume's quota, use the B<fs examine>, B<fs listquota>, or
B<fs quota> command.
=head1 CAUTIONS
Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
=head1 OPTIONS
=over 4
=item B<-path> <I<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.
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, F</afs/.example.com>). For
further discussion of the concept of read/write and read-only paths
through the filespace, see the B<fs mkmount> reference page.
=item B<-max> <I<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: C<K> for kibibytes (1024 bytes, the default), C<M> for mebibytes
(1024 kibibytes), C<G> for gibibytes (1024 mebibytes), and C<T> for
tebibytes (1024 gibibytes). A value of C<0> sets an unlimited quota, but
the size of the disk partition that houses the volume places an absolute
limit on the volume's size.
If the B<-path> argument is omitted (to set the quota of the volume
housing the current working directory), the B<-max> switch must be
included with this argument.
=item B<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 EXAMPLES
The following command imposes a maximum quota of 3000 kilobytes on the
volume that houses the F</afs/example.com/usr/smith> directory:
% fs setquota -path /afs/example.com/usr/smith -max 3000
=head1 PRIVILEGE REQUIRED
The issuer must belong to the system:administrators group.
=head1 SEE ALSO
L<fs_examine(1)>,
L<fs_listquota(1)>,
L<fs_quota(1)>,
L<fs_mkmount(1)>,
L<fs_setvol(1)>
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
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.