Fix: build: libcommon fd-tracker dependency is not available
[lttng-tools.git] / doc / man / lttng-view.1.txt
CommitLineData
79e094df
PP
1lttng-view(1)
2=============
e7f6af5d 3:revdate: 17 May 2021
79e094df
PP
4
5
6NAME
7----
484b2a0c 8lttng-view - Launch an LTTng trace reader
79e094df
PP
9
10
11SYNOPSIS
12--------
13[verse]
484b2a0c
PP
14*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *view* [option:--viewer='READER']
15 ['SESSION' | option:--trace-path='DIR']
79e094df
PP
16
17
18DESCRIPTION
19-----------
484b2a0c
PP
20The `lttng view` command launches an external trace reader to read the
21current traces of:
79e094df 22
484b2a0c
PP
23With the option:--session='SESSION' option::
24 The tracing session named 'SESSION'.
79e094df 25
484b2a0c
PP
26With the option:--trace-path='DIR' option::
27 The local file system directory 'DIR'.
79e094df 28
484b2a0c 29Otherwise::
26f0c779
PP
30 The current tracing session (see man:concepts(1) to learn more about
31 the current tracing session).
484b2a0c
PP
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.
79e094df 40
e7f6af5d
PP
41See the <<examples,EXAMPLES>> section below for usage examples.
42
79e094df 43
f5511eea 44include::common-lttng-cmd-options-head.txt[]
79e094df
PP
45
46
484b2a0c
PP
47option:-t 'DIR', option:--trace-path='DIR'::
48 Pass 'DIR' as the last argument of the trace reader command instead
49 of the output directory of the selected tracing session.
79e094df 50
484b2a0c
PP
51option:-e 'READER', option:--viewer='READER'::
52 Use the trace reader 'READER' to read the traces.
53+
54'READER' is the absolute path to the reader command to use, and it can
55contain command arguments as well. The `view` command passes the trace
56directory path to read to the 'READER' command as its last argument.
57+
58Without this option, the `view` command uses man:babeltrace2(1) if it's
59available. Otherwise, it tries to use man:babeltrace(1).
79e094df
PP
60
61
f5511eea 62include::common-lttng-cmd-help-options.txt[]
79e094df
PP
63
64
f5511eea
PP
65include::common-lttng-cmd-after-options.txt[]
66
67
e7f6af5d
PP
68[[examples]]
69EXAMPLES
70--------
71.Read the traces of the current tracing session with Babeltrace.
72====
73[role="term"]
74----
75$ lttng view
76----
77====
78
79.Read the traces of a specific tracing session with a custom trace reader.
80====
81See the option:--viewer option.
82
83[role="term"]
84----
85$ lttng view --viewer='/usr/bin/my-reader -zK --details=3' \
86 my-session
87----
88====
89
90
f5511eea 91include::common-footer.txt[]
79e094df
PP
92
93
94SEE ALSO
95--------
484b2a0c 96man:babeltrace2(1),
7c1a4458 97man:lttng(1)
This page took 0.036402 seconds and 4 git commands to generate.