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