X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fman%2Flttng.1;h=c0df4311948a80997d072f67caad81543875917c;hb=850767541647c102a299d7fbc39c97555ac70224;hp=d87280283f31307196ec46ab5b525ae9f7956c08;hpb=7c96a09685627a1cf7c105162cf031b78393a90a;p=lttng-tools.git diff --git a/doc/man/lttng.1 b/doc/man/lttng.1 index d87280283..c0df43119 100644 --- a/doc/man/lttng.1 +++ b/doc/man/lttng.1 @@ -1,4 +1,4 @@ -.TH "LTTNG" "1" "December 3rd, 2012" "" "" +.TH "LTTNG" "1" "July 18th, 2013" "" "" .SH "NAME" lttng \(em LTTng 2.x tracer control command line tool @@ -6,9 +6,7 @@ lttng \(em LTTng 2.x tracer control command line tool .SH "SYNOPSIS" .PP -.nf lttng [OPTIONS] -.fi .SH "DESCRIPTION" .PP @@ -106,7 +104,9 @@ contexts. If no channel is given (\-c), the context is added to all channels that were already enabled. If the session has no channel, a default channel is created. -Otherwise the context will be added only to the given channel (\-c). +If \fB\-c, \-\-channel\fP is omitted, but a non-default channel already +exists within the session, an error is returned. Otherwise the context +will be added only to the given channel (\-c). If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc file. @@ -455,8 +455,10 @@ Enable tracing event A tracing event is always assigned to a channel. If \fB\-c, \-\-channel\fP is omitted, a default channel named '\fBchannel0\fP' is created and the event is -added to it. For the user-space tracer, using \fB\-a, \-\-all\fP is the same as -using the wildcard "*". +added to it. If \fB\-c, \-\-channel\fP is omitted, but a non-default +channel already exists within the session, an error is returned. For the +user-space tracer, using \fB\-a, \-\-all\fP is the same as using the +wildcard "*". If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc file. @@ -597,6 +599,10 @@ NAME\fP again. If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc file. +If \fB\-c, \-\-channel\fP is omitted, the default channel name is used. +If \fB\-c, \-\-channel\fP is omitted, but a non-default channel already +exists within the session, an error is returned. + .B OPTIONS: .TP @@ -609,6 +615,9 @@ Simple listing of options .BR "\-s, \-\-session NAME" Apply on session name .TP +.BR "\-c, \-\-channel NAME" +Apply on channel name +.TP .BR "\-a, \-\-all-events" Disable all events. This does NOT disable "*" but rather every known events of the session. @@ -691,38 +700,42 @@ Simple listing of options .RE .PP -.IP "\fBsnapshot\fP ACTION" -.nf +.PP +\fBsnapshot\fP [OPTIONS] ACTION +.RS Snapshot command for LTTng session. -.fi .B OPTIONS: -.nf -\-h, \-\-help - Show summary of possible options and commands. -\-\-list-options - Simple listing of options -.fi +.TP +.BR "\-h, \-\-help" +Show summary of possible options and commands. +.TP +.BR "\-\-list-options" +Simple listing of options +.PP .B ACTION: -.nf +.TP \fBadd-output\fP [-m ] [-s ] [-n ] | -C -D Setup and add an snapshot output for a session. Output are 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 ] 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. +.TP \fBlist-output\fP [-s ] List the output of a session. Attributes of the output are printed. +.TP \fBrecord\fP [-m ] [-s ] [-n ] [ | -C -D ] Snapshot a session's buffer(s) for all domains. If an URL is specified, it is @@ -730,54 +743,59 @@ used instead of a previously added output. Specifying only a name or/and a max size will override the current output values. For instance, you can record a snapshot with a custom maximum size or with a different name. +.nf $ lttng add-output -n mysnapshot file:///data/snapshot [...] $ lttng snapshot record -n new_name_snapshot +.fi The above will create a snapshot in /data/snapshot/new_name_snapshot* directory rather then in mysnapshot*/ -.fi - -.B LONG OPTIONS -.nf -\-s, \-\-session NAME - Apply to session name. -\-n, \-\-name NAME - Name of the snapshot's output. -\-m, \-\-max-size SIZE - Maximum size in bytes of the snapshot. The maxium size does not - include the metadata file. -\-C, \-\-ctrl-url URL - Set control path URL. (Must use -D also) -\-D, \-\-data-url URL - Set data path URL. (Must use -C also) -.fi +.PP +.B DETAILED ACTION OPTIONS -.IP +.TP +.BR "\-s, \-\-session NAME" +Apply to session name. +.TP +.BR "\-n, \-\-name NAME" +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 metadata file. +.TP +.BR "\-C, \-\-ctrl-url URL" +Set control path URL. (Must use -D also) +.TP +.BR "\-D, \-\-data-url URL" +Set data path URL. (Must use -C also) +.RE +.PP -.IP "\fBstart\fP [NAME] [OPTIONS]" -.nf +.PP +\fBstart\fP [NAME] [OPTIONS] +.RS Start tracing It will start tracing for all tracers for a specific tracing session. - If NAME is omitted, the session name is taken from the .lttngrc file. -.fi .B OPTIONS: -.nf -\-h, \-\-help - Show summary of possible options and commands. -\-\-list-options - Simple listing of options -.fi - -.IP +.TP +.BR "\-h, \-\-help" +Show summary of possible options and commands. +.TP +.BR "\-\-list-options" +Simple listing of options +.RE +.PP -.IP "\fBstop\fP [NAME] [OPTIONS]" -.nf +.PP +\fBstop\fP [NAME] [OPTIONS] +.RS Stop tracing It will stop tracing for all tracers for a specific tracing session. Before @@ -786,75 +804,75 @@ until the trace is readable for the session. Use \-\-no-wait to avoid this behavior. If NAME is omitted, the session name is taken from the .lttngrc file. -.fi .B OPTIONS: -.nf -\-h, \-\-help - Show summary of possible options and commands. -\-\-list-options - Simple listing of options -\-\-no-wait - Don't wait for data availability. -.fi - -.IP +.TP +.BR "\-h, \-\-help" +Show summary of possible options and commands. +.TP +.BR "\-\-list-options" +Simple listing of options +.TP "\-\-no-wait" +Don't wait for data availability. +.RE +.PP -.IP "\fBversion\fP" -.nf +.PP +\fBversion\fP +.RS Show version information -.fi .B OPTIONS: -.nf -\-h, \-\-help - Show summary of possible options and commands. -\-\-list-options - Simple listing of options -.fi - -.IP - -.IP "\fBview\fP [SESSION_NAME] [OPTIONS]" -.nf -View traces of a tracing session - -By default, the babeltrace viewer will be used for text viewing. - -If SESSION_NAME is omitted, the session name is taken from the .lttngrc file. +.TP +.BR "\-h, \-\-help" +Show summary of possible options and commands. +.TP +.BR "\-\-list-options" +Simple listing of options +.RE +.PP -.fi +.PP +\fBview\fP [SESSION_NAME] [OPTIONS] +.RS +View traces of a tracing session. By default, the babeltrace viewer +will be used for text viewing. If SESSION_NAME is omitted, the session +name is taken from the .lttngrc file. .B OPTIONS: -.nf -\-h, \-\-help - Show this help -\-\-list-options - Simple listing of options -\-t, \-\-trace-path PATH - Trace directory path for the viewer -\-e, \-\-viewer CMD - Specify viewer and/or options to use - This will completely override the default viewers so - please make sure to specify the full command. The trace - directory path of the session will be appended at the end - to the arguments -.fi +.TP +.BR "\-h, \-\-help" +Show this help +.TP +.BR "\-\-list-options" +Simple listing of options +.TP +.BR "\-t, \-\-trace-path PATH" +Trace directory path for the viewer +.TP +.BR "\-e, \-\-viewer CMD" +Specify viewer and/or options to use This will completely override the +default viewers so please make sure to specify the full command. The +trace directory path of the session will be appended at the end to the +arguments +.RE +.PP .SH "EXIT VALUES" +.PP On success 0 is returned and a positive value on error. Value of 1 means a command error, 2 an undefined command, 3 a fatal error and 4 a command warning meaning that something went wrong during the command. Any other value above 10, please refer to -.BR +.BR "" for a detailed list or use lttng_strerror() to get a human readable string of the error code. - .PP + .SH "ENVIRONMENT VARIABLES" .PP @@ -865,17 +883,23 @@ Note that all command line options override environment variables. .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. +.PP + .SH "SEE ALSO" .BR babeltrace(1), .BR lttng-ust(3), .BR lttng-sessiond(8), .BR lttng-relayd(8), .BR lttng-health-check(3) + .SH "BUGS" +.PP If you encounter any issues or usability problem, please report it on our mailing list to help improve this project or at https://bugs.lttng.org which is a bugtracker. +.PP + .SH "CREDITS" .PP