mirror of
https://git.openafs.org/openafs.git
synced 2025-01-31 13:38:01 +00:00
03b9fcc883
Complete an initial editing and cleanup pass for all section one man pages. Fix various conversion problems, formatting inconsistencies, and obvious problems. Please note that no editing for content has yet been done; this is solely editing for formatting and correct conversion to POD. Also, add some additional section five man pages that were omitted from the first conversion run due to unusual file names, and globally replace CAVEATS with CAUTIONS in the man pages to match the original section name. The section one man pages should now be in reasonable shape and ready for additional review and further updates, although there are probably still remaining obvious problems. ==================== This delta was composed from multiple commits as part of the CVS->Git migration. The checkin message with each commit was inconsistent. The following are the additional commit messages. ==================== This file got the wrong name when it was originally committed. Fix.
70 lines
1.7 KiB
Plaintext
70 lines
1.7 KiB
Plaintext
=head1 NAME
|
|
|
|
fs apropos - Displays each help entry containing a keyword string
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<fs apropos> B<-topic> <I<help string>> [B<-help>]
|
|
|
|
B<fs ap> B<-t> <I<help string>> [B<-h>]
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<fs apropos> command displays the first line of the online help entry
|
|
for any B<fs> command that has in its name or short description the string
|
|
specified by the B<-topic> argument.
|
|
|
|
To display the syntax for a command, use the B<fs 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 ("") 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<fs>
|
|
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 fs commands that include the word C<cache>
|
|
in their names or short online descriptions:
|
|
|
|
% fs apropos cache
|
|
setcachesize: set cache size
|
|
flush: flush file from cache
|
|
getcacheparms: get cache usage info
|
|
monitor: set cache monitor host address
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
None
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<fs(1)>,
|
|
L<fs_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.
|