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<-human>] [B<-help>]
  11
  12 B<fs df> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-hu>] [B<-he>]
  13
  14 B<fs di> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-hu>] [B<-he>]
  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<-human>
  51
  52 Print space in a "human-readable" format. Instead of always printing space
  53 in kilobytes, show disk space in kilobytes, megabytes, gigabytes,
  54 terabytes, or petabytes, as appropriate.
  55
  56 =item B<-help>
  57
  58 Prints the online help for this command. All other valid options are
  59 ignored.
  60
  61 =back
  62
  63 =head1 OUTPUT
  64
  65 The output reports the following information about the volume and
  66 partition that houses each file or directory:
  67
  68 =over 4
  69
  70 =item Volume Name
  71
  72 The name of the volume.
  73
  74 =item total
  75
  76 The partition's total size. If B<-human> is not specified, this value is
  77 in kilobytes.
  78
  79 =item used
  80
  81 The amount of space used on the partition. If B<-human> is not specified,
  82 this value is in kilobytes.
  83
  84 =item avail
  85
  86 The amount of space available on the partition. If B<-human> is not
  87 specified, this value is in kilobytes.
  88
  89 =item %used
  90
  91 The percentage of the partition's total space that is used (the C<used>
  92 statistic divided by the C<kbytes> statistic, times 100).
  93
  94 =back
  95
  96 If the C<%used> statistic is greater than 90%, it is marked with the
  97 string C<<< <<WARNING >>> at the right margin.
  98
  99 If the volume is a read-only volume, the output includes information about
 100 only one of the partitions that houses it, generally the one on the file
 101 server machine with the lowest preference rank. To verify which machine
 102 the output is referring to, use the B<vos listvldb> command to list the
 103 volume's locations, and the B<vos partinfo> command to display the size of
 104 each one.
 105
 106 =head1 EXAMPLES
 107
 108 The following example shows the output for the partitions housing the
 109 volumes C<user.smith> and C<sun4x_56.bin>:
 110
 111   % fs diskfree -path /afs/example.com/usr/smith /afs/example.com/sun4x_56/bin
 112   Volume Name      total    used   avail     %used
 113   user.smith     4177920 3841258  336662       92% <<WARNING
 114   sun4x_56.bin   4423680 3174500 1249180       72%
 115
 116 =head1 PRIVILEGE REQUIRED
 117
 118 The issuer must have the C<r> (read) permission on the ACL of the root
 119 directory of the volume that houses the file or directory named by the
 120 B<-path> argument, and C<l> (list) permission on the ACL of each
 121 directory that precedes it in the pathname.
 122
 123 =head1 SEE ALSO
 124
 125 L<fs_examine(1)>
 126
 127 =head1 COPYRIGHT
 128
 129 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 130
 131 This documentation is covered by the IBM Public License Version 1.0.  It was
 132 converted from HTML to POD by software written by Chas Williams and Russ
 133 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.