chiark / gitweb /
Add (void) where we don't care about return value
[elogind.git] / man / modules-load.d.xml
index ea4f524048c79cbfa07c42c8d16c2dc408c4e29b..4b722aa12855c6cdcf99500a27174f08c2c2d1c9 100644 (file)
   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" conditional='HAVE_KMOD'>
-
-        <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/&lt;program&gt;.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>
-
-                <para>Each configuration file shall be named in the
-                style of <filename>&lt;program&gt;.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 file name.</para>
-        </refsect1>
-
-        <refsect1>
-                <title>Example</title>
-                <example>
-                        <title>/etc/modules-load.d/virtio-net.conf example:</title>
-
-                        <programlisting># Load virtio-net.ko at boot
+<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>
+    </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 project='man-pages'><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+    </para>
+  </refsect1>
 
 </refentry>