lfs-book/chapter06/module-init-tools.xml

<?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">
<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>650 KB</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>Prepare Module-Init-Tools for compilation:</para>

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

<para>Compile the package:</para>

<screen><userinput>make DOCBOOKTOMAN=""</userinput></screen>

<!-- Edit me -->
<para>The <envar>DOCBOOKTOMAN</envar> option allows the compile process to
complete without regenerating the man pages.</para>

<para>To test the results, issue:
<userinput>make check</userinput>.</para>

<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, genksyms, insmod,
insmod_ksymoops_clean, kallsyms (link to insmod), kernelversion, ksyms
(link to insmod), 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="genksyms">
<term><command>genksyms</command></term>
<listitem>
<para>Generates symbol version information</para>
<indexterm zone="ch-system-module-init-tools genksyms"><primary sortas="b-genksyms">genksyms</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_ksymoops_clean">
<term><command>insmod_ksymoops_clean</command></term>
<listitem>
<para>Deletes saved ksyms and modules not accessed for two days</para>
<indexterm zone="ch-system-module-init-tools insmod_ksymoops_clean"><primary sortas="b-insmod_ksymoops_clean">insmod_ksymoops_clean</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="kallsyms">
<term><command>kallsyms</command></term>
<listitem>
<para>Extracts all kernel symbols for debugging</para>
<indexterm zone="ch-system-module-init-tools kallsyms"><primary sortas="b-kallsyms">kallsyms</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="kernelversion">
<term><command>kernelversion</command></term>
<listitem>
<para>Reports the major version of the running kernel</para>
<indexterm zone="ch-system-module-init-tools kernelversion"><primary sortas="b-kernelversion">kernelversion</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="ksyms">
<term><command>ksyms</command></term>
<listitem>
<para>Displays exported kernel symbols</para>
<indexterm zone="ch-system-module-init-tools ksyms"><primary sortas="b-ksyms">ksyms</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>