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 the column headers.
  78                                 </para></listitem>
  79                         </varlistentry>
  80
  81                         <varlistentry>
  82                                 <term><option>-1</option></term>
  83
  84                                 <listitem><para>Show information of a
  85                                 single coredump only, instead of
  86                                 listing all known coredumps.
  87                                 </para></listitem>
  88                         </varlistentry>
  89
  90                         <varlistentry>
  91                                 <term><option>-F</option></term>
  92                                 <term><option>--field=</option></term>
  93
  94                                 <listitem><para>Print all possible
  95                                 data values the specified field
  96                                 takes in matching coredump entries of the
  97                                 journal.</para></listitem>
  98                         </varlistentry>
  99
 100                         <varlistentry>
 101                                 <term><option>-o</option></term>
 102                                 <term><option>--output=FILE</option></term>
 103
 104                                 <listitem><para>Write the core to
 105                                 <option>FILE</option>.</para></listitem>
 106                         </varlistentry>
 107
 108                         <xi:include href="standard-options.xml" xpointer="help" />
 109                         <xi:include href="standard-options.xml" xpointer="version" />
 110                         <xi:include href="standard-options.xml" xpointer="no-pager" />
 111
 112                 </variablelist>
 113
 114                 <para>The following commands are understood:</para>
 115
 116                 <variablelist>
 117                         <varlistentry>
 118                                 <term><command>list</command></term>
 119
 120                                 <listitem><para>List coredumps
 121                                 captured in the journal matching
 122                                 specified characteristics. If no
 123                                 command is specified, this is the
 124                                 implied default.</para></listitem>
 125                         </varlistentry>
 126
 127                         <varlistentry>
 128                                 <term><command>info</command></term>
 129
 130                                 <listitem><para>Show detailed
 131                                 information about coredumps captured
 132                                 in the journal.</para></listitem>
 133                         </varlistentry>
 134
 135                         <varlistentry>
 136                                 <term><command>dump</command></term>
 137
 138                                 <listitem><para>Extract the last coredump
 139                                 matching specified characteristics.
 140                                 The coredump will be written on standard output,
 141                                 unless an output file is specified with
 142                                 <option>-o/--output</option>.
 143                                 </para></listitem>
 144                         </varlistentry>
 145
 146                         <varlistentry>
 147                                 <term><command>gdb</command></term>
 148
 149                                 <listitem><para>Invoke the GNU
 150                                 debugger on the last coredump matching
 151                                 specified characteristics.
 152                                 </para></listitem>
 153                         </varlistentry>
 154
 155                 </variablelist>
 156
 157         </refsect1>
 158
 159         <refsect1>
 160                 <title>Matching</title>
 161
 162                 <para>A match can be:</para>
 163
 164                 <variablelist>
 165                         <varlistentry>
 166                                 <term><replaceable>PID</replaceable></term>
 167
 168                                 <listitem><para>Process ID of the
 169                                 process that dumped
 170                                 core. An integer.</para></listitem>
 171                         </varlistentry>
 172
 173                         <varlistentry>
 174                                 <term><replaceable>COMM</replaceable></term>
 175
 176                                 <listitem><para>Name of the executable
 177                                 (matches <option>COREDUMP_COMM=</option>).
 178                                 Must not contain slashes.
 179                                 </para></listitem>
 180                         </varlistentry>
 181
 182                         <varlistentry>
 183                                 <term><replaceable>EXE</replaceable></term>
 184
 185                                 <listitem><para>Path to the executable
 186                                 (matches <option>COREDUMP_EXE=</option>).
 187                                 Must contain at least one slash.
 188                                 </para></listitem>
 189                         </varlistentry>
 190
 191                         <varlistentry>
 192                                 <term><replaceable>MATCH</replaceable></term>
 193
 194                                 <listitem><para>General journalctl predicates
 195                                 (see <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
 196                                 Must contain an equal sign.
 197                                 </para></listitem>
 198                         </varlistentry>
 199                 </variablelist>
 200         </refsect1>
 201
 202         <refsect1>
 203                 <title>Exit status</title>
 204                 <para>On success, 0 is returned; otherwise, a non-zero failure
 205                 code is returned. Not finding any matching coredumps is treated
 206                 as failure.
 207                 </para>
 208         </refsect1>
 209
 210         <refsect1>
 211                 <title>See Also</title>
 212                 <para>
 213                         <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 214                         <citerefentry><refentrytitle>coredump.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 215                         <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 216                         <citerefentry project='man-pages'><refentrytitle>gdb</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 217                 </para>
 218         </refsect1>
 219
 220 </refentry>