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