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

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since c999585 was c999585, checked in by Jim Gifford <clfs@…>, 19 years ago

r646@server (orig r644): manuel | 2005-11-07 11:26:52 -0800
Correct the instructions for running the Module-Init-Tools' testsuite.

  • Property mode set to 100644
File size: 6.3 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 <!ENTITY % patches-entities SYSTEM "../../patches.ent">
6 %general-entities;
7 %patches-entities;
8]>
9
10<sect1 id="ch-system-module-init-tools" role="wrap">
11 <?dbhtml filename="module-init-tools.html"?>
12
13 <title>Module-Init-Tools-&module-init-tools-version;</title>
14
15 <indexterm zone="ch-system-module-init-tools">
16 <primary sortas="a-Module-Init-Tools">Module-Init-Tools</primary>
17 </indexterm>
18
19 <sect2 role="package">
20 <title/>
21
22 <para>The Module-Init-Tools package contains programs for handling kernel
23 modules in Linux kernels greater than or equal to version 2.5.47.</para>
24
25 <segmentedlist>
26 <segtitle>&buildtime;</segtitle>
27 <segtitle>&diskspace;</segtitle>
28
29 <seglistitem>
30 <seg>Not checked yet</seg>
31 <seg>Not checked yet</seg>
32 </seglistitem>
33 </segmentedlist>
34
35 <segmentedlist>
36 <segtitle>&dependencies;</segtitle>
37
38 <seglistitem>
39 <seg>Bash, Binutils, Bison, Coreutils, Diffutils, GCC, Glibc,
40 Grep, M4, Make, and Sed</seg>
41 </seglistitem>
42 </segmentedlist>
43
44 </sect2>
45
46 <sect2 role="installation">
47 <title>Installation of Module-Init-Tools</title>
48
49 <para os="a">Module-Init-Tools attempts to rewrite its
50 <filename>modprobe.conf</filename> man page during the build process.
51 This is unnecessary and also relies on <command>docbook2man</command>
52 &mdash; which is not installed in LFS. Run the following command to
53 avoid this:</para>
54
55<screen os="b"><userinput>touch modprobe.conf.5</userinput></screen>
56
57 <para os="g">If you wish to run the test suite for Module-Init-Tools, you
58 will need to download the separate testsuite tarball. Issue the
59 following commands to perform the tests (note that the
60 <command>make distclean</command> command is required to clean up
61 the source tree, as the source gets recompiled as part of the testing
62 process):</para>
63
64<screen os="g1"><userinput>tar -xvf ../module-init-tools-testsuite-&module-init-tools-version;.tar.bz2 &amp;&amp;
65./configure &amp;&amp;
66make check &amp;&amp;
67make distclean</userinput></screen>
68
69 <para os="c">Prepare Module-Init-Tools for compilation:</para>
70
71<screen os="c1"><userinput>./configure --prefix="" --enable-zlib</userinput></screen>
72
73 <variablelist os="d">
74 <title>The meaning of the configure options:</title>
75
76 <varlistentry>
77 <term><parameter>--enable-zlib</parameter></term>
78 <listitem>
79 <para>This allows the Module-Init-Tools package to handle compressed
80 kernel modules.</para>
81 </listitem>
82 </varlistentry>
83
84 </variablelist>
85
86 <para os="e">Compile the package:</para>
87
88<screen os="f"><userinput>make</userinput></screen>
89
90 <para os="h">Install the package:</para>
91
92<screen os="i"><userinput>make install</userinput></screen>
93
94 </sect2>
95
96 <sect2 id="contents-module-init-tools" role="content">
97 <title>Contents of Module-Init-Tools</title>
98
99 <segmentedlist>
100 <segtitle>Installed programs</segtitle>
101
102 <seglistitem>
103 <seg>depmod, insmod, insmod.static, lsmod (link to insmod),
104 modinfo, modprobe (link to insmod), and rmmod (link to insmod)</seg>
105 </seglistitem>
106 </segmentedlist>
107
108 <variablelist>
109 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
110 <?dbfo list-presentation="list"?>
111 <?dbhtml list-presentation="table"?>
112
113 <varlistentry id="depmod">
114 <term><command>depmod</command></term>
115 <listitem>
116 <para>Creates a dependency file based on the symbols it finds in
117 the existing set of modules; this dependency file is used by
118 <command>modprobe</command> to automatically load the required
119 modules</para>
120 <indexterm zone="ch-system-module-init-tools depmod">
121 <primary sortas="b-depmod">depmod</primary>
122 </indexterm>
123 </listitem>
124 </varlistentry>
125
126 <varlistentry id="insmod">
127 <term><command>insmod</command></term>
128 <listitem>
129 <para>Installs a loadable module in the running kernel</para>
130 <indexterm zone="ch-system-module-init-tools insmod">
131 <primary sortas="b-insmod">insmod</primary>
132 </indexterm>
133 </listitem>
134 </varlistentry>
135
136 <varlistentry id="insmod.static">
137 <term><command>insmod.static</command></term>
138 <listitem>
139 <para>A statically compiled version of <command>insmod</command></para>
140 <indexterm zone="ch-system-module-init-tools insmod.static">
141 <primary sortas="b-insmod.static">insmod.static</primary>
142 </indexterm>
143 </listitem>
144 </varlistentry>
145
146 <varlistentry id="lsmod">
147 <term><command>lsmod</command></term>
148 <listitem>
149 <para>Lists currently loaded modules</para>
150 <indexterm zone="ch-system-module-init-tools lsmod">
151 <primary sortas="b-lsmod">lsmod</primary>
152 </indexterm>
153 </listitem>
154 </varlistentry>
155
156 <varlistentry id="modinfo">
157 <term><command>modinfo</command></term>
158 <listitem>
159 <para>Examines an object file associated with a kernel module and
160 displays any information that it can glean</para>
161 <indexterm zone="ch-system-module-init-tools modinfo">
162 <primary sortas="b-modinfo">modinfo</primary>
163 </indexterm>
164 </listitem>
165 </varlistentry>
166
167 <varlistentry id="modprobe">
168 <term><command>modprobe</command></term>
169 <listitem>
170 <para>Uses a dependency file, created by <command>depmod</command>,
171 to automatically load relevant modules</para>
172 <indexterm zone="ch-system-module-init-tools modprobe">
173 <primary sortas="b-modprobe">modprobe</primary>
174 </indexterm>
175 </listitem>
176 </varlistentry>
177
178 <varlistentry id="rmmod">
179 <term><command>rmmod</command></term>
180 <listitem>
181 <para>Unloads modules from the running kernel</para>
182 <indexterm zone="ch-system-module-init-tools rmmod">
183 <primary sortas="b-rmmod">rmmod</primary>
184 </indexterm>
185 </listitem>
186 </varlistentry>
187
188 </variablelist>
189
190 </sect2>
191
192</sect1>
Note: See TracBrowser for help on using the repository browser.