chiark / gitweb /
sysctl.d, binfmt.d, modules-load.d: switch to stacked config dirs in /lib, /etc,...
[elogind.git] / man / modules-load.d.xml
1 <?xml version="1.0"?>
2 <!--*-nxml-*-->
3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!--
5   This file is part of systemd.
6
7   Copyright 2011 Lennart Poettering
8
9   systemd is free software; you can redistribute it and/or modify it
10   under the terms of the GNU General Public License as published by
11   the Free Software Foundation; either version 2 of the License, or
12   (at your option) any later version.
13
14   systemd is distributed in the hope that it will be useful, but
15   WITHOUT ANY WARRANTY; without even the implied warranty of
16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17   General Public License for more details.
18
19   You should have received a copy of the GNU General Public License
20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
21 -->
22 <refentry id="modules-load.d">
23
24         <refentryinfo>
25                 <title>modules-load.d</title>
26                 <productname>systemd</productname>
27
28                 <authorgroup>
29                         <author>
30                                 <contrib>Developer</contrib>
31                                 <firstname>Lennart</firstname>
32                                 <surname>Poettering</surname>
33                                 <email>lennart@poettering.net</email>
34                         </author>
35                 </authorgroup>
36         </refentryinfo>
37
38         <refmeta>
39                 <refentrytitle>modules-load.d</refentrytitle>
40                 <manvolnum>5</manvolnum>
41         </refmeta>
42
43         <refnamediv>
44                 <refname>modules-load.d</refname>
45                 <refpurpose>Configure kernel modules to load at boot</refpurpose>
46         </refnamediv>
47
48         <refsynopsisdiv>
49                 <para><filename>/usr/lib/modules-load.d/*.conf</filename></para>
50                 <para><filename>/etc/modules-load.d/*.conf</filename></para>
51                 <para><filename>/run/modules-load.d/*.conf</filename></para>
52         </refsynopsisdiv>
53
54         <refsect1>
55                 <title>Description</title>
56
57                 <para><command>systemd</command> uses
58                 files from the above directories to configure
59                 kernel modules to load during boot in a static list.
60                 Each configuration file is named in the style of
61                 <filename>/etc/modules-load.d/&lt;program&gt;.conf</filename>. Note
62                 that it is usually a better idea to use the automatic
63                 module loading by PCI ID, by DMI ID or similar
64                 triggers configured in the kernel modules themselves
65                 instead of relying on static configuration like
66                 this.</para>
67         </refsect1>
68
69         <refsect1>
70                 <title>Configuration Format</title>
71
72                 <para>The configuration files should simply contain a
73                 list of kernel module names to load, separated by
74                 newlines. Empty lines and lines whose first
75                 non-whitespace character is # or ; are ignored.</para>
76
77                 <para>Files in <filename>/etc/</filename> overwrite
78                 files with the same name in <filename>/usr/lib/</filename>.
79                 Files in <filename>/run</filename> overwrite files with
80                 the same name in <filename>/etc/</filename> and
81                 <filename>/usr/lib/</filename>. Packages should install their
82                 configuration files in <filename>/usr/lib/</filename>, files
83                 in <filename>/etc/</filename> are reserved for the local
84                 administration, which possibly decides to overwrite the
85                 configurations installed from packages. All files are sorted
86                 by filename in alphabetical order, regardless in which of the
87                 directories they reside, to ensure that a specific
88                 configuration file takes precedence over another file with
89                 an alphabetically later name.</para>
90         </refsect1>
91
92         <refsect1>
93                 <title>Example</title>
94                 <example>
95                         <title>/etc/modules-load.d/virtio-net.conf example:</title>
96
97                         <programlisting># Load virtio-net.ko at boot
98 virtio-net</programlisting>
99                 </example>
100         </refsect1>
101
102         <refsect1>
103                 <title>See Also</title>
104                 <para>
105                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
106                         <citerefentry><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry>
107                 </para>
108         </refsect1>
109
110 </refentry>