projects / lttng-tools.git / blame
| Commit | Line | Data |
|---|---|---|
| afaad15a PP |
1 | lttng-help(1) |
| 2 | ============= | |
| 484b2a0c | 3 | :revdate: 21 April 2021 |
| afaad15a PP |
4 | |
| 5 | ||
| 6 | NAME | |
| 7 | ---- | |
| 484b2a0c | 8 | lttng-help - Show the help of an LTTng command |
| afaad15a PP |
9 | |
| 10 | ||
| 11 | SYNOPSIS | |
| 12 | -------- | |
| 13 | [verse] | |
| ce19b9ed | 14 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *help* ['COMMAND'] |
| afaad15a PP |
15 | |
| 16 | ||
| 17 | DESCRIPTION | |
| 18 | ----------- | |
| 484b2a0c | 19 | The `lttng help` command shows the help of: |
| afaad15a | 20 | |
| 484b2a0c PP |
21 | With the 'COMMAND' argument:: |
| 22 | The ++lttng{nbsp}++__COMMAND__ command. | |
| afaad15a | 23 | |
| 484b2a0c PP |
24 | Without the 'COMMAND' argument:: |
| 25 | The man:lttng(1) command itself. | |
| afaad15a | 26 | |
| 484b2a0c PP |
27 | The `help` command is equivalent to: |
| 28 | ||
| 29 | [verse] | |
| 26f0c779 | 30 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] ['COMMAND'] nloption:--help |
| afaad15a | 31 | |
| 484b2a0c PP |
32 | The `help` command attempts to launch `/usr/bin/man` to view this the |
| 33 | manual page of the command. Override the manual pager path with the | |
| 34 | `LTTNG_MAN_BIN_PATH` environment variable. | |
| afaad15a PP |
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 | -------- | |
| 7c1a4458 | 48 | man:lttng(1) |