Fix: clarify session conf. directory in man

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

diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
index 3c7bbb44bd84bee3fa9ad58f6182832b6a5a5955..1475068c56f740194e1b2d161e3cc7df6ec9d0ca 100644 (file)
--- a/doc/man/lttng.1
+++ b/doc/man/lttng.1
@@ -776,8 +776,9 @@ already exists.
 Save tracing session configuration
 
 If SESSION is omitted, all session configurations will be saved to individual
 Save tracing session configuration
 
 If SESSION is omitted, all session configurations will be saved to individual

-\fB.lttng\fP files under the user's session configuration directory. The
-default session configuration file naming scheme is \fBSESSION.lttng\fP.
+\fB.lttng\fP files under the user's session configuration directory (default:
+~/.lttng/sessions/ or /var/run/lttng/sessions/ for root user). The default
+session configuration file naming scheme is \fBSESSION.lttng\fP.

 
 .B OPTIONS:
 
 
 .B OPTIONS:
 


@@ -789,7 +790,8 @@ Show summary of possible options and commands.
 Save all session configurations (default).
 .TP
 .BR "\-o, \-\-output-path PATH"
 Save all session configurations (default).
 .TP
 .BR "\-o, \-\-output-path PATH"

-Specify the output path for saved sessions (default: ~/.lttng/sessions/).
+Specify the output path for saved sessions. This overrides the default session
+configuration directory.

 .TP
 .BR "\-f, -\-force"
 Overwrite session configuration file if session name clashes.
 .TP
 .BR "\-f, -\-force"
 Overwrite session configuration file if session name clashes.


@@ -880,6 +882,10 @@ Name of the snapshot's output.
 Maximum size in bytes of the snapshot. The maxium size does not include the
 metadata file. Human readable format is accepted: {+k,+M,+G}. For instance,
 \-\-max-size 5M
 Maximum size in bytes of the snapshot. The maxium size does not include the
 metadata file. Human readable format is accepted: {+k,+M,+G}. For instance,
 \-\-max-size 5M

+
+The minimum size of a snapshot is computed by multiplying the total amount of
+streams in the session by the largest subbuffer size. This is to ensure
+fairness between channels when extracting data.

 .TP
 .BR "\-C, \-\-ctrl-url URL"
 Set control path URL. (Must use -D also)
 .TP
 .BR "\-C, \-\-ctrl-url URL"
 Set control path URL. (Must use -D also)