openafs/doc/man-pages/pod1/vos_listpart.pod
Russ Allbery fc5acc0151 pretty-html-synopsis-20060228
Implement proper synopsis wrapping for HTML generation.

This was done in three pieces.  First, add HTML-specific tags to the POD to
mark the synopsis for HTML purposes so that we can apply style information
to it.  Second, update the style sheet to indent all lines except for the
first in the synopsis section.  Third, add the appropriate S<> tags around
option and argument pairs so that we don't wrap between the option and its
argument.

Unfortunately, due to the <I<foo>> style that looks nicer for other reasons,
we have to use the very verbose S<<< >>>.  Oh well.
2006-03-01 05:02:29 +00:00

101 lines
2.7 KiB
Plaintext

=head1 NAME
vos listpart - Displays all AFS partitions on a file server machine
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<vos listpart> S<<< B<-server> <I<machine name>> >>> S<<< [B<-cell> <I<cell name>>] >>>
[B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>]
B<vos listp> S<<< B<-s> <I<machine name>> >>> S<<< [B<-c> <I<cell name>>] >>> [B<-n>]
[B<-l>] [B<-v>] [B<-h>]
=for html
</div>
=head1 DESCRIPTION
The B<vos listpart> command displays all of the valid AFS partitions on
the indicated file server machine, without consulting the Volume Location
Database (VLDB). The B<vos partinfo> command reports the size of a
partition and the available space on that partition.
=head1 OPTIONS
=over 4
=item B<-server> <I<server name>>
Identifies the file server machine for which to list the partitions.
Provide the machine's IP address or its host name (either fully qualified
or using an unambiguous abbreviation). For details, see L<vos(1)>.
=item B<-cell> <I<cell name>>
Names the cell in which to run the command. Do not combine this argument
with the B<-localauth> flag. For more details, see L<vos(1)>.
=item B<-noauth>
Assigns the unprivileged identity anonymous to the issuer. Do not combine
this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
=item B<-localauth>
Constructs a server ticket using a key from the local
B</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
to the Volume Server and Volume Location Server during mutual
authentication. Do not combine this flag with the B<-cell> argument or
B<-noauth> flag. For more details, see L<vos(1)>.
=item B<-verbose>
Produces on the standard output stream a detailed trace of the command's
execution. If this argument is omitted, only warnings and error messages
appear.
=item B<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 OUTPUT
The output consists of a list of partition names of the form
F</vicepI<xx>>, following the header:
The partitions on the server are:
The last line of the output reports the total number of partitions.
=head1 EXAMPLES
The following command displays the partitions on C<fs1.abc.com>:
% vos listpart fs1.abc.com
The partitions on the server are:
/vicepa /vicepb /vicepc /vicepd
Total: 4
=head1 PRIVILEGE REQUIRED
None
=head1 SEE ALSO
L<vos(1)>,
L<vos_partinfo(1)>
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
This documentation is covered by the IBM Public License Version 1.0. It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.