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