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