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