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