1LTTNG-HELP(1) LTTng Manual LTTNG-HELP(1)
2
3
4
6 lttng-help - Display help information about an LTTng command
7
9 lttng [GENERAL OPTIONS] help [COMMAND]
10
12 The lttng help command displays help information about an LTTng
13 command.
14
15 This command is the equivalent of:
16
17 $ lttng COMMAND --help
18
19 where COMMAND is the name of the command about which to get help. If
20 COMMAND is omitted, lttng help shows general help about the lttng(1)
21 command.
22
23 The lttng help command attempts to launch /usr/bin/man to view the
24 command’s man page. The path to the man pager can be overridden by the
25 LTTNG_MAN_BIN_PATH environment variable.
26
28 General options are described in lttng(1).
29
30 Program information
31 -h, --help
32 Show command help.
33
34 This option, like lttng-help(1), attempts to launch /usr/bin/man to
35 view the command’s man page. The path to the man pager can be
36 overridden by the LTTNG_MAN_BIN_PATH environment variable.
37
38 --list-options
39 List available command options.
40
42 LTTNG_ABORT_ON_ERROR
43 Set to 1 to abort the process after the first error is encountered.
44
45 LTTNG_HOME
46 Overrides the $HOME environment variable. Useful when the user
47 running the commands has a non-writable home directory.
48
49 LTTNG_MAN_BIN_PATH
50 Absolute path to the man pager to use for viewing help information
51 about LTTng commands (using lttng-help(1) or lttng COMMAND --help).
52
53 LTTNG_SESSION_CONFIG_XSD_PATH
54 Path in which the session.xsd session configuration XML schema may
55 be found.
56
57 LTTNG_SESSIOND_PATH
58 Full session daemon binary path.
59
60 The --sessiond-path option has precedence over this environment
61 variable.
62
63 Note that the lttng-create(1) command can spawn an LTTng session daemon
64 automatically if none is running. See lttng-sessiond(8) for the
65 environment variables influencing the execution of the session daemon.
66
68 $LTTNG_HOME/.lttngrc
69 User LTTng runtime configuration.
70
71 This is where the per-user current tracing session is stored
72 between executions of lttng(1). The current tracing session can be
73 set with lttng-set-session(1). See lttng-create(1) for more
74 information about tracing sessions.
75
76 $LTTNG_HOME/lttng-traces
77 Default output directory of LTTng traces. This can be overridden
78 with the --output option of the lttng-create(1) command.
79
80 $LTTNG_HOME/.lttng
81 User LTTng runtime and configuration directory.
82
83 $LTTNG_HOME/.lttng/sessions
84 Default location of saved user tracing sessions (see lttng-save(1)
85 and lttng-load(1)).
86
87 /usr/local/etc/lttng/sessions
88 System-wide location of saved tracing sessions (see lttng-save(1)
89 and lttng-load(1)).
90
91 Note
92 $LTTNG_HOME defaults to $HOME when not explicitly set.
93
95 0
96 Success
97
98 1
99 Command error
100
101 2
102 Undefined command
103
104 3
105 Fatal error
106
107 4
108 Command warning (something went wrong during the command)
109
111 If you encounter any issue or usability problem, please report it on
112 the LTTng bug tracker <https://bugs.lttng.org/projects/lttng-tools>.
113
115 · LTTng project website <https://lttng.org>
116
117 · LTTng documentation <https://lttng.org/docs>
118
119 · Git repositories <http://git.lttng.org>
120
121 · GitHub organization <http://github.com/lttng>
122
123 · Continuous integration <http://ci.lttng.org/>
124
125 · Mailing list <http://lists.lttng.org> for support and development:
126 lttng-dev@lists.lttng.org
127
128 · IRC channel <irc://irc.oftc.net/lttng>: #lttng on irc.oftc.net
129
131 This program is part of the LTTng-tools project.
132
133 LTTng-tools is distributed under the GNU General Public License version
134 2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>. See the
135 LICENSE <https://github.com/lttng/lttng-tools/blob/master/LICENSE> file
136 for details.
137
139 Special thanks to Michel Dagenais and the DORSAL laboratory
140 <http://www.dorsal.polymtl.ca/> at École Polytechnique de Montréal for
141 the LTTng journey.
142
143 Also thanks to the Ericsson teams working on tracing which helped us
144 greatly with detailed bug reports and unusual test cases.
145
147 lttng(1)
148
149
150
151LTTng 2.11.1 14 March 2017 LTTNG-HELP(1)