X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-ust.3.txt;h=816bebc7232a53f8b1752996c0eab97ae0892b81;hb=14dd1c6f0cb8124a1399dbdea0f3a3335ae22ca8;hp=1d69221d122f269311727c463b26f484ee379834;hpb=6488ae4ce8308349a872aa2bd744103608464cc5;p=lttng-ust.git diff --git a/doc/man/lttng-ust.3.txt b/doc/man/lttng-ust.3.txt index 1d69221d..816bebc7 100644 --- a/doc/man/lttng-ust.3.txt +++ b/doc/man/lttng-ust.3.txt @@ -1088,23 +1088,33 @@ int main(int argc, char* argv[]) ENVIRONMENT VARIABLES --------------------- +`LTTNG_HOME`:: + Alternative user's home directory. This variable is useful when the + user running the instrumented application has a non-writable home + directory. ++ +Unix sockets used for the communication between `liblttng-ust` and the +LTTng session and consumer daemons (part of the LTTng-tools project) +are located in a specific directory under `$LTTNG_HOME` (or `$HOME` if +`$LTTNG_HOME` is not set). + `LTTNG_UST_DEBUG`:: - Activate `liblttng-ust` debug and error output. + Activates `liblttng-ust`'s debug and error output if set to `1`. `LTTNG_UST_REGISTER_TIMEOUT`:: - Specify how long the applications should wait for the - _registration done_ session daemon command before proceeding to - execute the main program (milliseconds). + Waiting time for the _registration done_ session daemon command + before proceeding to execute the main program (milliseconds). + -The value 0 means _do not wait_. The value -1 means _wait forever_. -Setting this environment variable to 0 is recommended for applications +The value `0` means _do not wait_. The value `-1` means _wait forever_. +Setting this environment variable to `0` is recommended for applications with time constraints on the process startup time. + -Default: 3000. +Default: {lttng_ust_register_timeout}. `LTTNG_UST_WITHOUT_BADDR_STATEDUMP`:: - Prevent `liblttng-ust` from performing a base address state dump - (see the <> section above). + Prevents `liblttng-ust` from performing a base address state dump + (see the <> section above) if + set to `1`. `LTTNG_UST_GETCPU_PLUGIN`:: Path to the shared object which acts as the `getcpu()` override