doc: Make all vos pages =include common options
[openafs.git] / doc / man-pages / pod1 / vos_partinfo.pod.in
1 =head1 NAME
2
3 vos_partinfo - Reports the available and total space on a partition
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos partinfo> S<<< B<-server> <I<machine name>> >>>
11     S<<< [B<-partition> <I<partition name>>] >>> [B<-summary>]
12     S<<< [B<-cell> <I<cell name>>] >>>
13     [B<-noauth>] [B<-localauth>]
14     [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
15     S<<< [B<-config> <I<config directory>>] >>>
16     [B<-help>]
17
18 B<vos p> S<<< B<-se> <I<machine name>> >>>
19     S<<< [B<-p> <I<partition name>>] >>> [B<-su>]
20     S<<< [B<-c> <I<cell name>>] >>>
21     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
22     S<<< [B<-co> <I<config directory>>] >>>
23     [B<-h>]
24
25 =for html
26 </div>
27
28 =head1 DESCRIPTION
29
30 The vos partinfo command reports the amount of space available and total
31 size on either all of the partitions on the indicated file server machine
32 (if the B<-partition> argument is omitted) or the specified partition on
33 that file server machine. The Volume Location Database (VLDB) is not
34 consulted.
35
36 =head1 CAUTIONS
37
38 =include fragments/volsize-caution.pod
39
40 =head1 OPTIONS
41
42 =over 4
43
44 =item B<-server> <I<server name>>
45
46 Identifies the file server machine for which to display partition
47 information. Provide the machine's IP address or its host name (either
48 fully qualified or using an unambiguous abbreviation). For details, see
49 L<vos(1)>.
50
51 =item B<-partition> <I<partition name>>
52
53 Identifies which partition on the file server machine specified by the
54 B<-server> argument for which to display information. Provide the
55 partition's complete name with preceding slash (for example, C</vicepa>)
56 or use one of the three acceptable abbreviated forms. For details, see
57 L<vos(1)>.
58
59 =item B<-summary>
60
61 Prints storage summary.
62
63 =include fragments/vos-common.pod
64
65 =back
66
67 =head1 CAUTIONS
68
69 The partition-related statistics in this command's output do not always
70 agree with the corresponding values in the output of the standard UNIX
71 B<df> command. The statistics reported by this command can be up to five
72 minutes old, because the Cache Manager polls the File Server for partition
73 information at that frequency. Also, on some operating systems, the B<df>
74 command's report of partition size includes reserved space not included in
75 this command's calculation, and so is likely to be about 10% larger.
76
77 =head1 OUTPUT
78
79 The output reports the amount of space available and total space for each
80 specified partition.
81
82 =head1 EXAMPLES
83
84 The following command displays all partitions on the file server machine
85 C<fs2.example.com>.
86
87    % vos partinfo fs2.example.com
88    Free space on partition /vicepa: 27301 K blocks out of total 549197
89    Free space on partition /vicepb: 13646 K blocks out of total 69194
90    Free space on partition /vicepc: 31798 K blocks out of total 320315
91    Free space on partition /vicepd: 33302 K blocks out of total 494954
92
93 =head1 PRIVILEGE REQUIRED
94
95 None
96
97 =head1 SEE ALSO
98
99 L<vos(1)>,
100 L<vos_listpart(1)>
101
102 =head1 COPYRIGHT
103
104 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
105
106 This documentation is covered by the IBM Public License Version 1.0.  It was
107 converted from HTML to POD by software written by Chas Williams and Russ
108 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.