coredumpctl.xml 8.75 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
<?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://www.gnu.org/licenses/>.
-->

24
<refentry id="coredumpctl" conditional='ENABLE_COREDUMP'
25
          xmlns:xi="http://www.w3.org/2001/XInclude">
26 27

        <refentryinfo>
28
                <title>coredumpctl</title>
29 30 31 32 33 34 35 36 37 38 39 40 41
                <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>
42
                <refentrytitle>coredumpctl</refentrytitle>
43 44 45 46
                <manvolnum>1</manvolnum>
        </refmeta>

        <refnamediv>
47
                <refname>coredumpctl</refname>
48 49 50 51 52
                <refpurpose>Retrieve coredumps from the journal</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <cmdsynopsis>
53
                        <command>coredumpctl</command>
54 55 56 57 58 59 60 61 62
                        <arg choice="opt" rep="repeat">OPTIONS</arg>
                        <arg choice="req">COMMAND</arg>
                        <arg choice="opt" rep="repeat">PID|COMM|EXE|MATCH</arg>
                </cmdsynopsis>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

63
                <para><command>coredumpctl</command> may be used to
64 65 66 67 68 69 70 71 72 73
                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>
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
                        <varlistentry>
                                <term><option>--no-legend</option></term>

                                <listitem><para>Do not print the column headers.
                                </para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-1</option></term>

                                <listitem><para>Show information of a
                                single coredump only, instead of
                                listing all known coredumps.
                                </para></listitem>
                        </varlistentry>

90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
                        <varlistentry>
                                <term><option>-F</option></term>
                                <term><option>--field=</option></term>

                                <listitem><para>Print all possible
                                data values the specified field
                                takes in matching coredump entries of the
                                journal.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-o</option></term>
                                <term><option>--output=FILE</option></term>

                                <listitem><para>Write the core to
                                <option>FILE</option>.</para></listitem>
                        </varlistentry>

108 109 110
                        <xi:include href="standard-options.xml" xpointer="help" />
                        <xi:include href="standard-options.xml" xpointer="version" />
                        <xi:include href="standard-options.xml" xpointer="no-pager" />
111

112 113 114 115 116 117 118 119
                </variablelist>

                <para>The following commands are understood:</para>

                <variablelist>
                        <varlistentry>
                                <term><command>list</command></term>

120 121 122 123 124 125 126 127 128 129 130 131 132
                                <listitem><para>List coredumps
                                captured in the journal matching
                                specified characteristics. If no
                                command is specified, this is the
                                implied default.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>info</command></term>

                                <listitem><para>Show detailed
                                information about coredumps captured
                                in the journal.</para></listitem>
133 134 135 136 137 138 139
                        </varlistentry>

                        <varlistentry>
                                <term><command>dump</command></term>

                                <listitem><para>Extract the last coredump
                                matching specified characteristics.
140 141
                                The coredump will be written on standard output,
                                unless an output file is specified with
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
                                <option>-o/--output</option>.
                                </para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>gdb</command></term>

                                <listitem><para>Invoke the GNU
                                debugger on the last coredump matching
                                specified characteristics.
                                </para></listitem>
                        </varlistentry>

                </variablelist>

        </refsect1>

        <refsect1>
                <title>Matching</title>

162
                <para>A match can be:</para>
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195

                <variablelist>
                        <varlistentry>
                                <term><replaceable>PID</replaceable></term>

                                <listitem><para>Process ID of the
                                process that dumped
                                core. An integer.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><replaceable>COMM</replaceable></term>

                                <listitem><para>Name of the executable
                                (matches <option>COREDUMP_COMM=</option>).
                                Must not contain slashes.
                                </para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><replaceable>EXE</replaceable></term>

                                <listitem><para>Path to the executable
                                (matches <option>COREDUMP_EXE=</option>).
                                Must contain at least one slash.
                                </para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><replaceable>MATCH</replaceable></term>

                                <listitem><para>General journalctl predicates
                                (see <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
196
                                Must contain an equal sign.
197 198 199 200 201 202 203
                                </para></listitem>
                        </varlistentry>
                </variablelist>
        </refsect1>

        <refsect1>
                <title>Exit status</title>
204 205
                <para>On success, 0 is returned; otherwise, a non-zero failure
                code is returned. Not finding any matching coredumps is treated
206 207
                as failure.
                </para>
208 209 210 211 212 213 214 215 216 217 218
        </refsect1>

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>gdb</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>