update TODO

[thirdparty/systemd.git] / man / modules-load.d.xml

<?xml version="1.0"?>
<!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
<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>
  </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><simplelist>
      <member><filename>/etc/modules-load.d/*.conf</filename></member>
      <member><filename>/run/modules-load.d/*.conf</filename></member>
      <member><filename>/usr/lib/modules-load.d/*.conf</filename></member>
    </simplelist></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><simplelist type="inline">
      <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
      <member><citerefentry project='man-pages'><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
    </simplelist></para>
  </refsect1>

</refentry>