chiark / gitweb /
networkd: support vxlan parameters
[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 Lesser General Public License as published by
11   the Free Software Foundation; either version 2.1 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   Lesser General Public License for more details.
18
19   You should have received a copy of the GNU Lesser General Public License
20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
21 -->
22 <refentry id="modules-load.d" conditional='HAVE_KMOD'
23           xmlns:xi="http://www.w3.org/2001/XInclude">
24
25         <refentryinfo>
26                 <title>modules-load.d</title>
27                 <productname>systemd</productname>
28
29                 <authorgroup>
30                         <author>
31                                 <contrib>Developer</contrib>
32                                 <firstname>Lennart</firstname>
33                                 <surname>Poettering</surname>
34                                 <email>lennart@poettering.net</email>
35                         </author>
36                 </authorgroup>
37         </refentryinfo>
38
39         <refmeta>
40                 <refentrytitle>modules-load.d</refentrytitle>
41                 <manvolnum>5</manvolnum>
42         </refmeta>
43
44         <refnamediv>
45                 <refname>modules-load.d</refname>
46                 <refpurpose>Configure kernel modules to load at boot</refpurpose>
47         </refnamediv>
48
49         <refsynopsisdiv>
50                 <para><filename>/etc/modules-load.d/*.conf</filename></para>
51                 <para><filename>/run/modules-load.d/*.conf</filename></para>
52                 <para><filename>/usr/lib/modules-load.d/*.conf</filename></para>
53         </refsynopsisdiv>
54
55         <refsect1>
56                 <title>Description</title>
57
58                 <para><citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
59                 reads files from the above directories which contain
60                 kernel modules to load during boot in a static list.
61                 Each configuration file is named in the style of
62                 <filename>/etc/modules-load.d/<replaceable>program</replaceable>.conf</filename>. Note
63                 that it is usually a better idea to rely on the
64                 automatic module loading by PCI IDs, USB IDs, DMI IDs
65                 or similar triggers encoded in the kernel modules
66                 themselves instead of static configuration like
67                 this. In fact, most modern kernel modules are prepared
68                 for automatic loading already.</para>
69         </refsect1>
70
71         <refsect1>
72                 <title>Configuration Format</title>
73
74                 <para>The configuration files should simply contain a
75                 list of kernel module names to load, separated by
76                 newlines. Empty lines and lines whose first
77                 non-whitespace character is # or ; are ignored.</para>
78         </refsect1>
79
80         <xi:include href="standard-conf.xml" xpointer="confd" />
81
82         <refsect1>
83                 <title>Example</title>
84                 <example>
85                         <title>/etc/modules-load.d/virtio-net.conf example:</title>
86
87                         <programlisting># Load virtio-net.ko at boot
88 virtio-net</programlisting>
89                 </example>
90         </refsect1>
91
92         <refsect1>
93                 <title>See Also</title>
94                 <para>
95                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
96                         <citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
97                         <citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
98                         <citerefentry><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry>
99                 </para>
100         </refsect1>
101
102 </refentry>