Commit | Line | Data |
---|---|---|
e70712b3 | 1 | = babeltrace2-help(1) |
0659f3af | 2 | :manpagetype: command |
e70712b3 | 3 | :revdate: 14 September 2019 |
0659f3af PP |
4 | |
5 | ||
e70712b3 PP |
6 | == NAME |
7 | ||
8 | babeltrace2-help - Get help for a Babeltrace 2 plugin or component class | |
9 | ||
10 | ||
11 | == SYNOPSIS | |
12 | ||
13 | Get help for a Babeltrace~2 plugin: | |
14 | ||
15 | [verse] | |
16 | *babeltrace2* [<<gen-opts,'GENERAL OPTIONS'>>] *help* 'PLUGIN-NAME' | |
0659f3af | 17 | |
e70712b3 | 18 | Get help for a Babeltrace~2 component class: |
0659f3af | 19 | |
0659f3af | 20 | [verse] |
e70712b3 PP |
21 | *babeltrace2* [<<gen-opts,'GENERAL OPTIONS'>>] *help* |
22 | 'COMP-CLS-TYPE'.'PLUGIN-NAME'.'COMP-CLS-NAME' | |
0659f3af PP |
23 | |
24 | ||
e70712b3 | 25 | == DESCRIPTION |
0659f3af | 26 | |
e70712b3 PP |
27 | The `help` command prints the details and help text of either the |
28 | Babeltrace~2 plugin named 'PLUGIN-NAME' or the specific component | |
29 | class of type 'COMP-CLS-TYPE' named 'COMP-CLS-NAME' found in the plugin | |
30 | named 'PLUGIN-NAME'. | |
0659f3af | 31 | |
e70712b3 | 32 | include::common-see-babeltrace2-intro.txt[] |
0659f3af | 33 | |
e70712b3 PP |
34 | The available values for 'COMP-CLS-TYPE' are: |
35 | ||
36 | `source`:: | |
37 | `src`:: | |
0659f3af PP |
38 | Source component class. |
39 | ||
e70712b3 PP |
40 | `filter`:: |
41 | `flt`:: | |
0659f3af PP |
42 | Filter component class. |
43 | ||
44 | `sink`:: | |
45 | Sink component class. | |
46 | ||
e70712b3 | 47 | See <<examples,``EXAMPLES''>> for usage examples. |
0659f3af | 48 | |
0659f3af | 49 | |
e70712b3 | 50 | == OPTIONS |
0659f3af | 51 | |
0659f3af PP |
52 | include::common-gen-options.txt[] |
53 | ||
0659f3af PP |
54 | include::common-cmd-info-options.txt[] |
55 | ||
56 | ||
57 | [[examples]] | |
e70712b3 PP |
58 | == EXAMPLES |
59 | ||
0659f3af PP |
60 | .Get help for a plugin and all its component classes. |
61 | ==== | |
62 | [role="term"] | |
63 | ---- | |
e70712b3 | 64 | $ babeltrace2 help ctf |
0659f3af PP |
65 | ---- |
66 | ==== | |
67 | ||
68 | .Get help for a specific plugin's source component class. | |
69 | ==== | |
70 | [role="term"] | |
71 | ---- | |
e70712b3 | 72 | $ babeltrace2 help source.ctf.fs |
0659f3af PP |
73 | ---- |
74 | ==== | |
75 | ||
76 | .Get help for a specific plugin's sink component class. | |
77 | ==== | |
78 | [role="term"] | |
79 | ---- | |
e70712b3 | 80 | $ babeltrace2 help sink.text.pretty |
0659f3af PP |
81 | ---- |
82 | ==== | |
83 | ||
84 | ||
85 | include::common-cli-env.txt[] | |
86 | ||
e70712b3 | 87 | |
0659f3af PP |
88 | include::common-cli-files.txt[] |
89 | ||
e70712b3 | 90 | |
0659f3af PP |
91 | include::common-cmd-footer.txt[] |
92 | ||
93 | ||
e70712b3 PP |
94 | == SEE ALSO |
95 | ||
96 | man:babeltrace2-intro(7), | |
a8be4294 MJ |
97 | man:babeltrace2(1), |
98 | man:babeltrace2-list-plugins(1) |