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">
7 This file is part of systemd.
9 Copyright 2014 Zbigniew Jędrzejewski-Szmek
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.
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.
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/>.
25 <refentry id="coredump.conf" conditional="ENABLE_COREDUMP">
27 <title>coredump.conf</title>
28 <productname>systemd</productname>
32 <contrib>Developer</contrib>
33 <firstname>Lennart</firstname>
34 <surname>Poettering</surname>
35 <email>lennart@poettering.net</email>
41 <refentrytitle>coredump.conf</refentrytitle>
42 <manvolnum>5</manvolnum>
46 <refname>coredump.conf</refname>
47 <refpurpose>Coredump storage configuration file</refpurpose>
51 <para><filename>/etc/systemd/coredump.conf</filename></para>
55 <title>Description</title>
57 <para>This file configures the behaviour of <command>systemd-coredump</command>,
58 a handler for core dumps invoked by the kernel.</para>
62 <title>Options</title>
64 <para>All options are configured in the
65 <literal>[Coredump]</literal> section:</para>
70 <term><varname>Storage=</varname></term>
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>
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>
91 <term><varname>Compression=</varname></term>
93 <listitem><para>Controls the type of compression for external
94 storage. One of <literal>xz</literal> or
95 <literal>none</literal>.</para>
100 <term><varname>CompressionLevel=</varname></term>
102 <listitem><para>Controls the level of compression for external
103 storage. An integer between 0 and 9. See
104 <citerefentry><refentrytitle>xz</refentrytitle><manvolnum>1</manvolnum></citerefentry>
105 for more details.</para></listitem>
109 <term><varname>ProcessSizeMax=</varname></term>
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>
118 <term><varname>ExternalSizeMax=</varname></term>
119 <term><varname>JournalSizeMax=</varname></term>
121 <listitem><para>The maximum (uncompressed) size in bytes of a
122 core to be saved.</para></listitem>
129 <title>See Also</title>
131 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
132 <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>