[thirdparty/systemd.git] / man / systemd.conf.xml

<?xml version='1.0'?> <!--*-nxml-*-->
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="systemd.conf">
        <refentryinfo>
                <title>systemd.conf</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>systemd.conf</refentrytitle>
                <manvolnum>5</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>systemd.conf</refname>
                <refpurpose>System and service manager configuration file</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <para><filename>/etc/systemd/system.conf</filename></para>
                <para><filename>/etc/systemd/user.conf</filename></para>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para>When run as system instance systemd reads the
                configuration file <filename>system.conf</filename>,
                otherwise <filename>user.conf</filename>. These
                configuration files contain a few settings controlling
                basic manager operations.</para>

        </refsect1>

        <refsect1>
                <title>Options</title>

                <para>All options are configured in the
                <literal>[Manager]</literal> section:</para>

                <variablelist class='systemd-directives'>

                        <varlistentry>
                                <term><varname>LogLevel=</varname></term>
                                <term><varname>LogTarget=</varname></term>
                                <term><varname>LogColor=</varname></term>
                                <term><varname>LogLocation=</varname></term>
                                <term><varname>DumpCore=yes</varname></term>
                                <term><varname>CrashShell=no</varname></term>
                                <term><varname>ShowStatus=yes</varname></term>
                                <term><varname>CrashChVT=1</varname></term>
                                <term><varname>DefaultStandardOutput=journal</varname></term>
                                <term><varname>DefaultStandardError=inherit</varname></term>

                                <listitem><para>Configures various
                                parameters of basic manager
                                operation. These options may be
                                overridden by the respective command
                                line arguments. See
                                <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                                for details about these command line
                                arguments.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>CPUAffinity=</varname></term>

                                <listitem><para>Configures the initial
                                CPU affinity for the init
                                process. Takes a space-separated list
                                of CPU indexes.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>DefaultControllers=cpu</varname></term>

                                <listitem><para>Configures in which
                                cgroup controller hierarchies to
                                create per-service cgroups
                                automatically, in addition to the
                                name=systemd named hierarchy. Defaults
                                to 'cpu'. Takes a space separated list
                                of controller names. Pass an empty
                                string to ensure that systemd does not
                                touch any hierarchies but its
                                own.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>JoinControllers=cpu,cpuacct,cpuset net_cls,netprio</varname></term>

                                <listitem><para>Configures controllers
                                that shall be mounted in a single
                                hierarchy. By default systemd will
                                mount all controllers which are
                                enabled in the kernel in individual
                                hierarchies, with the exception of
                                those listed in this setting. Takes a
                                space separated list of comma
                                separated controller names, in order
                                to allow multiple joined
                                hierarchies. Defaults to
                                'cpu,cpuacct'. Pass an empty string to
                                ensure that systemd mounts all
                                controllers in separate
                                hierarchies.</para>

                                <para>Note that this option is only
                                applied once, at very early boot. If
                                you use an initial RAM disk (initrd)
                                that uses systemd it might hence be
                                necessary to rebuild the initrd if
                                this option is changed, and make sure
                                the new configuration file is included
                                in it. Otherwise the initrd might
                                mount the controllers in different
                                configuration than intended, and the
                                main system cannot remount them
                                anymore.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>RuntimeWatchdogSec=</varname></term>
                                <term><varname>ShutdownWatchdogSec=</varname></term>

                                <listitem><para>Configure the hardware
                                watchdog at runtime and at
                                reboot. Takes a timeout value in
                                seconds (or in other time units if
                                suffixed with <literal>ms</literal>,
                                <literal>min</literal>,
                                <literal>h</literal>,
                                <literal>d</literal>,
                                <literal>w</literal>). If
                                <varname>RuntimeWatchdogSec=</varname>
                                is set to a non-zero value the
                                watchdog hardware
                                (<filename>/dev/watchdog</filename>)
                                will be programmed to automatically
                                reboot the system if it is not
                                contacted within the specified timeout
                                interval. The system manager will
                                ensure to contact it at least once in
                                half the specified timeout
                                interval. This feature requires a
                                hardware watchdog device to be
                                present, as it is commonly the case in
                                embedded and server systems. Not all
                                hardware watchdogs allow configuration
                                of the reboot timeout, in which case
                                the closest available timeout is
                                picked. <varname>ShutdownWatchdogSec=</varname>
                                may be used to configure the hardware
                                watchdog when the system is asked to
                                reboot. It works as a safety net to
                                ensure that the reboot takes place
                                even if a clean reboot attempt times
                                out. By default
                                <varname>RuntimeWatchdogSec=</varname>
                                defaults to 0 (off), and
                                <varname>ShutdownWatchdogSec=</varname>
                                to 10min. These settings have no
                                effect if a hardware watchdog is not
                                available.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>CapabilityBoundingSet=</varname></term>

                                <listitem><para>Controls which
                                capabilities to include in the
                                capability bounding set for PID 1 and
                                its children. See
                                <citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                                for details. Takes a whitespace
                                separated list of capability names as
                                read by
                                <citerefentry><refentrytitle>cap_from_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
                                Capabilities listed will be included
                                in the bounding set, all others are
                                removed. If the list of capabilities
                                is prefixed with ~ all but the listed
                                capabilities will be included, the
                                effect of the assignment
                                inverted. Note that this option also
                                affects the respective capabilities in
                                the effective, permitted and
                                inheritable capability sets. The
                                capability bounding set may also be
                                individually configured for units
                                using the
                                <varname>CapabilityBoundingSet=</varname>
                                directive for units, but note that
                                capabilities dropped for PID 1 cannot
                                be regained in individual units, they
                                are lost for good.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>TimerSlackNSec=</varname></term>

                                <listitem><para>Sets the timer slack
                                in nanoseconds for PID 1 which is then
                                inherited to all executed processes,
                                unless overridden individually, for
                                example with the
                                <varname>TimerSlackNSec=</varname>
                                setting in service units (for details
                                see
                                <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>). The
                                timer slack controls the accuracy of
                                wake-ups triggered by timers. See
                                <citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
                                for more information. Note that in
                                contrast to most other time span
                                definitions this parameter takes an
                                integer value in nano-seconds if no
                                unit is specified. The usual time
                                units are understood
                                too.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>DefaultLimitCPU=</varname></term>
                                <term><varname>DefaultLimitFSIZE=</varname></term>
                                <term><varname>DefaultLimitDATA=</varname></term>
                                <term><varname>DefaultLimitSTACK=</varname></term>
                                <term><varname>DefaultLimitCORE=</varname></term>
                                <term><varname>DefaultLimitRSS=</varname></term>
                                <term><varname>DefaultLimitNOFILE=</varname></term>
                                <term><varname>DefaultLimitAS=</varname></term>
                                <term><varname>DefaultLimitNPROC=</varname></term>
                                <term><varname>DefaultLimitMEMLOCK=</varname></term>
                                <term><varname>DefaultLimitLOCKS=</varname></term>
                                <term><varname>DefaultLimitSIGPENDING=</varname></term>
                                <term><varname>DefaultLimitMSGQUEUE=</varname></term>
                                <term><varname>DefaultLimitNICE=</varname></term>
                                <term><varname>DefaultLimitRTPRIO=</varname></term>
                                <term><varname>DefaultLimitRTTIME=</varname></term>

                                <listitem><para>These settings control
                                various default resource limits for
                                units. See
                                <citerefentry><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry>
                                for details. Use the string
                                <varname>infinity</varname> to
                                configure no limit on a specific
                                resource. These settings may be
                                overridden in individual units
                                using the corresponding LimitXXX=
                                directives. Note that these resource
                                limits are only defaults for units,
                                they are not applied to PID 1
                                itself.</para></listitem>
                        </varlistentry>
                </variablelist>
        </refsect1>

        <refsect1>
                  <title>See Also</title>
                  <para>
                          <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                  </para>
        </refsect1>

</refentry>
Commit	Line	Data
f3e219a2 LP	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
5430f7f2 LP	12	under the terms of the GNU Lesser General Public License as published by
5430f7f2 LP	13	the Free Software Foundation; either version 2.1 of the License, or
f3e219a2 LP	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
5430f7f2	19	Lesser General Public License for more details.
f3e219a2	20
5430f7f2	21	You should have received a copy of the GNU Lesser General Public License
f3e219a2 LP	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>
34511ca7	47	<refpurpose>System and service manager configuration file</refpurpose>
f3e219a2 LP	48	</refnamediv>
	49
	50	<refsynopsisdiv>
4aa6e778 LP	51	<para><filename>/etc/systemd/system.conf</filename></para>
4aa6e778 LP	52	<para><filename>/etc/systemd/user.conf</filename></para>
f3e219a2 LP	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>,
af2d49f7	60	otherwise <filename>user.conf</filename>. These
f3e219a2 LP	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
ffafe91b	72	<variablelist class='systemd-directives'>
f3e219a2 LP	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>
706343f4	83	<term><varname>DefaultStandardOutput=journal</varname></term>
0a494f1f	84	<term><varname>DefaultStandardError=inherit</varname></term>
f3e219a2 LP	85
	86	<listitem><para>Configures various
	87	parameters of basic manager
	88	operation. These options may be
5471472d	89	overridden by the respective command
f3e219a2 LP	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
96d4ce01	101	process. Takes a space-separated list
f3e219a2	102	of CPU indexes.</para></listitem>
af2d49f7	103	</varlistentry>
06d4c99a LP	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
5471472d	113	to 'cpu'. Takes a space separated list
06d4c99a LP	114	of controller names. Pass an empty
06d4c99a LP	115	string to ensure that systemd does not
5471472d	116	touch any hierarchies but its
06d4c99a LP	117	own.</para></listitem>
06d4c99a LP	118	</varlistentry>
0c85a4f3 LP	119
0c85a4f3 LP	120	<varlistentry>
be5412d8	121	<term><varname>JoinControllers=cpu,cpuacct,cpuset net_cls,netprio</varname></term>
0c85a4f3 LP	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
49f43d5f	128	hierarchies, with the exception of
0c85a4f3 LP	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
e5e991a1 LP	137	hierarchies.</para>
	138
	139	<para>Note that this option is only
	140	applied once, at very early boot. If
	141	you use an initial RAM disk (initrd)
	142	that uses systemd it might hence be
	143	necessary to rebuild the initrd if
	144	this option is changed, and make sure
	145	the new configuration file is included
	146	in it. Otherwise the initrd might
	147	mount the controllers in different
	148	configuration than intended, and the
	149	main system cannot remount them
	150	anymore.</para></listitem>
0c85a4f3	151	</varlistentry>
e96d6be7 LP	152
	153	<varlistentry>
	154	<term><varname>RuntimeWatchdogSec=</varname></term>
	155	<term><varname>ShutdownWatchdogSec=</varname></term>
	156
	157	<listitem><para>Configure the hardware
	158	watchdog at runtime and at
	159	reboot. Takes a timeout value in
	160	seconds (or in other time units if
	161	suffixed with <literal>ms</literal>,
	162	<literal>min</literal>,
	163	<literal>h</literal>,
	164	<literal>d</literal>,
	165	<literal>w</literal>). If
	166	<varname>RuntimeWatchdogSec=</varname>
	167	is set to a non-zero value the
	168	watchdog hardware
	169	(<filename>/dev/watchdog</filename>)
	170	will be programmed to automatically
	171	reboot the system if it is not
	172	contacted within the specified timeout
	173	interval. The system manager will
	174	ensure to contact it at least once in
	175	half the specified timeout
	176	interval. This feature requires a
	177	hardware watchdog device to be
	178	present, as it is commonly the case in
	179	embedded and server systems. Not all
	180	hardware watchdogs allow configuration
	181	of the reboot timeout, in which case
	182	the closest available timeout is
	183	picked. <varname>ShutdownWatchdogSec=</varname>
	184	may be used to configure the hardware
	185	watchdog when the system is asked to
	186	reboot. It works as a safety net to
	187	ensure that the reboot takes place
	188	even if a clean reboot attempt times
	189	out. By default
	190	<varname>RuntimeWatchdogSec=</varname>
	191	defaults to 0 (off), and
	192	<varname>ShutdownWatchdogSec=</varname>
	193	to 10min. These settings have no
	194	effect if a hardware watchdog is not
	195	available.</para></listitem>
	196	</varlistentry>
c93ff2e9	197
ec8927ca LP	198	<varlistentry>
	199	<term><varname>CapabilityBoundingSet=</varname></term>
	200
	201	<listitem><para>Controls which
	202	capabilities to include in the
	203	capability bounding set for PID 1 and
	204	its children. See
	205	<citerefentry><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
	206	for details. Takes a whitespace
	207	separated list of capability names as
	208	read by
	209	<citerefentry><refentrytitle>cap_from_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
	210	Capabilities listed will be included
	211	in the bounding set, all others are
	212	removed. If the list of capabilities
	213	is prefixed with ~ all but the listed
	214	capabilities will be included, the
	215	effect of the assignment
	216	inverted. Note that this option also
bb31a4ac	217	affects the respective capabilities in
ec8927ca LP	218	the effective, permitted and
	219	inheritable capability sets. The
	220	capability bounding set may also be
	221	individually configured for units
	222	using the
	223	<varname>CapabilityBoundingSet=</varname>
	224	directive for units, but note that
	225	capabilities dropped for PID 1 cannot
	226	be regained in individual units, they
	227	are lost for good.</para></listitem>
	228	</varlistentry>
	229
aa0f64ac LP	230	<varlistentry>
	231	<term><varname>TimerSlackNSec=</varname></term>
	232
	233	<listitem><para>Sets the timer slack
	234	in nanoseconds for PID 1 which is then
	235	inherited to all executed processes,
bb31a4ac	236	unless overridden individually, for
aa0f64ac LP	237	example with the
	238	<varname>TimerSlackNSec=</varname>
	239	setting in service units (for details
	240	see
	241	<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>). The
	242	timer slack controls the accuracy of
	243	wake-ups triggered by timers. See
	244	<citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
	245	for more information. Note that in
	246	contrast to most other time span
	247	definitions this parameter takes an
	248	integer value in nano-seconds if no
	249	unit is specified. The usual time
	250	units are understood
	251	too.</para></listitem>
	252	</varlistentry>
	253
c93ff2e9 FC	254	<varlistentry>
	255	<term><varname>DefaultLimitCPU=</varname></term>
	256	<term><varname>DefaultLimitFSIZE=</varname></term>
	257	<term><varname>DefaultLimitDATA=</varname></term>
	258	<term><varname>DefaultLimitSTACK=</varname></term>
	259	<term><varname>DefaultLimitCORE=</varname></term>
	260	<term><varname>DefaultLimitRSS=</varname></term>
	261	<term><varname>DefaultLimitNOFILE=</varname></term>
	262	<term><varname>DefaultLimitAS=</varname></term>
	263	<term><varname>DefaultLimitNPROC=</varname></term>
	264	<term><varname>DefaultLimitMEMLOCK=</varname></term>
	265	<term><varname>DefaultLimitLOCKS=</varname></term>
	266	<term><varname>DefaultLimitSIGPENDING=</varname></term>
	267	<term><varname>DefaultLimitMSGQUEUE=</varname></term>
	268	<term><varname>DefaultLimitNICE=</varname></term>
	269	<term><varname>DefaultLimitRTPRIO=</varname></term>
	270	<term><varname>DefaultLimitRTTIME=</varname></term>
ec8927ca	271
c93ff2e9	272	<listitem><para>These settings control
ec8927ca LP	273	various default resource limits for
ec8927ca LP	274	units. See
c93ff2e9 FC	275	<citerefentry><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry>
	276	for details. Use the string
	277	<varname>infinity</varname> to
	278	configure no limit on a specific
ec8927ca	279	resource. These settings may be
bb31a4ac	280	overridden in individual units
ec8927ca LP	281	using the corresponding LimitXXX=
	282	directives. Note that these resource
	283	limits are only defaults for units,
	284	they are not applied to PID 1
	285	itself.</para></listitem>
c93ff2e9	286	</varlistentry>
f3e219a2 LP	287	</variablelist>
	288	</refsect1>
	289
	290	<refsect1>
	291	<title>See Also</title>
	292	<para>
	293	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
	294	</para>
	295	</refsect1>
	296
	297	</refentry>