doc: Make all vos pages =include common options
[openafs.git] / doc / man-pages / pod1 / vos_listpart.pod.in
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 =include fragments/vos-common.pod
43
44 =back
45
46 =head1 OUTPUT
47
48 The output consists of a list of partition names of the form
49 F</vicepI<xx>>, following the header:
50
51    The partitions on the server are:
52
53 The last line of the output reports the total number of partitions.
54
55 =head1 EXAMPLES
56
57 The following command displays the partitions on C<fs1.example.com>:
58
59    % vos listpart fs1.example.com
60    The partitions on the server are:
61        /vicepa     /vicepb     /vicepc     /vicepd
62    Total:  4
63
64 =head1 PRIVILEGE REQUIRED
65
66 None
67
68 =head1 SEE ALSO
69
70 L<vos(1)>,
71 L<vos_partinfo(1)>
72
73 =head1 COPYRIGHT
74
75 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
76
77 This documentation is covered by the IBM Public License Version 1.0.  It was
78 converted from HTML to POD by software written by Chas Williams and Russ
79 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.