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>--output=FILE</option></term>
  87                                 <term><option>-o FILE</option></term>
  88
  89                                 <listitem><para>Write the core to
  90                                 <option>FILE</option>.</para></listitem>
  91                         </varlistentry>
  92
  93                         <varlistentry>
  94                                 <term><option>--no-pager</option></term>
  95
  96                                 <listitem><para>Do not pipe output of
  97                                 <command>list</command> into a
  98                                 pager.</para></listitem>
  99                         </varlistentry>
 100
 101                 </variablelist>
 102
 103                 <para>The following commands are understood:</para>
 104
 105                 <variablelist>
 106                         <varlistentry>
 107                                 <term><command>list</command></term>
 108
 109                                 <listitem><para>List coredumps captured in the journal
 110                                 matching specified characteristics.</para></listitem>
 111                         </varlistentry>
 112
 113                         <varlistentry>
 114                                 <term><command>dump</command></term>
 115
 116                                 <listitem><para>Extract the last coredump
 117                                 matching specified characteristics.
 118                                 Coredump will be written on stdout, unless
 119                                 an output file is specified with
 120                                 <option>-o/--output</option>.
 121                                 </para></listitem>
 122                         </varlistentry>
 123
 124                 </variablelist>
 125
 126         </refsect1>
 127
 128         <refsect1>
 129                 <title>Matching</title>
 130
 131                 <para>Match can be:</para>
 132
 133                 <variablelist>
 134                         <varlistentry>
 135                                 <term><option>PID</option></term>
 136
 137                                 <listitem><para>Process ID of the
 138                                 process that dumped
 139                                 core. An integer.</para></listitem>
 140                         </varlistentry>
 141
 142                         <varlistentry>
 143                                 <term><option>COMM</option></term>
 144
 145                                 <listitem><para>Name of the executable
 146                                 (matches <option>COREDUMP_COMM=</option>).
 147                                 Must not contain slashes.
 148                                 </para></listitem>
 149                         </varlistentry>
 150
 151                         <varlistentry>
 152                                 <term><option>EXE</option></term>
 153
 154                                 <listitem><para>Path to the executable
 155                                 (matches <option>COREDUMP_EXE=</option>).
 156                                 Must contain at least one slash.
 157                                 </para></listitem>
 158                         </varlistentry>
 159
 160                         <varlistentry>
 161                                 <term><option>MATCH</option></term>
 162
 163                                 <listitem><para>General journalctl predicates
 164                                 (see <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
 165                                 Must contain an equals sign.
 166                                 </para></listitem>
 167                         </varlistentry>
 168                 </variablelist>
 169         </refsect1>
 170
 171         <refsect1>
 172                 <title>Exit status</title>
 173                 <para>On success 0 is returned, a non-zero failure
 174                 code otherwise. Not finding any mathing coredumps is treated
 175                 as failure.
 176                 </para>
 177         </refsect1>
 178
 179         <refsect1>
 180                 <title>See Also</title>
 181                 <para>
 182                         <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 183                 </para>
 184         </refsect1>
 185
 186 </refentry>