X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Fcommon-cmd-footer.txt;fp=doc%2Fman%2Fcommon-cmd-footer.txt;h=cbd3c3913a7baa69c8af1722df10fe517896e945;hp=0000000000000000000000000000000000000000;hb=5d231d824cb0cfba5c4074cc16f09fae8abc146b;hpb=307a84685f8eac50bba14692d73c69cc276ddc52 diff --git a/doc/man/common-cmd-footer.txt b/doc/man/common-cmd-footer.txt new file mode 100644 index 000000000..cbd3c3913 --- /dev/null +++ b/doc/man/common-cmd-footer.txt @@ -0,0 +1,46 @@ +ENVIRONMENT VARIABLES +--------------------- +`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 + `lttng COMMAND --help`). + +`LTTNG_SESSION_CONFIG_XSD_PATH`:: + Path in which the `session.xsd` session configuration XML + schema may be found. + +`LTTNG_SESSIOND_PATH`:: + Full session daemon binary path. ++ +The option:--sessiond-path option has precedence over this +environment variable. + +Note that the linklttng: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 +the execution of the session daemon. + + +EXIT STATUS +----------- +*0*:: + Success + +*1*:: + Command error + +*2*:: + Undefined command + +*3*:: + Fatal error + +*4*:: + Command warning (something went wrong during the command) + + +include::common-footer.txt[]