Update some manual pages for LTTng-tools 2.13

[lttng-tools.git] / doc / man / lttng-help.1.txt

diff --git a/doc/man/lttng-help.1.txt b/doc/man/lttng-help.1.txt
index 65b909dd9a8b9cd444b397a06303af57a489d699..1de72c55b24628ebf6018e890c742ab847066a14 100644 (file)
--- a/doc/man/lttng-help.1.txt
+++ b/doc/man/lttng-help.1.txt
@@ -1,11 +1,11 @@
 lttng-help(1)
 =============
-:revdate: 14 March 2017
+:revdate: 21 April 2021
 
 
 NAME
 ----
-lttng-help - Display help information about an LTTng command
+lttng-help - Show the help of an LTTng command
 
 
 SYNOPSIS
@@ -16,23 +16,22 @@ SYNOPSIS
 
 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
-man:lttng(1) command.
+The `help` command is equivalent to:
+
+[verse]
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] ['COMMAND'] --help
 
-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.
+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-cmd-options-head.txt[]