doc/man/Makefile.am: fix top comment
[lttng-tools.git] / doc / man / lttng-view.1.txt
CommitLineData
79e094df
PP
1lttng-view(1)
2=============
3
4
5NAME
6----
7lttng-view - View the traces of an LTTng tracing session
8
9
10SYNOPSIS
11--------
12[verse]
ce19b9ed 13*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *view* [option:--viewer='CMD'] [option:--trace-path='PATH' | 'SESSION']
79e094df
PP
14
15
16DESCRIPTION
17-----------
18The `lttng view` command launches an external trace viewer to view the
19current trace of a tracing session.
20
21If 'SESSION' is omitted, the viewer is launched for the current tracing
22session (see linklttng:lttng-create(1) for more information
23about the current tracing session). Otherwise, it is launched for the
24existing tracing session named 'SESSION'. `lttng list`
25outputs all the existing tracing sessions (see linklttng:lttng-list(1)).
26
27By default, the linklttng:babeltrace(1) trace viewer is launched.
28Another trace viewer command can be specified using the
29option:--viewer option.
30
31By default, the trace path of the chosen tracing session is given
32as the first positional argument to the trace viewer. This path can
33be overridden using the option:--trace-path option.
34
35
36include::common-cmd-options-head.txt[]
37
38
39option:-t, option:--trace-path='PATH'::
40 View trace at path 'PATH' instead of using the chosen tracing
41 session's trace path.
42
43option:-e, option:--viewer='CMD'::
44 Use 'CMD' as the trace viewer.
45
46
47include::common-cmd-help-options.txt[]
48
49
50include::common-cmd-footer.txt[]
51
52
53SEE ALSO
54--------
55linklttng:lttng(1)
This page took 0.025952 seconds and 5 git commands to generate.