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