doc/man-pages/pod1/fs_examine.pod

   1 =head1 NAME
   2
   3 fs examine - Displays information about the volume containing a directory or file
   4
   5 =head1 SYNOPSIS
   6
   7 B<fs examine> [B<-path> <I<dir/file path>>+]  [-help]
   8
   9 B<fs exa> [B<-p> <I<dir/file path>>+]  [-h]
  10
  11 B<fs listvol> [B<-p> <I<dir/file path>>+]  [-h]
  12
  13 B<fs listv> [B<-p> <I<dir/file path>>+]  [-h]
  14
  15 B<fs lv> [B<-p> <I<dir/file path>>+]  [-h]
  16
  17 =head1 DESCRIPTION
  18
  19 The fs examine command displays information about the volume
  20 containing each specified directory or file, including its volume ID number,
  21 quota and the percentage of its quota that is used.
  22
  23 This command provides the most information about a volume, but the fs
  24 listquota command displays similar information in tabular format, and
  25 the B<fs quota> command reports only the percentage of quota
  26 used.
  27
  28 To set volume quota, use the B<fs setquota> or fs setvol
  29 command.
  30
  31 =head1 CAVEATS
  32
  33 The partition-related statistics in this command's output do not
  34 always agree with the corresponding values in the output of the standard UNIX
  35 B<df> command. The statistics reported by this command can be
  36 up to five minutes old, because the Cache Manager polls the File Server for
  37 partition information at that frequency. Also, on some operating
  38 systems, the B<df> command's report of partition size includes
  39 reserved space not included in this command's calculation, and so is
  40 likely to be about 10% larger.
  41
  42 =head1 OPTIONS
  43
  44 =over 4
  45
  46 =item -path
  47
  48 Names a file or directory that resides in the volume about which to
  49 produce output. Partial pathnames are interpreted relative to the
  50 current working directory, which is also the default value if this argument is
  51 omitted.
  52
  53 =item -help
  54
  55 Prints the online help for this command. All other valid options
  56 are ignored.
  57
  58 =back
  59
  60 =head1 OUTPUT
  61
  62 The output displays information about the volume that houses each specified
  63 directory or file, in the following format
  64
  65    Volume status for vid = I<volume ID> named I<volume name>
  66    Current offline message is I<message>
  67    Current disk quota is I<quota in kilobytes>
  68    Current blocks used are I<volume size in kilobytes>
  69    The partition has I<available partition> blocks available out of
  70       I<partition size>
  71
  72 where the first line specifies the volume's ID number and name.
  73 The C<Current> C<offline> C<message> line appears only
  74 if an administrator has included the B<-offlinemsg> argument to the
  75 B<fs setvol> command. The remaining lines report, respectively,
  76
  77 =over 4
  78
  79 =item *
  80
  81 the volume's quota in kilobytes, or the string C<unlimited>
  82 to indicate an unlimited quota
  83
  84
  85 =item *
  86
  87 the volume's current size in kilobytes
  88
  89
  90 =item *
  91
  92 the number of blocks available and total size of the host partition, both
  93 in kilobytes.
  94
  95
  96 =back
  97
  98 =head1 EXAMPLES
  99
 100 The following example shows the output for the volume
 101 B<user.smith> and the partition housing it:
 102
 103    % fs examine -path /afs/abc.com/usr/smith
 104    Volume status for vid = 50489902 named user.smith
 105    Current maximum quota is 15000
 106    Current blocks used are 5073
 107    The partition has 336662 blocks available out of 4177920
 108
 109 =head1 PRIVILEGE REQUIRED
 110
 111 The issuer must have the B<l> (lookup) permission on the
 112 ACL of the root directory of the volume that houses the file or directory
 113 named by the B<-path> argument, and on the ACL of each directory that
 114 precedes it in the pathname.
 115
 116 =head1 SEE ALSO
 117
 118 L<fs_listquota(1)>,
 119 L<fs_quota(1)>,
 120 L<fs_setquota(1)>,
 121 L<fs_setvol(1)>
 122
 123 =head1 COPYRIGHT
 124
 125 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 126
 127 This documentation is covered by the IBM Public License Version 1.0.  It was
 128 converted from HTML to POD by software written by Chas Williams and Russ
 129 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.