4 :revdate: 5 October 2017
9 babeltrace2-help - Get help for a Babeltrace plugin or component class
15 *babeltrace2 help* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path]
16 [opt:--omit-system-plugin-path]
17 [opt:--plugin-path='PATH'[:__PATH__]...]
18 ('PLUGIN' | 'TYPE.PLUGIN.COMPCLS')
23 The `help` command prints the details and help text of either the plugin
24 'PLUGIN' or the specific component class 'TYPE.PLUGIN.COMPCLS'.
26 See man:babeltrace2-intro(7) to learn more about the Babeltrace
27 project and its core concepts.
29 The available values for 'TYPE' are:
32 Source component class.
35 Filter component class.
40 See <<examples,EXAMPLES>> for usage examples.
43 include::common-cmd-plugin-path.txt[]
48 include::common-gen-options.txt[]
50 include::common-plugin-path-options.txt[]
52 include::common-cmd-info-options.txt[]
58 .Get help for a plugin and all its component classes.
62 $ babeltrace2 help my-plugin
66 .Get help for a specific plugin's source component class.
70 $ babeltrace2 help src.my-plugin.my-source
74 .Get help for a specific plugin's sink component class.
78 $ babeltrace2 help sink.my-plugin.my-sink
83 include::common-cli-env.txt[]
85 include::common-cli-files.txt[]
87 include::common-cmd-footer.txt[]
93 man:babeltrace2-list-plugins(1)
94 man:babeltrace2-intro(7)