man/coredump.conf.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   4         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   5
   6 <!--
   7   This file is part of systemd.
   8
   9   Copyright 2014 Zbigniew Jędrzejewski-Szmek
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 -->
  24
  25 <refentry id="coredump.conf" conditional="ENABLE_COREDUMP">
  26   <refentryinfo>
  27     <title>coredump.conf</title>
  28     <productname>systemd</productname>
  29
  30     <authorgroup>
  31       <author>
  32         <contrib>Developer</contrib>
  33         <firstname>Lennart</firstname>
  34         <surname>Poettering</surname>
  35         <email>lennart@poettering.net</email>
  36       </author>
  37     </authorgroup>
  38   </refentryinfo>
  39
  40   <refmeta>
  41     <refentrytitle>coredump.conf</refentrytitle>
  42     <manvolnum>5</manvolnum>
  43   </refmeta>
  44
  45   <refnamediv>
  46     <refname>coredump.conf</refname>
  47     <refpurpose>Coredump storage configuration file</refpurpose>
  48   </refnamediv>
  49
  50   <refsynopsisdiv>
  51     <para><filename>/etc/systemd/coredump.conf</filename></para>
  52   </refsynopsisdiv>
  53
  54   <refsect1>
  55     <title>Description</title>
  56
  57     <para>This file configures the behaviour of <command>systemd-coredump</command>,
  58     a handler for core dumps invoked by the kernel.</para>
  59   </refsect1>
  60
  61   <refsect1>
  62     <title>Options</title>
  63
  64     <para>All options are configured in the
  65     <literal>[Coredump]</literal> section:</para>
  66
  67     <variablelist>
  68
  69       <varlistentry>
  70         <term><varname>Storage=</varname></term>
  71
  72         <listitem><para>Controls where to store cores. One of
  73         <literal>none</literal>, <literal>external</literal>,
  74         <literal>journal</literal>, and <literal>both</literal>. When
  75         <literal>none</literal>, the coredumps will be logged but not
  76         stored permanently. When <literal>external</literal> (the
  77         default), cores will be stored in <filename>/var/lib/systemd/coredump</filename>.
  78         When <literal>journal</literal>, cores will be stored in
  79         the journal and rotated following normal journal
  80         rotation patterns. When <literal>both</literal>, cores
  81         will be stored in both locations.</para>
  82
  83         <para>When cores are stored in the journal, they might be
  84         compressed following journal compression settings, see
  85         <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  86         When cores are stored externally, they will be compressed
  87         by default, see below.</para></listitem>
  88       </varlistentry>
  89
  90       <varlistentry>
  91         <term><varname>Compress=</varname></term>
  92
  93         <listitem><para>Controls the type of compression for external
  94         storage. Takes a boolean argument, defaults to
  95         <literal>yes</literal>.</para>
  96         </listitem>
  97       </varlistentry>
  98
  99       <varlistentry>
 100         <term><varname>ProcessSizeMax=</varname></term>
 101
 102         <listitem><para>The maximum size in bytes of a core
 103         which will be processed. Coredumps exceeding this size
 104         will be logged, but the backtrace will not be generated
 105         and the core will not be stored.</para></listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109         <term><varname>ExternalSizeMax=</varname></term>
 110         <term><varname>JournalSizeMax=</varname></term>
 111
 112         <listitem><para>The maximum (uncompressed) size in bytes of a
 113         core to be saved.</para></listitem>
 114       </varlistentry>
 115
 116       <varlistentry>
 117         <term><varname>MaxUse=</varname></term>
 118         <term><varname>KeepFree=</varname></term>
 119
 120         <listitem><para>Enforce limits on the disk space taken up by
 121         externally stored coredumps. <option>MaxUse=</option> makes
 122         sure that old coredumps are removed as soon as the total disk
 123         space taken up by coredumps grows beyond this limit (defaults
 124         to 10% of the total disk size). <option>KeepFree=</option>
 125         controls how much disk space to keep free at least (defaults
 126         to 15% of the total disk size). Note that the disk space used
 127         by coredumps might temporarily exceed these limits while
 128         coredumps are processed. Note that old coredumps are also
 129         removed based on time via
 130         <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para></listitem>
 131       </varlistentry>
 132     </variablelist>
 133
 134   </refsect1>
 135
 136   <refsect1>
 137     <title>See Also</title>
 138     <para>
 139       <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 140       <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 141       <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 142     </para>
 143   </refsect1>
 144
 145 </refentry>