source: BOOK/final-system/common/module-init-tools.xml @ af4f700

clfs-1.2clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since af4f700 was af4f700, checked in by Chris Staub <chris@…>, 15 years ago

Minor text fixes

  • Property mode set to 100644
File size: 6.7 KB
Line 
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  <title>Module-Init-Tools-&module-init-tools-version;</title>
12
13  <indexterm zone="ch-system-module-init-tools">
14    <primary sortas="a-Module-Init-Tools">Module-Init-Tools</primary>
15  </indexterm>
16
17  <sect2 role="package">
18    <title/>
19
20    <para>The Module-Init-Tools package contains programs for handling kernel
21    modules in Linux kernels greater than or equal to version 2.5.47.</para>
22
23  </sect2>
24
25  <sect2 role="installation">
26    <title>Installation of Module-Init-Tools</title>
27
28    <para os="a1">The tarball only contains sgml source for the manual pages.  The
29    following patch contains the result of processing this through
30    <command>docbook2man</command> which we do not build as part of a basic CLFS
31    install:</para>
32
33<screen os="a2"><userinput>patch -Np1 -i ../&module-init-tools-manpages-patch;</userinput></screen>
34
35    <para os="c">Issue the following commands to perform the tests</para>
36
37    <note os="cc">
38      <para>The <command>make clean</command> command is required to clean up
39      the source tree, otherwise the code built for testing will be installed,
40      and the test version of <command>modprobe</command> does not function
41      outside the test environment.</para>
42    </note>
43
44<screen os="d"><userinput>./configure &amp;&amp;
45make check &amp;&amp;
46make clean</userinput></screen>
47
48    <para os="e">Prepare Module-Init-Tools for compilation:</para>
49
50<screen os="f"><userinput>./configure --prefix=/usr \
51    --bindir=/bin --sbindir=/sbin \
52    --enable-zlib</userinput></screen>
53
54    <variablelist os="g">
55      <title>The meaning of the configure options:</title>
56
57      <varlistentry>
58        <term><parameter>--enable-zlib</parameter></term>
59        <listitem>
60          <para>This allows the Module-Init-Tools package to handle compressed
61          kernel modules.</para>
62        </listitem>
63      </varlistentry>
64
65    </variablelist>
66
67    <para os="h">Compile the package:</para>
68
69<screen os="i"><userinput>make</userinput></screen>
70
71    <para os="j">Install the package:</para>
72
73<screen os="k"><userinput>make INSTALL=install install</userinput></screen>
74
75    <variablelist os="l">
76      <title>The meaning of the make install parameter:</title>
77      <varlistentry>
78        <term><parameter>INSTALL=install</parameter></term>
79        <listitem>
80          <para>Normally, <command>make install</command> will not install the binaries if they
81          already exist. This option overrides that behavior by calling
82          <command>install</command> instead of using the default wrapper
83          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, generate-modprobe.conf, insmod, insmod.static,
98        lsmod (link to insmod), modinfo, modprobe (link to insmod), and
99        rmmod (link to insmod)</seg>
100      </seglistitem>
101    </segmentedlist>
102
103    <variablelist>
104      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
105      <?dbfo list-presentation="list"?>
106      <?dbhtml list-presentation="table"?>
107
108      <varlistentry id="depmod">
109        <term><command>depmod</command></term>
110        <listitem>
111          <para>Creates a dependency file based on the symbols it finds in
112          the existing set of modules; this dependency file is used by
113          <command>modprobe</command> to automatically load the required
114          modules</para>
115          <indexterm zone="ch-system-module-init-tools depmod">
116            <primary sortas="b-depmod">depmod</primary>
117          </indexterm>
118        </listitem>
119      </varlistentry>
120
121      <varlistentry id="generate-modprobe.conf">
122        <term><command>generate-modprobe.conf</command></term>
123        <listitem>
124          <para>Creates a modprobe.conf file from an existing 2.2 or 2.4
125          module setup</para>
126          <indexterm zone="ch-system-module-init-tools generate-modprobe.conf">
127            <primary sortas="b-generate-modprobe.conf">generate-modprobe.conf</primary>
128          </indexterm>
129        </listitem>
130      </varlistentry>
131
132      <varlistentry id="insmod">
133        <term><command>insmod</command></term>
134        <listitem>
135          <para>Installs a loadable module in the running kernel</para>
136          <indexterm zone="ch-system-module-init-tools insmod">
137            <primary sortas="b-insmod">insmod</primary>
138          </indexterm>
139        </listitem>
140      </varlistentry>
141
142      <varlistentry id="insmod.static">
143        <term><command>insmod.static</command></term>
144        <listitem>
145          <para>A statically compiled version of <command>insmod</command></para>
146          <indexterm zone="ch-system-module-init-tools insmod.static">
147            <primary sortas="b-insmod.static">insmod.static</primary>
148          </indexterm>
149        </listitem>
150      </varlistentry>
151
152      <varlistentry id="lsmod">
153        <term><command>lsmod</command></term>
154        <listitem>
155          <para>Lists currently loaded modules</para>
156          <indexterm zone="ch-system-module-init-tools lsmod">
157            <primary sortas="b-lsmod">lsmod</primary>
158          </indexterm>
159        </listitem>
160      </varlistentry>
161
162      <varlistentry id="modinfo">
163        <term><command>modinfo</command></term>
164        <listitem>
165          <para>Examines an object file associated with a kernel module and
166          displays any information that it can glean</para>
167          <indexterm zone="ch-system-module-init-tools modinfo">
168            <primary sortas="b-modinfo">modinfo</primary>
169          </indexterm>
170        </listitem>
171      </varlistentry>
172
173      <varlistentry id="modprobe">
174        <term><command>modprobe</command></term>
175        <listitem>
176          <para>Uses a dependency file, created by <command>depmod</command>,
177          to automatically load relevant modules</para>
178          <indexterm zone="ch-system-module-init-tools modprobe">
179            <primary sortas="b-modprobe">modprobe</primary>
180          </indexterm>
181        </listitem>
182      </varlistentry>
183
184      <varlistentry id="rmmod">
185        <term><command>rmmod</command></term>
186        <listitem>
187          <para>Unloads modules from the running kernel</para>
188          <indexterm zone="ch-system-module-init-tools rmmod">
189            <primary sortas="b-rmmod">rmmod</primary>
190          </indexterm>
191        </listitem>
192      </varlistentry>
193
194    </variablelist>
195
196  </sect2>
197
198</sect1>
Note: See TracBrowser for help on using the repository browser.