openafs/doc/man-pages/pod1/fs_listcells.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

86 lines
2.2 KiB
Plaintext

=head1 NAME
fs listcells - Displays the database server machines known to the Cache Manager
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<fs listcells> [B<-numeric>] [B<-help>]
B<fs listc> [B<-n>] [B<-h>]
=for html
</div>
=head1 DESCRIPTION
The B<fs listcells> command formats and displays the list of the database
server machines that the Cache Manager stores in kernel memory for its
home cell and foreign cells.
At each reboot of the client machine, the Cache Manager copies the
contents of F</usr/vice/etc/CellServDB> into kernel memory. To modify the
list between reboots, use the B<fs newcell> command.
=head1 OPTIONS
=over 4
=item B<-numeric>
Displays each database server machine's IP address rather than hostname.
=item B<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 OUTPUT
The output includes a line for each cell included in the Cache Manager's
kernel memory list, in the following format:
Cell <cell> on hosts <database server machines>
The Cache Manager stores IP addresses, but by default has them translated
to hostnames before reporting them, by passing them to the cell's name
service (such as the Domain Name Service or a local host table). The name
service sometimes returns hostnames in uppercase letters, or an IP address
if it cannot resolve a name.
Using the B<-numeric> flag bypasses the translation to hostnames, which
can result in significantly faster production of output. The output
includes IP addresses only.
=head1 EXAMPLES
The following example shows output for several cells as illustrations of
the different formats for machine names:
% fs listcells
Cell abc.com on hosts fs1.abc.com fs2.abc.com fs3.abc.com
Cell stateu.edu on hosts DB1.FS.STATEU.EDU
DB2.FS.STATEU.EDU DB3.FS.STATEU.EDU
Cell def.gov on hosts 138.255.0.2 sv3.def.gov
=head1 PRIVILEGE REQUIRED
None
=head1 SEE ALSO
L<CellServDB(5)>,
L<fs_newcell(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.