chiark / gitweb /
man: document $MAINPID
[elogind.git] / man / modules-load.d.xml
index e2f7d5c..33c466f 100644 (file)
@@ -7,19 +7,19 @@
   Copyright 2011 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it
   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
   (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/>.
 -->
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
-<refentry id="modules-load.d">
+<refentry id="modules-load.d" conditional='HAVE_KMOD'>
 
         <refentryinfo>
                 <title>modules-load.d</title>
 
         <refentryinfo>
                 <title>modules-load.d</title>
         <refsect1>
                 <title>Description</title>
 
         <refsect1>
                 <title>Description</title>
 
-               <para><command>systemd</command> uses
-               files from the above directories 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 usually 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>
+                <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>
         </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>
-
-                <para>Each configuration file is named in the style of
-                <filename>&lt;program&gt;.conf</filename>.
-                Files in <filename>/etc/</filename> overwrite
-                files with the same name in <filename>/usr/lib/</filename>.
-                Files in <filename>/run</filename> overwrite files with
-                the same name in <filename>/etc/</filename> and
-                <filename>/usr/lib/</filename>. Packages should install their
-                configuration files in <filename>/usr/lib/</filename>, files
-                in <filename>/etc/</filename> are reserved for the local
-                administration, which possibly decides to overwrite the
-                configurations installed from packages. All files are sorted
-                by filename in alphabetical order, regardless in which of the
-                directories they reside, to ensure that a specific
-                configuration file takes precedence over another file with
-                an alphabetically later name.</para>
+                <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>
+
+                <para>Each configuration file shall be named in the
+                style of <filename><replaceable>program</replaceable>.conf</filename>.
+                Files in <filename>/etc/</filename> override files
+                with the same name in <filename>/usr/lib/</filename>
+                and <filename>/run/</filename>. Files in
+                <filename>/run/</filename> override files with the
+                same name in <filename>/usr/lib/</filename>. Packages
+                should install their configuration files in
+                <filename>/usr/lib/</filename>, files in
+                <filename>/etc/</filename> are reserved for the local
+                administrator, who may use this logic to override the
+                configuration files installed from vendor
+                packages.</para>
+
+                <para>If the administrator wants to disable a
+                configuration file supplied by the vendor, the
+                recommended way is to place a symlink to
+                <filename>/dev/null</filename> in
+                <filename>/etc/modules-load.d/</filename> bearing the
+                same filename.</para>
         </refsect1>
 
         <refsect1>
         </refsect1>
 
         <refsect1>
@@ -105,6 +111,8 @@ virtio-net</programlisting>
                 <title>See Also</title>
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                 <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>
                         <citerefentry><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                 </para>
         </refsect1>