doc/man: add FILES section

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/doc/man/common-cmd-footer.txt b/doc/man/common-cmd-footer.txt
index da241ec966a210be7d8af69ba5f6fac4c1e67fe7..61f5bb0a1ab29fd0f1aae7fd1b62e3989279b04a 100644 (file)
--- a/doc/man/common-cmd-footer.txt
+++ b/doc/man/common-cmd-footer.txt
@@ -25,6 +25,35 @@ linklttng:lttng-sessiond(8) for the environment variables influencing
 the execution of the session daemon.
 
 
 the execution of the session daemon.
 
 

+FILES
+-----
+`$LTTNG_HOME/.lttngrc`::
+    User LTTng runtime configuration.
++
+This is where the per-user current tracing session is stored between
+executions of linklttng:lttng(1). The current tracing session can be set
+with linklttng:lttng-set-session(1). See linklttng:lttng-create(1) for
+more information about tracing sessions.
+
+`$LTTNG_HOME/lttng-traces`::
+    Default output directory of LTTng traces. This can be overridden
+    with the nloption:--output option of the linklttng:lttng-create(1)
+    command.
+
+`$LTTNG_HOME/.lttng`::
+    User LTTng runtime and configuration directory.
+
+`$LTTNG_HOME/.lttng/sessions`::
+    Default location of saved user tracing sessions (see
+    linklttng:lttng-save(1) and linklttng:lttng-load(1)).
+
+`/etc/lttng/sessions`::
+    System-wide location of saved tracing sessions
+    (see linklttng:lttng-save(1) and linklttng:lttng-load(1)).
+
+NOTE: `$LTTNG_HOME` defaults to `$HOME` when not explicitly set.
+
+

 EXIT STATUS
 -----------
 *0*::
 EXIT STATUS
 -----------
 *0*::

diff --git a/doc/man/lttng-relayd.8.txt b/doc/man/lttng-relayd.8.txt
index 32eccbeda142b34a9de22ece4f2d5b64cf2f3155..3f6759e166110a731b586c772ced9fbd8e9cfdf9 100644 (file)
--- a/doc/man/lttng-relayd.8.txt
+++ b/doc/man/lttng-relayd.8.txt
@@ -156,6 +156,18 @@ ENVIRONMENT VARIABLES
     Path to relay daemon health's socket.
 
 
     Path to relay daemon health's socket.
 
 

+FILES
+-----
+`$LTTNG_HOME/.lttng`::
+    User LTTng runtime and configuration directory.
+
+`$LTTNG_HOME/lttng-traces`::
+    Default output directory of LTTng traces. This can be overridden
+    with the option:--output option.
+
+NOTE: `$LTTNG_HOME` defaults to `$HOME` when not explicitly set.
+
+

 EXIT STATUS
 -----------
 *0*::
 EXIT STATUS
 -----------
 *0*::

diff --git a/doc/man/lttng-sessiond.8.txt b/doc/man/lttng-sessiond.8.txt
index df119e78beff0d79f3b70415536cb92bdce7066d..a373415208f30021614c960755bf482d00c0d900 100644 (file)
--- a/doc/man/lttng-sessiond.8.txt
+++ b/doc/man/lttng-sessiond.8.txt
@@ -261,6 +261,35 @@ The option:--kmod-probes option overrides this variable.
     Tracing session configuration XML schema definition (XSD) path.
 
 
     Tracing session configuration XML schema definition (XSD) path.
 
 

+FILES
+-----
+`$LTTNG_HOME/.lttng`::
+    User LTTng runtime and configuration directory.
+
+`$LTTNG_HOME/lttng-traces`::
+    Default output directory of LTTng traces. This can be overridden
+    with the nloption:--output option of the linklttng:lttng-create(1)
+    command.
+
+`$LTTNG_HOME/.lttng/sessions`::
+    Default location of saved user tracing sessions (see
+    linklttng:lttng-save(1) and linklttng:lttng-load(1)).
+
+`/etc/lttng/sessions`::
+    System-wide location of saved tracing sessions
+    (see linklttng:lttng-save(1) and linklttng:lttng-load(1)).
+
+`$LTTNG_HOME/.lttng/lttng.conf`::
+    Default location of the session daemon configuration file (see the
+    option:--config option).
+
+`/etc/lttng/lttng.conf`::
+    System-wide location of the session daemon configuration file (see
+    the option:--config option).
+
+NOTE: `$LTTNG_HOME` defaults to `$HOME` when not explicitly set.
+
+

 EXIT STATUS
 -----------
 *0*::
 EXIT STATUS
 -----------
 *0*::