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