man: document /etc/modules-load.d/

[elogind.git] / man / modules-load.d.xml

diff --git a/man/modules-load.d.xml b/man/modules-load.d.xml
new file mode 100644 (file)
index 0000000..47acc08
--- /dev/null
+++ b/man/modules-load.d.xml
@@ -0,0 +1,95 @@
+<?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.
+
+  Copyright 2010 Brandon Philips
+
+  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
+  (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.
+
+  You should have received a copy of the GNU 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>