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