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

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

r627@server (orig r625): jim | 2005-10-31 12:59:34 -0800
Import of Cross-LFS Book

  • Property mode set to 100644
File size: 5.9 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="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="g">To test the results, issue:
79    <userinput>make check</userinput>.</para>
80
81    <para os="h">Install the package:</para>
82
83<screen os="i"><userinput>make install</userinput></screen>
84
85  </sect2>
86
87  <sect2 id="contents-module-init-tools" role="content">
88    <title>Contents of Module-Init-Tools</title>
89
90    <segmentedlist>
91      <segtitle>Installed programs</segtitle>
92
93      <seglistitem>
94        <seg>depmod, insmod, insmod.static, lsmod (link to insmod),
95        modinfo, modprobe (link to insmod), and rmmod (link to insmod)</seg>
96      </seglistitem>
97    </segmentedlist>
98
99    <variablelist>
100      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
101      <?dbfo list-presentation="list"?>
102      <?dbhtml list-presentation="table"?>
103
104      <varlistentry id="depmod">
105        <term><command>depmod</command></term>
106        <listitem>
107          <para>Creates a dependency file based on the symbols it finds in
108          the existing set of modules; this dependency file is used by
109          <command>modprobe</command> to automatically load the required
110          modules</para>
111          <indexterm zone="ch-system-module-init-tools depmod">
112            <primary sortas="b-depmod">depmod</primary>
113          </indexterm>
114        </listitem>
115      </varlistentry>
116
117      <varlistentry id="insmod">
118        <term><command>insmod</command></term>
119        <listitem>
120          <para>Installs a loadable module in the running kernel</para>
121          <indexterm zone="ch-system-module-init-tools insmod">
122            <primary sortas="b-insmod">insmod</primary>
123          </indexterm>
124        </listitem>
125      </varlistentry>
126
127      <varlistentry id="insmod.static">
128        <term><command>insmod.static</command></term>
129        <listitem>
130          <para>A statically compiled version of <command>insmod</command></para>
131          <indexterm zone="ch-system-module-init-tools insmod.static">
132            <primary sortas="b-insmod.static">insmod.static</primary>
133          </indexterm>
134        </listitem>
135      </varlistentry>
136
137      <varlistentry id="lsmod">
138        <term><command>lsmod</command></term>
139        <listitem>
140          <para>Lists currently loaded modules</para>
141          <indexterm zone="ch-system-module-init-tools lsmod">
142            <primary sortas="b-lsmod">lsmod</primary>
143          </indexterm>
144        </listitem>
145      </varlistentry>
146
147      <varlistentry id="modinfo">
148        <term><command>modinfo</command></term>
149        <listitem>
150          <para>Examines an object file associated with a kernel module and
151          displays any information that it can glean</para>
152          <indexterm zone="ch-system-module-init-tools modinfo">
153            <primary sortas="b-modinfo">modinfo</primary>
154          </indexterm>
155        </listitem>
156      </varlistentry>
157
158      <varlistentry id="modprobe">
159        <term><command>modprobe</command></term>
160        <listitem>
161          <para>Uses a dependency file, created by <command>depmod</command>,
162          to automatically load relevant modules</para>
163          <indexterm zone="ch-system-module-init-tools modprobe">
164            <primary sortas="b-modprobe">modprobe</primary>
165          </indexterm>
166        </listitem>
167      </varlistentry>
168
169      <varlistentry id="rmmod">
170        <term><command>rmmod</command></term>
171        <listitem>
172          <para>Unloads modules from the running kernel</para>
173          <indexterm zone="ch-system-module-init-tools rmmod">
174            <primary sortas="b-rmmod">rmmod</primary>
175          </indexterm>
176        </listitem>
177      </varlistentry>
178
179    </variablelist>
180
181  </sect2>
182
183</sect1>
Note: See TracBrowser for help on using the repository browser.