tmf: Move plugins to the Trace Compass namespace
[deliverable/tracecompass.git] / org.eclipse.linuxtools.tracing.rcp.help / doc / User-Guide.mediawiki
CommitLineData
2b042910
BH
1= Overview =
2The Linux Tools Trace Viewer is a stand-alone application based on Eclipse's
3Rich Client Platform (RCP). The purpose of this is to provide a lightweight
4application to view and analyze traces. It includes all TMF (Tracing and
5Monitoring Framework) features, as well as all features from the LTTng (Linux
6Tracing Toolkit next generation) Eclipse integration, which are provided by the
7Linux Tools Project.
8
9= Getting Started =
10To start the Linux Tools Trace Viewer, go to the directory where the Trace
11Viewer is installed and then run the application named '''traceViewer'''.
12During startup, the Trace Viewer will create, if necessary, an Eclipse workspace
13in the user's home directory with the name ''.traceviewer''. It also creates, if
14needed, a default tracing project called ''Tracing''.
15
16Now the application can be used as described in the User Guide for Linux Tools
17LTTng integration (see section [[#References | References]]).
18
76fccfb0 19= Opening a Trace =
1aec2e92
BH
20To open a trace, click on the '''File''' menu and select '''Open Trace...'''.
21A new dialog will show for selecting a trace to open. Select a trace file
22and then click on '''OK'''. Note that for traces that are directories
23(such as Common Trace Format (CTF) traces) any file in the trace directory can
24be selected to open the trace. Now, the trace viewer's auto detection algorithm
25will validate the trace against all known trace types. If multiple trace types
d3e89107
BH
26are valid, a trace type is chosen based on a confidence criteria. The
27validation process and the computation of the confidence level are trace type
28specific. After successful validation the trace will be opened with the
29detected trace type.
30
31Alternatively the user can launch the trace viewer with the command-line
32argument '''--open <trace-path>'''. The trace will then automatically open
33using the same algorithm than described above.
76fccfb0
MK
34
35In both of the above cases, the trace will be linked to the default project.
36
2b042910
BH
37= References =
38
39* [http://www.eclipse.org/linuxtools/projectPages/lttng/ Linux Tools - LTTng integration]
40* [http://www.lttng.org/ LTTng project]
2b042910 41
This page took 0.037469 seconds and 5 git commands to generate.