chiark / gitweb /
units: networkd - fix busname to work on kdbus
[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 kernel
60     modules to load during boot in a static list. Each configuration
61     file is named in the style of
62     <filename>/etc/modules-load.d/<replaceable>program</replaceable>.conf</filename>.
63     Note that it is usually a better idea to rely on the automatic
64     module loading by PCI IDs, USB IDs, DMI IDs or similar triggers
65     encoded in the kernel modules themselves instead of static
66     configuration like this. In fact, most modern kernel modules are
67     prepared for automatic loading already.</para>
68   </refsect1>
69
70   <refsect1>
71     <title>Configuration Format</title>
72
73     <para>The configuration files should simply contain a list of
74     kernel module names to load, separated by newlines. Empty lines
75     and lines whose first non-whitespace character is # or ; are
76     ignored.</para>
77   </refsect1>
78
79   <xi:include href="standard-conf.xml" xpointer="confd" />
80
81   <refsect1>
82     <title>Example</title>
83     <example>
84       <title>/etc/modules-load.d/virtio-net.conf example:</title>
85
86       <programlisting># Load virtio-net.ko at boot
87 virtio-net</programlisting>
88     </example>
89   </refsect1>
90
91   <refsect1>
92     <title>See Also</title>
93     <para>
94       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
95       <citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
96       <citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
97       <citerefentry><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry>
98     </para>
99   </refsect1>
100
101 </refentry>