mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 07:20:11 +00:00
6ef9f39335
The NAME heading for man pages can't contain a space in the program side or the man pages won't index with some man implementations.
74 lines
1.7 KiB
Plaintext
74 lines
1.7 KiB
Plaintext
=head1 NAME
|
|
|
|
kas_apropos - Displays each help entry containing a keyword string
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
=for html
|
|
<div class="synopsis">
|
|
|
|
B<kas apropos> S<<< B<-topic> <I<help string>> >>> [B<-help>]
|
|
|
|
B<kas a> S<<< B<-t> <I<help string>> >>> [B<-h>]
|
|
|
|
=for html
|
|
</div>
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<kas apropos> command displays the first line of the online help
|
|
entry for any B<kas> command that has the string specified by the
|
|
B<-topic> argument in its name or short description.
|
|
|
|
To display the syntax for a command, use the B<kas help> command.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item B<-topic> <I<help string>>
|
|
|
|
Specifies the keyword string to match, in lowercase letters only. If the
|
|
string is more than a single word, surround it with double quotes (C<"">)
|
|
or other delimiters.
|
|
|
|
=item B<-help>
|
|
|
|
Prints the online help for this command. All other valid options are
|
|
ignored.
|
|
|
|
=back
|
|
|
|
=head1 OUTPUT
|
|
|
|
The first line of a command's online help entry names it and briefly
|
|
describes its function. This command displays the first line for any
|
|
B<kas> command where the string specified with the B<-topic> argument is
|
|
part of the command name or first line.
|
|
|
|
=head1 EXAMPLES
|
|
|
|
The following command lists all B<kas> commands that include the word
|
|
C<key> in their names or short descriptions:
|
|
|
|
% kas apropos key
|
|
setkey: set a user's key
|
|
stringtokey: convert a string to a key
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
None, and no password is required.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<kas(8)>,
|
|
L<kas_help(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.
|