chiark / gitweb /
bus: make sd_bus_request_name() and sd_bus_release_name() behave more like other...
[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         </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 class='systemd-directives'>
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>DefaultTimeoutStartSec=</varname></term>
98                                 <term><varname>DefaultTimeoutStopSec=</varname></term>
99                                 <term><varname>DefaultRestartSec=</varname></term>
100
101                                 <listitem><para>Configures the default
102                                 time-outs for starting and stopping of
103                                 units, as well as the default time to
104                                 sleep between automatic restarts of
105                                 units, as configured per-unit in
106                                 <varname>TimeoutStartSec=</varname>,
107                                 <varname>TimeoutStopSec=</varname> and
108                                 <varname>RestartSec=</varname> (for
109                                 service units, see
110                                 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
111                                 for details on the per-unit
112                                 settings). For non-service units,
113                                 <varname>DefaultTimeoutStartSec=</varname>
114                                 sets the default
115                                 <varname>TimeoutSec=</varname> value.
116                                 </para></listitem>
117                         </varlistentry>
118                         <varlistentry>
119                                 <term><varname>DefaultStartLimitInterval=</varname></term>
120                                 <term><varname>DefaultStartLimitBurst=</varname></term>
121
122                                 <listitem><para>Configure the default start rate
123                                 limiting, as configured per-service by
124                                 <varname>StartLimitInterval=</varname> and
125                                 <varname>StartLimitBurst=</varname>. See
126                                 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
127                                 for details on the per-service
128                                 settings).
129                                 </para></listitem>
130                         </varlistentry>
131
132                         <varlistentry>
133                                 <term><varname>CPUAffinity=</varname></term>
134
135                                 <listitem><para>Configures the initial
136                                 CPU affinity for the init
137                                 process. Takes a space-separated list
138                                 of CPU indexes.</para></listitem>
139                         </varlistentry>
140
141                         <varlistentry>
142                                 <term><varname>JoinControllers=cpu,cpuacct net_cls,netprio</varname></term>
143
144                                 <listitem><para>Configures controllers
145                                 that shall be mounted in a single
146                                 hierarchy. By default, systemd will
147                                 mount all controllers which are
148                                 enabled in the kernel in individual
149                                 hierarchies, with the exception of
150                                 those listed in this setting. Takes a
151                                 space-separated list of comma-separated
152                                 controller names, in order
153                                 to allow multiple joined
154                                 hierarchies. Defaults to
155                                 'cpu,cpuacct'. Pass an empty string to
156                                 ensure that systemd mounts all
157                                 controllers in separate
158                                 hierarchies.</para>
159
160                                 <para>Note that this option is only
161                                 applied once, at very early boot. If
162                                 you use an initial RAM disk (initrd)
163                                 that uses systemd, it might hence be
164                                 necessary to rebuild the initrd if
165                                 this option is changed, and make sure
166                                 the new configuration file is included
167                                 in it. Otherwise, the initrd might
168                                 mount the controller hierarchies in a
169                                 different configuration than intended,
170                                 and the main system cannot remount
171                                 them anymore.</para></listitem>
172                         </varlistentry>
173
174                         <varlistentry>
175                                 <term><varname>RuntimeWatchdogSec=</varname></term>
176                                 <term><varname>ShutdownWatchdogSec=</varname></term>
177
178                                 <listitem><para>Configure the hardware
179                                 watchdog at runtime and at
180                                 reboot. Takes a timeout value in
181                                 seconds (or in other time units if
182                                 suffixed with <literal>ms</literal>,
183                                 <literal>min</literal>,
184                                 <literal>h</literal>,
185                                 <literal>d</literal>,
186                                 <literal>w</literal>). If
187                                 <varname>RuntimeWatchdogSec=</varname>
188                                 is set to a non-zero value, the
189                                 watchdog hardware
190                                 (<filename>/dev/watchdog</filename>)
191                                 will be programmed to automatically
192                                 reboot the system if it is not
193                                 contacted within the specified timeout
194                                 interval. The system manager will
195                                 ensure to contact it at least once in
196                                 half the specified timeout
197                                 interval. This feature requires a
198                                 hardware watchdog device to be
199                                 present, as it is commonly the case in
200                                 embedded and server systems. Not all
201                                 hardware watchdogs allow configuration
202                                 of the reboot timeout, in which case
203                                 the closest available timeout is
204                                 picked. <varname>ShutdownWatchdogSec=</varname>
205                                 may be used to configure the hardware
206                                 watchdog when the system is asked to
207                                 reboot. It works as a safety net to
208                                 ensure that the reboot takes place
209                                 even if a clean reboot attempt times
210                                 out. By default
211                                 <varname>RuntimeWatchdogSec=</varname>
212                                 defaults to 0 (off), and
213                                 <varname>ShutdownWatchdogSec=</varname>
214                                 to 10min. These settings have no
215                                 effect if a hardware watchdog is not
216                                 available.</para></listitem>
217                         </varlistentry>
218
219                         <varlistentry>
220                                 <term><varname>CapabilityBoundingSet=</varname></term>
221
222                                 <listitem><para>Controls which
223                                 capabilities to include in the
224                                 capability bounding set for PID 1 and
225                                 its children. See
226                                 <citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
227                                 for details. Takes a whitespace-separated
228                                 list of capability names as read by
229                                 <citerefentry><refentrytitle>cap_from_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
230                                 Capabilities listed will be included
231                                 in the bounding set, all others are
232                                 removed. If the list of capabilities
233                                 is prefixed with ~, all but the listed
234                                 capabilities will be included, the
235                                 effect of the assignment
236                                 inverted. Note that this option also
237                                 affects the respective capabilities in
238                                 the effective, permitted and
239                                 inheritable capability sets. The
240                                 capability bounding set may also be
241                                 individually configured for units
242                                 using the
243                                 <varname>CapabilityBoundingSet=</varname>
244                                 directive for units, but note that
245                                 capabilities dropped for PID 1 cannot
246                                 be regained in individual units, they
247                                 are lost for good.</para></listitem>
248                         </varlistentry>
249
250                         <varlistentry>
251                                 <term><varname>TimerSlackNSec=</varname></term>
252
253                                 <listitem><para>Sets the timer slack
254                                 in nanoseconds for PID 1 which is then
255                                 inherited to all executed processes,
256                                 unless overridden individually, for
257                                 example with the
258                                 <varname>TimerSlackNSec=</varname>
259                                 setting in service units (for details
260                                 see
261                                 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>). The
262                                 timer slack controls the accuracy of
263                                 wake-ups triggered by timers. See
264                                 <citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
265                                 for more information. Note that in
266                                 contrast to most other time span
267                                 definitions this parameter takes an
268                                 integer value in nano-seconds if no
269                                 unit is specified. The usual time
270                                 units are understood
271                                 too.</para></listitem>
272                         </varlistentry>
273
274                         <varlistentry>
275                                 <term><varname>DefaultEnvironment=</varname></term>
276
277                                 <listitem><para>Sets manager
278                                 environment variables passed to all
279                                 executed processes. Takes a
280                                 space-separated list of variable
281                                 assignments. See
282                                 <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>
283                                 for details about environment
284                                 variables.</para>
285
286                                 <para>Example:
287
288                                 <programlisting>DefaultEnvironment="VAR1=word1 word2" VAR2=word3 "VAR3=word 5 6"</programlisting>
289
290                                 Sets three variables
291                                 <literal>VAR1</literal>,
292                                 <literal>VAR2</literal>,
293                                 <literal>VAR3</literal>.</para></listitem>
294                         </varlistentry>
295
296                         <varlistentry>
297                                 <term><varname>DefaultLimitCPU=</varname></term>
298                                 <term><varname>DefaultLimitFSIZE=</varname></term>
299                                 <term><varname>DefaultLimitDATA=</varname></term>
300                                 <term><varname>DefaultLimitSTACK=</varname></term>
301                                 <term><varname>DefaultLimitCORE=</varname></term>
302                                 <term><varname>DefaultLimitRSS=</varname></term>
303                                 <term><varname>DefaultLimitNOFILE=</varname></term>
304                                 <term><varname>DefaultLimitAS=</varname></term>
305                                 <term><varname>DefaultLimitNPROC=</varname></term>
306                                 <term><varname>DefaultLimitMEMLOCK=</varname></term>
307                                 <term><varname>DefaultLimitLOCKS=</varname></term>
308                                 <term><varname>DefaultLimitSIGPENDING=</varname></term>
309                                 <term><varname>DefaultLimitMSGQUEUE=</varname></term>
310                                 <term><varname>DefaultLimitNICE=</varname></term>
311                                 <term><varname>DefaultLimitRTPRIO=</varname></term>
312                                 <term><varname>DefaultLimitRTTIME=</varname></term>
313
314                                 <listitem><para>These settings control
315                                 various default resource limits for
316                                 units. See
317                                 <citerefentry><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry>
318                                 for details. Use the string
319                                 <varname>infinity</varname> to
320                                 configure no limit on a specific
321                                 resource. These settings may be
322                                 overridden in individual units
323                                 using the corresponding LimitXXX=
324                                 directives. Note that these resource
325                                 limits are only defaults for units,
326                                 they are not applied to PID 1
327                                 itself.</para></listitem>
328                         </varlistentry>
329                 </variablelist>
330         </refsect1>
331
332         <refsect1>
333                   <title>See Also</title>
334                   <para>
335                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
336                           <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
337                           <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>
338                   </para>
339         </refsect1>
340
341 </refentry>