openafs/doc/man-pages/pod1/fs_setvol.pod
Russ Allbery fc5acc0151 pretty-html-synopsis-20060228
Implement proper synopsis wrapping for HTML generation.

This was done in three pieces.  First, add HTML-specific tags to the POD to
mark the synopsis for HTML purposes so that we can apply style information
to it.  Second, update the style sheet to indent all lines except for the
first in the synopsis section.  Third, add the appropriate S<> tags around
option and argument pairs so that we don't wrap between the option and its
argument.

Unfortunately, due to the <I<foo>> style that looks nicer for other reasons,
we have to use the very verbose S<<< >>>.  Oh well.
2006-03-01 05:02:29 +00:00

110 lines
3.4 KiB
Plaintext

=head1 NAME
fs setvol - Set quota and messages for a volume containing a file or directory
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<fs setvol> S<<< [B<-path> <I<dir/file path>>+] >>>
S<<< [B<-max> <I<disk space quota in 1K units>>] >>>
S<<< [B<-offlinemsg> <I<offline message>>] >>> [B<-help>]
B<fs setv> S<<< [B<-p> <I<dir/file path>>+] >>>
S<<< [B<-ma> <I<disk space quota in 1K units>>] >>>
S<<< [B<-o> <I<offline message>>] >>> [B<-h>]
B<fs sv> S<<< [B<-p> <I<dir/file path>>+] >>>
S<<< [B<-ma> <I<disk space quota in 1K units>>] >>>
S<<< [B<-o> <I<offline message>>] >>> [B<-h>]
=for html
</div>
=head1 DESCRIPTION
The B<fs setvol> command sets the quota (maximum possible size) of the
read/write volume that contains each directory or file named by the
B<-path> argument. To associate a message with the volume which then
appears in the output of the B<fs examine> command, include the
B<-offlinemsg> argument.
To display all of the settings made with this command, use the B<fs
examine> command. The B<fs listquota> command reports a fileset's quota,
and the B<fs quota> command the percent of quota used.
To set quota on one volume at a time, use the B<fs setquota> command.
=head1 OPTIONS
=over 4
=item B<-path> <I<dir/file path>>+
Names each file or directory for which to set the host volume's quota and
offline message. 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/.abc.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<disk space quota in 1K units>>
Sets the maximum amount of file server disk space the volume can
occupy. Provide a positive integer to indicate the number of one-kilobyte
blocks (C<1024> is one megabyte). 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 (so that the command sets the quota of
the volume housing the current working directory), the B<-max> switch must
be provided.
=item B<-offlinemsg>
Associates a message with the volume which then appears in the output of
the B<fs examine> command. Its intended use is to explain why the volume
is currently offline.
=item B<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 EXAMPLES
The following command imposes a 6500 kilobyte quota on the volumes mounted
at the home directories F</afs/abc.com/usr/smith> and
F</afs/abc.com/usr/pat>:
% cd /afs/abc.com/usr
% fs setvol -path smith pat -max 6500B<>
=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_mkmount(1)>,
L<fs_quota(1)>,
L<fs_setquota(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.