journal-remote: remove unnecessary gnutls includes (#3895)

[thirdparty/systemd.git] / man / coredump.conf.xml

diff --git a/man/coredump.conf.xml b/man/coredump.conf.xml
index 37916f0400d4beb1763418b8348adb28edccc857..4f95680a3aac3f74366f4d95de5ac0a2ad949099 100644 (file)
--- a/man/coredump.conf.xml
+++ b/man/coredump.conf.xml
@@ -1,5 +1,4 @@
 <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
-<?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">
 
@@ -46,7 +45,7 @@
   <refnamediv>
     <refname>coredump.conf</refname>
     <refname>coredump.conf.d</refname>
-    <refpurpose>Coredump storage configuration files</refpurpose>
+    <refpurpose>Core dump storage configuration files</refpurpose>
   </refnamediv>
 
   <refsynopsisdiv>
@@ -59,12 +58,19 @@
   <refsect1>
     <title>Description</title>
 
-    <para>These files configure the behaviour of <command>systemd-coredump</command>,
-    a handler for core dumps invoked by the kernel.</para>
+    <para>These files configure the behavior of
+    <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+    a handler for core dumps invoked by the kernel. Whether <command>systemd-coredump</command> is used
+    is determined by the kernel's
+    <varname>kernel.core_pattern</varname> <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+    setting. See
+    <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+    and
+    <citerefentry project='man-pages'><refentrytitle>core</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    pages for the details.</para>
   </refsect1>
 
-  <xi:include href="standard-conf.xml" xpointer="confd" />
-  <xi:include href="standard-conf.xml" xpointer="conf" />
+  <xi:include href="standard-conf.xml" xpointer="main-conf" />
 
   <refsect1>
     <title>Options</title>
@@ -80,7 +86,7 @@
         <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
+        <literal>none</literal>, the core dumps 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
@@ -98,8 +104,8 @@
       <varlistentry>
         <term><varname>Compress=</varname></term>
 
-        <listitem><para>Controls the type of compression for external
-        storage. Takes a boolean argument, defaults to
+        <listitem><para>Controls compression for external
+        storage. Takes a boolean argument, which defaults to
         <literal>yes</literal>.</para>
         </listitem>
       </varlistentry>
@@ -108,7 +114,7 @@
         <term><varname>ProcessSizeMax=</varname></term>
 
         <listitem><para>The maximum size in bytes of a core
-        which will be processed. Coredumps exceeding this size
+        which will be processed. Core dumps exceeding this size
         will be logged, but the backtrace will not be generated
         and the core will not be stored.</para></listitem>
       </varlistentry>
@@ -126,16 +132,18 @@
         <term><varname>KeepFree=</varname></term>
 
         <listitem><para>Enforce limits on the disk space taken up by
-        externally stored coredumps. <option>MaxUse=</option> makes
-        sure that old coredumps are removed as soon as the total disk
-        space taken up by coredumps grows beyond this limit (defaults
+        externally stored core dumps. <option>MaxUse=</option> makes
+        sure that old core dumps are removed as soon as the total disk
+        space taken up by core dumps grows beyond this limit (defaults
         to 10% of the total disk size). <option>KeepFree=</option>
         controls how much disk space to keep free at least (defaults
         to 15% of the total disk size). Note that the disk space used
-        by coredumps might temporarily exceed these limits while
-        coredumps are processed. Note that old coredumps are also
+        by core dumps might temporarily exceed these limits while
+        core dumps are processed. Note that old core dumps are also
         removed based on time via
-        <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para></listitem>
+        <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>. Set
+        either value to 0 to turn off size-based
+        clean-up.</para></listitem>
       </varlistentry>
     </variablelist>