X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-view.1.txt;h=02d788c5e72b2ebf5fc2e9638fc0ed79f9ba5b07;hp=6874aad3cd27545821334e844b4e43fb4cac1658;hb=HEAD;hpb=484b2a0cbefcf0c7072622a5a411ea5ed849da28 diff --git a/doc/man/lttng-view.1.txt b/doc/man/lttng-view.1.txt index 6874aad3c..02d788c5e 100644 --- a/doc/man/lttng-view.1.txt +++ b/doc/man/lttng-view.1.txt @@ -1,6 +1,6 @@ lttng-view(1) ============= -:revdate: 21 April 2021 +:revdate: 14 June 2021 NAME @@ -21,31 +21,32 @@ The `lttng view` command launches an external trace reader to read the current traces of: With the option:--session='SESSION' option:: - The tracing session named 'SESSION'. + The recording session named 'SESSION'. With the option:--trace-path='DIR' option:: The local file system directory 'DIR'. Otherwise:: - The current tracing session (see man:lttng-create(1) and - man:lttng-set-session(1) to learn more about the current tracing - session). + The current recording session (see man:concepts(1) to learn more + about the current recording session). With the option:--session option or without the option:--trace-path -option, the mode of the selected tracing session may :not: be network +option, the mode of the selected recording session may :not: be network streaming or live. By default, the `view` command attempts to launch man:babeltrace2(1) or, if it's not available, man:babeltrace(1). Override which trace reader to launch with the option:--viewer option. +See the ``<>'' section below for usage examples. -include::common-cmd-options-head.txt[] + +include::common-lttng-cmd-options-head.txt[] option:-t 'DIR', option:--trace-path='DIR':: Pass 'DIR' as the last argument of the trace reader command instead - of the output directory of the selected tracing session. + of the output directory of the selected recording session. option:-e 'READER', option:--viewer='READER':: Use the trace reader 'READER' to read the traces. @@ -58,10 +59,36 @@ Without this option, the `view` command uses man:babeltrace2(1) if it's available. Otherwise, it tries to use man:babeltrace(1). -include::common-cmd-help-options.txt[] +include::common-lttng-cmd-help-options.txt[] + + +include::common-lttng-cmd-after-options.txt[] + + +[[examples]] +EXAMPLES +-------- +.Read the traces of the current recording session with Babeltrace. +==== +[role="term"] +---- +$ lttng view +---- +==== + +.Read the traces of a specific recording session with a custom trace reader. +==== +See the option:--viewer option. + +[role="term"] +---- +$ lttng view --viewer='/usr/bin/my-reader -zK --details=3' \ + my-session +---- +==== -include::common-cmd-footer.txt[] +include::common-footer.txt[] SEE ALSO