e7db9677d7d157c2accb93e6d7c8536007253fbd
[openafs.git] / doc / man-pages / pod8 / uss_apropos.pod
1 =head1 NAME
2
3 uss apropos - Displays each help entry containing a keyword string.
4
5 =head1 SYNOPSIS
6
7 B<uss apropos> B<-topic> <I<help string>> [B<-help>]
8
9 B<uss ap> B<-t> <I<help string>> [B<-h>]
10
11 =head1 DESCRIPTION
12
13 The B<uss apropos> command displays the first line of the online help
14 entry for any B<uss> command that has in its name or short description the
15 string specified by the B<-topic> argument.
16
17 To display the syntax for a command, use the B<uss help> command.
18
19 =head1 OPTIONS
20
21 =over 4
22
23 =item B<-topic> <I<help string>>+
24
25 Specifies the keyword string to match, in lowercase letters only.  If the
26 string is more than a single word, surround it with double quotes (C<"">)
27 or other delimiters.
28
29 =item B<-help>
30
31 Prints the online help for this command. All other valid options are
32 ignored.
33
34 =back
35
36 =head1 OUTPUT
37
38 The first line of a command's online help entry names it and briefly
39 describes its function. This command displays the first line for any
40 B<uss> command where the string specified by the B<-topic> argument is
41 part of the command name or first line.
42
43 =head1 EXAMPLES
44
45 The following command lists all uss commands that include the word
46 C<create> in their names or short descriptions:
47
48    % uss apropos create
49    add: create a new user
50
51 =head1 PRIVILEGE REQUIRED
52
53 None
54
55 =head1 SEE ALSO
56
57 L<uss(8)>,
58 L<uss_help(8)>
59
60 =head1 COPYRIGHT
61
62 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
63
64 This documentation is covered by the IBM Public License Version 1.0.  It was
65 converted from HTML to POD by software written by Chas Williams and Russ
66 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.