Update some manual pages for LTTng-tools 2.13

[lttng-tools.git] / doc / man / lttng-view.1.txt

lttng-view(1)
=============
:revdate: 21 April 2021


NAME
----
lttng-view - Launch an LTTng trace reader


SYNOPSIS
--------
[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *view* [option:--viewer='READER']
      ['SESSION' | option:--trace-path='DIR']


DESCRIPTION
-----------
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'.

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).

With the option:--session option or without the option:--trace-path
option, the mode of the selected tracing 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.


include::common-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.

option:-e 'READER', option:--viewer='READER'::
    Use the trace reader 'READER' to read the traces.
+
'READER' is the absolute path to the reader command to use, and it can
contain command arguments as well. The `view` command passes the trace
directory path to read to the 'READER' command as its last argument.
+
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-cmd-footer.txt[]


SEE ALSO
--------
man:babeltrace2(1),
man:lttng(1)