lttng-help(1)

1LTTNG-HELP(1)                    LTTng Manual                    LTTNG-HELP(1)
2
3
4

NAME

6       lttng-help - Show the help of an LTTng command
7

SYNOPSIS

9       lttng [GENERAL OPTIONS] help [COMMAND]
10

DESCRIPTION

12       The lttng help command shows the help of:
13
14       With the COMMAND argument
15           The lttng COMMAND command.
16
17       Without the COMMAND argument
18           The lttng(1) command itself.
19
20       The help command is equivalent to:
21
22           lttng [GENERAL OPTIONS] [COMMAND] --help
23
24       The help command attempts to launch /usr/bin/man to view this the
25       manual page of the command. Override the manual pager path with the
26       LTTNG_MAN_BIN_PATH environment variable.
27

OPTIONS

29       See lttng(1) for GENERAL OPTIONS.
30
31   Program information
32       -h, --help
33           Show help.
34
35           This option attempts to launch /usr/bin/man to view this manual
36           page. Override the manual pager path with the LTTNG_MAN_BIN_PATH
37           environment variable.
38
39       --list-options
40           List available command options and quit.
41

EXIT STATUS

43       0
44           Success
45
46       1
47           Command error
48
49       2
50           Undefined command
51
52       3
53           Fatal error
54
55       4
56           Command warning (something went wrong during the command)
57

ENVIRONMENT

59       LTTNG_ABORT_ON_ERROR
60           Set to 1 to abort the process after the first error is encountered.
61
62       LTTNG_HOME
63           Path to the LTTng home directory.
64
65           Defaults to $HOME.
66
67           Useful when the Unix user running the commands has a non-writable
68           home directory.
69
70       LTTNG_MAN_BIN_PATH
71           Absolute path to the manual pager to use to read the LTTng
72           command-line help (with lttng-help(1) or with the --help option)
73           instead of /usr/bin/man.
74
75       LTTNG_SESSION_CONFIG_XSD_PATH
76           Path to the directory containing the session.xsd recording session
77           configuration XML schema.
78
79       LTTNG_SESSIOND_PATH
80           Absolute path to the LTTng session daemon binary (see lttng-
81           sessiond(8)) to spawn from the lttng-create(1) command.
82
83           The --sessiond-path general option overrides this environment
84           variable.
85

FILES

87       $LTTNG_HOME/.lttngrc
88           Unix user’s LTTng runtime configuration.
89
90           This is where LTTng stores the name of the Unix user’s current
91           recording session between executions of lttng(1).  lttng-create(1)
92           and lttng-set-session(1) set the current recording session.
93
94       $LTTNG_HOME/lttng-traces
95           Default output directory of LTTng traces in local and snapshot
96           modes.
97
98           Override this path with the --output option of the lttng-create(1)
99           command.
100
101       $LTTNG_HOME/.lttng
102           Unix user’s LTTng runtime and configuration directory.
103
104       $LTTNG_HOME/.lttng/sessions
105           Default directory containing the Unix user’s saved recording
106           session configurations (see lttng-save(1) and lttng-load(1)).
107
108       /usr/local/etc/lttng/sessions
109           Directory containing the system-wide saved recording session
110           configurations (see lttng-save(1) and lttng-load(1)).
111
112       Note
113           $LTTNG_HOME defaults to the value of the HOME environment variable.
114

RESOURCES

116       •   LTTng project website <https://lttng.org>
117
118       •   LTTng documentation <https://lttng.org/docs>
119
120       •   LTTng bug tracker <https://bugs.lttng.org>
121
122       •   Git repositories <https://git.lttng.org>
123
124       •   GitHub organization <https://github.com/lttng>
125
126       •   Continuous integration <https://ci.lttng.org/>
127
128       •   Mailing list <https://lists.lttng.org/> for support and
129           development: lttng-dev@lists.lttng.org
130
131       •   IRC channel <irc://irc.oftc.net/lttng>: #lttng on irc.oftc.net
132

COPYRIGHT

134       This program is part of the LTTng-tools project.
135
136       LTTng-tools is distributed under the GNU General Public License
137       version 2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>.
138       See the LICENSE <https://github.com/lttng/lttng-
139       tools/blob/master/LICENSE> file for details.
140

THANKS

142       Special thanks to Michel Dagenais and the DORSAL laboratory
143       <http://www.dorsal.polymtl.ca/> at École Polytechnique de Montréal for
144       the LTTng journey.
145
146       Also thanks to the Ericsson teams working on tracing which helped us
147       greatly with detailed bug reports and unusual test cases.
148