man/pstore.conf.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <refentry id="pstore.conf" conditional="ENABLE_PSTORE"
   7           xmlns:xi="http://www.w3.org/2001/XInclude">
   8   <refentryinfo>
   9     <title>pstore.conf</title>
  10     <productname>systemd</productname>
  11   </refentryinfo>
  12
  13   <refmeta>
  14     <refentrytitle>pstore.conf</refentrytitle>
  15     <manvolnum>5</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>pstore.conf</refname>
  20     <refname>pstore.conf.d</refname>
  21     <refpurpose>PStore configuration file</refpurpose>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <para><simplelist>
  26       <member><filename>/etc/systemd/pstore.conf</filename></member>
  27       <member><filename>/run/systemd/pstore.conf</filename></member>
  28       <member><filename>/usr/lib/systemd/pstore.conf</filename></member>
  29       <member><filename>/etc/systemd/pstore.conf.d/*.conf</filename></member>
  30       <member><filename>/run/systemd/pstore.conf.d/*.conf</filename></member>
  31       <member><filename>/usr/lib/systemd/pstore.conf.d/*.conf</filename></member>
  32     </simplelist></para>
  33   </refsynopsisdiv>
  34
  35   <refsect1>
  36     <title>Description</title>
  37
  38     <para>This file configures the behavior of
  39     <citerefentry><refentrytitle>systemd-pstore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  40     a tool for archiving the contents of the persistent storage filesystem,
  41     <ulink url="https://docs.kernel.org/admin-guide/abi-testing.html#abi-sys-fs-pstore">pstore</ulink>.
  42     </para>
  43   </refsect1>
  44
  45   <xi:include href="standard-conf.xml" xpointer="main-conf" />
  46
  47   <refsect1>
  48     <title>Options</title>
  49
  50     <para>All options are configured in the
  51     [PStore] section:</para>
  52
  53     <variablelist class='config-directives'>
  54
  55       <varlistentry>
  56         <term><varname>Storage=</varname></term>
  57
  58         <listitem><para>Controls where to archive (i.e. copy) files from the pstore filesystem. One of <literal>none</literal>,
  59         <literal>external</literal>, and <literal>journal</literal>. When
  60         <literal>none</literal>, the tool exits without processing files in the pstore filesystem.
  61         When <literal>external</literal> (the default), files are archived into <filename>/var/lib/systemd/pstore/</filename>,
  62         and logged into the journal.
  63         When <literal>journal</literal>, pstore file contents are logged only in the journal.</para>
  64
  65         <xi:include href="version-info.xml" xpointer="v243"/>
  66         </listitem>
  67
  68       </varlistentry>
  69
  70       <varlistentry>
  71         <term><varname>Unlink=</varname></term>
  72
  73         <listitem><para>Controls whether or not files are removed from pstore after processing.
  74         Takes a boolean value. When true, a pstore file is removed from the pstore once it has been
  75         archived (either to disk or into the journal). When false, processing of pstore files occurs
  76         normally, but the files remain in the pstore.
  77         The default is true in order to maintain the pstore in a nearly empty state, so that the pstore
  78         has storage available for the next kernel error event.
  79         </para>
  80
  81         <xi:include href="version-info.xml" xpointer="v243"/></listitem>
  82       </varlistentry>
  83     </variablelist>
  84
  85     <para>The defaults for all values are listed as comments in the
  86     template <filename>/etc/systemd/pstore.conf</filename> file that
  87     is installed by default.</para>
  88   </refsect1>
  89
  90   <refsect1>
  91     <title>See Also</title>
  92     <para>
  93       <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  94     </para>
  95   </refsect1>
  96
  97 </refentry>