man1-editing-pass-20051209
[openafs.git] / doc / man-pages / pod1 / fs_examine.pod
1 =head1 NAME
2
3 fs examine - Shows data about the volume containing a directory or file
4
5 =head1 SYNOPSIS
6
7 B<fs examine> [B<-path> <I<dir/file path>>+] [B<-help>]
8
9 B<fs exa> [B<-p> <I<dir/file path>>+] [B<-h>] 
10
11 B<fs listvol> [B<-p> <I<dir/file path>>+] [B<-h>] 
12
13 B<fs listv> [B<-p> <I<dir/file path>>+] [B<-h>] 
14
15 B<fs lv> [B<-p> <I<dir/file path>>+] [B<-h>]
16
17 =head1 DESCRIPTION
18
19 The fs examine command displays information about the volume containing
20 each specified directory or file, including its volume ID number, quota
21 and the percentage of its quota that is used.
22
23 This command provides the most information about a volume, but the B<fs
24 listquota> command displays similar information in tabular format, and the
25 B<fs quota> command reports only the percentage of quota used.
26
27 To set volume quota, use the B<fs setquota> or B<fs setvol> command.
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 in the volume 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 displays information about the volume that houses each
60 specified directory or file, in the following format
61
62    Volume status for vid = I<volume ID> named I<volume name>
63    Current offline message is I<message>
64    Current disk quota is I<quota in kilobytes>
65    Current blocks used are I<volume size in kilobytes>
66    The partition has I<available partition> blocks available out of
67       I<partition size>
68
69 where the first line specifies the volume's ID number and name.  The
70 C<Current offline message> line appears only if an administrator has
71 included the B<-offlinemsg> argument to the B<fs setvol> command. The
72 remaining lines report, respectively,
73
74 =over 4
75
76 =item *
77
78 The volume's quota in kilobytes, or the string C<unlimited> to indicate an
79 unlimited quota.
80
81 =item *
82
83 The volume's current size in kilobytes.
84
85 =item *
86
87 The number of blocks available and total size of the host partition, both
88 in kilobytes.
89
90 =back
91
92 =head1 EXAMPLES
93
94 The following example shows the output for the volume C<user.smith> and
95 the partition housing it:
96
97    % fs examine -path /afs/abc.com/usr/smith
98    Volume status for vid = 50489902 named user.smith
99    Current maximum quota is 15000
100    Current blocks used are 5073
101    The partition has 336662 blocks available out of 4177920 
102
103 =head1 PRIVILEGE REQUIRED
104
105 The issuer must have the C<l> (lookup) permission on the ACL of the root
106 directory of the volume that houses the file or directory named by the
107 B<-path> argument, and on the ACL of each directory that precedes it in
108 the pathname.
109
110 =head1 SEE ALSO
111
112 L<fs_listquota(1)>,
113 L<fs_quota(1)>,
114 L<fs_setquota(1)>,
115 L<fs_setvol(1)>
116
117 =head1 COPYRIGHT
118
119 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
120
121 This documentation is covered by the IBM Public License Version 1.0.  It was
122 converted from HTML to POD by software written by Chas Williams and Russ
123 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.