auth: fix cellservdb update check
[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>] [B<-help>]
15
16 B<vos p> S<<< B<-se> <I<machine name>> >>>
17     S<<< [B<-p> <I<partition name>>] >>> [B<-su>]
18     S<<< [B<-c> <I<cell name>>] >>>
19     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
20
21 =for html
22 </div>
23
24 =head1 DESCRIPTION
25
26 The vos partinfo command reports the amount of space available and total
27 size on either all of the partitions on the indicated file server machine
28 (if the B<-partition> argument is omitted) or the specified partition on
29 that file server machine. The Volume Location Database (VLDB) is not
30 consulted.
31
32 =head1 CAUTIONS
33
34 =include fragments/volsize-caution.pod
35
36 =head1 OPTIONS
37
38 =over 4
39
40 =item B<-server> <I<server name>>
41
42 Identifies the file server machine for which to display partition
43 information. Provide the machine's IP address or its host name (either
44 fully qualified or using an unambiguous abbreviation). For details, see
45 L<vos(1)>.
46
47 =item B<-partition> <I<partition name>>
48
49 Identifies which partition on the file server machine specified by the
50 B<-server> argument for which to display information. Provide the
51 partition's complete name with preceding slash (for example, C</vicepa>)
52 or use one of the three acceptable abbreviated forms. For details, see
53 L<vos(1)>.
54
55 =item B<-summary>
56
57 Prints storage summary.
58
59 =item B<-cell> <I<cell name>>
60
61 Names the cell in which to run the command. Do not combine this argument
62 with the B<-localauth> flag. For more details, see L<vos(1)>.
63
64 =item B<-noauth>
65
66 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
67 combine this flag with the B<-localauth> flag. For more details, see
68 L<vos(1)>.
69
70 =item B<-localauth>
71
72 Constructs a server ticket using a key from the local
73 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
74 to the Volume Server and Volume Location Server during mutual
75 authentication. Do not combine this flag with the B<-cell> argument or
76 B<-noauth> flag. For more details, see L<vos(1)>.
77
78 =item B<-verbose>
79
80 Produces on the standard output stream a detailed trace of the command's
81 execution. If this argument is omitted, only warnings and error messages
82 appear.
83
84 =item B<-encrypt>
85
86 Encrypts the command so that the operation's results are not transmitted
87 across the network in clear text. This option is available in OpenAFS
88 versions 1.4.11 or later and 1.5.60 or later.
89
90 =item B<-noresolve>
91
92 Shows all servers as IP addresses instead of the DNS name. This is very
93 useful when the server address is registered as 127.0.0.1 or when dealing
94 with multi-homed servers. This option is available in OpenAFS
95 versions 1.4.8 or later and 1.5.35 or later.
96
97 =item B<-help>
98
99 Prints the online help for this command. All other valid options are
100 ignored.
101
102 =back
103
104 =head1 CAUTIONS
105
106 The partition-related statistics in this command's output do not always
107 agree with the corresponding values in the output of the standard UNIX
108 B<df> command. The statistics reported by this command can be up to five
109 minutes old, because the Cache Manager polls the File Server for partition
110 information at that frequency. Also, on some operating systems, the B<df>
111 command's report of partition size includes reserved space not included in
112 this command's calculation, and so is likely to be about 10% larger.
113
114 =head1 OUTPUT
115
116 The output reports the amount of space available and total space for each
117 specified partition.
118
119 =head1 EXAMPLES
120
121 The following command displays all partitions on the file server machine
122 C<fs2.example.com>.
123
124    % vos partinfo fs2.example.com
125    Free space on partition /vicepa: 27301 K blocks out of total 549197
126    Free space on partition /vicepb: 13646 K blocks out of total 69194
127    Free space on partition /vicepc: 31798 K blocks out of total 320315
128    Free space on partition /vicepd: 33302 K blocks out of total 494954
129
130 =head1 PRIVILEGE REQUIRED
131
132 None
133
134 =head1 SEE ALSO
135
136 L<vos(1)>,
137 L<vos_listpart(1)>
138
139 =head1 COPYRIGHT
140
141 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
142
143 This documentation is covered by the IBM Public License Version 1.0.  It was
144 converted from HTML to POD by software written by Chas Williams and Russ
145 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.