Debian Codegraph @

upstream/debian-unstable/man5/pstore.conf.5

raw
1 '\" t
2 .TH "PSTORE\&.CONF" "5" "" "systemd 261~rc3" "pstore.conf"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 pstore.conf, pstore.conf.d \- PStore configuration file
24 .SH "SYNOPSIS"
25 .PP
26 .RS 4
27 /etc/systemd/pstore\&.conf
28 .RE
29 .RS 4
30 /run/systemd/pstore\&.conf
31 .RE
32 .RS 4
33 /usr/local/lib/systemd/pstore\&.conf
34 .RE
35 .RS 4
36 /usr/lib/systemd/pstore\&.conf
37 .RE
38 .RS 4
39 /etc/systemd/pstore\&.conf\&.d/*\&.conf
40 .RE
41 .RS 4
42 /run/systemd/pstore\&.conf\&.d/*\&.conf
43 .RE
44 .RS 4
45 /usr/local/lib/systemd/pstore\&.conf\&.d/*\&.conf
46 .RE
47 .RS 4
48 /usr/lib/systemd/pstore\&.conf\&.d/*\&.conf
49 .RE
50 .SH "DESCRIPTION"
51 .PP
52 This file configures the behavior of
53 \fBsystemd-pstore\fR(8), a tool for archiving the contents of the persistent storage filesystem,
54 \m[blue]\fBpstore\fR\m[]\&\s-2\u[1]\d\s+2\&.
55 .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE"
56 .PP
57 The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used:
58 /etc/systemd/,
59 /run/systemd/,
60 /usr/local/lib/systemd/
61 \&\s-2\u[2]\d\s+2,
62 /usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in
63 /etc/
64 if it is shipped under
65 /usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&.
66 .PP
67 In addition to the main configuration file, drop\-in configuration snippets are read from
68 /usr/lib/systemd/*\&.conf\&.d/,
69 /usr/local/lib/systemd/*\&.conf\&.d/, and
70 /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the
71 *\&.conf\&.d/
72 configuration subdirectories are sorted by their filename in lexicographic order, regardless of in which of the subdirectories they reside\&. When multiple files specify the same option, for options which accept just a single value, the entry in the file sorted last takes precedence, and for options which accept a list of values, entries are collected as they occur in the sorted files\&.
73 .PP
74 When packages need to customize the configuration, they can install drop\-ins under
75 /usr/\&. Files in
76 /etc/
77 are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in
78 /usr/
79 and the range 60\-90 for drop\-ins in
80 /etc/
81 and
82 /run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&.
83 .PP
84 To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to
85 /dev/null
86 in the configuration directory in
87 /etc/, with the same filename as the vendor configuration file\&.
88 .SH "OPTIONS"
89 .PP
90 All options are configured in the [PStore] section:
91 .PP
92 \fIStorage=\fR
93 .RS 4
94 Controls where to archive (i\&.e\&. copy) files from the pstore filesystem\&. One of
95 "none",
96 "external", and
97 "journal"\&. When
98 "none", the tool exits without processing files in the pstore filesystem\&. When
99 "external"
100 (the default), files are archived into
101 /var/lib/systemd/pstore/, and logged into the journal\&. When
102 "journal", pstore file contents are logged only in the journal\&.
103 .sp
104 Added in version 243\&.
105 .RE
106 .PP
107 \fIUnlink=\fR
108 .RS 4
109 Controls whether or not files are removed from pstore after processing\&. Takes a boolean value\&. When true, a pstore file is removed from the pstore once it has been archived (either to disk or into the journal)\&. When false, processing of pstore files occurs normally, but the files remain in the pstore\&. The default is true in order to maintain the pstore in a nearly empty state, so that the pstore has storage available for the next kernel error event\&.
110 .sp
111 Added in version 243\&.
112 .RE
113 .PP
114 Use
115 .sp
116 .if n \{\
117 .RS 4
118 .\}
119 .nf
120 systemd\-analyze cat\-config systemd/pstore\&.conf
121 .fi
122 .if n \{\
123 .RE
124 .\}
125 .sp
126 to display the full config\&.
127 .SH "SEE ALSO"
128 .PP
129 \fBsystemd-pstore.service\fR(8)
130 .SH "NOTES"
131 .IP " 1." 4
132 pstore
133 .RS 4
134 \%https://docs.kernel.org/admin-guide/abi-testing.html#abi-sys-fs-pstore
135 .RE
136 .IP " 2." 4
137 💣💥🧨💥💥💣 Please note that those configuration files must be available at all times. If
138 /usr/local/
139 is a separate partition, it may not be available during early boot, and must not be used for configuration.
140