lttng cli: Accept human readable sizes for --subbuf-size

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

diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
index a8e02fafa11718c70436559071d6069c9d3f4f82..65fa3d17f465e2a2fcd1dbfb4ef0da8fd1d1c477 100644 (file)
--- a/doc/man/lttng.1
+++ b/doc/man/lttng.1
@@ -327,7 +327,7 @@ same type.
 \-\-overwrite
         Flight recorder mode : overwrites events when subbuffers are full
 \-\-subbuf-size SIZE
-        Subbuffer size in bytes (default: 4096, kernel default: 262144)
+        Subbuffer size in bytes {+k,+M,+G} (default: 4096, kernel default: 262144)
         Needs to be a power of 2 for both tracers
 \-\-num-subbuf NUM
         Number of subbuffers (default: 4)
@@ -335,7 +335,7 @@ same type.
 \-\-switch-timer USEC
         Switch subbuffer timer interval in µsec (default: 0)
 \-\-read-timer USEC
-        Read timer interval in µsec (default: 200)
+        Read timer interval in µsec (UST default: 0, kernel default: 200000)
 \-\-output TYPE
         Channel output type. Possible values: mmap, splice
 \-\-buffers-uid
@@ -345,6 +345,29 @@ same type.
         Use per PID buffer (\-u only). Each application has its own buffers.
 \-\-buffers-global
         Use shared buffer for the whole system (\-k only)
+\-C, \-\-tracefile-size SIZE
+        Maximum size of each tracefile within a stream (in bytes).
+\-W, \-\-tracefile-count COUNT
+        Used in conjunction with \-C option, this will limit the number
+        of files created to the specified count.
+
+.B EXAMPLES:
+
+$ lttng enable-channel -C 4096 -W 32 chan1
+For each stream, the maximum size of a trace file will be 4096 bytes divided
+over a \fBmaximum\fP of 32 different files. The file count is appended after
+the stream number as seen in the following example. The last trace file is
+smaller than 4096 since it was not completely filled.
+
+        ~/lttng-traces/[...]/chan1_0_0 (4096)
+        ~/lttng-traces/[...]/chan1_0_1 (4096)
+        ~/lttng-traces/[...]/chan1_0_2 (3245)
+        ~/lttng-traces/[...]/chan1_1_0 (4096)
+        ...
+
+$ lttng enable-channel -C 4096
+This will create trace files of 4096 bytes and will create new ones as long as
+there is data available.
 .fi
 
 .IP