Commit | Line | Data |
---|---|---|
afaad15a PP |
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* ['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 | -------------------- | |
24 | lttng COMMAND --help | |
25 | -------------------- | |
26 | ||
27 | where `COMMAND` is the name of the command about which to get help. If | |
28 | 'COMMAND' is omitted, `lttng help` shows general help about the | |
29 | linklttng:lttng(1) command. | |
30 | ||
31 | The `lttng help` command attempts to launch `/usr/bin/man` to view | |
32 | the command's man page. The path to the man pager can be overridden | |
33 | by the `LTTNG_MAN_BIN_PATH` environment variable. | |
34 | ||
35 | ||
36 | include::common-cmd-options-head.txt[] | |
37 | ||
38 | ||
39 | include::common-cmd-help-options.txt[] | |
40 | ||
41 | ||
42 | include::common-cmd-footer.txt[] | |
43 | ||
44 | ||
45 | SEE ALSO | |
46 | -------- | |
47 | linklttng:lttng(1) |