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

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