Update maintainer section of the man pages

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

diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
index 7a41e64d7d46d9056ac294704102de5ae1a71cab..77ef0c330aaddbe3d7aa5a49961b69362f155581 100644 (file)
--- a/doc/man/lttng.1
+++ b/doc/man/lttng.1
@@ -40,10 +40,10 @@ running as Alice that can be used to trace her applications along side with a
 root daemon or even a Bob daemon. We highly recommend starting the session
 daemon at boot time for stable and long term tracing.
 
-All user-space applications instrumented with lttng-ust(3) will
-automatically register to the session daemon. This feature gives you the
-ability to list available traceable applications and tracepoints on a per user
-basis. (See \fBlist\fP command).
+Each user-space application instrumented with lttng-ust(3) will automatically
+register with the root session daemon and its user session daemon. This allows
+each daemon to list the available traceable applications and tracepoints at any
+given moment (See the \fBlist\fP command).
 .SH "OPTIONS"
 
 .PP
@@ -233,6 +233,8 @@ The $HOME environment variable can be overridden by defining the environment
 variable LTTNG_HOME. This is useful when the user running the commands has
 a non-writeable home directory.
 
+The session name MUST NOT contain the character '/'.
+
 .B OPTIONS:
 
 .TP
@@ -253,12 +255,13 @@ Set the session in snapshot mode. Created in no-output mode and uses the
 URL, if one is specified, as the default snapshot output.  Every channel will be set
 in overwrite mode and with mmap output (splice not supported).
 .TP
-.BR "\-\-live USEC"
+.BR "\-\-live [USEC]"
 Set the session exclusively in live mode. The paremeter is the delay in micro
 seconds before the data is flushed and streamed. The live mode allows you to
 stream the trace and view it while it's being recorded by any tracer. For that,
 you need a lttng-relayd and this session requires a network URL (\-U or
-\-C/\-D).
+\-C/\-D). If no USEC nor URL is provided, the default is to use a timer value
+set to 1000000 and the network URL set to net://127.0.0.1.
 
 To read a live session, you can use babeltrace(1) or the live streaming
 protocol in doc/live-reading-protocol.txt. Here is an example:
@@ -394,7 +397,8 @@ Apply to the user-space tracer
 Discard event when subbuffers are full (default)
 .TP
 .BR "\-\-overwrite"
-Flight recorder mode : overwrites events when subbuffers are full
+Flight recorder mode: overwrites events when subbuffers are full. The
+number of subbuffer must be 2 or more.
 .TP
 .BR "\-\-subbuf-size SIZE"
 Subbuffer size in bytes {+k,+M,+G}.
@@ -519,6 +523,8 @@ e.g.:
 .TP
 .BR "\-\-loglevel NAME"
 Tracepoint loglevel range from 0 to loglevel. Listed in the help (\-h).
+For the JUL domain, the loglevel ranges are detailed with the \-\-help
+option thus starting from SEVERE to FINEST.
 .TP
 .BR "\-\-loglevel-only NAME"
 Tracepoint loglevel (only this loglevel).
@@ -575,6 +581,11 @@ running applications can be found under columns "PID" and "LWP" of the
   '$ctx.vtid == 1234'
 .fi
 
+Context information is available to all filters whether or not the add-context
+command has been used to add it to the event's channel, as long as the context
+field exists for that domain. For example, the filter examples given above will
+never fail to link: no add-context is required for the event's channel.
+
 .TP
 .BR "\-x, \-\-exclude LIST"
 Add exclusions to UST tracepoints:
@@ -660,7 +671,6 @@ Apply for the user-space tracer
 .TP
 .BR "\-j, \-\-jul"
 Apply for Java application using Java Util Logging interface (JUL)
-.TP
 .RE
 .PP
 
@@ -856,7 +866,8 @@ Show summary of possible options and commands.
 .TP
 .BR "\-\-list-options"
 Simple listing of options
-.TP "\-\-no-wait"
+.TP
+.BR "\-\-no-wait"
 Don't wait for data availability.
 .RE
 .PP
@@ -1015,5 +1026,5 @@ Montreal for the LTTng journey.
 .PP
 lttng-tools was originally written by Mathieu Desnoyers, Julien Desfossez and
 David Goulet. More people have since contributed to it. It is currently
-maintained by David Goulet <dgoulet@efficios.com>.
+maintained by Jérémie Galarneau <jeremie.galarneau@efficios.com>.
 .PP