Introduce LTTNG_UST_APP_PATH environment variable

[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 76b5c37aa60a9cb6e7a1e8e26a39e97abc4ea436..081388961f4994553a4b80083c4e0427ed5a1af4 100644 (file)
--- a/doc/man/lttng-ust.3.txt
+++ b/doc/man/lttng-ust.3.txt
@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: 2016 Philippe Proulx <pproulx@efficios.com>
+// SPDX-License-Identifier: CC-BY-4.0
+//
 lttng-ust(3)
 ============
 :object-type: library
@@ -1479,18 +1482,22 @@ int main(int argc, char* argv[])
 
 ENVIRONMENT VARIABLES
 ---------------------
-`LTTNG_UST_HOME`::
+`LTTNG_UST_APP_PATH`::
+    Path under which unix sockets used for the communication between
+    the application (tracee) instrumented with `liblttng-ust` and the
+    LTTng session and consumer daemons (part of the LTTng-tools project)
+    are located. When `$LTTNG_UST_APP_PATH` is specified, only this path
+    is considered for connecting to a session daemon. The
+    `$LTTNG_UST_APP_PATH` target directory must exist and be accessible
+    by the user before the application is executed for tracing to work.
+    Setting this environment variable disables connection to root and
+    per-user session daemons.
+
+`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_UST_HOME` (or `$HOME` if
-`$LTTNG_UST_HOME` is not set).
-
-NOTE: `$LTTNG_HOME` is also supported as a fallback of `$LTTNG_UST_HOME` for
-backward compatibility reason.
+    directory. This path is where unix sockets for communication with
+    the per-user session daemon are located.
 
 `LTTNG_UST_ALLOW_BLOCKING`::
     If set, allow the application to retry event tracing when there's