]>
Commit | Line | Data |
---|---|---|
9b4abc69 ED |
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.2/docbookx.dtd"> | |
4 | <!-- SPDX-License-Identifier: LGPL-2.1+ --> | |
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> | |
26 | <filename>/etc/systemd/pstore.conf</filename> | |
27 | <filename>/etc/systemd/pstore.conf.d/*</filename> | |
28 | </para> | |
29 | </refsynopsisdiv> | |
30 | ||
31 | <refsect1> | |
32 | <title>Description</title> | |
33 | ||
34 | <para>This file configures the behavior of | |
35 | <citerefentry><refentrytitle>systemd-pstore</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
36 | a tool for archiving the contents of the persistent storage filesystem, | |
37 | <ulink url="https://www.kernel.org/doc/Documentation/ABI/testing/pstore">pstore</ulink>. | |
38 | </para> | |
39 | </refsect1> | |
40 | ||
41 | <xi:include href="standard-conf.xml" xpointer="main-conf" /> | |
42 | ||
43 | <refsect1> | |
44 | <title>Options</title> | |
45 | ||
46 | <para>All options are configured in the | |
bdac5608 | 47 | [PStore] section:</para> |
9b4abc69 ED |
48 | |
49 | <variablelist class='config-directives'> | |
50 | ||
51 | <varlistentry> | |
52 | <term><varname>Storage=</varname></term> | |
53 | ||
54 | <listitem><para>Controls where to archive (i.e. copy) files from the pstore filesystem. One of <literal>none</literal>, | |
55 | <literal>external</literal>, and <literal>journal</literal>. When | |
56 | <literal>none</literal>, the tool exits without processing files in the pstore filesystem. | |
57 | When <literal>external</literal> (the default), files are archived into <filename>/var/lib/systemd/pstore/</filename>, | |
58 | and logged into the journal. | |
59 | When <literal>journal</literal>, pstore file contents are logged only in the journal.</para> | |
60 | </listitem> | |
61 | ||
62 | </varlistentry> | |
63 | ||
64 | <varlistentry> | |
65 | <term><varname>Unlink=</varname></term> | |
66 | ||
67 | <listitem><para>Controls whether or not files are removed from pstore after processing. | |
68 | Takes a boolean value. When true, a pstore file is removed from the pstore once it has been | |
69 | archived (either to disk or into the journal). When false, processing of pstore files occurs | |
70 | normally, but the files remain in the pstore. | |
71 | The default is true in order to maintain the pstore in a nearly empty state, so that the pstore | |
72 | has storage available for the next kernel error event. | |
73 | </para></listitem> | |
74 | </varlistentry> | |
75 | </variablelist> | |
76 | ||
77 | <para>The defaults for all values are listed as comments in the | |
78 | template <filename>/etc/systemd/pstore.conf</filename> file that | |
79 | is installed by default.</para> | |
80 | </refsect1> | |
81 | ||
82 | <refsect1> | |
83 | <title>See Also</title> | |
84 | <para> | |
e9dd6984 | 85 | <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> |
9b4abc69 ED |
86 | </para> |
87 | </refsect1> | |
88 | ||
89 | </refentry> |