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="systemd-coredumpctl">
27 <title>systemd-coredumpctl</title>
28 <productname>systemd</productname>
32 <contrib>Developer</contrib>
33 <firstname>Zbigniew</firstname>
34 <surname>Jędrzejewski-Szmek</surname>
35 <email>zbyszek@in.waw.pl</email>
41 <refentrytitle>systemd-coredumpctl</refentrytitle>
42 <manvolnum>1</manvolnum>
46 <refname>systemd-coredumpctl</refname>
47 <refpurpose>Retrieve coredumps from the journal</refpurpose>
52 <command>systemd-coredumpctl <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">PID|COMM|EXE|MATCH</arg></command>
57 <title>Description</title>
59 <para><command>systemd-coredumpctl</command> may be used to
60 retrieve coredumps from
61 <citerefentry><refentrytitle>systemd-journald</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
65 <title>Options</title>
67 <para>The following options are understood:</para>
71 <term><option>--help</option></term>
72 <term><option>-h</option></term>
74 <listitem><para>Print a short help
75 text and exit.</para></listitem>
79 <term><option>--version</option></term>
81 <listitem><para>Print a short version
82 string and exit.</para></listitem>
86 <term><option>--field=</option></term>
87 <term><option>-F</option></term>
89 <listitem><para>Print all possible
90 data values the specified field
91 takes in matching coredump entries of the
92 journal.</para></listitem>
96 <term><option>--output=FILE</option></term>
97 <term><option>-o FILE</option></term>
99 <listitem><para>Write the core to
100 <option>FILE</option>.</para></listitem>
104 <term><option>--no-pager</option></term>
106 <listitem><para>Do not pipe output of
107 <command>list</command> into a
108 pager.</para></listitem>
112 <term><option>--no-legend</option></term>
114 <listitem><para>Do not print the column headers.
120 <para>The following commands are understood:</para>
124 <term><command>list</command></term>
126 <listitem><para>List coredumps captured in the journal
127 matching specified characteristics.</para></listitem>
131 <term><command>dump</command></term>
133 <listitem><para>Extract the last coredump
134 matching specified characteristics.
135 Coredump will be written on stdout, unless
136 an output file is specified with
137 <option>-o/--output</option>.
143 <term><command>gdb</command></term>
145 <listitem><para>Invoke the GNU
146 debugger on the last coredump matching
147 specified characteristics.
156 <title>Matching</title>
158 <para>Match can be:</para>
162 <term><option>PID</option></term>
164 <listitem><para>Process ID of the
166 core. An integer.</para></listitem>
170 <term><option>COMM</option></term>
172 <listitem><para>Name of the executable
173 (matches <option>COREDUMP_COMM=</option>).
174 Must not contain slashes.
179 <term><option>EXE</option></term>
181 <listitem><para>Path to the executable
182 (matches <option>COREDUMP_EXE=</option>).
183 Must contain at least one slash.
188 <term><option>MATCH</option></term>
190 <listitem><para>General journalctl predicates
191 (see <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
192 Must contain an equals sign.
199 <title>Exit status</title>
200 <para>On success 0 is returned, a non-zero failure
201 code otherwise. Not finding any matching coredumps is treated
207 <title>See Also</title>
209 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
210 <citerefentry><refentrytitle>gdb</refentrytitle><manvolnum>1</manvolnum></citerefentry>