Document tracing session rotation features
[lttng-tools.git] / doc / man / common-cmd-footer.txt
1 ENVIRONMENT VARIABLES
2 ---------------------
3 `LTTNG_ABORT_ON_ERROR`::
4 Set to 1 to abort the process after the first error is encountered.
5
6 `LTTNG_HOME`::
7 Overrides the `$HOME` environment variable. Useful when the user
8 running the commands has a non-writable home directory.
9
10 `LTTNG_MAN_BIN_PATH`::
11 Absolute path to the man pager to use for viewing help information
12 about LTTng commands (using man:lttng-help(1) or
13 `lttng COMMAND --help`).
14
15 `LTTNG_SESSION_CONFIG_XSD_PATH`::
16 Path in which the `session.xsd` session configuration XML
17 schema may be found.
18
19 `LTTNG_SESSIOND_PATH`::
20 Full session daemon binary path.
21 +
22 The genoption:--sessiond-path option has precedence over this
23 environment variable.
24
25 Note that the man:lttng-create(1) command can spawn an LTTng
26 session daemon automatically if none is running. See
27 man:lttng-sessiond(8) for the environment variables influencing
28 the execution of the session daemon.
29
30
31 FILES
32 -----
33 `$LTTNG_HOME/.lttngrc`::
34 User LTTng runtime configuration.
35 +
36 This is where the per-user current tracing session is stored between
37 executions of man:lttng(1). The current tracing session can be set
38 with man:lttng-set-session(1). See man:lttng-create(1) for
39 more information about tracing sessions.
40
41 `$LTTNG_HOME/lttng-traces`::
42 Default output directory of LTTng traces. This can be overridden
43 with the nloption:--output option of the man:lttng-create(1)
44 command.
45
46 `$LTTNG_HOME/.lttng`::
47 User LTTng runtime and configuration directory.
48
49 `$LTTNG_HOME/.lttng/sessions`::
50 Default location of saved user tracing sessions (see
51 man:lttng-save(1) and man:lttng-load(1)).
52
53 +{system_sessions_dir}+::
54 System-wide location of saved tracing sessions
55 (see man:lttng-save(1) and man:lttng-load(1)).
56
57 NOTE: `$LTTNG_HOME` defaults to `$HOME` when not explicitly set.
58
59
60 EXIT STATUS
61 -----------
62 *0*::
63 Success
64
65 *1*::
66 Command error
67
68 *2*::
69 Undefined command
70
71 *3*::
72 Fatal error
73
74 *4*::
75 Command warning (something went wrong during the command)
76
77
78 include::common-footer.txt[]
This page took 0.032566 seconds and 5 git commands to generate.