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