Document filter (help and manpage)

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

diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
index 611366026acf9eb013463cace14bc1d802109d57..089d87fa09861188d8e38551b1c4fde7b54829cf 100644 (file)
--- a/doc/man/lttng.1
+++ b/doc/man/lttng.1
@@ -1,4 +1,4 @@
-.TH "LTTNG" "1" "February 9, 2012" "" ""
+.TH "LTTNG" "1" "July 17, 2012" "" ""
 
 .SH "NAME"
 lttng \(em LTTng 2.0 tracer control command line tool
@@ -53,7 +53,7 @@ Show summary of possible options and commands.
 .TP
 .BR "\-v, \-\-verbose"
 Increase verbosity.
-Three levels of verbosity are available which are triggered by putting additionnal v to 
+Three levels of verbosity are available which are triggered by putting additional v to
 the option (\-vv or \-vvv)
 .TP
 .BR "\-q, \-\-quiet"
@@ -239,6 +239,8 @@ If NAME is omitted, the session name is taken from the .lttngrc file.
 .nf
 \-h, \-\-help
         Show summary of possible options and commands.
+\-a, \-\-all
+        Destroy all sessions
 \-\-list-options
         Simple listing of options
 .fi
@@ -249,6 +251,8 @@ If NAME is omitted, the session name is taken from the .lttngrc file.
 .nf
 Enable tracing channel
 
+To enable event, you must first enable a channel which contains event(s).
+
 If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
 file.
 .fi
@@ -274,7 +278,7 @@ file.
 \-\-subbuf-size
         Subbuffer size in bytes (default: 4096, kernel default: 262144)
 \-\-num-subbuf
-        Number of subbufers (default: 4)
+        Number of subbuffers (default: 4)
         Needs to be a power of 2 for kernel and ust tracers
 \-\-switch-timer
         Switch subbuffer timer interval in usec (default: 0)
@@ -336,6 +340,29 @@ file.
         Enabling syscalls tracing (kernel tracer), you will not be able to disable them
         with disable-event. This is a known limitation. You can disable the entire
         channel to do the trick.
+
+\-\-filter 'expression'
+       Set a filter on a newly enabled event.
+       Filter expression on event fields, event recording
+       depends on evaluation. Only specify on first activation
+       of a given event within a session. Filter 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.
+       Currently, filter is only implemented for the user-space 
+       tracer.
+       Expression examples:
+
+       'intfield > 500 && intfield < 503'
+       '(stringfield == "test" || intfield != 10) && intfield > 33'
+       'doublefield > 1.1 && intfield < 5.3'
+
+       Wildcards are allowed at the end of strings:
+       'seqfield1 == "te*"'
+       In string literals, the escape character is a '\\'.
+       Use '\\*' for the '*' character, and '\\\\' for the
+       '\\' character.
+
 .fi
 
 .IP "\fBdisable-channel\fP NAME[,NAME2,...] [\-k|\-u] [OPTIONS]"
@@ -398,7 +425,7 @@ With no arguments, it will list available tracing session(s).
 
 With the session name, it will display the details of the session including
 the trace file path, the associated channels and their state (activated
-and deactivated), the activated events and more. 
+and deactivated), the activated events and more.
 
 With \-k alone, it will list all available kernel events (except the system
 calls events).
@@ -421,7 +448,7 @@ You can now enable any event listed by using the name :
 \-\-list-options
         Simple listing of options
 \-k, \-\-kernel
-        Select kernel domain (FIXME : apparition de la notion de "domain" ici)
+        Select kernel domain
 \-u, \-\-userspace
         Select user-space domain.
 
@@ -637,6 +664,15 @@ Tracing already started
 
 .IP "81"
 Tracing already stopped
+
+.IP "98"
+No UST consumer detected
+
+.IP "99"
+No Kernel consumer detected
+
+.IP "100"
+Event already enabled with different loglevel
 .PP
 .SH "ENVIRONMENT VARIABLES"
 
@@ -645,7 +681,7 @@ Note that all command line options override environment variables.
 .PP
 
 .PP
-.IP "LTTNG_SESSIOND_PATH_ENV"
+.IP "LTTNG_SESSIOND_PATH"
 Allows one to specify the full session daemon binary path to lttng command line
 tool. You can also use \-\-sessiond-path option having the same effect.
 .SH "SEE ALSO"