summaryrefslogtreecommitdiffstats
path: root/man/systemd-sysctl.service.xml
blob: 686b2cdef43bd66d1fbc963a7bec128733522b23 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<?xml version="1.0"?>
<!--*-nxml-*-->
<!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 2012 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-sysctl.service"
    xmlns:xi="http://www.w3.org/2001/XInclude">

  <refentryinfo>
    <title>systemd-sysctl.service</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-sysctl.service</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>systemd-sysctl.service</refname>
    <refname>systemd-sysctl</refname>
    <refpurpose>Configure kernel parameters at boot</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>/usr/lib/systemd/systemd-sysctl</command>
      <arg choice="opt" rep="repeat">OPTIONS</arg>
      <arg choice="opt" rep="repeat"><replaceable>CONFIGFILE</replaceable></arg>
    </cmdsynopsis>
    <para><filename>systemd-sysctl.service</filename></para>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><filename>systemd-sysctl.service</filename> is an early boot
    service that configures
    <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
    kernel parameters by invoking <command>/usr/lib/systemd/systemd-sysctl</command>.</para>

    <para>When invoked with no arguments, <command>/usr/lib/systemd/systemd-sysctl</command> applies
    all directives from configuration files listed in
    <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
    If one or more filenames are passed on the command line, only the directives in these files are
    applied.</para>

    <para>In addition, <option>--prefix=</option> option may be used to limit which sysctl
    settings are applied.</para>

    <para>See
    <citerefentry project='man-pages'><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
    for information about the configuration of sysctl settings. After sysctl configuration is
    changed on disk, it must be written to the files in <filename>/proc/sys</filename> before it
    takes effect. It is possible to update specific settings, or simply to reload all configuration,
    see Examples below.</para>
  </refsect1>

  <refsect1><title>Options</title>
    <variablelist>
      <varlistentry id='prefix'>
        <term><option>--prefix=</option></term>
        <listitem>
          <para>Only apply rules with the specified prefix.</para>
        </listitem>
      </varlistentry>

      <xi:include href="standard-options.xml" xpointer="help" />
      <xi:include href="standard-options.xml" xpointer="version" />

    </variablelist>
  </refsect1>

  <refsect1>
    <title>Examples</title>

    <example>
      <title>Reset all sysctl settings</title>

      <programlisting>systemctl restart systemd-sysctl</programlisting>
    </example>

    <example>
      <title>View coredump handler configuration</title>

      <programlisting># sysctl kernel.core_pattern
kernel.core_pattern = |/usr/libexec/abrt-hook-ccpp %s %c %p %u %g %t %P %I
</programlisting>
    </example>

    <example>
      <title>Update coredump handler configuration</title>

      <programlisting># /usr/lib/systemd/systemd-sysctl --prefix kernel.core_pattern</programlisting>

      <para>This searches all the directories listed in
      <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
      for configuration files and writes <filename>/proc/sys/kernel/core_pattern</filename>.</para>
    </example>

    <example>
      <title>Update coredump handler configuration according to a specific file</title>

      <programlisting># /usr/lib/systemd/systemd-sysctl 50-coredump.conf</programlisting>

      <para>This applies all the settings found in <filename>50-coredump.conf</filename>.
      Either <filename>/etc/sysctl.d/50-coredump.conf</filename>, or
      <filename>/run/sysctl.d/50-coredump.conf</filename>, or
      <filename>/usr/lib/sysctl.d/50-coredump.conf</filename> will be used, in the order
      of preference.</para>
    </example>

    <para>See
    <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
    for various ways to directly apply sysctl settings.</para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry project='man-pages'><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
      <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
    </para>
  </refsect1>

</refentry>