Fix: report error to client on consumerd error

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

diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
index 9884862febbc42bf5a79c4bf17a87a59ddc841a4..f13d5d341d608b8e6a3c77106bf5e9be9e5ff235 100644 (file)
--- a/doc/man/lttng.1
+++ b/doc/man/lttng.1
@@ -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"
@@ -249,6 +249,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 +276,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)
@@ -398,7 +400,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 +423,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.
 
@@ -533,6 +535,117 @@ If SESSION_NAME is omitted, the session name is taken from the .lttngrc file.
         to the arguments
 .fi
 
+.SH "EXIT VALUES"
+
+.IP "0"
+Success
+
+.IP "1"
+Command error
+
+.IP "2"
+Undefined command
+
+.IP "3"
+Fatal error
+
+.IP "4"
+Command warning
+
+.IP "16"
+No session found by the name given
+
+.IP "18"
+Error in session creation
+
+.IP "21"
+Error in application(s) listing
+
+.IP "28"
+Session name already exists
+
+.IP "33"
+Kernel tracer unavailable
+
+.IP "35"
+Kernel event exists
+
+.IP "37"
+Kernel channel exists
+
+.IP "38"
+Kernel channel creation failed
+
+.IP "39"
+Kernel channel not found
+
+.IP "40"
+Kernel channel disable failed
+
+.IP "41"
+Kernel channel enable failed
+
+.IP "42"
+Kernel context failed
+
+.IP "43"
+Kernel enable event failed
+
+.IP "44"
+Kernel disable event failed
+
+.IP "53"
+Kernel listing events failed
+
+.IP "60"
+UST channel disable failed
+
+.IP "61"
+UST channel enable failed
+
+.IP "62"
+UST adding context failed
+
+.IP "63"
+UST event enable failed
+
+.IP "64"
+UST event disable failed
+
+.IP "66"
+UST start failed
+
+.IP "67"
+UST stop failed
+
+.IP "75"
+UST event exists
+
+.IP "76"
+UST event not found
+
+.IP "77"
+UST context exists
+
+.IP "78"
+UST invalid context
+
+.IP "79"
+Tracing the kernel requires a root lttng-sessiond daemon and "tracing" group
+user membership.
+
+.IP "80"
+Tracing already started
+
+.IP "81"
+Tracing already stopped
+
+.IP "98"
+No UST consumer detected
+
+.IP "99"
+No Kernel consumer detected
+.PP
 .SH "ENVIRONMENT VARIABLES"
 
 .PP
@@ -540,7 +653,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"