man/coredump.conf.xml

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