]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd.conf.xml
journald: splitt of syslog protocol support into its own file
[thirdparty/systemd.git] / man / systemd.conf.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5
6 <!--
7 This file is part of systemd.
8
9 Copyright 2010 Lennart Poettering
10
11 systemd is free software; you can redistribute it and/or modify it
12 under the terms of the GNU Lesser General Public License as published by
13 the Free Software Foundation; either version 2.1 of the License, or
14 (at your option) any later version.
15
16 systemd is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 Lesser General Public License for more details.
20
21 You should have received a copy of the GNU Lesser General Public License
22 along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 -->
24
25 <refentry id="systemd.conf">
26 <refentryinfo>
27 <title>systemd.conf</title>
28 <productname>systemd</productname>
29
30 <authorgroup>
31 <author>
32 <contrib>Developer</contrib>
33 <firstname>Lennart</firstname>
34 <surname>Poettering</surname>
35 <email>lennart@poettering.net</email>
36 </author>
37 </authorgroup>
38 </refentryinfo>
39
40 <refmeta>
41 <refentrytitle>systemd.conf</refentrytitle>
42 <manvolnum>5</manvolnum>
43 </refmeta>
44
45 <refnamediv>
46 <refname>systemd.conf</refname>
47 <refpurpose>System and service manager configuration file</refpurpose>
48 </refnamediv>
49
50 <refsynopsisdiv>
51 <para><filename>/etc/systemd/system.conf</filename></para>
52 <para><filename>/etc/systemd/user.conf</filename></para>
53 </refsynopsisdiv>
54
55 <refsect1>
56 <title>Description</title>
57
58 <para>When run as system instance systemd reads the
59 configuration file <filename>system.conf</filename>,
60 otherwise <filename>user.conf</filename>. These
61 configuration files contain a few settings controlling
62 basic manager operations.</para>
63
64 </refsect1>
65
66 <refsect1>
67 <title>Options</title>
68
69 <para>All options are configured in the
70 <literal>[Manager]</literal> section:</para>
71
72 <variablelist>
73
74 <varlistentry>
75 <term><varname>LogLevel=</varname></term>
76 <term><varname>LogTarget=</varname></term>
77 <term><varname>LogColor=</varname></term>
78 <term><varname>LogLocation=</varname></term>
79 <term><varname>DumpCore=yes</varname></term>
80 <term><varname>CrashShell=no</varname></term>
81 <term><varname>ShowStatus=yes</varname></term>
82 <term><varname>CrashChVT=1</varname></term>
83 <term><varname>DefaultStandardOutput=journal</varname></term>
84 <term><varname>DefaultStandardError=inherit</varname></term>
85
86 <listitem><para>Configures various
87 parameters of basic manager
88 operation. These options may be
89 overridden by the respective command
90 line arguments. See
91 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
92 for details about these command line
93 arguments.</para></listitem>
94 </varlistentry>
95
96 <varlistentry>
97 <term><varname>CPUAffinity=</varname></term>
98
99 <listitem><para>Configures the initial
100 CPU affinity for the init
101 process. Takes a space-separated list
102 of CPU indexes.</para></listitem>
103 </varlistentry>
104
105 <varlistentry>
106 <term><varname>DefaultControllers=cpu</varname></term>
107
108 <listitem><para>Configures in which
109 cgroup controller hierarchies to
110 create per-service cgroups
111 automatically, in addition to the
112 name=systemd named hierarchy. Defaults
113 to 'cpu'. Takes a space separated list
114 of controller names. Pass an empty
115 string to ensure that systemd does not
116 touch any hierarchies but its
117 own.</para></listitem>
118 </varlistentry>
119
120 <varlistentry>
121 <term><varname>JoinControllers=cpu,cpuacct</varname></term>
122
123 <listitem><para>Configures controllers
124 that shall be mounted in a single
125 hierarchy. By default systemd will
126 mount all controllers which are
127 enabled in the kernel in individual
128 hierarchies, with the exception of
129 those listed in this setting. Takes a
130 space separated list of comma
131 separated controller names, in order
132 to allow multiple joined
133 hierarchies. Defaults to
134 'cpu,cpuacct'. Pass an empty string to
135 ensure that systemd mounts all
136 controllers in separate
137 hierarchies.</para></listitem>
138 </varlistentry>
139
140 <varlistentry>
141 <term><varname>RuntimeWatchdogSec=</varname></term>
142 <term><varname>ShutdownWatchdogSec=</varname></term>
143
144 <listitem><para>Configure the hardware
145 watchdog at runtime and at
146 reboot. Takes a timeout value in
147 seconds (or in other time units if
148 suffixed with <literal>ms</literal>,
149 <literal>min</literal>,
150 <literal>h</literal>,
151 <literal>d</literal>,
152 <literal>w</literal>). If
153 <varname>RuntimeWatchdogSec=</varname>
154 is set to a non-zero value the
155 watchdog hardware
156 (<filename>/dev/watchdog</filename>)
157 will be programmed to automatically
158 reboot the system if it is not
159 contacted within the specified timeout
160 interval. The system manager will
161 ensure to contact it at least once in
162 half the specified timeout
163 interval. This feature requires a
164 hardware watchdog device to be
165 present, as it is commonly the case in
166 embedded and server systems. Not all
167 hardware watchdogs allow configuration
168 of the reboot timeout, in which case
169 the closest available timeout is
170 picked. <varname>ShutdownWatchdogSec=</varname>
171 may be used to configure the hardware
172 watchdog when the system is asked to
173 reboot. It works as a safety net to
174 ensure that the reboot takes place
175 even if a clean reboot attempt times
176 out. By default
177 <varname>RuntimeWatchdogSec=</varname>
178 defaults to 0 (off), and
179 <varname>ShutdownWatchdogSec=</varname>
180 to 10min. These settings have no
181 effect if a hardware watchdog is not
182 available.</para></listitem>
183 </varlistentry>
184
185 <varlistentry>
186 <term><varname>CapabilityBoundingSet=</varname></term>
187
188 <listitem><para>Controls which
189 capabilities to include in the
190 capability bounding set for PID 1 and
191 its children. See
192 <citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
193 for details. Takes a whitespace
194 separated list of capability names as
195 read by
196 <citerefentry><refentrytitle>cap_from_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
197 Capabilities listed will be included
198 in the bounding set, all others are
199 removed. If the list of capabilities
200 is prefixed with ~ all but the listed
201 capabilities will be included, the
202 effect of the assignment
203 inverted. Note that this option also
204 effects the respective capabilities in
205 the effective, permitted and
206 inheritable capability sets. The
207 capability bounding set may also be
208 individually configured for units
209 using the
210 <varname>CapabilityBoundingSet=</varname>
211 directive for units, but note that
212 capabilities dropped for PID 1 cannot
213 be regained in individual units, they
214 are lost for good.</para></listitem>
215 </varlistentry>
216
217 <varlistentry>
218 <term><varname>TimerSlackNSec=</varname></term>
219
220 <listitem><para>Sets the timer slack
221 in nanoseconds for PID 1 which is then
222 inherited to all executed processes,
223 unless overriden individually, for
224 example with the
225 <varname>TimerSlackNSec=</varname>
226 setting in service units (for details
227 see
228 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>). The
229 timer slack controls the accuracy of
230 wake-ups triggered by timers. See
231 <citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
232 for more information. Note that in
233 contrast to most other time span
234 definitions this parameter takes an
235 integer value in nano-seconds if no
236 unit is specified. The usual time
237 units are understood
238 too.</para></listitem>
239 </varlistentry>
240
241 <varlistentry>
242 <term><varname>DefaultLimitCPU=</varname></term>
243 <term><varname>DefaultLimitFSIZE=</varname></term>
244 <term><varname>DefaultLimitDATA=</varname></term>
245 <term><varname>DefaultLimitSTACK=</varname></term>
246 <term><varname>DefaultLimitCORE=</varname></term>
247 <term><varname>DefaultLimitRSS=</varname></term>
248 <term><varname>DefaultLimitNOFILE=</varname></term>
249 <term><varname>DefaultLimitAS=</varname></term>
250 <term><varname>DefaultLimitNPROC=</varname></term>
251 <term><varname>DefaultLimitMEMLOCK=</varname></term>
252 <term><varname>DefaultLimitLOCKS=</varname></term>
253 <term><varname>DefaultLimitSIGPENDING=</varname></term>
254 <term><varname>DefaultLimitMSGQUEUE=</varname></term>
255 <term><varname>DefaultLimitNICE=</varname></term>
256 <term><varname>DefaultLimitRTPRIO=</varname></term>
257 <term><varname>DefaultLimitRTTIME=</varname></term>
258
259 <listitem><para>These settings control
260 various default resource limits for
261 units. See
262 <citerefentry><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry>
263 for details. Use the string
264 <varname>infinity</varname> to
265 configure no limit on a specific
266 resource. These settings may be
267 overriden in individual units
268 using the corresponding LimitXXX=
269 directives. Note that these resource
270 limits are only defaults for units,
271 they are not applied to PID 1
272 itself.</para></listitem>
273 </varlistentry>
274 </variablelist>
275 </refsect1>
276
277 <refsect1>
278 <title>See Also</title>
279 <para>
280 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
281 </para>
282 </refsect1>
283
284 </refentry>