X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng.1;h=827c39c2064e125aa3cc3f487c5b74565ad056e9;hb=41ed8e47358244890326cb14dfae889ed0adb1ba;hp=fd62558eec7a8e53ea60104be2c2c1b67727fa9f;hpb=d07ceecd2f35ccf383c7529a18dcc9b9c4b8cb17;p=lttng-tools.git diff --git a/doc/man/lttng.1 b/doc/man/lttng.1 index fd62558ee..827c39c20 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 @@ -498,7 +510,7 @@ there is data available. .PP .PP -\fBenable-event\fP NAME[,NAME2,...] [-k|-u] [OPTIONS] +\fBenable-event\fP NAME[,NAME2,...] (\-k | \-u | \-j | \-l | \-p) [OPTIONS] .RS Enable tracing event @@ -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: @@ -1106,6 +1117,7 @@ found. .BR lttng-ust(3), .BR lttng-sessiond(8), .BR lttng-relayd(8), +.BR lttng-crash(1), .SH "BUGS"