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