man1-editing-pass-20051209
[openafs.git] / doc / man-pages / pod1 / fs_setvol.pod
index c7bb382..5768638 100644 (file)
@@ -1,95 +1,90 @@
 =head1 NAME
 
-fs setvol - Set maximum quota and messages for the volume containing a file or
-directory
+fs setvol - Set quota and messages for a volume containing a file or directory
 
 =head1 SYNOPSIS
 
-B<fs setvol> [B<-path> <I<dir/file path>>+]  [-max <I<disk space quota in 1K units>>]
-[B<-offlinemsg> <I<offline message>>]  [B<-help>]
+B<fs setvol> [B<-path> <I<dir/file path>>+]
+    [B<-max> <I<disk space quota in 1K units>>]
+    [B<-offlinemsg> <I<offline message>>] [B<-help>]
 
-B<fs setv> [B<-p> <I<dir/file path>>+]  [-ma <I<disk space quota in 1K  units>>] 
-[B<-o> <I<offline message>>]  [B<-h>]
+B<fs setv> [B<-p> <I<dir/file path>>+]
+    [B<-ma> <I<disk space quota in 1K units>>] 
+    [B<-o> <I<offline message>>] [B<-h>]
     
-B<fs sv> [B<-p> <I<dir/file path>>+]  [-ma <I<disk space quota in 1K units>>] 
-[B<-o> <I<offline message>>]  [B<-h>]
+B<fs sv> [B<-p> <I<dir/file path>>+]
+    [B<-ma> <I<disk space quota in 1K units>>] 
+    [B<-o> <I<offline message>>] [B<-h>]
 
 =head1 DESCRIPTION
 
-The 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
+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 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 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 fs setquota
-command.
+To set quota on one volume at a time, use the B<fs setquota> command.
 
 =head1 OPTIONS
 
 =over 4
 
-=item -path
+=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
+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,
-B</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.
+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 -max
+=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 (B<1024> is one megabyte). A value of
-B<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.
+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 -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.
+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 -offlinemsg
->
+=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.
+the B<fs examine> command. Its intended use is to explain why the volume
+is currently offline.
 
-=item -help
+=item B<-help>
 
-Prints the online help for this command. All other valid options
-are ignored.
+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 B</afs/abc.com/usr/smith> and
-B</afs/abc.com/usr/pat>:
+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.
+The issuer must belong to the system:administrators group.
 
 =head1 SEE ALSO