mirror of
https://github.com/systemd/systemd
synced 2024-10-14 20:17:52 +00:00
man: add coredump.conf(5)
This commit is contained in:
Zbigniew Jędrzejewski-Szmek
parent
9fe13294a9
commit
3cc765d271
|
|
@ -664,6 +664,7 @@ endif
|
|||
|
||||
if ENABLE_COREDUMP
|
||||
MANPAGES += \
|
||||
man/coredump.conf.5 \
|
||||
man/coredumpctl.1
|
||||
MANPAGES_ALIAS += \
|
||||
#
|
||||
|
|
@ -1483,6 +1484,7 @@ EXTRA_DIST += \
|
|||
man/bootctl.xml \
|
||||
man/bootup.xml \
|
||||
man/busctl.xml \
|
||||
man/coredump.conf.xml \
|
||||
man/coredumpctl.xml \
|
||||
man/crypttab.xml \
|
||||
man/daemon.xml \
|
||||
|
|
|
|||
136
man/coredump.conf.xml
Normal file
136
man/coredump.conf.xml
Normal file
|
|
@ -0,0 +1,136 @@
|
|||
<?xml version='1.0'?> <!--*-nxml-*-->
|
||||
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||||
|
||||
<!--
|
||||
This file is part of systemd.
|
||||
|
||||
Copyright 2014 Zbigniew Jędrzejewski-Szmek
|
||||
|
||||
systemd is free software; you can redistribute it and/or modify it
|
||||
under the terms of the GNU Lesser General Public License as published by
|
||||
the Free Software Foundation; either version 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
systemd is distributed in the hope that it will be useful, but
|
||||
WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public License
|
||||
along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
||||
-->
|
||||
|
||||
<refentry id="coredump.conf" conditional="ENABLE_COREDUMP">
|
||||
<refentryinfo>
|
||||
<title>coredump.conf</title>
|
||||
<productname>systemd</productname>
|
||||
|
||||
<authorgroup>
|
||||
<author>
|
||||
<contrib>Developer</contrib>
|
||||
<firstname>Lennart</firstname>
|
||||
<surname>Poettering</surname>
|
||||
<email>lennart@poettering.net</email>
|
||||
</author>
|
||||
</authorgroup>
|
||||
</refentryinfo>
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>coredump.conf</refentrytitle>
|
||||
<manvolnum>5</manvolnum>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>coredump.conf</refname>
|
||||
<refpurpose>Coredump storage configuration file</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<para><filename>/etc/systemd/coredump.conf</filename></para>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<para>This file configures the behaviour of <command>systemd-coredump</command>,
|
||||
a handler for core dumps invoked by the kernel.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Options</title>
|
||||
|
||||
<para>All options are configured in the
|
||||
<literal>[Coredump]</literal> section:</para>
|
||||
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>Storage=</varname></term>
|
||||
|
||||
<listitem><para>Controls where to store cores. One of
|
||||
<literal>none</literal>, <literal>external</literal>,
|
||||
<literal>journal</literal>, and <literal>both</literal>. When
|
||||
<literal>none</literal> the coredumps will be logged but not
|
||||
stored permanently. When <literal>external</literal> (the
|
||||
default), cores will be stored in <filename>/var/lib/systemd/coredump</filename>.
|
||||
When <literal>journal</literal>, cores will be stored in
|
||||
the journal and rotated following normal journal
|
||||
rotation patterns. When <literal>both</literal>, cores
|
||||
will be stored in both locations.</para>
|
||||
|
||||
<para>When cores are stored in the journal, they might be
|
||||
compressed following journal compression settings, see
|
||||
<citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
|
||||
When cores are stored externally, they will be compressed
|
||||
by default, see below.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>Compression=</varname></term>
|
||||
|
||||
<listitem><para>Controls the type of compression for external
|
||||
storage. One of <literal>xz</literal> or
|
||||
<literal>none</literal>.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>CompressionLevel=</varname></term>
|
||||
|
||||
<listitem><para>Controls the level of compression for external
|
||||
storage. An integer between 0 and 9. See
|
||||
<citerefentry><refentrytitle>xz</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
for more details.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>ProcessSizeMax=</varname></term>
|
||||
|
||||
<listitem><para>The maximum size in bytes of a core
|
||||
which will be processed. Coredumps exceeding this size
|
||||
will be logged, but the backtrace will not be generated
|
||||
and the core will not be stored.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>ExternalSizeMax=</varname></term>
|
||||
<term><varname>JournalSizeMax=</varname></term>
|
||||
|
||||
<listitem><para>The maximum (uncompressed) size in bytes of a
|
||||
core to be saved.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
|
@ -9,6 +9,9 @@
|
|||
|
||||
[Coredump]
|
||||
#Storage=external
|
||||
#Compression=xz
|
||||
#CompressionLevel=6
|
||||
|
||||
#ProcessSizeMax=2G
|
||||
#ExternalSizeMax=2G
|
||||
#JournalSizeMax=767M
|
||||
|
|
|
|||
Loading…
Reference in a new issue