mirror of
https://git.openafs.org/openafs.git
synced 2025-01-31 13:38:01 +00:00
e3dfba8e6c
This is the initial conversion of the AFS Adminstrators Reference into POD for use as man pages. The man pages are now generated via pod2man from regen.sh so that only those working from CVS have to have pod2man available. The Makefile only installs. The pages have also been sorted out into pod1, pod5, and pod8 directories, making conversion to the right section of man page easier without maintaining a separate list and allowing for names to be duplicated between pod5 and pod1 or pod8 (which will likely be needed in a few cases). This reconversion is done with a new script based on work by Chas Williams. In some cases, the output is worse than the previous POD pages, but this is a more comprehensive conversion. This is only the first step, and this initial conversion has various problems. In addition, the file man pages that didn't have simple names have not been converted in this pass and will be added later. Some of the man pages have syntax problems and all of them have formatting errors. The next editing pass, coming shortly, will clean up most of the remaining mess.
98 lines
2.3 KiB
Plaintext
98 lines
2.3 KiB
Plaintext
=head1 NAME
|
|
|
|
bos help - Displays the syntax of specified bos commands or lists
|
|
functional descriptions of all B<bos> commands
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<bos help> [B<-topic> <I<help string>>+] [-help]
|
|
|
|
B<bos h> [B<-t> <I<help string>>+] [-h]
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The bos help command displays the complete online help entry
|
|
(short description and syntax statement) for each command operation code
|
|
specified by the B<-topic> argument. If the B<-topic>
|
|
argument is omitted, the output includes the first line (name and short
|
|
description) of the online help entry for every B<bos> command.
|
|
|
|
To list every bos command whose name or short description
|
|
includes a specified keyword, use the B<bos apropos> command.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item -topic
|
|
>
|
|
|
|
Indicates each command for which to display the complete online help
|
|
entry. Omit the B<bos> part of the command name, providing only
|
|
the operation code (for example, specify B<status>, not B<bos
|
|
status>). If this argument is omitted, the output briefly
|
|
describes every B<bos> command.
|
|
|
|
=item -help
|
|
|
|
Prints the online help for this command. All other valid options
|
|
are ignored.
|
|
|
|
=back
|
|
|
|
=head1 OUTPUT
|
|
|
|
The online help entry for each bos command consists of the
|
|
following two or three lines:
|
|
|
|
=over 4
|
|
|
|
=item *
|
|
|
|
The first line names the command and briefly describes its
|
|
function.
|
|
|
|
|
|
=item *
|
|
|
|
The second line lists aliases for the command, if any.
|
|
|
|
|
|
=item *
|
|
|
|
The final line, which begins with the string C<Usage>, lists the
|
|
command's options in the prescribed order. Online help entries use
|
|
the same symbols (for example, brackets) as the reference pages in this
|
|
document.
|
|
|
|
|
|
=back
|
|
|
|
=head1 EXAMPLES
|
|
|
|
The following command displays the online help entry for the bos
|
|
status command:
|
|
|
|
% bos help status
|
|
bos status: show server instance status
|
|
Usage: bos status -server <machine name> [-instance <server
|
|
process name>+] [-long] [-cell <cell name>] [-noauth]
|
|
[-localauth] [-help]
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
None
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<bos(1)>,
|
|
L<bos_apropos(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.
|