source: clfs-sysroot/BOOK/final-system/common/module-init-tools.xml@ 10d6394

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;
]>

<sect1 id="ch-system-module-init-tools" role="wrap">
  <?dbhtml filename="module-init-tools.html"?>

  <title>Module-Init-Tools-&module-init-tools-version;</title>

  <indexterm zone="ch-system-module-init-tools">
    <primary sortas="a-Module-Init-Tools">Module-Init-Tools</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>The Module-Init-Tools package contains programs for handling kernel
    modules in Linux kernels greater than or equal to version 2.5.47.</para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Module-Init-Tools</title>

    <para os="a">Prepare Module-Init-Tools for compilation:</para>

<screen os="b"><userinput>./configure --build=${CLFS_HOST} --host=${CLFS_TARGET} \
    --prefix=/ --enable-zlib</userinput></screen>

    <variablelist os="c">
      <title>The meaning of the configure options:</title>

      <varlistentry>
        <term><parameter>--enable-zlib</parameter></term>
        <listitem>
          <para>This allows the Module-Init-Tools package to handle compressed
          kernel modules.</para>
        </listitem>
      </varlistentry>

    </variablelist>

    <para os="d">Compile the package:</para>

<screen os="e"><userinput>make</userinput></screen>

    <para os="f">Install the package:</para>

<screen os="g"><userinput>make DESTDIR=${CLFS} INSTALL=install install</userinput></screen>

    <variablelist os="h">
      <title>The meaning of the make parameter:</title>
      <varlistentry>
        <term><parameter>INSTALL=install</parameter></term>
        <listitem>
          <para>Normally, make install will not install the binaries if they
          already exist. This option overrides that behavior by calling
          <command>install</command> instead of using the default wrapper
          script.</para>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

  <sect2 id="contents-module-init-tools" role="content">
    <title>Contents of Module-Init-Tools</title>

    <segmentedlist>
      <segtitle>Installed programs</segtitle>

      <seglistitem>
        <seg>depmod, generate-modprobe.conf, insmod, insmod.static,
        lsmod (link to insmod), modinfo, modprobe (link to insmod), and
        rmmod (link to insmod)</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="depmod">
        <term><command>depmod</command></term>
        <listitem>
          <para>Creates a dependency file based on the symbols it finds in
          the existing set of modules; this dependency file is used by
          <command>modprobe</command> to automatically load the required
          modules</para>
          <indexterm zone="ch-system-module-init-tools depmod">
            <primary sortas="b-depmod">depmod</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="generate-modprobe.conf">
        <term><command>generate-modprobe.conf</command></term>
        <listitem>
          <para>Creates a modprobe.conf file from an existing 2.2 or 2.4
          module setup</para>
          <indexterm zone="ch-system-module-init-tools generate-modprobe.conf">
            <primary sortas="b-generate-modprobe.conf">generate-modprobe.conf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="insmod">
        <term><command>insmod</command></term>
        <listitem>
          <para>Installs a loadable module in the running kernel</para>
          <indexterm zone="ch-system-module-init-tools insmod">
            <primary sortas="b-insmod">insmod</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="insmod.static">
        <term><command>insmod.static</command></term>
        <listitem>
          <para>A statically compiled version of <command>insmod</command></para>
          <indexterm zone="ch-system-module-init-tools insmod.static">
            <primary sortas="b-insmod.static">insmod.static</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lsmod">
        <term><command>lsmod</command></term>
        <listitem>
          <para>Lists currently loaded modules</para>
          <indexterm zone="ch-system-module-init-tools lsmod">
            <primary sortas="b-lsmod">lsmod</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="modinfo">
        <term><command>modinfo</command></term>
        <listitem>
          <para>Examines an object file associated with a kernel module and
          displays any information that it can glean</para>
          <indexterm zone="ch-system-module-init-tools modinfo">
            <primary sortas="b-modinfo">modinfo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="modprobe">
        <term><command>modprobe</command></term>
        <listitem>
          <para>Uses a dependency file, created by <command>depmod</command>,
          to automatically load relevant modules</para>
          <indexterm zone="ch-system-module-init-tools modprobe">
            <primary sortas="b-modprobe">modprobe</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rmmod">
        <term><command>rmmod</command></term>
        <listitem>
          <para>Unloads modules from the running kernel</para>
          <indexterm zone="ch-system-module-init-tools rmmod">
            <primary sortas="b-rmmod">rmmod</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>