lttng-stop(1): add usage examples
[lttng-tools.git] / doc / man / lttng-view.1.txt
... / ...
CommitLineData
1lttng-view(1)
2=============
3:revdate: 29 April 2021
4
5
6NAME
7----
8lttng-view - Launch an LTTng trace reader
9
10
11SYNOPSIS
12--------
13[verse]
14*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *view* [option:--viewer='READER']
15 ['SESSION' | option:--trace-path='DIR']
16
17
18DESCRIPTION
19-----------
20The `lttng view` command launches an external trace reader to read the
21current traces of:
22
23With the option:--session='SESSION' option::
24 The tracing session named 'SESSION'.
25
26With the option:--trace-path='DIR' option::
27 The local file system directory 'DIR'.
28
29Otherwise::
30 The current tracing session (see man:concepts(1) to learn more about
31 the current tracing session).
32
33With the option:--session option or without the option:--trace-path
34option, the mode of the selected tracing session may :not: be network
35streaming or live.
36
37By default, the `view` command attempts to launch man:babeltrace2(1) or,
38if it's not available, man:babeltrace(1). Override which trace reader to
39launch with the option:--viewer option.
40
41
42include::common-lttng-cmd-options-head.txt[]
43
44
45option:-t 'DIR', option:--trace-path='DIR'::
46 Pass 'DIR' as the last argument of the trace reader command instead
47 of the output directory of the selected tracing session.
48
49option:-e 'READER', option:--viewer='READER'::
50 Use the trace reader 'READER' to read the traces.
51+
52'READER' is the absolute path to the reader command to use, and it can
53contain command arguments as well. The `view` command passes the trace
54directory path to read to the 'READER' command as its last argument.
55+
56Without this option, the `view` command uses man:babeltrace2(1) if it's
57available. Otherwise, it tries to use man:babeltrace(1).
58
59
60include::common-lttng-cmd-help-options.txt[]
61
62
63include::common-lttng-cmd-after-options.txt[]
64
65
66include::common-footer.txt[]
67
68
69SEE ALSO
70--------
71man:babeltrace2(1),
72man:lttng(1)
This page took 0.034938 seconds and 4 git commands to generate.