mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 07:20:11 +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.
72 lines
1.7 KiB
Plaintext
72 lines
1.7 KiB
Plaintext
=head1 NAME
|
|
|
|
fstrace apropos - Displays each help entry containing a keyword string
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<fstrace apropos -topic> <I<help string>> [-help]
|
|
|
|
B<fstrace ap -t> <I<help string>> [-h]
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The fstrace apropos command displays the first line of the
|
|
online help entry for any B<fstrace> command that contains in its name
|
|
or short description the string specified with the B<-topic>
|
|
argument.
|
|
|
|
To display a command's complete syntax, use the fstrace
|
|
help command.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item -topic
|
|
|
|
Specifies the keyword string to match, in lowercase letters only.
|
|
If the string is more than a single word, surround it with double quotes ("")
|
|
or other delimiters.
|
|
|
|
=item -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<fstrace> 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 fstrace commands that include
|
|
the word B<set> in their names or short descriptions:
|
|
|
|
% fstrace apropos set
|
|
clear: clear logs by logname or by event set
|
|
lsset: list available event sets
|
|
setlog: set the size of a log
|
|
setset: set state of event sets
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
None
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<fstrace(1)>,
|
|
L<fstrace_help(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.
|