source: chapter06/module-init-tools.xml@ 835892c

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE section [
  <!ENTITY % general-entities SYSTEM "../general.ent">
  %general-entities;
]>
<section xmlns="http://docbook.org/docbook-ng"
         xml:id="ch-system-module-init-tools"
         xreflabel="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>

<section 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>Module-Init-Tools installation depends on</segtitle>
<seglistitem><seg>Bash, Binutils, Bison,
Coreutils, Diffutils, Flex, GCC, Glibc, Grep, M4, Make, Sed</seg></seglistitem>
</segmentedlist>
</section>

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

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

<para>Install it:</para>

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

</section>


<section xml: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><title>Short descriptions</title>

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

<varlistentry xml:id="genksyms">
<term><command>genksyms</command></term>
<listitem>
<indexterm zone="ch-system-module-init-tools genksyms"><primary sortas="b-genksyms">genksyms</primary></indexterm>
<para>generates symbol version information.</para>
</listitem>
</varlistentry>

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

<varlistentry xml:id="insmod_ksymoops_clean">
<term><command>insmod_ksymoops_clean</command></term>
<listitem>
<indexterm zone="ch-system-module-init-tools insmod_ksymoops_clean"><primary sortas="b-insmod_ksymoops_clean">insmod_ksymoops_clean</primary></indexterm>
<para>deletes saved ksyms and modules not accessed for two days.</para>
</listitem>
</varlistentry>

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

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

<varlistentry xml:id="ksyms">
<term><command>ksyms</command></term>
<listitem>
<indexterm zone="ch-system-module-init-tools ksyms"><primary sortas="b-ksyms">ksyms</primary></indexterm>
<para>displays exported kernel symbols.</para>
</listitem>
</varlistentry>

<varlistentry xml:id="lsmod">
<term><command>lsmod</command></term>
<listitem>
<indexterm zone="ch-system-module-init-tools lsmod"><primary sortas="b-lsmod">lsmod</primary></indexterm>
<para>shows which modules are loaded.</para>
</listitem>
</varlistentry>

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

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

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

</section>

</section>