X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng.1;h=419398c02da3c756b378a20c2f65174b2f3b058e;hp=b2505d0ff7d2c3802ad6cc3924b153b1b71b0add;hb=7a988b549113d01a43abefb7eff036f0ba2b98a3;hpb=887432871ca16e00f69fb2aa9e26562ba124e70a diff --git a/doc/man/lttng.1 b/doc/man/lttng.1 index b2505d0ff..419398c02 100644 --- a/doc/man/lttng.1 +++ b/doc/man/lttng.1 @@ -1,7 +1,7 @@ .TH "LTTNG" "1" "May 13th, 2014" "" "" .SH "NAME" -lttng \(em LTTng 2.x tracer control command line tool +lttng \- LTTng 2.x tracer control command line tool .SH "SYNOPSIS" @@ -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,15 @@ $ 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. + +See the \fBlttng-crash(1)\fP utility for more information on crash recovery. + .TP .BR "\-U, \-\-set-url=URL" Set URL for the consumer output destination. It is persistent for the @@ -592,7 +604,6 @@ given event within a session. Specifying a filter is only allowed when enabling events within a session before tracing is started. If the filter fails to link with the event within the traced domain, the event will be discarded. -Filtering is currently only implemented for the user-space tracer. Expression examples: @@ -935,10 +946,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) @@ -1110,6 +1117,7 @@ found. .BR lttng-ust(3), .BR lttng-sessiond(8), .BR lttng-relayd(8), +.BR lttng-crash(1), .SH "BUGS"