X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng.1;h=827c39c2064e125aa3cc3f487c5b74565ad056e9;hb=895707daf3f9a3cbe4eb9915a42e1677d221c218;hp=9f642b812f8cefdff6d70961370bf963d4b40752;hpb=d7ba13889c8692b14f99238ddf2721ed78df89d2;p=lttng-tools.git diff --git a/doc/man/lttng.1 b/doc/man/lttng.1 index 9f642b812..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 @@ -306,7 +309,10 @@ recorded in /tmp/lttng. .BR "\-\-shm-path PATH" Path where shared memory holding buffers should be created. Useful -when used with pramfs to extract trace data after crash. +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" @@ -504,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 @@ -598,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: @@ -1112,6 +1117,7 @@ found. .BR lttng-ust(3), .BR lttng-sessiond(8), .BR lttng-relayd(8), +.BR lttng-crash(1), .SH "BUGS"