modules-load.d.xml 5.27 KB
Newer Older
1 2 3 4 5 6
<?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.

7
  Copyright 2011 Lennart Poettering
8 9

  systemd is free software; you can redistribute it and/or modify it
10 11
  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
12 13 14 15 16
  (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
17
  Lesser General Public License for more details.
18

19
  You should have received a copy of the GNU Lesser General Public License
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
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="modules-load.d">

        <refentryinfo>
                <title>modules-load.d</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>modules-load.d</refentrytitle>
                <manvolnum>5</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>modules-load.d</refname>
                <refpurpose>Configure kernel modules to load at boot</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <para><filename>/etc/modules-load.d/*.conf</filename></para>
50
                <para><filename>/run/modules-load.d/*.conf</filename></para>
51
                <para><filename>/usr/lib/modules-load.d/*.conf</filename></para>
52 53 54 55 56
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

57 58 59 60 61 62 63 64 65 66 67
                <para><citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                reads files from the above directories which contain
                kernel modules to load during boot in a static list.
                Each configuration file is named in the style of
                <filename>/etc/modules-load.d/&lt;program&gt;.conf</filename>. Note
                that it is usually a better idea to rely on the
                automatic module loading by PCI IDs, USB IDs, DMI IDs
                or similar triggers encoded in the kernel modules
                themselves instead of static configuration like
                this. In fact, most modern kernel modules are prepared
                for automatic loading already.</para>
68 69 70
        </refsect1>

        <refsect1>
71
                <title>Configuration Format</title>
72

73 74 75 76
                <para>The configuration files should simply contain a
                list of kernel module names to load, separated by
                newlines. Empty lines and lines whose first
                non-whitespace character is # or ; are ignored.</para>
77

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
                <para>Each configuration file shall be named in the
                style of <filename>&lt;program&gt;.conf</filename>.
                Files in <filename>/etc/</filename> override files
                with the same name in <filename>/usr/lib/</filename>
                and <filename>/run/</filename>. Files in
                <filename>/run/</filename> override files with the
                same name in <filename>/usr/lib/</filename>. Packages
                should install their configuration files in
                <filename>/usr/lib/</filename>, files in
                <filename>/etc/</filename> are reserved for the local
                administrator, who may use this logic to override the
                configuration files installed from vendor
                packages.</para>

                <para>If the administrator wants to disable a
                configuration file supplied by the vendor the
                recommended way is to place a symlink to
                <filename>/dev/null</filename> in
                <filename>/etc/modules-load.d/</filename> bearing the
                same file name.</para>
98 99 100 101 102
        </refsect1>

        <refsect1>
                <title>Example</title>
                <example>
103
                        <title>/etc/modules-load.d/virtio-net.conf example:</title>
104

105 106
                        <programlisting># Load virtio-net.ko at boot
virtio-net</programlisting>
107 108 109 110 111 112 113
                </example>
        </refsect1>

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
114 115
                        <citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
116 117 118 119 120
                        <citerefentry><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>