chiark / gitweb /
include <poll.h> instead of <sys/poll.h>
[elogind.git] / man / modules-load.d.xml
index 47acc08e63541668822f24aa54c66d76b03fbe8b..34a937db68b6cfafedb3b547f1ab3539c3140368 100644 (file)
@@ -4,92 +4,98 @@
 <!--
   This file is part of systemd.
 
-  Copyright 2010 Brandon Philips
+  Copyright 2011 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it
-  under the terms of the GNU General Public License as published by
-  the Free Software Foundation; either version 2 of the License, or
+  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
-  General Public License for more details.
+  Lesser General Public License for more details.
 
-  You should have received a copy of the GNU General Public License
+  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="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>
-        </refsynopsisdiv>
-
-        <refsect1>
-                <title>Description</title>
-
-               <para><command>systemd</command> uses
-               <filename>/etc/modules-load.d/</filename> to configure
-               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 usally a better idea to use the automatic
-               module loading by PCI ID, by DMI ID or similar
-               triggers configured in the kernel modules themselves
-               instead of relying on static configuration like
-               this.</para>
-        </refsect1>
-
-        <refsect1>
-               <title>Configuration Format</title>
-
-               <para>The configuration files should simply contain a
-               list of kernel modul names to load, seperated by
-               newlines. Empty lines and lines whose first
-               non-whitespace character is # or ; are ignored.</para>
-
-        </refsect1>
-
-        <refsect1>
-                <title>Example</title>
-                <example>
-                        <title>/etc/modules-load.d/uinput.conf example:</title>
-
-                        <programlisting># Load uinput.ko at boot
-uinput</programlisting>
-                </example>
-        </refsect1>
-
-        <refsect1>
-                <title>See Also</title>
-                <para>
-                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-                </para>
-        </refsect1>
+<refentry id="modules-load.d" conditional='HAVE_KMOD'
+    xmlns:xi="http://www.w3.org/2001/XInclude">
+
+  <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>
+    <para><filename>/run/modules-load.d/*.conf</filename></para>
+    <para><filename>/usr/lib/modules-load.d/*.conf</filename></para>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <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/<replaceable>program</replaceable>.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>
+  </refsect1>
+
+  <refsect1>
+    <title>Configuration Format</title>
+
+    <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>
+  </refsect1>
+
+  <xi:include href="standard-conf.xml" xpointer="confd" />
+
+  <refsect1>
+    <title>Example</title>
+    <example>
+      <title>/etc/modules-load.d/virtio-net.conf example:</title>
+
+      <programlisting># Load virtio-net.ko at boot
+virtio-net</programlisting>
+    </example>
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+    <para>
+      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+    </para>
+  </refsect1>
 
 </refentry>