man/systemd-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="systemd-coredumpctl">
  25
  26         <refentryinfo>
  27                 <title>systemd-coredumpctl</title>
  28                 <productname>systemd</productname>
  29
  30                 <authorgroup>
  31                         <author>
  32                                 <contrib>Developer</contrib>
  33                                 <firstname>Zbigniew</firstname>
  34                                 <surname>Jędrzejewski-Szmek</surname>
  35                                 <email>zbyszek@in.waw.pl</email>
  36                         </author>
  37                 </authorgroup>
  38         </refentryinfo>
  39
  40         <refmeta>
  41                 <refentrytitle>systemd-coredumpctl</refentrytitle>
  42                 <manvolnum>1</manvolnum>
  43         </refmeta>
  44
  45         <refnamediv>
  46                 <refname>systemd-coredumpctl</refname>
  47                 <refpurpose>Retrieve coredumps from the journal</refpurpose>
  48         </refnamediv>
  49
  50         <refsynopsisdiv>
  51                 <cmdsynopsis>
  52                         <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>
  53                 </cmdsynopsis>
  54         </refsynopsisdiv>
  55
  56         <refsect1>
  57                 <title>Description</title>
  58
  59                 <para><command>systemd-coredumpctl</command> may be used to
  60                 retrieve coredumps from
  61                 <citerefentry><refentrytitle>systemd-journald</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
  62         </refsect1>
  63
  64         <refsect1>
  65                 <title>Options</title>
  66
  67                 <para>The following options are understood:</para>
  68
  69                 <variablelist>
  70                         <varlistentry>
  71                                 <term><option>--help</option></term>
  72                                 <term><option>-h</option></term>
  73
  74                                 <listitem><para>Print a short help
  75                                 text and exit.</para></listitem>
  76                         </varlistentry>
  77
  78                         <varlistentry>
  79                                 <term><option>--version</option></term>
  80
  81                                 <listitem><para>Print a short version
  82                                 string and exit.</para></listitem>
  83                         </varlistentry>
  84
  85                         <varlistentry>
  86                                 <term><option>--field=</option></term>
  87                                 <term><option>-F</option></term>
  88
  89                                 <listitem><para>Print all possible
  90                                 data values the specified field
  91                                 takes in matching coredump entries of the
  92                                 journal.</para></listitem>
  93                         </varlistentry>
  94
  95                         <varlistentry>
  96                                 <term><option>--output=FILE</option></term>
  97                                 <term><option>-o FILE</option></term>
  98
  99                                 <listitem><para>Write the core to
 100                                 <option>FILE</option>.</para></listitem>
 101                         </varlistentry>
 102
 103                         <varlistentry>
 104                                 <term><option>--no-pager</option></term>
 105
 106                                 <listitem><para>Do not pipe output of
 107                                 <command>list</command> into a
 108                                 pager.</para></listitem>
 109                         </varlistentry>
 110
 111                         <varlistentry>
 112                                 <term><option>--no-legend</option></term>
 113
 114                                 <listitem><para>Do not print the column headers.
 115                                 </para></listitem>
 116                         </varlistentry>
 117
 118                 </variablelist>
 119
 120                 <para>The following commands are understood:</para>
 121
 122                 <variablelist>
 123                         <varlistentry>
 124                                 <term><command>list</command></term>
 125
 126                                 <listitem><para>List coredumps captured in the journal
 127                                 matching specified characteristics.</para></listitem>
 128                         </varlistentry>
 129
 130                         <varlistentry>
 131                                 <term><command>dump</command></term>
 132
 133                                 <listitem><para>Extract the last coredump
 134                                 matching specified characteristics.
 135                                 Coredump will be written on stdout, unless
 136                                 an output file is specified with
 137                                 <option>-o/--output</option>.
 138                                 </para></listitem>
 139                         </varlistentry>
 140
 141
 142                         <varlistentry>
 143                                 <term><command>gdb</command></term>
 144
 145                                 <listitem><para>Invoke the GNU
 146                                 debugger on the last coredump matching
 147                                 specified characteristics.
 148                                 </para></listitem>
 149                         </varlistentry>
 150
 151                 </variablelist>
 152
 153         </refsect1>
 154
 155         <refsect1>
 156                 <title>Matching</title>
 157
 158                 <para>Match can be:</para>
 159
 160                 <variablelist>
 161                         <varlistentry>
 162                                 <term><option>PID</option></term>
 163
 164                                 <listitem><para>Process ID of the
 165                                 process that dumped
 166                                 core. An integer.</para></listitem>
 167                         </varlistentry>
 168
 169                         <varlistentry>
 170                                 <term><option>COMM</option></term>
 171
 172                                 <listitem><para>Name of the executable
 173                                 (matches <option>COREDUMP_COMM=</option>).
 174                                 Must not contain slashes.
 175                                 </para></listitem>
 176                         </varlistentry>
 177
 178                         <varlistentry>
 179                                 <term><option>EXE</option></term>
 180
 181                                 <listitem><para>Path to the executable
 182                                 (matches <option>COREDUMP_EXE=</option>).
 183                                 Must contain at least one slash.
 184                                 </para></listitem>
 185                         </varlistentry>
 186
 187                         <varlistentry>
 188                                 <term><option>MATCH</option></term>
 189
 190                                 <listitem><para>General journalctl predicates
 191                                 (see <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
 192                                 Must contain an equals sign.
 193                                 </para></listitem>
 194                         </varlistentry>
 195                 </variablelist>
 196         </refsect1>
 197
 198         <refsect1>
 199                 <title>Exit status</title>
 200                 <para>On success 0 is returned, a non-zero failure
 201                 code otherwise. Not finding any matching coredumps is treated
 202                 as failure.
 203                 </para>
 204         </refsect1>
 205
 206         <refsect1>
 207                 <title>See Also</title>
 208                 <para>
 209                         <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 210                         <citerefentry><refentrytitle>gdb</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 211                 </para>
 212         </refsect1>
 213
 214 </refentry>