coredumpctl(1)

1COREDUMPCTL(1)                    coredumpctl                   COREDUMPCTL(1)
2
3
4

NAME

6       coredumpctl - Retrieve and process saved core dumps and metadata
7

SYNOPSIS

9       coredumpctl [OPTIONS...] {COMMAND} [PID|COMM|EXE|MATCH...]
10

DESCRIPTION

12       coredumpctl is a tool that can be used to retrieve and process core
13       dumps and metadata which were saved by systemd-coredump(8).
14

COMMANDS

16       The following commands are understood:
17
18       list
19           List core dumps captured in the journal matching specified
20           characteristics. If no command is specified, this is the implied
21           default.
22
23           The output is designed to be human readable and contains list
24           contains a table with the following columns:
25
26           TIME
27               The timestamp of the crash, as reported by the kernel.
28
29           PID
30               The identifier of the process that crashed.
31
32           UID, GID
33               The user and group identifiers of the process that crashed.
34
35           SIGNAL
36               The signal that caused the process to crash, when applicable.
37
38           COREFILE
39               Information whether the coredump was stored, and whether it is
40               still accessible: "none" means the core was not stored, "-"
41               means that it was not available (for example because the
42               process was not terminated by a signal), "present" means that
43               the core file is accessible by the current user, "journal"
44               means that the core was stored in the "journal", "truncated" is
45               the same as one of the previous two, but the core was too large
46               and was not stored in its entirety, "error" means that the core
47               file cannot be accessed, most likely because of insufficient
48               permissions, and "missing" means that the core was stored in a
49               file, but this file has since been removed.
50
51           EXE
52               The full path to the executable. For backtraces of scripts this
53               is the name of the interpreter.
54
55           It's worth noting that different restrictions apply to data saved
56           in the journal and core dump files saved in
57           /var/lib/systemd/coredump, see overview in systemd-coredump(8).
58           Thus it may very well happen that a particular core dump is still
59           listed in the journal while its corresponding core dump file has
60           already been removed.
61
62       info
63           Show detailed information about the last core dump or core dumps
64           matching specified characteristics captured in the journal.
65
66       dump
67           Extract the last core dump matching specified characteristics. The
68           core dump will be written on standard output, unless an output file
69           is specified with --output=.
70
71       debug
72           Invoke a debugger on the last core dump matching specified
73           characteristics. By default, gdb(1) will be used. This may be
74           changed using the --debugger= option or the $SYSTEMD_DEBUGGER
75           environment variable.
76

OPTIONS

78       The following options are understood:
79
80       -h, --help
81           Print a short help text and exit.
82
83       --version
84           Print a short version string and exit.
85
86       --no-legend
87           Do not print column headers.
88
89       --no-pager
90           Do not pipe output into a pager.
91
92       -1
93           Show information of a single core dump only, instead of listing all
94           known core dumps.
95
96       -S, --since
97           Only print entries which are since the specified date.
98
99       -U, --until
100           Only print entries which are until the specified date.
101
102       -r, --reverse
103           Reverse output so that the newest entries are displayed first.
104
105       -F FIELD, --field=FIELD
106           Print all possible data values the specified field takes in
107           matching core dump entries of the journal.
108
109       -o FILE, --output=FILE
110           Write the core to FILE.
111
112       --debugger=DEBUGGER
113           Use the given debugger for the debug command. If not given and
114           $SYSTEMD_DEBUGGER is unset, then gdb(1) will be used.
115
116       -D DIR, --directory=DIR
117           Use the journal files in the specified DIR.
118
119       -q, --quiet
120           Suppresses informational messages about lack of access to journal
121           files and possible in-flight coredumps.
122

MATCHING

124       A match can be:
125
126       PID
127           Process ID of the process that dumped core. An integer.
128
129       COMM
130           Name of the executable (matches COREDUMP_COMM=). Must not contain
131           slashes.
132
133       EXE
134           Path to the executable (matches COREDUMP_EXE=). Must contain at
135           least one slash.
136
137       MATCH
138           General journalctl match filter, must contain an equals sign ("=").
139           See journalctl(1).
140

EXIT STATUS

142       On success, 0 is returned; otherwise, a non-zero failure code is
143       returned. Not finding any matching core dumps is treated as failure.
144

ENVIRONMENT

146       $SYSTEMD_DEBUGGER
147           Use the given debugger for the debug command. See the --debugger=
148           option.
149

EXAMPLES

151       Example 1. List all the core dumps of a program named foo
152
153           # coredumpctl list foo
154
155       Example 2. Invoke gdb on the last core dump
156
157           # coredumpctl debug
158
159       Example 3. Show information about a process that dumped core, matching
160       by its PID 6654
161
162           # coredumpctl info 6654
163
164       Example 4. Extract the last core dump of /usr/bin/bar to a file named
165       bar.coredump
166
167           # coredumpctl -o bar.coredump dump /usr/bin/bar
168