X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Fcommon-cmd-footer.txt;h=6d16c035152f3ade5052de9184c70faea1bd035e;hp=cbd3c3913a7baa69c8af1722df10fe517896e945;hb=9d16b343fb9e781fc8d8fa3c448a3f382306dd33;hpb=5d231d824cb0cfba5c4074cc16f09fae8abc146b diff --git a/doc/man/common-cmd-footer.txt b/doc/man/common-cmd-footer.txt index cbd3c3913..6d16c0351 100644 --- a/doc/man/common-cmd-footer.txt +++ b/doc/man/common-cmd-footer.txt @@ -1,12 +1,15 @@ ENVIRONMENT VARIABLES --------------------- +`LTTNG_ABORT_ON_ERROR`:: + Set to 1 to abort the process after the first error is encountered. + `LTTNG_HOME`:: Overrides the `$HOME` environment variable. Useful when the user running the commands has a non-writable home directory. `LTTNG_MAN_BIN_PATH`:: Absolute path to the man pager to use for viewing help information - about LTTng commands (using linklttng:lttng-help(1) or + about LTTng commands (using man:lttng-help(1) or `lttng COMMAND --help`). `LTTNG_SESSION_CONFIG_XSD_PATH`:: @@ -16,15 +19,44 @@ ENVIRONMENT VARIABLES `LTTNG_SESSIOND_PATH`:: Full session daemon binary path. + -The option:--sessiond-path option has precedence over this +The genoption:--sessiond-path option has precedence over this environment variable. -Note that the linklttng:lttng-create(1) command can spawn an LTTng +Note that the man:lttng-create(1) command can spawn an LTTng session daemon automatically if none is running. See -linklttng:lttng-sessiond(8) for the environment variables influencing +man:lttng-sessiond(8) for the environment variables influencing the execution of the session daemon. +FILES +----- +`$LTTNG_HOME/.lttngrc`:: + User LTTng runtime configuration. ++ +This is where the per-user current tracing session is stored between +executions of man:lttng(1). The current tracing session can be set +with man:lttng-set-session(1). See man:lttng-create(1) for +more information about tracing sessions. + +`$LTTNG_HOME/lttng-traces`:: + Default output directory of LTTng traces. This can be overridden + with the nloption:--output option of the man:lttng-create(1) + command. + +`$LTTNG_HOME/.lttng`:: + User LTTng runtime and configuration directory. + +`$LTTNG_HOME/.lttng/sessions`:: + Default location of saved user tracing sessions (see + man:lttng-save(1) and man:lttng-load(1)). + ++{system_sessions_dir}+:: + System-wide location of saved tracing sessions + (see man:lttng-save(1) and man:lttng-load(1)). + +NOTE: `$LTTNG_HOME` defaults to `$HOME` when not explicitly set. + + EXIT STATUS ----------- *0*::