source: chapter06/module-init-tools.xml@ 462a903

<?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">
  <!ENTITY % patches-entities SYSTEM "../patches.ent">
  %general-entities;
  %patches-entities;
]>
<sect1 id="ch-system-module-init-tools" role="wrap">
<title>Module-Init-Tools-&module-init-tools-version;</title>
<?dbhtml filename="module-init-tools.html"?>

<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>

<segmentedlist>
<segtitle>&buildtime;</segtitle>
<segtitle>&diskspace;</segtitle>
<seglistitem><seg>0.1 SBU</seg><seg>4.9 MB</seg></seglistitem>
</segmentedlist>

<segmentedlist>
<segtitle>&dependencies;</segtitle>
<seglistitem><seg>Bash, Binutils, Bison,
Coreutils, Diffutils, Flex, GCC, Glibc, Grep, M4, Make, and Sed</seg></seglistitem>
</segmentedlist>
</sect2>

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

<para>Module-Init-Tools attempts to rewrite its
<filename>modprobe.conf</filename> man page during the build process. This is
unnecessary and also relies on <command>docbook2man</command> &mdash; which is not
installed in LFS. Run the following command to avoid this:</para>

<screen><userinput>touch modprobe.conf.5</userinput></screen>

<para>If you wish to run the test suite for Module-Init-Tools, you will need to
download the separate testsuite tarball.  Issue the following commands to
perform the tests (note that the <command>make distclean</command> command is
required to clean up the source tree, as the source gets recompiled as part of
the testing process):</para>

<screen><userinput>tar -xvf ../module-init-tools-testsuite-&module-init-tools-version;.tar.bz2 &amp;&amp;
./configure &amp;&amp;
make check &amp;&amp;
make distclean</userinput></screen>

<para>Prepare Module-Init-Tools for compilation:</para>

<screen><userinput>./configure --prefix="" --enable-zlib</userinput></screen>

<para>The meaning of the configure options:</para>

<variablelist>
<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>Compile the package:</para>

<screen><userinput>make</userinput></screen>

<para>Install the package:</para>

<screen><userinput>make install</userinput></screen>

</sect2>


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

<segmentedlist>
<segtitle>Installed programs</segtitle>
<seglistitem><seg>depmod, 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="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>