projects / lttng-tools.git / blame
| Commit | Line | Data |
|---|---|---|
| af1c4164 PP |
1 | EXIT STATUS |
| 2 | ----------- | |
| 3 | *0*:: | |
| 4 | Success | |
| 5 | ||
| 6 | *1*:: | |
| 7 | Command error | |
| 8 | ||
| 9 | *2*:: | |
| 10 | Undefined command | |
| 11 | ||
| 12 | *3*:: | |
| 13 | Fatal error | |
| 14 | ||
| 15 | *4*:: | |
| 16 | Command warning (something went wrong during the command) | |
| 17 | ||
| 18 | ||
| 19 | ENVIRONMENT | |
| 20 | ----------- | |
| 9bbd8e06 | 21 | `LTTNG_ABORT_ON_ERROR`:: |
| 484b2a0c PP |
22 | Set to `1` to abort the process after the first error is |
| 23 | encountered. | |
| 9bbd8e06 | 24 | |
| 5d231d82 | 25 | `LTTNG_HOME`:: |
| 484b2a0c PP |
26 | Path to the LTTng home directory. |
| 27 | + | |
| 28 | Defaults to `$HOME`. | |
| 29 | + | |
| 30 | Useful when the Unix user running the commands has a non-writable home | |
| 31 | directory. | |
| 5d231d82 PP |
32 | |
| 33 | `LTTNG_MAN_BIN_PATH`:: | |
| 484b2a0c PP |
34 | Absolute path to the manual pager to use to read the LTTng |
| 35 | command-line help (with man:lttng-help(1) or with the | |
| 36 | nloption:--help option) instead of `/usr/bin/man`. | |
| 5d231d82 PP |
37 | |
| 38 | `LTTNG_SESSION_CONFIG_XSD_PATH`:: | |
| 484b2a0c PP |
39 | Path to the directory containing the `session.xsd` tracing session |
| 40 | configuration XML schema. | |
| 5d231d82 PP |
41 | |
| 42 | `LTTNG_SESSIOND_PATH`:: | |
| 26f0c779 PP |
43 | Absolute path to the LTTng session daemon binary (see |
| 44 | man:lttng-sessiond(8)). | |
| 5d231d82 | 45 | + |
| 484b2a0c PP |
46 | The genoption:--sessiond-path general option overrides this environment |
| 47 | variable. | |
| 48 | + | |
| 49 | NOTE: The man:lttng-create(1) command can spawn an LTTng session daemon | |
| 50 | automatically if none is running. See man:lttng-sessiond(8) for the | |
| 51 | environment variables affecting the execution of the session daemon. | |
| 5d231d82 PP |
52 | |
| 53 | ||
| 900690ca PP |
54 | FILES |
| 55 | ----- | |
| 56 | `$LTTNG_HOME/.lttngrc`:: | |
| 484b2a0c | 57 | Unix user's LTTng runtime configuration. |
| 900690ca | 58 | + |
| 484b2a0c PP |
59 | This is where LTTng stores the name of the Unix user's current tracing |
| 60 | session between executions of man:lttng(1). man:lttng-create(1) and | |
| 61 | man:lttng-set-session(1) set the current tracing session. | |
| 900690ca PP |
62 | |
| 63 | `$LTTNG_HOME/lttng-traces`:: | |
| 484b2a0c PP |
64 | Default output directory of LTTng traces in local and snapshot |
| 65 | modes. | |
| 66 | + | |
| 67 | Override this path with the nloption:--output option of the | |
| 68 | man:lttng-create(1) command. | |
| 900690ca PP |
69 | |
| 70 | `$LTTNG_HOME/.lttng`:: | |
| 484b2a0c | 71 | Unix user's LTTng runtime and configuration directory. |
| 900690ca PP |
72 | |
| 73 | `$LTTNG_HOME/.lttng/sessions`:: | |
| 484b2a0c PP |
74 | Default directory containing the Unix user's saved tracing session |
| 75 | configurations (see man:lttng-save(1) and man:lttng-load(1)). | |
| 900690ca | 76 | |
| d8065e7e | 77 | +{system_sessions_dir}+:: |
| 484b2a0c PP |
78 | Directory containing the system-wide saved tracing session |
| 79 | configurations (see man:lttng-save(1) and man:lttng-load(1)). | |
| 900690ca | 80 | |
| 484b2a0c PP |
81 | NOTE: `$LTTNG_HOME` defaults to the value of the `HOME` environment |
| 82 | variable. | |
| 900690ca PP |
83 | |
| 84 | ||
| 5d231d82 | 85 | include::common-footer.txt[] |