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