doc/man/Makefile.am: fix top comment
[lttng-tools.git] / doc / man / lttng-help.1.txt
CommitLineData
afaad15a
PP
1lttng-help(1)
2=============
3
4
5NAME
6----
7lttng-help - Display help information about an LTTng command
8
9
10SYNOPSIS
11--------
12[verse]
ce19b9ed 13*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *help* ['COMMAND']
afaad15a
PP
14
15
16DESCRIPTION
17-----------
18The `lttng help` command displays help information about an LTTng
19command.
20
21This command is the equivalent of:
22
d4f093aa 23[role="term"]
afaad15a
PP
24--------------------
25lttng COMMAND --help
26--------------------
27
28where `COMMAND` is the name of the command about which to get help. If
29'COMMAND' is omitted, `lttng help` shows general help about the
30linklttng:lttng(1) command.
31
32The `lttng help` command attempts to launch `/usr/bin/man` to view
33the command's man page. The path to the man pager can be overridden
34by the `LTTNG_MAN_BIN_PATH` environment variable.
35
36
37include::common-cmd-options-head.txt[]
38
39
40include::common-cmd-help-options.txt[]
41
42
43include::common-cmd-footer.txt[]
44
45
46SEE ALSO
47--------
48linklttng:lttng(1)
This page took 0.026631 seconds and 5 git commands to generate.