X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-help.1.txt;h=a371a944bc0cb3f155c27fc69b83d6ce74b8e940;hb=48c77bf7ccc9a88c229432a6db4871940914bedb;hp=c0f4d6442ae1c1b622398cb9f5db18acc08d0410;hpb=d4f093aa457acf5492c099f40badcc8379c95fe9;p=lttng-tools.git

diff --git a/doc/man/lttng-help.1.txt b/doc/man/lttng-help.1.txt
index c0f4d6442..a371a944b 100644
--- a/doc/man/lttng-help.1.txt
+++ b/doc/man/lttng-help.1.txt
@@ -1,48 +1,51 @@
 lttng-help(1)
 =============
+:revdate: 21 April 2021
 
 
 NAME
 ----
-lttng-help - Display help information about an LTTng command
+lttng-help - Show the help of an LTTng command
 
 
 SYNOPSIS
 --------
 [verse]
-*lttng* ['GENERAL OPTIONS'] *help* ['COMMAND']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *help* ['COMMAND']
 
 
 DESCRIPTION
 -----------
-The `lttng help` command displays help information about an LTTng
-command.
+The `lttng help` command shows the help of:
 
-This command is the equivalent of:
+With the 'COMMAND' argument::
+    The ++lttng{nbsp}++__COMMAND__ command.
 
-[role="term"]
---------------------
-lttng COMMAND --help
---------------------
+Without the 'COMMAND' argument::
+    The man:lttng(1) command itself.
 
-where `COMMAND` is the name of the command about which to get help. If
-'COMMAND' is omitted, `lttng help` shows general help about the
-linklttng:lttng(1) command.
+The `help` command is equivalent to:
 
-The `lttng help` command attempts to launch `/usr/bin/man` to view
-the command's man page. The path to the man pager can be overridden
-by the `LTTNG_MAN_BIN_PATH` environment variable.
+[verse]
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] ['COMMAND'] nloption:--help
+
+The `help` command attempts to launch `/usr/bin/man` to view this the
+manual page of the command. Override the manual pager path with the
+`LTTNG_MAN_BIN_PATH` environment variable.
+
+
+include::common-lttng-cmd-options-head.txt[]
 
 
-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-help-options.txt[]
 
 
-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-after-options.txt[]
 
 
-include::common-cmd-footer.txt[]
+include::common-footer.txt[]
 
 
 SEE ALSO
 --------
-linklttng:lttng(1)
+man:lttng(1)