X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng.1;h=1475068c56f740194e1b2d161e3cc7df6ec9d0ca;hp=9f95a8a13c2a04497579ca43505447d0b82bb530;hb=553067af0eedeae7dccfa7c83b5a68335a088b75;hpb=aa3514e96f12c13f681a81ea275dc51dd63473c8 diff --git a/doc/man/lttng.1 b/doc/man/lttng.1 index 9f95a8a13..1475068c5 100644 --- a/doc/man/lttng.1 +++ b/doc/man/lttng.1 @@ -1,4 +1,4 @@ -.TH "LTTNG" "1" "February 05th, 2014" "" "" +.TH "LTTNG" "1" "May 13th, 2014" "" "" .SH "NAME" lttng \(em LTTng 2.x tracer control command line tool @@ -402,7 +402,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}. @@ -442,6 +443,8 @@ Use shared buffer for the whole system (\-k only) .BR "\-C, \-\-tracefile-size SIZE" 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 of CTF 1.8. .TP .BR "\-W, \-\-tracefile-count COUNT" Used in conjunction with \-C option, this will limit the number of files @@ -587,6 +590,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: @@ -735,6 +743,61 @@ List available domain(s) .RE .PP +.PP +\fBload\fP [OPTIONS] [NAME] +.RS +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. + +.B OPTIONS: + +.TP +.BR "\-h, \-\-help" +Show summary of possible options and commands. +.TP +.BR "\-a, \-\-all" +Load all session configurations (default). +.TP +.BR "\-i, \-\-input-path PATH" +Specify the input path for session configurations. +.TP +.BR "\-f, -\-force" +Overwrite current session configuration(s) if a session of the same name +already exists. +.RE +.PP + +.PP +\fBsave\fP [OPTIONS] [SESSION] +.RS +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 (default: +~/.lttng/sessions/ or /var/run/lttng/sessions/ for root user). The default +session configuration file naming scheme is \fBSESSION.lttng\fP. + +.B OPTIONS: + +.TP +.BR "\-h, \-\-help" +Show summary of possible options and commands. +.TP +.BR "\-a, \-\-all" +Save all session configurations (default). +.TP +.BR "\-o, \-\-output-path PATH" +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. +.RE +.PP + .PP \fBset-session\fP NAME [OPTIONS] .RS @@ -819,6 +882,10 @@ Name of the snapshot's output. Maximum size in bytes of the snapshot. The maxium 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) @@ -980,6 +1047,12 @@ 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. .PP +.PP +.IP "LTTNG_SESSION_CONFIG_XSD_PATH" +Set the path in which the \fBsession.xsd\fP session configuration schema may be +found. +.PP + .SH "SEE ALSO" .BR babeltrace(1), .BR lttng-ust(3),