doc: vos manpage fixes
[openafs.git] / doc / man-pages / pod1 / vos_listpart.pod
1 =head1 NAME
2
3 vos_listpart - Displays all AFS partitions on a file server machine
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos listpart> S<<< B<-server> <I<machine name>> >>>
11     S<<< [B<-cell> <I<cell name>>] >>>
12     [B<-noauth>] [B<-localauth>]
13     [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
14     S<<< [B<-config> <I<config directory>>] >>>
15     [B<-help>]
16
17 B<vos listp> S<<< B<-s> <I<machine name>> >>> S<<< [B<-c> <I<cell name>>] >>>
18     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
19     S<<< [B<-co> <I<config directory>>] >>>
20     [B<-h>]
21
22 =for html
23 </div>
24
25 =head1 DESCRIPTION
26
27 The B<vos listpart> command displays all of the valid AFS partitions on
28 the indicated file server machine, without consulting the Volume Location
29 Database (VLDB). The B<vos partinfo> command reports the size of a
30 partition and the available space on that partition.
31
32 =head1 OPTIONS
33
34 =over 4
35
36 =item B<-server> <I<server name>>
37
38 Identifies the file server machine for which to list the partitions.
39 Provide the machine's IP address or its host name (either fully qualified
40 or using an unambiguous abbreviation). For details, see L<vos(1)>.
41
42 =item B<-cell> <I<cell name>>
43
44 Names the cell in which to run the command. Do not combine this argument
45 with the B<-localauth> flag. For more details, see L<vos(1)>.
46
47 =item B<-noauth>
48
49 Assigns the unprivileged identity anonymous to the issuer. Do not combine
50 this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
51
52 =item B<-localauth>
53
54 Constructs a server ticket using a key from the local
55 B</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<-encrypt>
67
68 Encrypts the command so that the operation's results are not transmitted
69 across the network in clear text. This option is available in OpenAFS
70 versions 1.4.11 or later and 1.5.60 or later.
71
72 =item B<-noresolve>
73
74 Shows all servers as IP addresses instead of the DNS name. This is very
75 useful when the server address is registered as 127.0.0.1 or when dealing
76 with multi-homed servers. This option is available in OpenAFS
77 versions 1.4.8 or later and 1.5.35 or later.
78
79 =item B<-help>
80
81 Prints the online help for this command. All other valid options are
82 ignored.
83
84 =back
85
86 =head1 OUTPUT
87
88 The output consists of a list of partition names of the form
89 F</vicepI<xx>>, following the header:
90
91    The partitions on the server are:
92
93 The last line of the output reports the total number of partitions.
94
95 =head1 EXAMPLES
96
97 The following command displays the partitions on C<fs1.example.com>:
98
99    % vos listpart fs1.example.com
100    The partitions on the server are:
101        /vicepa     /vicepb     /vicepc     /vicepd
102    Total:  4
103
104 =head1 PRIVILEGE REQUIRED
105
106 None
107
108 =head1 SEE ALSO
109
110 L<vos(1)>,
111 L<vos_partinfo(1)>
112
113 =head1 COPYRIGHT
114
115 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
116
117 This documentation is covered by the IBM Public License Version 1.0.  It was
118 converted from HTML to POD by software written by Chas Williams and Russ
119 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.