Update the remaining manual pages for LTTng-tools 2.13
[lttng-tools.git] / doc / man / lttng-crash.1.txt
... / ...
CommitLineData
1lttng-crash(1)
2==============
3:revdate: 3 May 2021
4
5
6NAME
7----
8lttng-crash - Recover and read LTTng trace buffers in the event of a crash
9
10
11SYNOPSIS
12--------
13[verse]
14*lttng-crash* [option:--extract='DIR' | option:--viewer='READER'] [option:-verbose]... 'SHMDIR'
15
16
17DESCRIPTION
18-----------
19include::common-intro.txt[]
20
21The `lttng-crash` command-line tool recovers LTTng trace buffers in the
22event of a system crash.
23
24`lttng-crash` reads files within the directory 'SHMDIR' and does one
25of:
26
27Without the option:--extract option::
28 Launches a trace reader (see the option:--viewer option) to view the
29 recovered traces.
30
31With the option:--extract='DIR' option::
32 Extracts the files as uncorrupted LTTng traces to the 'DIR'
33 directory.
34
35'SHMDIR' is the directory specified as the argument of the
36nloption:--shm-path option of the man:lttng-create(1) command used to
37create the tracing session for which to recover the traces.
38
39
40OPTIONS
41-------
42option:-x 'DIR', option:--extract='DIR'::
43 Extract recovered traces to the directory 'DIR'; do :not: execute
44 any trace reader.
45
46option:-v, option:--verbose::
47 Increase verbosity.
48+
49Specify this option up to three times to get more levels of verbosity.
50
51option:-e 'READER', option:--viewer='READER'::
52 Use the trace reader 'READER' to read the trace buffers.
53+
54'READER' is the absolute path to the reader command to use, and it can
55contain command arguments as well. `lttng-crash` passes the trace
56directory paths to the 'READER' command as its last arguments.
57+
58Without this option, `lttng crash` uses man:babeltrace2(1) if it's
59available. Otherwise, it tries to use man:babeltrace(1).
60
61
62Program information
63~~~~~~~~~~~~~~~~~~~
64include::common-help-option.txt[]
65
66option:-V, option:--version::
67 Show version and quit.
68
69
70EXIT STATUS
71-----------
72*0*::
73 Success
74
75*1*::
76 Error
77
78*3*::
79 Fatal error
80
81
82include::common-footer.txt[]
83
84
85SEE ALSO
86--------
87man:babeltrace2(1),
88man:lttng(1),
89man:lttng-create(1)
This page took 0.023435 seconds and 4 git commands to generate.