.TP
.BR "\-\-list\-commands"
Simple listing of lttng commands.
+.TP
+.BR "\-m, \-\-mi TYPE
+Machine interface
+
+TYPE supported: XML
+
+Machine interface (MI) mode converts the traditional pretty printing to a
+machine output syntax. MI mode provides a format change-resistant way to access
+information generated via the lttng command line.
+
+When using MI mode, the data is printed on \fBstdout\fP. Error and warning are
+printed on \fBstderr\fP with the pretty print default format.
+
+If any errors occur during the execution of a command, the return value of the
+command will be different than zero. In this case, lttng does NOT guarantee the
+syntax and data validity of the generated MI output.
+
+For XML output type, a schema definition (XSD) file used for validation can be
+found under src/common/mi_lttng.xsd
+
.SH "COMMANDS"
.PP
in overwrite mode and with mmap output (splice not supported).
.TP
.BR "\-\-live [USEC]"
-Set the session exclusively in live mode. The paremeter is the delay in micro
+Set the session exclusively in live mode. The parameter 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
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}.
Maximum size of each tracefile within a stream (in bytes).
0 means unlimited. (default: 0)
Note: traces generated with this option may inaccurately report
-discarded events as per CTF 1.8.
+discarded events as of CTF 1.8.
.TP
.BR "\-W, \-\-tracefile-count COUNT"
Used in conjunction with \-C option, this will limit the number of files
.BR "\-j, \-\-jul"
Apply for Java application using Java Util Logging interface (JUL)
.TP
+.BR "\-l, \-\-log4j"
+Apply for Java application using LOG4J
+.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.
.TP
.BR "\-j, \-\-jul"
Apply for Java application using Java Util Logging interface (JUL)
+.TP
+.BR "\-l, \-\-log4j"
+Apply for Java application using LOG4J
.RE
.PP
.BR "\-j, \-\-jul"
Apply for Java application using JUL
.TP
+.TP
+.BR "\-l, \-\-log4j"
+Apply for Java application using LOG4J
.BR "\-f, \-\-fields"
List event fields
Load tracing session configuration
If NAME is omitted, all session configurations found in both the user's session
-configuration directory and the system session configuration directory will be
-loaded.
+configuration directory (default: ~/.lttng/sessions/) and the system session
+configuration directory (default: /etc/lttng/sessions/) will be loaded. Note
+that the sessions in the user directory are loaded first and then the system
+wide directory are loaded.
.B OPTIONS:
Load all session configurations (default).
.TP
.BR "\-i, \-\-input-path PATH"
-Specify the input path for session configurations.
+Specify the input path for session configurations. This overrides the default
+session configuration directory.
.TP
.BR "\-f, -\-force"
Overwrite current session configuration(s) if a session of the same name
Save tracing session configuration
If SESSION is omitted, all session configurations will be saved to individual
-\fB.lttng\fP files under the user's session configuration directory. The
-default session configuration file naming scheme is \fBSESSION.lttng\fP.
+\fB.lttng\fP files under the user's session configuration directory (default:
+~/.lttng/sessions/). The default session configuration file naming scheme is
+\fBSESSION.lttng\fP.
+
+For instance, a user in the tracing group saving a session from a root session
+daemon will save it in her/his user directory.
.B OPTIONS:
Save all session configurations (default).
.TP
.BR "\-o, \-\-output-path PATH"
-Specify the output path for saved sessions (default: ~/.lttng/sessions/).
+Specify the output path for saved sessions. This overrides the default session
+configuration directory.
.TP
.BR "\-f, -\-force"
Overwrite session configuration file if session name clashes.
Name of the snapshot's output.
.TP
.BR "\-m, \-\-max-size SIZE"
-Maximum size in bytes of the snapshot. The maxium size does not include the
+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)
.PP
If you encounter any issues or usability problem, please report it on our
mailing list <lttng-dev@lists.lttng.org> to help improve this project or
-at https://bugs.lttng.org which is a bugtracker.
+at https://bugs.lttng.org which is a bug tracker.
.PP
.SH "CREDITS"
projects / lttng-tools.git / blobdiff