Docs: clarify lttng.1 shm-path section

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

diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
index f6d21e7ad4b9663a8100110a984c41329d41799b..f2b08bbfa9f6d665d499c0b364adde8b261e8c2f 100644 (file)
--- a/doc/man/lttng.1
+++ b/doc/man/lttng.1
@@ -27,10 +27,11 @@ kernel and/or instrumented applications (lttng-ust(3)). Aggregating and reading
 those traces is done using the babeltrace(1) text viewer.
 
 We introduce the notion of \fBtracing domains\fP which is essentially a type of
-tracer (kernel, user space, JUL or LOG4J for now). In the future, we could see
-more tracer like for instance an hypervisor. For some commands, you'll need to
-specify on which domain the command operates (\-u, \-k or \-j). For instance,
-the kernel domain must be specified when enabling a kernel event.
+tracer (kernel, user space, JUL, LOG4J or Python for now). In the future, we
+could see more tracer like for instance an hypervisor. For some commands,
+you'll need to specify on which domain the command operates (\-u, \-k, \-l, \-j
+or \-p). For instance, the kernel domain must be specified when enabling a
+kernel event.
 
 In order to trace the kernel, the session daemon needs to be running as root.
 LTTng provides the use of a \fBtracing group\fP (default: tracing). Whomever is
@@ -301,6 +302,13 @@ $ 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.
+
 .TP
 .BR "\-U, \-\-set-url=URL"
 Set URL for the consumer output destination. It is persistent for the
@@ -542,6 +550,9 @@ Apply for Java application using Java Util Logging interface (JUL)
 .BR "\-l, \-\-log4j"
 Apply for Java application using LOG4J
 .TP
+.BR "\-p, \-\-python"
+Apply for Python application using the logging module.
+.TP
 .BR "\-\-tracepoint"
 Tracepoint event (default). Userspace tracer supports wildcards at the end
 of string. Don't forget to quote to deal with bash expansion.
@@ -557,6 +568,8 @@ For the JUL domain, the loglevel ranges are detailed with the \-\-help
 option thus starting from SEVERE to FINEST.
 For the LOG4J domain, loglevels range from FATAL to TRACE which are also
 detailed in the help.
+For the Python domain, loglevels range from CRITICAL to DEBUG which are
+detailed in the help as well.
 .TP
 .BR "\-\-loglevel-only NAME"
 Tracepoint loglevel (only this loglevel).
@@ -708,6 +721,9 @@ Apply for Java application using Java Util Logging interface (JUL)
 .TP
 .BR "\-l, \-\-log4j"
 Apply for Java application using LOG4J
+.TP
+.BR "\-p, \-\-python"
+Apply for Python application using the logging module.
 .RE
 .PP
 
@@ -728,6 +744,8 @@ With \-j alone, the available JUL event from registered application will be
 list. The event corresponds to the Logger name in the Java JUL application.
 With \-l alone, the available LOG4J event from registered application will be
 list. The event corresponds to the Logger name in the Java LOG4J application.
+With \-p alone, the available Python event from registered application will be
+list. The event corresponds to the Logger name in the Python application.
 With \-u alone, it will list all available user-space events from registered
 applications. Here is an example of 'lttng list \-u':
 
@@ -758,9 +776,12 @@ Select user-space domain.
 .BR "\-j, \-\-jul"
 Apply for Java application using JUL
 .TP
-.TP
 .BR "\-l, \-\-log4j"
 Apply for Java application using LOG4J
+.TP
+.BR "\-p, \-\-python"
+Apply for Python application using the logging module.
+.TP
 .BR "\-f, \-\-fields"
 List event fields
 
@@ -875,15 +896,15 @@ Simple listing of options
 .TP
 \fBadd-output\fP [-m <SIZE>] [-s <NAME>] [-n <NAME>] <URL> | -C <URL> -D <URL>
 
-Setup and add an snapshot output for a session. Output are the destination
+Setup and add a snapshot output for a session. Output is the destination
 where the snapshot will be sent. Only one output is permitted. To change it,
 you'll need to delete it and add back the new one.
 
 .TP
 \fBdel-output\fP ID | NAME [-s <NAME>]
 
-Delete an output for a session using the ID. You can either specify the
-output's ID that can be found with list-output or the name.
+Delete an output for a session using the output's ID. You can either specify the
+output by name or use its ID as returned by the list-output command.
 
 .TP
 \fBlist-output\fP [-s <NAME>]
@@ -921,10 +942,6 @@ Name of the snapshot's output.
 Maximum size in bytes of the snapshot. The maximum size does not include the
 metadata file. Human readable format is accepted: {+k,+M,+G}. For instance,
 \-\-max-size 5M
-
-The minimum size of a snapshot is computed by multiplying the total amount of
-streams in the session by the largest subbuffer size. This is to ensure
-fairness between channels when extracting data.
 .TP
 .BR "\-C, \-\-ctrl-url URL"
 Set control path URL. (Must use -D also)
@@ -1138,5 +1155,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