lttng-ust(3): document $LTTNG_HOME

[lttng-ust.git] / doc / man / lttng-ust.3.txt

diff --git a/doc/man/lttng-ust.3.txt b/doc/man/lttng-ust.3.txt
index c7b82c1a61876762a0026b183b8c3d1aabdce890..27c1fd6bd656cfd1f7e704810bc58aaf6221d971 100644 (file)
--- a/doc/man/lttng-ust.3.txt
+++ b/doc/man/lttng-ust.3.txt
@@ -776,7 +776,7 @@ This event has no fields.
 +
 This event has no fields.
 
-`lttng_ust_statedump:soinfo`::
+`lttng_ust_statedump:bin_info`::
     Emitted when information about a currently loaded executable or
     shared object is found.
 +
@@ -787,7 +787,7 @@ Fields:
 | Field name                 | Description
 | `baddr`                    | Base address of loaded executable
 | `memsz`                    | Size of loaded executable in memory
-| `sopath`                   | Path to loaded executable file
+| `path`                     | Path to loaded executable file
 | `is_pic`                   | Whether the executable is
                                position-independent code
 |==================================================================
@@ -1088,6 +1088,16 @@ int main(int argc, char* argv[])
 
 ENVIRONMENT VARIABLES
 ---------------------
+`LTTNG_HOME`::
+    Overrides the `$HOME` environment variable. 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.
 
@@ -1100,7 +1110,7 @@ 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