doc/man-pages/pod1/fs_diskfree.pod

   1 =head1 NAME
   2
   3 fs diskfree - Shows data about the partition housing a directory or file
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<fs diskfree> S<<< [B<-path> <I<dir/file path>>+] >>> [B<-help>]
  11
  12 B<fs df> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
  13
  14 B<fs di> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
  15
  16 =for html
  17 </div>
  18
  19 =head1 DESCRIPTION
  20
  21 The B<fs diskfree> command formats and displays information about the
  22 partition that houses the volume containing the specified directory or
  23 file, including its size and how much space is currently used.
  24
  25 To display information about the volume itself, use the B<fs examine>
  26 command. The B<fs examine> and B<fs quota> commands also display
  27 information about a volume.
  28
  29 =head1 CAUTIONS
  30
  31 The partition-related statistics in this command's output do not always
  32 agree with the corresponding values in the output of the standard UNIX
  33 B<df> command. The statistics reported by this command can be up to five
  34 minutes old, because the Cache Manager polls the File Server for partition
  35 information at that frequency. Also, on some operating systems, the B<df>
  36 command's report of partition size includes reserved space not included in
  37 this command's calculation, and so is likely to be about 10% larger.
  38
  39 =head1 OPTIONS
  40
  41 =over 4
  42
  43 =item B<-path> <I<dir/file path>>+
  44
  45 Names a file or directory that resides on the partition about which to
  46 produce output. Partial pathnames are interpreted relative to the current
  47 working directory, which is also the default value if this argument is
  48 omitted.
  49
  50 =item B<-help>
  51
  52 Prints the online help for this command. All other valid options are
  53 ignored.
  54
  55 =back
  56
  57 =head1 OUTPUT
  58
  59 The output reports the following information about the volume and
  60 partition that houses each file or directory:
  61
  62 =over 4
  63
  64 =item Volume Name
  65
  66 The name of the volume.
  67
  68 =item kbytes
  69
  70 The partition's total size in kilobytes.
  71
  72 =item used
  73
  74 The number of kilobytes used on the partition.
  75
  76 =item avail
  77
  78 The number of kilobytes available on the partition.
  79
  80 =item %used
  81
  82 The percentage of the partition's total space that is used (the C<used>
  83 statistic divided by the C<kbytes> statistic, times 100).
  84
  85 =back
  86
  87 If the C<%used> statistic is greater than 90%, it is marked with the
  88 string C<<< <<WARNING >>> at the right margin.
  89
  90 If the volume is a read-only volume, the output includes information about
  91 only one of the partitions that houses it, generally the one on the file
  92 server machine with the lowest preference rank. To verify which machine
  93 the output is referring to, use the B<vos listvldb> command to list the
  94 volume's locations, and the B<vos partinfo> command to display the size of
  95 each one.
  96
  97 =head1 EXAMPLES
  98
  99 The following example shows the output for the partitions housing the
 100 volumes C<user.smith> and C<sun4x_56.bin>:
 101
 102    % fs diskfree -path /afs/abc.com/usr/smith /afs/abc.com/sun4x_56/bin
 103    Volume Name     kbytes  used     avail     %used
 104    user.smith     4177920 3841258  336662       92% <<WARNING
 105    sun4x_56.bin   4423680 3174500 1249180       72%
 106
 107 =head1 PRIVILEGE REQUIRED
 108
 109 The issuer must have the C<l> (lookup) permission on the ACL of the root
 110 directory of the volume that houses the file or directory named by the
 111 B<-path> argument, and on the ACL of each directory that precedes it in
 112 the pathname.
 113
 114 =head1 SEE ALSO
 115
 116 L<fs_examine(1)>
 117
 118 =head1 COPYRIGHT
 119
 120 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 121
 122 This documentation is covered by the IBM Public License Version 1.0.  It was
 123 converted from HTML to POD by software written by Chas Williams and Russ
 124 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.