mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 15:30:14 +00:00
fc5acc0151
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.
100 lines
2.5 KiB
Plaintext
100 lines
2.5 KiB
Plaintext
=head1 NAME
|
|
|
|
kas help - Displays help for kas commands
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
=for html
|
|
<div class="synopsis">
|
|
|
|
B<kas help> S<<< [B<-topic> <I<help string>>+] >>> [B<-help>]
|
|
|
|
B<kas h> S<<< [B<-t> <I<help string>>+] >>> [B<-h>]
|
|
|
|
=for html
|
|
</div>
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<kas 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<kas> command.
|
|
|
|
To list every kas command whose name or short description includes a
|
|
specified keyword, use the B<kas apropos> command.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item B<-topic> <I<help string>>+
|
|
|
|
Indicates each command for which to display the complete online help
|
|
entry. Omit the B<kas> part of the command name, providing only the
|
|
operation code (for example, specify B<setpassword>, not B<kas
|
|
setpassword>). If this argument is omitted, the output briefly describes
|
|
every B<kas> command.
|
|
|
|
=item B<-help>
|
|
|
|
Prints the online help for this command. All other valid options are
|
|
ignored.
|
|
|
|
=back
|
|
|
|
=head1 OUTPUT
|
|
|
|
The online help entry for each B<kas> 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 B<kas
|
|
setpassword> command:
|
|
|
|
% kas help setpassword
|
|
kas setpassword: set a user's password
|
|
aliases: sp
|
|
Usage: kas setpassword -name <name of user>
|
|
[-new_password <new password>] [-kvno <key version number>]
|
|
[-admin_username <admin principal to use for authentication>]
|
|
[-password_for_admin <password>] [-cell <cell name>]
|
|
[-servers <explicit list of authentication servers>+] [-help]
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
None, and no password is required.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<kas(8)>,
|
|
L<kas_apropos(8)>
|
|
|
|
=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.
|