3 :revdate: 14 September 2019
8 babeltrace2-help - Get help for a Babeltrace 2 plugin or component class
13 Get help for a Babeltrace~2 plugin:
16 *babeltrace2* [<<gen-opts,'GENERAL OPTIONS'>>] *help* 'PLUGIN-NAME'
18 Get help for a Babeltrace~2 component class:
21 *babeltrace2* [<<gen-opts,'GENERAL OPTIONS'>>] *help*
22 'COMP-CLS-TYPE'.'PLUGIN-NAME'.'COMP-CLS-NAME'
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
32 include::common-see-babeltrace2-intro.txt[]
34 The available values for 'COMP-CLS-TYPE' are:
38 Source component class.
42 Filter component class.
47 See <<examples,``EXAMPLES''>> for usage examples.
52 include::common-gen-options.txt[]
54 include::common-cmd-info-options.txt[]
60 .Get help for a plugin and all its component classes.
64 $ babeltrace2 help ctf
68 .Get help for a specific plugin's source component class.
72 $ babeltrace2 help source.ctf.fs
76 .Get help for a specific plugin's sink component class.
80 $ babeltrace2 help sink.text.pretty
85 include::common-cli-env.txt[]
88 include::common-cli-files.txt[]
91 include::common-cmd-footer.txt[]
96 man:babeltrace2-intro(7),
98 man:babeltrace2-list-plugins(1)