systemd-coredumpctl.xml revision 5a5c72ca6ed88b7068e08b0ebc191a5b21991b62
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd<?xml version='1.0'?> <!--*-nxml-*-->
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd<!--
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd This file is part of systemd.
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd Copyright 2012 Zbigniew Jędrzejewski-Szmek
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd systemd is free software; you can redistribute it and/or modify it
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd under the terms of the GNU Lesser General Public License as published by
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd the Free Software Foundation; either version 2.1 of the License, or
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd (at your option) any later version.
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd systemd is distributed in the hope that it will be useful, but
3f08db06526d6901aa08c110b5bc7dde6bc39905nd WITHOUT ANY WARRANTY; without even the implied warranty of
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd Lesser General Public License for more details.
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
3f08db06526d6901aa08c110b5bc7dde6bc39905nd You should have received a copy of the GNU Lesser General Public License
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd along with systemd; If not, see <http://www.gnu.org/licenses/>.
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd-->
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd<refentry id="systemd-coredumpctl">
ecc5150d35c0dc5ee5119c2717e6660fa331abbftakashi
c04f76acce77126cf88b09350e56ea8c6b4a064enilgun <refentryinfo>
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd <title>systemd-coredumpctl</title>
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end <productname>systemd</productname>
d474d8ef01ec5c2a09341cd148851ed383c3287crbowen
d474d8ef01ec5c2a09341cd148851ed383c3287crbowen <authorgroup>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <author>
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluem <contrib>Developer</contrib>
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluem <firstname>Zbigniew</firstname>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <surname>Jędrzejewski-Szmek</surname>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <email>zbyszek@in.waw.pl</email>
3f08db06526d6901aa08c110b5bc7dde6bc39905nd </author>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </authorgroup>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </refentryinfo>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <refmeta>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <refentrytitle>systemd-coredumpctl</refentrytitle>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <manvolnum>1</manvolnum>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </refmeta>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <refnamediv>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <refname>systemd-coredumpctl</refname>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <refpurpose>Retrieve coredumps from the journal</refpurpose>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </refnamediv>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <refsynopsisdiv>
71fccc298df6a1540d408151a26aa22beed55d0bnd <cmdsynopsis>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <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>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </cmdsynopsis>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </refsynopsisdiv>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <refsect1>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <title>Description</title>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <para><command>systemd-coredumpctl</command> may be used to
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd retrieve coredumps from
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <citerefentry><refentrytitle>systemd-journald</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </refsect1>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <refsect1>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <title>Options</title>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <para>The following options are understood:</para>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <variablelist>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <term><option>--help</option></term>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <term><option>-h</option></term>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <listitem><para>Print a short help
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd text and exit.</para></listitem>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <term><option>--version</option></term>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <listitem><para>Print a short version
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd string and exit.</para></listitem>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <term><option>--field=</option></term>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <term><option>-F</option></term>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <listitem><para>Print all possible
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd data values the specified field
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd takes in matching coredump entries of the
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd journal.</para></listitem>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <term><option>--output=FILE</option></term>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <term><option>-o FILE</option></term>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
71fccc298df6a1540d408151a26aa22beed55d0bnd <listitem><para>Write the core to
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <option>FILE</option>.</para></listitem>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <term><option>--no-pager</option></term>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <listitem><para>Do not pipe output of
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <command>list</command> into a
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd pager.</para></listitem>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <term><option>--no-legend</option></term>
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <listitem><para>Do not print the column headers.
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </para></listitem>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </variablelist>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <para>The following commands are understood:</para>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <variablelist>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <term><command>list</command></term>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <listitem><para>List coredumps captured in the journal
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd matching specified characteristics.</para></listitem>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <term><command>dump</command></term>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <listitem><para>Extract the last coredump
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd matching specified characteristics.
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd Coredump will be written on stdout, unless
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd an output file is specified with
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <option>-o/--output</option>.
71fccc298df6a1540d408151a26aa22beed55d0bnd </para></listitem>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </varlistentry>
a8703cfb67133446eef7af1043640e71486e9ecand
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <term><command>gdb</command></term>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <listitem><para>Invoke the GNU
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd debugger on the last coredump matching
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd specified characteristics.
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </para></listitem>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
71fccc298df6a1540d408151a26aa22beed55d0bnd </variablelist>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </refsect1>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
71fccc298df6a1540d408151a26aa22beed55d0bnd <refsect1>
71fccc298df6a1540d408151a26aa22beed55d0bnd <title>Matching</title>
71fccc298df6a1540d408151a26aa22beed55d0bnd
71fccc298df6a1540d408151a26aa22beed55d0bnd <para>Match can be:</para>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <variablelist>
b3c7a2279fa7a45f5807d9a404760b9b3760df50nd <varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <term><option>PID</option></term>
316f02e3836836c82e19019ff23f90a7ebc65289nilgun
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <listitem><para>Process ID of the
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd process that dumped
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd core. An integer.</para></listitem>
22d5d84393d960a2027f472036f3fee15d7dbce9nd </varlistentry>
22d5d84393d960a2027f472036f3fee15d7dbce9nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <varlistentry>
50c04f297d76a57ead2fa6b73845f7563b1fc788sf <term><option>COMM</option></term>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <listitem><para>Name of the executable
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd (matches <option>COREDUMP_COMM=</option>).
623eebe956d9c2d6d073ed3eae855b56030b40e9noodl Must not contain slashes.
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </para></listitem>
ffb88a4885747797937e30a5ac8b1606da3cb4adnd </varlistentry>
909ce17e2bd0faef7b1c294f2307f009793fd493nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <term><option>EXE</option></term>
cd34a6fbf0a2619544a72eadb73f309370bf6682wrowe
42af92a661a06b3cebc88d585aad75064a309d51nd <listitem><para>Path to the executable
ffb88a4885747797937e30a5ac8b1606da3cb4adnd (matches <option>COREDUMP_EXE=</option>).
6fe26506780e73be2a412d758af77fafdf03291and Must contain at least one slash.
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </para></listitem>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <term><option>MATCH</option></term>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
08cf4a15275e4cb65a424b3a1db5410bfb51085cjim <listitem><para>General journalctl predicates
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd (see <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
78f97ce162b66a0dbfd7af4dcd9984f162569b04minfrin Must contain an equals sign.
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </para></listitem>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </varlistentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </variablelist>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </refsect1>
7906201913b68fe78b9d6a22ab33bf21d82c490eminfrin
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <refsect1>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <title>Exit status</title>
05ede5110427cb9dc071cc671d5aaba5d3b88c79nd <para>On success 0 is returned, a non-zero failure
e8b603fa9ccf7b17b11b42df6d8916fd97c2331dnd code otherwise. Not finding any matching coredumps is treated
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd as failure.
4ed26c413f67a5aae20b95909828f30bb5dc2286poirier </para>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </refsect1>
611049e38bfbaeb173d2d7fab2e44a48753436a1nd
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <refsect1>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <title>See Also</title>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <para>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd <citerefentry><refentrytitle>gdb</refentrytitle><manvolnum>1</manvolnum></citerefentry>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd </para>
03a4ff9ac4c9b8009249010e7c53bb86ff05915and </refsect1>
6116c12fdd3ed06d388fe6572e50a22e9320dfa5nd
d0828c8a321dc5e9ea60550f052294669c08cf93jim</refentry>
d0828c8a321dc5e9ea60550f052294669c08cf93jim