Update manual pages for 2.0.0-rc1

[babeltrace.git] / doc / man / babeltrace2-help.1.txt

diff --git a/doc/man/babeltrace2-help.1.txt b/doc/man/babeltrace2-help.1.txt
index e1b7d7c5bc75248eccbc41f69efaff224330d976..37216337048d016561912ba9502af5ddf9177810 100644 (file)
--- a/doc/man/babeltrace2-help.1.txt
+++ b/doc/man/babeltrace2-help.1.txt
@@ -1,65 +1,67 @@
-babeltrace2-help(1)
-==================
+= babeltrace2-help(1)
 :manpagetype: command
-:revdate: 5 October 2017
+:revdate: 14 September 2019
 
 
-NAME
-----
-babeltrace2-help - Get help for a Babeltrace plugin or component class
+== NAME
+
+babeltrace2-help - Get help for a Babeltrace 2 plugin or component class
+
+
+== SYNOPSIS
+
+Get help for a Babeltrace~2 plugin:
+
+[verse]
+*babeltrace2* [<<gen-opts,'GENERAL OPTIONS'>>] *help* 'PLUGIN-NAME'
 
+Get help for a Babeltrace~2 component class:
 
-SYNOPSIS
---------
 [verse]
-*babeltrace2 help* ['GENERAL OPTIONS'] [opt:--omit-home-plugin-path]
-                [opt:--omit-system-plugin-path]
-                [opt:--plugin-path='PATH'[:__PATH__]...]
-                ('PLUGIN' | 'TYPE.PLUGIN.COMPCLS')
+*babeltrace2* [<<gen-opts,'GENERAL OPTIONS'>>] *help*
+            'COMP-CLS-TYPE'.'PLUGIN-NAME'.'COMP-CLS-NAME'
 
 
-DESCRIPTION
------------
-The `help` command prints the details and help text of either the plugin
-'PLUGIN' or the specific component class 'TYPE.PLUGIN.COMPCLS'.
+== DESCRIPTION
 
-See man:babeltrace2-intro(7) to learn more about the Babeltrace
-project and its core concepts.
+The `help` command prints the details and help text of either the
+Babeltrace~2 plugin named 'PLUGIN-NAME' or the specific component
+class of type 'COMP-CLS-TYPE' named 'COMP-CLS-NAME' found in the plugin
+named 'PLUGIN-NAME'.
 
-The available values for 'TYPE' are:
+include::common-see-babeltrace2-intro.txt[]
 
-`source` or `src`::
+The available values for 'COMP-CLS-TYPE' are:
+
+`source`::
+`src`::
     Source component class.
 
-`filter` or `flt`::
+`filter`::
+`flt`::
     Filter component class.
 
 `sink`::
     Sink component class.
 
-See <<examples,EXAMPLES>> for usage examples.
-
+See <<examples,``EXAMPLES''>> for usage examples.
 
-include::common-cmd-plugin-path.txt[]
 
+== OPTIONS
 
-OPTIONS
--------
 include::common-gen-options.txt[]
 
-include::common-plugin-path-options.txt[]
-
 include::common-cmd-info-options.txt[]
 
 
 [[examples]]
-EXAMPLES
---------
+== EXAMPLES
+
 .Get help for a plugin and all its component classes.
 ====
 [role="term"]
 ----
-$ babeltrace2 help my-plugin
+$ babeltrace2 help ctf
 ----
 ====
 
@@ -67,7 +69,7 @@ $ babeltrace2 help my-plugin
 ====
 [role="term"]
 ----
-$ babeltrace2 help src.my-plugin.my-source
+$ babeltrace2 help source.ctf.fs
 ----
 ====
 
@@ -75,20 +77,22 @@ $ babeltrace2 help src.my-plugin.my-source
 ====
 [role="term"]
 ----
-$ babeltrace2 help sink.my-plugin.my-sink
+$ babeltrace2 help sink.text.pretty
 ----
 ====
 
 
 include::common-cli-env.txt[]
 
+
 include::common-cli-files.txt[]
 
+
 include::common-cmd-footer.txt[]
 
 
-SEE ALSO
---------
+== SEE ALSO
+
+man:babeltrace2-intro(7),
 man:babeltrace2(1),
 man:babeltrace2-list-plugins(1)
-man:babeltrace2-intro(7)