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" conditional='ENABLE_COREDUMP'>
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</command>
53 <arg choice="opt" rep="repeat">OPTIONS</arg>
54 <arg choice="req">COMMAND</arg>
55 <arg choice="opt" rep="repeat">PID|COMM|EXE|MATCH</arg>
60 <title>Description</title>
62 <para><command>systemd-coredumpctl</command> may be used to
63 retrieve coredumps from
64 <citerefentry><refentrytitle>systemd-journald</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
68 <title>Options</title>
70 <para>The following options are understood:</para>
74 <term><option>-h</option></term>
75 <term><option>--help</option></term>
77 <listitem><para>Print a short help
78 text and exit.</para></listitem>
82 <term><option>--version</option></term>
84 <listitem><para>Print a short version
85 string and exit.</para></listitem>
89 <term><option>-F</option></term>
90 <term><option>--field=</option></term>
92 <listitem><para>Print all possible
93 data values the specified field
94 takes in matching coredump entries of the
95 journal.</para></listitem>
99 <term><option>-o</option></term>
100 <term><option>--output=FILE</option></term>
102 <listitem><para>Write the core to
103 <option>FILE</option>.</para></listitem>
107 <term><option>--no-pager</option></term>
109 <listitem><para>Do not pipe output of
110 <command>list</command> into a
111 pager.</para></listitem>
115 <term><option>--no-legend</option></term>
117 <listitem><para>Do not print the column headers.
123 <para>The following commands are understood:</para>
127 <term><command>list</command></term>
129 <listitem><para>List coredumps captured in the journal
130 matching specified characteristics.</para></listitem>
134 <term><command>dump</command></term>
136 <listitem><para>Extract the last coredump
137 matching specified characteristics.
138 Coredump will be written on stdout, unless
139 an output file is specified with
140 <option>-o/--output</option>.
146 <term><command>gdb</command></term>
148 <listitem><para>Invoke the GNU
149 debugger on the last coredump matching
150 specified characteristics.
159 <title>Matching</title>
161 <para>Match can be:</para>
165 <term><replaceable>PID</replaceable></term>
167 <listitem><para>Process ID of the
169 core. An integer.</para></listitem>
173 <term><replaceable>COMM</replaceable></term>
175 <listitem><para>Name of the executable
176 (matches <option>COREDUMP_COMM=</option>).
177 Must not contain slashes.
182 <term><replaceable>EXE</replaceable></term>
184 <listitem><para>Path to the executable
185 (matches <option>COREDUMP_EXE=</option>).
186 Must contain at least one slash.
191 <term><replaceable>MATCH</replaceable></term>
193 <listitem><para>General journalctl predicates
194 (see <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
195 Must contain an equals sign.
202 <title>Exit status</title>
203 <para>On success 0 is returned, a non-zero failure
204 code otherwise. Not finding any matching coredumps is treated
210 <title>See Also</title>
212 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
213 <citerefentry><refentrytitle>gdb</refentrytitle><manvolnum>1</manvolnum></citerefentry>