From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Wed, 11 May 2016 15:49:48 +0000 (-0400)
Subject: lttng-ust(3): document $LTTNG_HOME
X-Git-Tag: v2.9.0-rc1~114
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=0ce823281d505aada6ddeb56a84a556d1b483d36;p=lttng-ust.git

lttng-ust(3): document $LTTNG_HOME

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
---

diff --git a/doc/man/lttng-ust.3.txt b/doc/man/lttng-ust.3.txt
index ff0e14f7..27c1fd6b 100644
--- a/doc/man/lttng-ust.3.txt
+++ b/doc/man/lttng-ust.3.txt
@@ -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.