X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng.1;h=e831867a2fe7c5b9fe51f9008684c6a3a631d824;hp=2023cae9420fd206131b2d51f9f6161cebb5a667;hb=5975c30aac46bd29da9331652180a8de3c9e2d6e;hpb=c138a39bf483662d3aa07bf4740f265a1f1c0f13 diff --git a/doc/man/lttng.1 b/doc/man/lttng.1 index 2023cae94..e831867a2 100644 --- a/doc/man/lttng.1 +++ b/doc/man/lttng.1 @@ -621,8 +621,9 @@ Apply for the user-space tracer .RE .PP -.IP "\fBlist\fP [\-k|\-u] [SESSION [SESSION_OPTIONS]]" -.nf +.PP +\fBlist\fP [OPTIONS] [SESSION [SESSION OPTIONS]] +.RS List tracing session information. With no arguments, it will list available tracing session(s). @@ -636,84 +637,96 @@ calls events). With \-u alone, it will list all available user-space events from registered applications. Here is an example of 'lttng list \-u': +.nf PID: 7448 - Name: /tmp/lttng-ust/tests/hello/.libs/lt-hello ust_tests_hello:tptest_sighandler (type: tracepoint) ust_tests_hello:tptest (type: tracepoint) +.fi You can now enable any event listed by using the name : \fBust_tests_hello:tptest\fP. -.fi .B OPTIONS: -.nf -\-h, \-\-help - Show summary of possible options and commands. -\-\-list-options - Simple listing of options -\-k, \-\-kernel - Select kernel domain -\-u, \-\-userspace - Select user-space domain. +.TP +.BR "\-h, \-\-help" +Show summary of possible options and commands. +.TP +.BR "\-\-list-options" +Simple listing of options +.TP +.BR "\-k, \-\-kernel" +Select kernel domain +.TP +.BR "\-u, \-\-userspace" +Select user-space domain. +.PP .B SESSION OPTIONS: -\-c, \-\-channel NAME - List details of a channel -\-d, \-\-domain - List available domain(s) -.fi +.TP +.BR "\-c, \-\-channel NAME" +List details of a channel +.TP +.BR "\-d, \-\-domain" +List available domain(s) +.RE +.PP -.IP "\fBset-session\fP NAME" -.nf +.PP +\fBset-session\fP NAME [OPTIONS] +.RS Set current session name Will change the session name in 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 "\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 @@ -721,54 +734,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 @@ -777,36 +795,35 @@ 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 +.TP +.BR "\-h, \-\-help" +Show summary of possible options and commands. +.TP +.BR "\-\-list-options" +Simple listing of options +.RE +.PP .IP "\fBview\fP [SESSION_NAME] [OPTIONS]" .nf