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

Last change on this file since d649544 was d649544, checked in by Jim Gifford <clfs@…>, 16 years ago

r745@server (orig r743): jim | 2005-11-21 14:37:00 -0800

r765@server: jim | 2005-11-21 14:36:33 -0800
Added: prefix=/ to module init tools build


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