doc/man-pages/pod/fs_diskfree.pod

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