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