doc/man/babeltrace2-help.1.txt

   1 babeltrace2-help(1)
   2 ==================
   3 :manpagetype: command
   4 :revdate: 5 October 2017
   5
   6
   7 NAME
   8 ----
   9 babeltrace2-help - Get help for a Babeltrace plugin or component class
  10
  11
  12 SYNOPSIS
  13 --------
  14 [verse]
  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')
  19
  20
  21 DESCRIPTION
  22 -----------
  23 The `help` command prints the details and help text of either the plugin
  24 'PLUGIN' or the specific component class 'TYPE.PLUGIN.COMPCLS'.
  25
  26 See man:babeltrace2-intro(7) to learn more about the Babeltrace
  27 project and its core concepts.
  28
  29 The available values for 'TYPE' are:
  30
  31 `source` or `src`::
  32     Source component class.
  33
  34 `filter` or `flt`::
  35     Filter component class.
  36
  37 `sink`::
  38     Sink component class.
  39
  40 See <<examples,EXAMPLES>> for usage examples.
  41
  42
  43 include::common-cmd-plugin-path.txt[]
  44
  45
  46 OPTIONS
  47 -------
  48 include::common-gen-options.txt[]
  49
  50 include::common-plugin-path-options.txt[]
  51
  52 include::common-cmd-info-options.txt[]
  53
  54
  55 [[examples]]
  56 EXAMPLES
  57 --------
  58 .Get help for a plugin and all its component classes.
  59 ====
  60 [role="term"]
  61 ----
  62 $ babeltrace2 help my-plugin
  63 ----
  64 ====
  65
  66 .Get help for a specific plugin's source component class.
  67 ====
  68 [role="term"]
  69 ----
  70 $ babeltrace2 help src.my-plugin.my-source
  71 ----
  72 ====
  73
  74 .Get help for a specific plugin's sink component class.
  75 ====
  76 [role="term"]
  77 ----
  78 $ babeltrace2 help sink.my-plugin.my-sink
  79 ----
  80 ====
  81
  82
  83 include::common-cli-env.txt[]
  84
  85 include::common-cli-files.txt[]
  86
  87 include::common-cmd-footer.txt[]
  88
  89
  90 SEE ALSO
  91 --------
  92 man:babeltrace2(1),
  93 man:babeltrace2-list-plugins(1)
  94 man:babeltrace2-intro(7)