Commit | Line | Data |
---|---|---|
805e021f CE |
1 | =head1 NAME |
2 | ||
3 | fstrace_help - Displays help for fstrace commands | |
4 | ||
5 | =head1 SYNOPSIS | |
6 | ||
7 | =for html | |
8 | <div class="synopsis"> | |
9 | ||
10 | B<fstrace help> S<<< [B<-topic> <I<help string>>+] >>> [B<-help>] | |
11 | ||
12 | B<fstrace h> S<<< [B<-t> <I<help string>>+] >>> [B<-h>] | |
13 | ||
14 | =for html | |
15 | </div> | |
16 | ||
17 | =head1 DESCRIPTION | |
18 | ||
19 | The B<fstrace help> command displays the complete online help entry (short | |
20 | description and syntax statement) for each command operation code | |
21 | specified by the B<-topic> argument. If the B<-topic> argument is omitted, | |
22 | the output includes the first line (name and short description) of the | |
23 | online help entry for every B<fstrace> command. | |
24 | ||
25 | To list every fstrace command whose name or short description includes a | |
26 | specified keyword, use the B<fstrace apropos> command. | |
27 | ||
28 | =head1 OPTIONS | |
29 | ||
30 | =over 4 | |
31 | ||
32 | =item B<-topic> <I<help string>>+ | |
33 | ||
34 | Indicates each command for which to display the complete online help | |
35 | entry. Omit the B<fstrace> part of the command name, providing only the | |
36 | operation code (for example, specify B<clear>, not B<fstrace clear>). If | |
37 | this argument is omitted, the output briefly describes every B<fstrace> | |
38 | command. | |
39 | ||
40 | =item B<-help> | |
41 | ||
42 | Prints the online help for this command. All other valid options are | |
43 | ignored. | |
44 | ||
45 | =back | |
46 | ||
47 | =head1 OUTPUT | |
48 | ||
49 | The online help entry for each B<fstrace> command consists of two or three | |
50 | lines: | |
51 | ||
52 | =over 4 | |
53 | ||
54 | =item * | |
55 | ||
56 | The first line names the command and briefly describes its function. | |
57 | ||
58 | =item * | |
59 | ||
60 | The second line lists aliases for the command, if any. | |
61 | ||
62 | =item * | |
63 | ||
64 | The final line, which begins with the string C<Usage>, lists the command's | |
65 | options in the prescribed order. Online help entries use the same symbols | |
66 | (for example, brackets) as the reference pages in this document. | |
67 | ||
68 | =back | |
69 | ||
70 | =head1 EXAMPLES | |
71 | ||
72 | The following command displays the online help entry for the B<fstrace | |
73 | setset> command: | |
74 | ||
75 | % fstrace help -topic setset | |
76 | fstrace setset: set state of event sets | |
77 | Usage: fstrace setset [-set <set_name>+] [-active] [-inactive] | |
78 | [-dormant] [-help] | |
79 | ||
80 | =head1 PRIVILEGE REQUIRED | |
81 | ||
82 | None | |
83 | ||
84 | =head1 SEE ALSO | |
85 | ||
86 | L<fstrace(8)>, | |
87 | L<fstrace_apropos(8)> | |
88 | ||
89 | =head1 COPYRIGHT | |
90 | ||
91 | IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved. | |
92 | ||
93 | This documentation is covered by the IBM Public License Version 1.0. It was | |
94 | converted from HTML to POD by software written by Chas Williams and Russ | |
95 | Allbery, based on work by Alf Wachsmann and Elizabeth Cassell. |