mirror of
https://git.openafs.org/openafs.git
synced 2025-01-31 13:38:01 +00:00
e2a90e6769
This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names. RCS file: /cvs/openafs/doc/man-pages/pod8/Attic/package_apropos.pod,v Working file: doc/man-pages/pod8/package_apropos.pod head: 1.2 branch: locks: strict access list: keyword substitution: kv total revisions: 4; selected revisions: 0 description: RCS file: /cvs/openafs/doc/man-pages/pod8/Attic/package_help.pod,v Working file: doc/man-pages/pod8/package_help.pod head: 1.2 branch: locks: strict access list: keyword substitution: kv total revisions: 4; selected revisions: 0 description: RCS file: /cvs/openafs/doc/man-pages/pod8/Attic/package_test.pod,v Working file: doc/man-pages/pod8/package_test.pod head: 1.2 branch: locks: strict access list: keyword substitution: kv total revisions: 4; selected revisions: 0 description: RCS file: /cvs/openafs/doc/man-pages/pod8/Attic/tapeconfig.pod,v Working file: doc/man-pages/pod8/tapeconfig.pod head: 1.2 branch: locks: strict access list: keyword substitution: kv total revisions: 4; selected revisions: 0 description: RCS file: /cvs/openafs/doc/man-pages/pod8/Attic/xstat_cm_test.pod,v Working file: doc/man-pages/pod8/xstat_cm_test.pod head: 1.2 branch: locks: strict access list: keyword substitution: kv total revisions: 4; selected revisions: 0 description: RCS file: /cvs/openafs/doc/man-pages/pod8/Attic/xstat_fs_test.pod,v Working file: doc/man-pages/pod8/xstat_fs_test.pod head: 1.2 branch: locks: strict access list: keyword substitution: kv total revisions: 4; selected revisions: 0 description: (cherry picked from commit ab4abf15fef60308b982c73b6d1a17fa60577120)
67 lines
1.6 KiB
Plaintext
67 lines
1.6 KiB
Plaintext
=head1 NAME
|
|
|
|
uss apropos - Displays each help entry containing a keyword string.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<uss apropos> B<-topic> <I<help string>> [B<-help>]
|
|
|
|
B<uss ap> B<-t> <I<help string>> [B<-h>]
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<uss apropos> command displays the first line of the online help
|
|
entry for any B<uss> 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<uss 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<uss> command where the string specified by the B<-topic> argument is
|
|
part of the command name or first line.
|
|
|
|
=head1 EXAMPLES
|
|
|
|
The following command lists all uss commands that include the word
|
|
C<create> in their names or short descriptions:
|
|
|
|
% uss apropos create
|
|
add: create a new user
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
None
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<uss(8)>,
|
|
L<uss_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.
|