man/coredump.conf.xml

   1 <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
   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           xmlns:xi="http://www.w3.org/2001/XInclude">
  27   <refentryinfo>
  28     <title>coredump.conf</title>
  29     <productname>systemd</productname>
  30
  31     <authorgroup>
  32       <author>
  33         <contrib>Developer</contrib>
  34         <firstname>Lennart</firstname>
  35         <surname>Poettering</surname>
  36         <email>lennart@poettering.net</email>
  37       </author>
  38     </authorgroup>
  39   </refentryinfo>
  40
  41   <refmeta>
  42     <refentrytitle>coredump.conf</refentrytitle>
  43     <manvolnum>5</manvolnum>
  44   </refmeta>
  45
  46   <refnamediv>
  47     <refname>coredump.conf</refname>
  48     <refname>coredump.conf.d</refname>
  49     <refpurpose>Coredump storage configuration files</refpurpose>
  50   </refnamediv>
  51
  52   <refsynopsisdiv>
  53     <para><filename>/etc/systemd/coredump.conf</filename></para>
  54     <para><filename>/etc/systemd/coredump.conf.d/*.conf</filename></para>
  55     <para><filename>/run/systemd/coredump.conf.d/*.conf</filename></para>
  56     <para><filename>/usr/lib/systemd/coredump.conf.d/*.conf</filename></para>
  57   </refsynopsisdiv>
  58
  59   <refsect1>
  60     <title>Description</title>
  61
  62     <para>These files configure the behaviour of
  63     <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  64     a handler for core dumps invoked by the kernel.</para>
  65   </refsect1>
  66
  67   <xi:include href="standard-conf.xml" xpointer="confd" />
  68   <xi:include href="standard-conf.xml" xpointer="conf" />
  69
  70   <refsect1>
  71     <title>Options</title>
  72
  73     <para>All options are configured in the
  74     <literal>[Coredump]</literal> section:</para>
  75
  76     <variablelist>
  77
  78       <varlistentry>
  79         <term><varname>Storage=</varname></term>
  80
  81         <listitem><para>Controls where to store cores. One of
  82         <literal>none</literal>, <literal>external</literal>,
  83         <literal>journal</literal>, and <literal>both</literal>. When
  84         <literal>none</literal>, the coredumps will be logged but not
  85         stored permanently. When <literal>external</literal> (the
  86         default), cores will be stored in <filename>/var/lib/systemd/coredump</filename>.
  87         When <literal>journal</literal>, cores will be stored in
  88         the journal and rotated following normal journal
  89         rotation patterns. When <literal>both</literal>, cores
  90         will be stored in both locations.</para>
  91
  92         <para>When cores are stored in the journal, they might be
  93         compressed following journal compression settings, see
  94         <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  95         When cores are stored externally, they will be compressed
  96         by default, see below.</para></listitem>
  97       </varlistentry>
  98
  99       <varlistentry>
 100         <term><varname>Compress=</varname></term>
 101
 102         <listitem><para>Controls compression for external
 103         storage. Takes a boolean argument, defaults to
 104         <literal>yes</literal>.</para>
 105         </listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109         <term><varname>ProcessSizeMax=</varname></term>
 110
 111         <listitem><para>The maximum size in bytes of a core
 112         which will be processed. Coredumps exceeding this size
 113         will be logged, but the backtrace will not be generated
 114         and the core will not be stored.</para></listitem>
 115       </varlistentry>
 116
 117       <varlistentry>
 118         <term><varname>ExternalSizeMax=</varname></term>
 119         <term><varname>JournalSizeMax=</varname></term>
 120
 121         <listitem><para>The maximum (uncompressed) size in bytes of a
 122         core to be saved.</para></listitem>
 123       </varlistentry>
 124
 125       <varlistentry>
 126         <term><varname>MaxUse=</varname></term>
 127         <term><varname>KeepFree=</varname></term>
 128
 129         <listitem><para>Enforce limits on the disk space taken up by
 130         externally stored coredumps. <option>MaxUse=</option> makes
 131         sure that old coredumps are removed as soon as the total disk
 132         space taken up by coredumps grows beyond this limit (defaults
 133         to 10% of the total disk size). <option>KeepFree=</option>
 134         controls how much disk space to keep free at least (defaults
 135         to 15% of the total disk size). Note that the disk space used
 136         by coredumps might temporarily exceed these limits while
 137         coredumps are processed. Note that old coredumps are also
 138         removed based on time via
 139         <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para></listitem>
 140       </varlistentry>
 141     </variablelist>
 142
 143   </refsect1>
 144
 145   <refsect1>
 146     <title>See Also</title>
 147     <para>
 148       <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 149       <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 150       <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 151     </para>
 152   </refsect1>
 153
 154 </refentry>