doc/man-pages/pod1/fs_setvol.pod.in

   1 =head1 NAME
   2
   3 fs_setvol - Set quota and messages for a volume containing a file or directory
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<fs setvol> S<<< [B<-path> <I<dir/file path>>+] >>>
  11     S<<< [B<-max> <I<disk space quota in 1K units>>] >>>
  12     S<<< [B<-offlinemsg> <I<offline message>>] >>> [B<-help>]
  13
  14 B<fs setv> S<<< [B<-p> <I<dir/file path>>+] >>>
  15     S<<< [B<-ma> <I<disk space quota in 1K units>>] >>>
  16     S<<< [B<-o> <I<offline message>>] >>> [B<-h>]
  17
  18 B<fs sv> S<<< [B<-p> <I<dir/file path>>+] >>>
  19     S<<< [B<-ma> <I<disk space quota in 1K units>>] >>>
  20     S<<< [B<-o> <I<offline message>>] >>> [B<-h>]
  21
  22 =for html
  23 </div>
  24
  25 =head1 DESCRIPTION
  26
  27 The B<fs setvol> command sets the quota (maximum possible size) of the
  28 read/write volume that contains each directory or file named by the
  29 B<-path> argument. To associate a message with the volume which then
  30 appears in the output of the B<fs examine> command, include the
  31 B<-offlinemsg> argument.
  32
  33 To display all of the settings made with this command, use the B<fs
  34 examine> command. The B<fs listquota> command reports a fileset's quota,
  35 and the B<fs quota> command the percent of quota used.
  36
  37 To set quota on one volume at a time, use the B<fs setquota> command.
  38
  39 =head1 CAUTIONS
  40
  41 =include fragments/volsize-caution.pod
  42
  43 =head1 OPTIONS
  44
  45 =over 4
  46
  47 =item B<-path> <I<dir/file path>>+
  48
  49 Names each file or directory for which to set the host volume's quota and
  50 offline message. Partial pathnames are interpreted relative to the current
  51 working directory, which is also the default value if this argument is
  52 omitted.
  53
  54 Specify the read/write path to the file or directory, to avoid the failure
  55 that results from attempting to change a read-only volume. By convention,
  56 the read/write path is indicated by placing a period before the cell name
  57 at the pathname's second level (for example, F</afs/.example.com>). For
  58 further discussion of the concept of read/write and read-only paths
  59 through the filespace, see the B<fs mkmount> reference page.
  60
  61 =item B<-max> <I<disk space quota in 1K units>>
  62
  63 Sets the maximum amount of file server disk space the volume can
  64 occupy. Provide a positive integer to indicate the number of one-kilobyte
  65 blocks (C<1024> is one megabyte). A value of C<0> sets an unlimited quota,
  66 but the size of the disk partition that houses the volume places an
  67 absolute limit on the volume's size.
  68
  69 If the B<-path> argument is omitted (so that the command sets the quota of
  70 the volume housing the current working directory), the B<-max> switch must
  71 be provided.
  72
  73 =item B<-offlinemsg>
  74
  75 Associates a message with the volume which then appears in the output of
  76 the B<fs examine> command. Its intended use is to explain why the volume
  77 is currently offline.
  78
  79 =item B<-help>
  80
  81 Prints the online help for this command. All other valid options are
  82 ignored.
  83
  84 =back
  85
  86 =head1 EXAMPLES
  87
  88 The following command imposes a 6500 kilobyte quota on the volumes mounted
  89 at the home directories F</afs/example.com/usr/smith> and
  90 F</afs/example.com/usr/pat>:
  91
  92    % cd /afs/example.com/usr
  93    % fs setvol -path smith pat -max 6500B<>
  94
  95 =head1 PRIVILEGE REQUIRED
  96
  97 The issuer must belong to the system:administrators group.
  98
  99 =head1 SEE ALSO
 100
 101 L<fs_examine(1)>,
 102 L<fs_listquota(1)>,
 103 L<fs_mkmount(1)>,
 104 L<fs_quota(1)>,
 105 L<fs_setquota(1)>
 106
 107 =head1 COPYRIGHT
 108
 109 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 110
 111 This documentation is covered by the IBM Public License Version 1.0.  It was
 112 converted from HTML to POD by software written by Chas Williams and Russ
 113 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.