2012-10-19 14:29:46 +04:00
<?xml version='1.0'?> <!-- * - nxml - * -->
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of systemd.
Copyright 2012 Zbigniew Jędrzejewski-Szmek
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http: / / w w w . g n u . o r g / l i c e n s e s /> .
-->
<refentry id= "systemd-coredumpctl" >
<refentryinfo >
<title > systemd-coredumpctl</title>
<productname > systemd</productname>
<authorgroup >
<author >
<contrib > Developer</contrib>
<firstname > Zbigniew</firstname>
<surname > Jędrzejewski-Szmek</surname>
<email > zbyszek@in.waw.pl</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta >
<refentrytitle > systemd-coredumpctl</refentrytitle>
<manvolnum > 1</manvolnum>
</refmeta>
<refnamediv >
<refname > systemd-coredumpctl</refname>
<refpurpose > Retrieve coredumps from the journal</refpurpose>
</refnamediv>
<refsynopsisdiv >
<cmdsynopsis >
2012-11-29 23:26:12 +04:00
<command > systemd-coredumpctl</command>
<arg choice= "opt" rep= "repeat" > OPTIONS</arg>
<arg choice= "req" > COMMAND</arg>
<arg choice= "opt" rep= "repeat" > PID|COMM|EXE|MATCH</arg>
2012-10-19 14:29:46 +04:00
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
<para > <command > systemd-coredumpctl</command> may be used to
retrieve coredumps from
<citerefentry > <refentrytitle > systemd-journald</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> .</para>
</refsect1>
<refsect1 >
<title > Options</title>
<para > The following options are understood:</para>
<variablelist >
<varlistentry >
<term > <option > --help</option> </term>
<term > <option > -h</option> </term>
<listitem > <para > Print a short help
text and exit.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > --version</option> </term>
<listitem > <para > Print a short version
string and exit.</para> </listitem>
</varlistentry>
2012-10-30 14:15:24 +04:00
<varlistentry >
<term > <option > --field=</option> </term>
<term > <option > -F</option> </term>
<listitem > <para > Print all possible
data values the specified field
takes in matching coredump entries of the
journal.</para> </listitem>
</varlistentry>
2012-10-19 14:29:46 +04:00
<varlistentry >
<term > <option > --output=FILE</option> </term>
<term > <option > -o FILE</option> </term>
<listitem > <para > Write the core to
<option > FILE</option> .</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > --no-pager</option> </term>
<listitem > <para > Do not pipe output of
<command > list</command> into a
pager.</para> </listitem>
</varlistentry>
2012-10-30 12:45:19 +04:00
<varlistentry >
<term > <option > --no-legend</option> </term>
<listitem > <para > Do not print the column headers.
</para> </listitem>
</varlistentry>
2012-10-19 14:29:46 +04:00
</variablelist>
<para > The following commands are understood:</para>
<variablelist >
<varlistentry >
<term > <command > list</command> </term>
<listitem > <para > List coredumps captured in the journal
matching specified characteristics.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <command > dump</command> </term>
<listitem > <para > Extract the last coredump
matching specified characteristics.
Coredump will be written on stdout, unless
an output file is specified with
<option > -o/--output</option> .
</para> </listitem>
</varlistentry>
2012-10-27 03:19:47 +04:00
<varlistentry >
<term > <command > gdb</command> </term>
<listitem > <para > Invoke the GNU
debugger on the last coredump matching
specified characteristics.
</para> </listitem>
</varlistentry>
2012-10-19 14:29:46 +04:00
</variablelist>
</refsect1>
<refsect1 >
<title > Matching</title>
<para > Match can be:</para>
<variablelist >
<varlistentry >
<term > <option > PID</option> </term>
<listitem > <para > Process ID of the
process that dumped
core. An integer.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > COMM</option> </term>
<listitem > <para > Name of the executable
(matches <option > COREDUMP_COMM=</option> ).
Must not contain slashes.
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > EXE</option> </term>
<listitem > <para > Path to the executable
(matches <option > COREDUMP_EXE=</option> ).
Must contain at least one slash.
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > MATCH</option> </term>
<listitem > <para > General journalctl predicates
(see <citerefentry > <refentrytitle > journalctl</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ).
Must contain an equals sign.
</para> </listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 >
<title > Exit status</title>
<para > On success 0 is returned, a non-zero failure
2012-11-06 23:27:38 +04:00
code otherwise. Not finding any matching coredumps is treated
2012-10-19 14:29:46 +04:00
as failure.
</para>
</refsect1>
<refsect1 >
<title > See Also</title>
<para >
2012-10-27 03:19:47 +04:00
<citerefentry > <refentrytitle > systemd-journald.service</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > gdb</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry>
2012-10-19 14:29:46 +04:00
</para>
</refsect1>
</refentry>
