man/coredumpctl.xml

   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">
   4
   5 <!--
   6   This file is part of systemd.
   7
   8   Copyright 2012 Zbigniew Jędrzejewski-Szmek
   9
  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.
  14
  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.
  19
  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/>.
  22 -->
  23
  24 <refentry id="coredumpctl" conditional='ENABLE_COREDUMP'
  25     xmlns:xi="http://www.w3.org/2001/XInclude">
  26
  27   <refentryinfo>
  28     <title>coredumpctl</title>
  29     <productname>systemd</productname>
  30
  31     <authorgroup>
  32       <author>
  33         <contrib>Developer</contrib>
  34         <firstname>Zbigniew</firstname>
  35         <surname>Jędrzejewski-Szmek</surname>
  36         <email>zbyszek@in.waw.pl</email>
  37       </author>
  38     </authorgroup>
  39   </refentryinfo>
  40
  41   <refmeta>
  42     <refentrytitle>coredumpctl</refentrytitle>
  43     <manvolnum>1</manvolnum>
  44   </refmeta>
  45
  46   <refnamediv>
  47     <refname>coredumpctl</refname>
  48     <refpurpose>Retrieve coredumps from the journal</refpurpose>
  49   </refnamediv>
  50
  51   <refsynopsisdiv>
  52     <cmdsynopsis>
  53       <command>coredumpctl</command>
  54       <arg choice="opt" rep="repeat">OPTIONS</arg>
  55       <arg choice="req">COMMAND</arg>
  56       <arg choice="opt" rep="repeat">PID|COMM|EXE|MATCH</arg>
  57     </cmdsynopsis>
  58   </refsynopsisdiv>
  59
  60   <refsect1>
  61     <title>Description</title>
  62
  63     <para><command>coredumpctl</command> may be used to
  64     retrieve coredumps from
  65     <citerefentry><refentrytitle>systemd-journald</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
  66   </refsect1>
  67
  68   <refsect1>
  69     <title>Options</title>
  70
  71     <para>The following options are understood:</para>
  72
  73     <variablelist>
  74       <varlistentry>
  75         <term><option>--no-legend</option></term>
  76
  77         <listitem><para>Do not print column headers.
  78         </para></listitem>
  79       </varlistentry>
  80
  81       <varlistentry>
  82         <term><option>-1</option></term>
  83
  84         <listitem><para>Show information of a single coredump only,
  85         instead of listing all known coredumps. </para></listitem>
  86       </varlistentry>
  87
  88       <varlistentry>
  89         <term><option>-F</option></term>
  90         <term><option>--field=</option></term>
  91
  92         <listitem><para>Print all possible data values the specified
  93         field takes in matching coredump entries of the
  94         journal.</para></listitem>
  95       </varlistentry>
  96
  97       <varlistentry>
  98         <term><option>-o</option></term>
  99         <term><option>--output=FILE</option></term>
 100
 101         <listitem><para>Write the core to <option>FILE</option>.
 102         </para></listitem>
 103       </varlistentry>
 104
 105       <xi:include href="standard-options.xml" xpointer="help" />
 106       <xi:include href="standard-options.xml" xpointer="version" />
 107       <xi:include href="standard-options.xml" xpointer="no-pager" />
 108
 109     </variablelist>
 110
 111     <para>The following commands are understood:</para>
 112
 113     <variablelist>
 114       <varlistentry>
 115         <term><command>list</command></term>
 116
 117         <listitem><para>List coredumps captured in the journal
 118         matching specified characteristics. If no command is
 119         specified, this is the implied default.</para></listitem>
 120       </varlistentry>
 121
 122       <varlistentry>
 123         <term><command>info</command></term>
 124
 125         <listitem><para>Show detailed information about coredumps
 126         captured in the journal.</para></listitem>
 127       </varlistentry>
 128
 129       <varlistentry>
 130         <term><command>dump</command></term>
 131
 132         <listitem><para>Extract the last coredump matching specified
 133         characteristics. The coredump will be written on standard
 134         output, unless an output file is specified with
 135         <option>-o/--output</option>. </para></listitem>
 136       </varlistentry>
 137
 138       <varlistentry>
 139         <term><command>gdb</command></term>
 140
 141         <listitem><para>Invoke the GNU debugger on the last coredump
 142         matching specified characteristics. </para></listitem>
 143       </varlistentry>
 144
 145     </variablelist>
 146
 147   </refsect1>
 148
 149   <refsect1>
 150     <title>Matching</title>
 151
 152     <para>A match can be:</para>
 153
 154     <variablelist>
 155       <varlistentry>
 156         <term><replaceable>PID</replaceable></term>
 157
 158         <listitem><para>Process ID of the
 159         process that dumped
 160         core. An integer.</para></listitem>
 161       </varlistentry>
 162
 163       <varlistentry>
 164         <term><replaceable>COMM</replaceable></term>
 165
 166         <listitem><para>Name of the executable (matches
 167         <option>COREDUMP_COMM=</option>). Must not contain slashes.
 168         </para></listitem>
 169       </varlistentry>
 170
 171       <varlistentry>
 172         <term><replaceable>EXE</replaceable></term>
 173
 174         <listitem><para>Path to the executable (matches
 175         <option>COREDUMP_EXE=</option>). Must contain at least one
 176         slash. </para></listitem>
 177       </varlistentry>
 178
 179       <varlistentry>
 180         <term><replaceable>MATCH</replaceable></term>
 181
 182         <listitem><para>General journalctl predicates (see
 183         <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
 184         Must contain an equal sign. </para></listitem>
 185       </varlistentry>
 186     </variablelist>
 187   </refsect1>
 188
 189   <refsect1>
 190     <title>Exit status</title>
 191     <para>On success, 0 is returned; otherwise, a non-zero failure
 192     code is returned. Not finding any matching coredumps is treated as
 193     failure.
 194     </para>
 195   </refsect1>
 196
 197   <refsect1>
 198     <title>Examples</title>
 199
 200     <example>
 201       <title>List all the coredumps of a program named foo</title>
 202
 203       <programlisting># coredumpctl list foo</programlisting>
 204     </example>
 205
 206     <example>
 207       <title>Invoke gdb on the last coredump</title>
 208
 209       <programlisting># coredumpctl gdb</programlisting>
 210     </example>
 211
 212     <example>
 213       <title>Show information about a process that dumped core,
 214       matching by its PID 6654</title>
 215
 216       <programlisting># coredumpctl info 6654</programlisting>
 217     </example>
 218
 219     <example>
 220       <title>Extract the last coredump of /usr/bin/bar to a file named
 221       <filename noindex="true">bar.coredump</filename></title>
 222
 223       <programlisting># coredumpctl -o bar.coredump dump /usr/bin/bar</programlisting>
 224     </example>
 225   </refsect1>
 226
 227   <refsect1>
 228     <title>See Also</title>
 229     <para>
 230       <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 231       <citerefentry><refentrytitle>coredump.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 232       <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 233       <citerefentry project='man-pages'><refentrytitle>gdb</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 234     </para>
 235   </refsect1>
 236
 237 </refentry>