BOOK/chapter06/module-init-tools.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   4   <!ENTITY % general-entities SYSTEM "../general.ent">
   5   %general-entities;
   6 ]>
   7
   8 <sect1 id="ch-system-module-init-tools" role="wrap">
   9   <?dbhtml filename="module-init-tools.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>module-init-tools</productname>
  13     <productnumber>&module-init-tools-version;</productnumber>
  14     <address>&module-init-tools-url;</address>
  15   </sect1info>
  16
  17   <title>Module-Init-Tools-&module-init-tools-version;</title>
  18
  19   <indexterm zone="ch-system-module-init-tools">
  20     <primary sortas="a-Module-Init-Tools">Module-Init-Tools</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The Module-Init-Tools package contains programs for handling kernel
  27     modules in Linux kernels greater than or equal to version 2.5.47.</para>
  28
  29     <segmentedlist>
  30       <segtitle>&buildtime;</segtitle>
  31       <segtitle>&diskspace;</segtitle>
  32
  33       <seglistitem>
  34         <seg>&module-init-tools-ch6-sbu;</seg>
  35         <seg>&module-init-tools-ch6-du;</seg>
  36       </seglistitem>
  37     </segmentedlist>
  38
  39   </sect2>
  40
  41   <sect2 role="installation">
  42     <title>Installation of Module-Init-Tools</title>
  43
  44     <para>Apply a patch that contains the generated man pages that were missing
  45     from the released source tarball:</para>
  46
  47 <screen><userinput remap="pre">patch -Np1 -i ../&module-init-tools-man-patch;</userinput></screen>
  48
  49     <para>The test suite of this package is geared towards the needs of its
  50     Maintainer. The command <command>make check</command> builds a specially
  51     wrapped version of modprobe which is useless for normal operation. To run
  52     this (about 0.2 SBU), issue the following commands (note that the
  53     <command>make clean</command> command is required to clean up the source
  54     tree before recompiling for normal use):</para>
  55
  56 <screen><userinput remap="test">DOCBOOKTOMAN=/bin/true ./configure
  57 make check
  58 sed -i -e 's@../../configure@DOCBOOKTOMAN=/bin/true &amp;@' tests/runtests
  59 ./tests/runtests
  60 make clean</userinput></screen>
  61
  62     <para>Prepare Module-Init-Tools for compilation:</para>
  63
  64 <screen><userinput remap="configure">DOCBOOKTOMAN=/bin/true ./configure --prefix=/ \
  65     --enable-zlib-dynamic --mandir=/usr/share/man</userinput></screen>
  66
  67     <para>Compile the package:</para>
  68
  69 <screen><userinput remap="make">make</userinput></screen>
  70
  71     <para>Install the package:</para>
  72
  73 <screen><userinput remap="install">make INSTALL=install install</userinput></screen>
  74
  75     <variablelist>
  76       <title>The meaning of the make parameter:</title>
  77       <varlistentry>
  78         <term><parameter>INSTALL=install</parameter></term>
  79         <listitem>
  80           <para>Normally, <command>make install</command> will not install the
  81           binaries if they already exist. This option overrides that behavior by
  82           calling <command>install</command> instead of using the default
  83           wrapper script.</para>
  84         </listitem>
  85       </varlistentry>
  86     </variablelist>
  87
  88   </sect2>
  89
  90   <sect2 id="contents-module-init-tools" role="content">
  91     <title>Contents of Module-Init-Tools</title>
  92
  93     <segmentedlist>
  94       <segtitle>Installed programs</segtitle>
  95
  96       <seglistitem>
  97         <seg>depmod, insmod, insmod.static, lsmod, modinfo, modprobe, and rmmod</seg>
  98       </seglistitem>
  99     </segmentedlist>
 100
 101     <variablelist>
 102       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 103       <?dbfo list-presentation="list"?>
 104       <?dbhtml list-presentation="table"?>
 105
 106       <varlistentry id="depmod">
 107         <term><command>depmod</command></term>
 108         <listitem>
 109           <para>Creates a dependency file based on the symbols it finds in the
 110           existing set of modules; this dependency file is used by
 111           <command>modprobe</command> to automatically load the required
 112           modules</para>
 113           <indexterm zone="ch-system-module-init-tools depmod">
 114             <primary sortas="b-depmod">depmod</primary>
 115           </indexterm>
 116         </listitem>
 117       </varlistentry>
 118
 119       <varlistentry id="insmod">
 120         <term><command>insmod</command></term>
 121         <listitem>
 122           <para>Installs a loadable module in the running kernel</para>
 123           <indexterm zone="ch-system-module-init-tools insmod">
 124             <primary sortas="b-insmod">insmod</primary>
 125           </indexterm>
 126         </listitem>
 127       </varlistentry>
 128
 129       <varlistentry id="insmod.static">
 130         <term><command>insmod.static</command></term>
 131         <listitem>
 132           <para>A statically compiled version of <command>insmod</command></para>
 133           <indexterm zone="ch-system-module-init-tools insmod.static">
 134             <primary sortas="b-insmod.static">insmod.static</primary>
 135           </indexterm>
 136         </listitem>
 137       </varlistentry>
 138
 139       <varlistentry id="lsmod">
 140         <term><command>lsmod</command></term>
 141         <listitem>
 142           <para>Lists currently loaded modules</para>
 143           <indexterm zone="ch-system-module-init-tools lsmod">
 144             <primary sortas="b-lsmod">lsmod</primary>
 145           </indexterm>
 146         </listitem>
 147       </varlistentry>
 148
 149       <varlistentry id="modinfo">
 150         <term><command>modinfo</command></term>
 151         <listitem>
 152           <para>Examines an object file associated with a kernel module and
 153           displays any information that it can glean</para>
 154           <indexterm zone="ch-system-module-init-tools modinfo">
 155             <primary sortas="b-modinfo">modinfo</primary>
 156           </indexterm>
 157         </listitem>
 158       </varlistentry>
 159
 160       <varlistentry id="modprobe">
 161         <term><command>modprobe</command></term>
 162         <listitem>
 163           <para>Uses a dependency file, created by
 164           <command>depmod</command>, to automatically load relevant modules</para>
 165           <indexterm zone="ch-system-module-init-tools modprobe">
 166             <primary sortas="b-modprobe">modprobe</primary>
 167           </indexterm>
 168         </listitem>
 169       </varlistentry>
 170
 171       <varlistentry id="rmmod">
 172         <term><command>rmmod</command></term>
 173         <listitem>
 174           <para>Unloads modules from the running kernel</para>
 175           <indexterm zone="ch-system-module-init-tools rmmod">
 176             <primary sortas="b-rmmod">rmmod</primary>
 177           </indexterm>
 178         </listitem>
 179       </varlistentry>
 180
 181     </variablelist>
 182
 183   </sect2>
 184
 185 </sect1>