Using LTTNG_HOME environment variable if exists, with fallback to HOME

[lttng-tools.git] / doc / man / lttng.1

diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
index f472d389d7bd9262d57dfacc109eab47d3f677ce..26fd44a69db986148a9b7150868a721b8ca8f4b1 100644 (file)
--- a/doc/man/lttng.1
+++ b/doc/man/lttng.1
@@ -214,6 +214,10 @@ automatically created having this form: 'auto-yyyymmdd-hhmmss'.
 
 If no \fB\-o, \-\-output\fP is specified, the traces will be written in
 $HOME/lttng-traces.
+
+The $HOME environment variable can be overridden by defining the environment
+variable LTTNG_HOME. This is useful when the user running the commands has
+a non-writeable home directory.
 .fi
 
 .B OPTIONS: