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

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

r1119@server (orig r1117): chris | 2006-01-31 17:59:55 -0800
Updated package dependencies

  • Property mode set to 100644
File size: 5.8 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  %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, Gawk, GCC,
28        Glibc, Grep, M4, Make, Sed, and Zlib</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="c">Issue the following commands to perform the tests
46    (note that the <command>make distclean</command> command is required
47    to clean up the source tree, as the source gets recompiled as part
48    of the testing process):</para>
49
50<screen os="d"><userinput>./configure &amp;&amp;
51make check &amp;&amp;
52make distclean</userinput></screen>
53
54    <para os="e">Prepare Module-Init-Tools for compilation:</para>
55
56<screen os="f"><userinput>./configure --prefix=/ --enable-zlib</userinput></screen>
57
58    <variablelist os="g">
59      <title>The meaning of the configure options:</title>
60
61      <varlistentry>
62        <term><parameter>--enable-zlib</parameter></term>
63        <listitem>
64          <para>This allows the Module-Init-Tools package to handle compressed
65          kernel modules.</para>
66        </listitem>
67      </varlistentry>
68
69    </variablelist>
70
71    <para os="h">Compile the package:</para>
72
73<screen os="i"><userinput>make</userinput></screen>
74
75    <para os="j">Install the package:</para>
76
77<screen os="k"><userinput>make install</userinput></screen>
78
79  </sect2>
80
81  <sect2 id="contents-module-init-tools" role="content">
82    <title>Contents of Module-Init-Tools</title>
83
84    <segmentedlist>
85      <segtitle>Installed programs</segtitle>
86
87      <seglistitem>
88        <seg>depmod, insmod, insmod.static, lsmod (link to insmod),
89        modinfo, modprobe (link to insmod), and rmmod (link to insmod)</seg>
90      </seglistitem>
91    </segmentedlist>
92
93    <variablelist>
94      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
95      <?dbfo list-presentation="list"?>
96      <?dbhtml list-presentation="table"?>
97
98      <varlistentry id="depmod">
99        <term><command>depmod</command></term>
100        <listitem>
101          <para>Creates a dependency file based on the symbols it finds in
102          the existing set of modules; this dependency file is used by
103          <command>modprobe</command> to automatically load the required
104          modules</para>
105          <indexterm zone="ch-system-module-init-tools depmod">
106            <primary sortas="b-depmod">depmod</primary>
107          </indexterm>
108        </listitem>
109      </varlistentry>
110
111      <varlistentry id="insmod">
112        <term><command>insmod</command></term>
113        <listitem>
114          <para>Installs a loadable module in the running kernel</para>
115          <indexterm zone="ch-system-module-init-tools insmod">
116            <primary sortas="b-insmod">insmod</primary>
117          </indexterm>
118        </listitem>
119      </varlistentry>
120
121      <varlistentry id="insmod.static">
122        <term><command>insmod.static</command></term>
123        <listitem>
124          <para>A statically compiled version of <command>insmod</command></para>
125          <indexterm zone="ch-system-module-init-tools insmod.static">
126            <primary sortas="b-insmod.static">insmod.static</primary>
127          </indexterm>
128        </listitem>
129      </varlistentry>
130
131      <varlistentry id="lsmod">
132        <term><command>lsmod</command></term>
133        <listitem>
134          <para>Lists currently loaded modules</para>
135          <indexterm zone="ch-system-module-init-tools lsmod">
136            <primary sortas="b-lsmod">lsmod</primary>
137          </indexterm>
138        </listitem>
139      </varlistentry>
140
141      <varlistentry id="modinfo">
142        <term><command>modinfo</command></term>
143        <listitem>
144          <para>Examines an object file associated with a kernel module and
145          displays any information that it can glean</para>
146          <indexterm zone="ch-system-module-init-tools modinfo">
147            <primary sortas="b-modinfo">modinfo</primary>
148          </indexterm>
149        </listitem>
150      </varlistentry>
151
152      <varlistentry id="modprobe">
153        <term><command>modprobe</command></term>
154        <listitem>
155          <para>Uses a dependency file, created by <command>depmod</command>,
156          to automatically load relevant modules</para>
157          <indexterm zone="ch-system-module-init-tools modprobe">
158            <primary sortas="b-modprobe">modprobe</primary>
159          </indexterm>
160        </listitem>
161      </varlistentry>
162
163      <varlistentry id="rmmod">
164        <term><command>rmmod</command></term>
165        <listitem>
166          <para>Unloads modules from the running kernel</para>
167          <indexterm zone="ch-system-module-init-tools rmmod">
168            <primary sortas="b-rmmod">rmmod</primary>
169          </indexterm>
170        </listitem>
171      </varlistentry>
172
173    </variablelist>
174
175  </sect2>
176
177</sect1>
Note: See TracBrowser for help on using the repository browser.