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 dda9cec6e55c7fcfcc52384036d8206042005809..27c1fd6bd656cfd1f7e704810bc58aaf6221d971 100644 (file)
--- a/doc/man/lttng-ust.3.txt
+++ b/doc/man/lttng-ust.3.txt
@@ -776,19 +776,21 @@ This event has no fields.
 +
 This event has no fields.
 
-`lttng_ust_statedump:soinfo`::
-    Emitted when information about a currently loaded shared object is
-    found.
+`lttng_ust_statedump:bin_info`::
+    Emitted when information about a currently loaded executable or
+    shared object is found.
 +
 Fields:
 +
 [options="header"]
-|==============================================================
+|==================================================================
 | Field name                 | Description
-| `baddr`                    | Base address of loaded library
-| `memsz`                    | Size of loaded library in memory
-| `sopath`                   | Path to loaded library file
-|==============================================================
+| `baddr`                    | Base address of loaded executable
+| `memsz`                    | Size of loaded executable in memory
+| `path`                     | Path to loaded executable file
+| `is_pic`                   | Whether the executable is
+                               position-independent code
+|==================================================================
 
 `lttng_ust_statedump:build_id`::
     Emitted when a build ID is found in a currently loaded shared
@@ -843,6 +845,39 @@ cc -c app.c
 cc -o app tp.o app.o -llttng-ust -ldl
 -------------------------------------
 
+Using the man:lttng(1) tool, create an LTTng tracing session, enable
+all the events of this tracepoint provider, and start tracing:
+
+[role="term"]
+----------------------------------------------
+lttng create my-session
+lttng enable-event --userspace 'my_provider:*'
+lttng start
+----------------------------------------------
+
+You may also enable specific events:
+
+[role="term"]
+----------------------------------------------------------
+lttng enable-event --userspace my_provider:big_event
+lttng enable-event --userspace my_provider:event_instance2
+----------------------------------------------------------
+
+Run the application:
+
+[role="term"]
+--------------------
+./app some arguments
+--------------------
+
+Stop the current tracing session and inspect the recorded events:
+
+[role="term"]
+----------
+lttng stop
+lttng view
+----------
+
 
 Tracepoint provider header file
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1053,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.
 
@@ -1065,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