chiark / gitweb /
man: rename systemd.conf to systemd-system.conf
[elogind.git] / man / systemd-system.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-system.conf">
26         <refentryinfo>
27                 <title>systemd-system.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-system.conf</refentrytitle>
42                 <manvolnum>5</manvolnum>
43         </refmeta>
44
45         <refnamediv>
46                 <refname>systemd-system.conf</refname>
47                 <refname>systemd-user.conf</refname>
48                 <refpurpose>System and session service manager configuration file</refpurpose>
49         </refnamediv>
50
51         <refsynopsisdiv>
52                 <para><filename>/etc/systemd/system.conf</filename></para>
53                 <para><filename>/etc/systemd/user.conf</filename></para>
54         </refsynopsisdiv>
55
56         <refsect1>
57                 <title>Description</title>
58
59                 <para>When run as system instance systemd reads the
60                 configuration file <filename>system.conf</filename>,
61                 otherwise <filename>user.conf</filename>. These
62                 configuration files contain a few settings controlling
63                 basic manager operations.</para>
64
65         </refsect1>
66
67         <refsect1>
68                 <title>Options</title>
69
70                 <para>All options are configured in the
71                 <literal>[Manager]</literal> section:</para>
72
73                 <variablelist class='systemd-directives'>
74
75                         <varlistentry>
76                                 <term><varname>LogLevel=</varname></term>
77                                 <term><varname>LogTarget=</varname></term>
78                                 <term><varname>LogColor=</varname></term>
79                                 <term><varname>LogLocation=</varname></term>
80                                 <term><varname>DumpCore=yes</varname></term>
81                                 <term><varname>CrashShell=no</varname></term>
82                                 <term><varname>ShowStatus=yes</varname></term>
83                                 <term><varname>CrashChVT=1</varname></term>
84                                 <term><varname>DefaultStandardOutput=journal</varname></term>
85                                 <term><varname>DefaultStandardError=inherit</varname></term>
86
87                                 <listitem><para>Configures various
88                                 parameters of basic manager
89                                 operation. These options may be
90                                 overridden by the respective command
91                                 line arguments. See
92                                 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
93                                 for details about these command line
94                                 arguments.</para></listitem>
95                         </varlistentry>
96
97                         <varlistentry>
98                                 <term><varname>CPUAffinity=</varname></term>
99
100                                 <listitem><para>Configures the initial
101                                 CPU affinity for the init
102                                 process. Takes a space-separated list
103                                 of CPU indexes.</para></listitem>
104                         </varlistentry>
105
106                         <varlistentry>
107                                 <term><varname>DefaultControllers=cpu</varname></term>
108
109                                 <listitem><para>Configures in which
110                                 cgroup controller hierarchies to
111                                 create per-service cgroups
112                                 automatically, in addition to the
113                                 name=systemd named hierarchy. Defaults
114                                 to 'cpu'. Takes a space separated list
115                                 of controller names. Pass an empty
116                                 string to ensure that systemd does not
117                                 touch any hierarchies but its
118                                 own.</para>
119
120                                 <para>Note that the default value of
121                                 'cpu' will make realtime scheduling
122                                 unavailable to system services. See
123                                 <ulink
124                                 url="http://www.freedesktop.org/wiki/Software/systemd/MyServiceCantGetRealtime">My
125                                 Service Can't Get Realtime!</ulink>
126                                 for more
127                                 information.</para></listitem>
128                         </varlistentry>
129
130                         <varlistentry>
131                                 <term><varname>JoinControllers=cpu,cpuacct,cpuset net_cls,netprio</varname></term>
132
133                                 <listitem><para>Configures controllers
134                                 that shall be mounted in a single
135                                 hierarchy. By default systemd will
136                                 mount all controllers which are
137                                 enabled in the kernel in individual
138                                 hierarchies, with the exception of
139                                 those listed in this setting. Takes a
140                                 space separated list of comma
141                                 separated controller names, in order
142                                 to allow multiple joined
143                                 hierarchies. Defaults to
144                                 'cpu,cpuacct'. Pass an empty string to
145                                 ensure that systemd mounts all
146                                 controllers in separate
147                                 hierarchies.</para>
148
149                                 <para>Note that this option is only
150                                 applied once, at very early boot. If
151                                 you use an initial RAM disk (initrd)
152                                 that uses systemd it might hence be
153                                 necessary to rebuild the initrd if
154                                 this option is changed, and make sure
155                                 the new configuration file is included
156                                 in it. Otherwise the initrd might
157                                 mount the controller hierachies in a
158                                 different configuration than intended,
159                                 and the main system cannot remount
160                                 them anymore.</para></listitem>
161                         </varlistentry>
162
163                         <varlistentry>
164                                 <term><varname>RuntimeWatchdogSec=</varname></term>
165                                 <term><varname>ShutdownWatchdogSec=</varname></term>
166
167                                 <listitem><para>Configure the hardware
168                                 watchdog at runtime and at
169                                 reboot. Takes a timeout value in
170                                 seconds (or in other time units if
171                                 suffixed with <literal>ms</literal>,
172                                 <literal>min</literal>,
173                                 <literal>h</literal>,
174                                 <literal>d</literal>,
175                                 <literal>w</literal>). If
176                                 <varname>RuntimeWatchdogSec=</varname>
177                                 is set to a non-zero value the
178                                 watchdog hardware
179                                 (<filename>/dev/watchdog</filename>)
180                                 will be programmed to automatically
181                                 reboot the system if it is not
182                                 contacted within the specified timeout
183                                 interval. The system manager will
184                                 ensure to contact it at least once in
185                                 half the specified timeout
186                                 interval. This feature requires a
187                                 hardware watchdog device to be
188                                 present, as it is commonly the case in
189                                 embedded and server systems. Not all
190                                 hardware watchdogs allow configuration
191                                 of the reboot timeout, in which case
192                                 the closest available timeout is
193                                 picked. <varname>ShutdownWatchdogSec=</varname>
194                                 may be used to configure the hardware
195                                 watchdog when the system is asked to
196                                 reboot. It works as a safety net to
197                                 ensure that the reboot takes place
198                                 even if a clean reboot attempt times
199                                 out. By default
200                                 <varname>RuntimeWatchdogSec=</varname>
201                                 defaults to 0 (off), and
202                                 <varname>ShutdownWatchdogSec=</varname>
203                                 to 10min. These settings have no
204                                 effect if a hardware watchdog is not
205                                 available.</para></listitem>
206                         </varlistentry>
207
208                         <varlistentry>
209                                 <term><varname>CapabilityBoundingSet=</varname></term>
210
211                                 <listitem><para>Controls which
212                                 capabilities to include in the
213                                 capability bounding set for PID 1 and
214                                 its children. See
215                                 <citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
216                                 for details. Takes a whitespace
217                                 separated list of capability names as
218                                 read by
219                                 <citerefentry><refentrytitle>cap_from_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
220                                 Capabilities listed will be included
221                                 in the bounding set, all others are
222                                 removed. If the list of capabilities
223                                 is prefixed with ~ all but the listed
224                                 capabilities will be included, the
225                                 effect of the assignment
226                                 inverted. Note that this option also
227                                 affects the respective capabilities in
228                                 the effective, permitted and
229                                 inheritable capability sets. The
230                                 capability bounding set may also be
231                                 individually configured for units
232                                 using the
233                                 <varname>CapabilityBoundingSet=</varname>
234                                 directive for units, but note that
235                                 capabilities dropped for PID 1 cannot
236                                 be regained in individual units, they
237                                 are lost for good.</para></listitem>
238                         </varlistentry>
239
240                         <varlistentry>
241                                 <term><varname>TimerSlackNSec=</varname></term>
242
243                                 <listitem><para>Sets the timer slack
244                                 in nanoseconds for PID 1 which is then
245                                 inherited to all executed processes,
246                                 unless overridden individually, for
247                                 example with the
248                                 <varname>TimerSlackNSec=</varname>
249                                 setting in service units (for details
250                                 see
251                                 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>). The
252                                 timer slack controls the accuracy of
253                                 wake-ups triggered by timers. See
254                                 <citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
255                                 for more information. Note that in
256                                 contrast to most other time span
257                                 definitions this parameter takes an
258                                 integer value in nano-seconds if no
259                                 unit is specified. The usual time
260                                 units are understood
261                                 too.</para></listitem>
262                         </varlistentry>
263
264                         <varlistentry>
265                                 <term><varname>DefaultLimitCPU=</varname></term>
266                                 <term><varname>DefaultLimitFSIZE=</varname></term>
267                                 <term><varname>DefaultLimitDATA=</varname></term>
268                                 <term><varname>DefaultLimitSTACK=</varname></term>
269                                 <term><varname>DefaultLimitCORE=</varname></term>
270                                 <term><varname>DefaultLimitRSS=</varname></term>
271                                 <term><varname>DefaultLimitNOFILE=</varname></term>
272                                 <term><varname>DefaultLimitAS=</varname></term>
273                                 <term><varname>DefaultLimitNPROC=</varname></term>
274                                 <term><varname>DefaultLimitMEMLOCK=</varname></term>
275                                 <term><varname>DefaultLimitLOCKS=</varname></term>
276                                 <term><varname>DefaultLimitSIGPENDING=</varname></term>
277                                 <term><varname>DefaultLimitMSGQUEUE=</varname></term>
278                                 <term><varname>DefaultLimitNICE=</varname></term>
279                                 <term><varname>DefaultLimitRTPRIO=</varname></term>
280                                 <term><varname>DefaultLimitRTTIME=</varname></term>
281
282                                 <listitem><para>These settings control
283                                 various default resource limits for
284                                 units. See
285                                 <citerefentry><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry>
286                                 for details. Use the string
287                                 <varname>infinity</varname> to
288                                 configure no limit on a specific
289                                 resource. These settings may be
290                                 overridden in individual units
291                                 using the corresponding LimitXXX=
292                                 directives. Note that these resource
293                                 limits are only defaults for units,
294                                 they are not applied to PID 1
295                                 itself.</para></listitem>
296                         </varlistentry>
297                 </variablelist>
298         </refsect1>
299
300         <refsect1>
301                   <title>See Also</title>
302                   <para>
303                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
304                           <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
305                   </para>
306         </refsect1>
307
308 </refentry>