Add --enable-embedded-help option to embed --help messages in binaries
[lttng-tools.git] / doc / man / lttng-crash.1.txt
CommitLineData
aec4668a
PP
1lttng-crash(1)
2==============
3
4
5NAME
6----
7lttng-crash - Recover and view LTTng 2 trace buffers in the event of a crash
8
9
10SYNOPSIS
11--------
12[verse]
13*lttng-crash* [option:--extract='PATH' | option:--viewer='VIEWER'] [option:-v | option:-vv | option:-vvv]
14
15
16DESCRIPTION
17-----------
18The http://lttng.org/[_Linux Trace Toolkit: next generation_] is an open
19source software package used for correlated tracing of the Linux kernel,
20user applications, and user libraries.
21
22LTTng consists of Linux kernel modules (for Linux kernel tracing) and
23dynamically loaded libraries (for user application and library tracing).
24
25The _`lttng-crash`_ command-line tool is used to recover and view
26LTTng trace buffers in the event of a system crash.
27
28
29OPTIONS
30-------
59b19c3c 31option:-x 'PATH', option:--extract='PATH'::
aec4668a
PP
32 Extract recovered traces to path 'PATH'; do not execute the trace
33 viewer.
34
35option:-v, option:--verbose::
36 Increase verbosity.
37+
38Three levels of verbosity are available, which are triggered by
39appending additional `v` letters to the option
40(that is, `-vv` and `-vvv`).
41
59b19c3c 42option:-e 'VIEWER', option:--viewer='VIEWER'::
aec4668a
PP
43 Use trace viewer 'VIEWER' to view the trace buffers. 'VIEWER' is the
44 absolute path to the viewer command to use, and it can contain
45 command arguments as well. The trace directory paths are passed to
46 the 'VIEWER' command as its last arguments.
47+
48Default: `babeltrace`.
49
50
51Program information
52~~~~~~~~~~~~~~~~~~~
53option:-h, option:--help::
54 Show help.
55
56option:-V, option:--version::
57 Show version.
58
59
60EXIT STATUS
61-----------
62*0*::
63 Success
64
65*1*::
66 Error
67
68*3*::
69 Fatal error
70
71
72include::common-footer.txt[]
73
74
75SEE ALSO
76--------
7c1a4458
PP
77man:lttng(1),
78man:lttng-sessiond(8),
79man:lttng-relayd(8),
80man:lttng-ust(3),
81man:babeltrace(1)
This page took 0.030305 seconds and 5 git commands to generate.