X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=doc%2Fman%2Flttng.1;h=84bc370c758e78e863c0710226ac0b1ff27c5dcb;hb=05ec9ff7b0578958c5b83986aa38f2fa6edf57a7;hp=e831867a2fe7c5b9fe51f9008684c6a3a631d824;hpb=5975c30aac46bd29da9331652180a8de3c9e2d6e;p=lttng-tools.git diff --git a/doc/man/lttng.1 b/doc/man/lttng.1 index e831867a2..84bc370c7 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 @@ -216,7 +214,7 @@ Dynamic function entry/return probe (default) .PP .PP -.IP \fBcreate\fP [NAME] [OPTIONS] +\fBcreate\fP [NAME] [OPTIONS] .RS Create tracing session. @@ -249,7 +247,7 @@ Simple listing of options Specify output path for traces .TP .BR "\-\-no-output" -Traces will not be outputed +Traces will not be outputted .TP .BR "\-\-snapshot" Set the session in snapshot mode. Created in no-output mode and uses the @@ -455,8 +453,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 +597,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 +613,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. @@ -735,7 +742,7 @@ 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 add-output -n mysnapshot file:///data/snapshot [...] $ lttng snapshot record -n new_name_snapshot .fi @@ -754,8 +761,9 @@ Apply to session 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. +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 .TP .BR "\-C, \-\-ctrl-url URL" Set control path URL. (Must use -D also) @@ -825,44 +833,45 @@ Simple listing of options .RE .PP -.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. - -.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 @@ -873,17 +882,22 @@ 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