Fix: add default session conf. dir to manpage

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

diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
index 483df2aefab2cd8799d6db18e3b7d7c6dc4bf535..cd0aae29466ebfe76b0e04317e544a462a338f0d 100644 (file)
--- a/doc/man/lttng.1
+++ b/doc/man/lttng.1
@@ -402,7 +402,8 @@ Apply to the user-space tracer
 Discard event when subbuffers are full (default)
 .TP
 .BR "\-\-overwrite"
 Discard event when subbuffers are full (default)
 .TP
 .BR "\-\-overwrite"

-Flight recorder mode : overwrites events when subbuffers are full
+Flight recorder mode: overwrites events when subbuffers are full. The
+number of subbuffer must be 2 or more.

 .TP
 .BR "\-\-subbuf-size SIZE"
 Subbuffer size in bytes {+k,+M,+G}.
 .TP
 .BR "\-\-subbuf-size SIZE"
 Subbuffer size in bytes {+k,+M,+G}.


@@ -443,7 +444,7 @@ Use shared buffer for the whole system (\-k only)
 Maximum size of each tracefile within a stream (in bytes).
 0 means unlimited. (default: 0)
 Note: traces generated with this option may inaccurately report
 Maximum size of each tracefile within a stream (in bytes).
 0 means unlimited. (default: 0)
 Note: traces generated with this option may inaccurately report

-discarded events as per CTF 1.8.
+discarded events as of CTF 1.8.

 .TP
 .BR "\-W, \-\-tracefile-count COUNT"
 Used in conjunction with \-C option, this will limit the number of files
 .TP
 .BR "\-W, \-\-tracefile-count COUNT"
 Used in conjunction with \-C option, this will limit the number of files


@@ -748,8 +749,8 @@ List available domain(s)
 Load tracing session configuration
 
 If NAME is omitted, all session configurations found in both the user's session
 Load tracing session configuration
 
 If NAME is omitted, all session configurations found in both the user's session

-configuration directory and the system session configuration directory will be
-loaded.
+configuration directory (default: ~/.lttng/sessions/) and the system session
+configuration directory (default: /etc/lttng/sessions/) will be loaded.

 
 .B OPTIONS:
 
 
 .B OPTIONS:
 


@@ -761,7 +762,8 @@ Show summary of possible options and commands.
 Load all session configurations (default).
 .TP
 .BR "\-i, \-\-input-path PATH"
 Load all session configurations (default).
 .TP
 .BR "\-i, \-\-input-path PATH"

-Specify the input path for session configurations.
+Specify the input path for session configurations. This overrides the default
+session configuration directory.

 .TP
 .BR "\-f, -\-force"
 Overwrite current session configuration(s) if a session of the same name
 .TP
 .BR "\-f, -\-force"
 Overwrite current session configuration(s) if a session of the same name


@@ -775,8 +777,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/). The default session configuration file naming scheme is
+\fBSESSION.lttng\fP.

 
 .B OPTIONS:
 
 
 .B OPTIONS:
 


@@ -788,7 +791,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.


@@ -879,6 +883,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)