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