1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 This file is part of systemd.
8 Copyright 2012 Zbigniew Jędrzejewski-Szmek
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
24 <refentry id="coredumpctl" conditional='ENABLE_COREDUMP'
25 xmlns:xi="http://www.w3.org/2001/XInclude">
28 <title>coredumpctl</title>
29 <productname>systemd</productname>
33 <contrib>Developer</contrib>
34 <firstname>Zbigniew</firstname>
35 <surname>Jędrzejewski-Szmek</surname>
36 <email>zbyszek@in.waw.pl</email>
42 <refentrytitle>coredumpctl</refentrytitle>
43 <manvolnum>1</manvolnum>
47 <refname>coredumpctl</refname>
48 <refname>systemd-coredumpctl</refname>
50 <refpurpose>Retrieve coredumps from the journal</refpurpose>
55 <command>coredumpctl</command>
56 <arg choice="opt" rep="repeat">OPTIONS</arg>
57 <arg choice="req">COMMAND</arg>
58 <arg choice="opt" rep="repeat">PID|COMM|EXE|MATCH</arg>
63 <title>Description</title>
65 <para><command>coredumpctl</command> may be used to
66 retrieve coredumps from
67 <citerefentry><refentrytitle>systemd-journald</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
69 <para><command>systemd-coredumpctl</command> is a
71 <command>coredumpctl</command>.</para>
75 <title>Options</title>
77 <para>The following options are understood:</para>
81 <term><option>--no-legend</option></term>
83 <listitem><para>Do not print the column headers.
88 <term><option>-1</option></term>
90 <listitem><para>Show information of a
91 single coredump only, instead of
92 listing all known coredumps.
97 <term><option>-F</option></term>
98 <term><option>--field=</option></term>
100 <listitem><para>Print all possible
101 data values the specified field
102 takes in matching coredump entries of the
103 journal.</para></listitem>
107 <term><option>-o</option></term>
108 <term><option>--output=FILE</option></term>
110 <listitem><para>Write the core to
111 <option>FILE</option>.</para></listitem>
114 <xi:include href="standard-options.xml" xpointer="help" />
115 <xi:include href="standard-options.xml" xpointer="version" />
116 <xi:include href="standard-options.xml" xpointer="no-pager" />
120 <para>The following commands are understood:</para>
124 <term><command>list</command></term>
126 <listitem><para>List coredumps
127 captured in the journal matching
128 specified characteristics. If no
129 command is specified this is the
130 implied default.</para></listitem>
134 <term><command>info</command></term>
136 <listitem><para>Show detailed
137 information about coredumps captured
138 in the journal.</para></listitem>
142 <term><command>dump</command></term>
144 <listitem><para>Extract the last coredump
145 matching specified characteristics.
146 The coredump will be written on standard output,
147 unless an output file is specified with
148 <option>-o/--output</option>.
153 <term><command>gdb</command></term>
155 <listitem><para>Invoke the GNU
156 debugger on the last coredump matching
157 specified characteristics.
166 <title>Matching</title>
168 <para>A match can be:</para>
172 <term><replaceable>PID</replaceable></term>
174 <listitem><para>Process ID of the
176 core. An integer.</para></listitem>
180 <term><replaceable>COMM</replaceable></term>
182 <listitem><para>Name of the executable
183 (matches <option>COREDUMP_COMM=</option>).
184 Must not contain slashes.
189 <term><replaceable>EXE</replaceable></term>
191 <listitem><para>Path to the executable
192 (matches <option>COREDUMP_EXE=</option>).
193 Must contain at least one slash.
198 <term><replaceable>MATCH</replaceable></term>
200 <listitem><para>General journalctl predicates
201 (see <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
202 Must contain an equal sign.
209 <title>Exit status</title>
210 <para>On success, 0 is returned; otherwise, a non-zero failure
211 code is returned. Not finding any matching coredumps is treated
217 <title>See Also</title>
219 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
220 <citerefentry><refentrytitle>gdb</refentrytitle><manvolnum>1</manvolnum></citerefentry>