Man page fixes: missing --version option and typo
[lttng-tools.git] / doc / man / lttng.1
index b2505d0ff7d2c3802ad6cc3924b153b1b71b0add..564f888f515ab340af45bceb33e5cb8b22921c03 100644 (file)
@@ -48,7 +48,7 @@ given moment (See the \fBlist\fP command).
 .SH "OPTIONS"
 
 .PP
-This program follow the usual GNU command line syntax with long options starting with
+This program follows the usual GNU command line syntax with long options starting with
 two dashes. Below is a summary of the available options.
 .PP
 
@@ -56,6 +56,9 @@ two dashes. Below is a summary of the available options.
 .BR "\-h, \-\-help"
 Show summary of possible options and commands.
 .TP
+.BR "\-V, \-\-version"
+Show version.
+.TP
 .BR "\-v, \-\-verbose"
 Increase verbosity.
 Three levels of verbosity are available which are triggered by putting additional v to
@@ -302,6 +305,13 @@ $ lttng start
 After the start, you'll be able to read the events while they are being
 recorded in /tmp/lttng.
 
+.TP
+.BR "\-\-shm-path PATH"
+
+Path where shared memory holding buffers should be created. Useful
+when used with PRAMFS or other persistent memory filesystems to extract
+trace data in the event of a crash requiring a reboot.
+
 .TP
 .BR "\-U, \-\-set-url=URL"
 Set URL for the consumer output destination. It is persistent for the
@@ -935,10 +945,6 @@ Name of the snapshot's output.
 Maximum size in bytes of the snapshot. The maximum 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)
This page took 0.023109 seconds and 4 git commands to generate.