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

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 973b8dd9 was 0f9d1e9, checked in by Joe Ciccone <jciccone@…>, 17 years ago

Removed DOCBOOKTOMAN from the module-init-tools page, Ken's patch provides the files the target would normally use this variable to generate, leaving this argument in could result in some blank man pages instead of an error if the clock was skewed.

  • 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
36 (note that the <command>make clean</command>
37 command is required to clean up the source tree, otherwise the code
38 built for testing will be installed, and the test version of
39 <command>modprobe</command> does not function outside the test
40 environment).</para>
41
42<screen os="d"><userinput>./configure &amp;&amp;
43make check &amp;&amp;
44make clean &amp;&amp;</userinput></screen>
45
46 <para os="e">Prepare Module-Init-Tools for compilation:</para>
47
48<screen os="f"><userinput>./configure --prefix=/ --enable-zlib</userinput></screen>
49
50 <variablelist os="g">
51 <title>The meaning of the configure options:</title>
52
53 <varlistentry>
54 <term><parameter>--enable-zlib</parameter></term>
55 <listitem>
56 <para>This allows the Module-Init-Tools package to handle compressed
57 kernel modules.</para>
58 </listitem>
59 </varlistentry>
60
61 </variablelist>
62
63 <para os="h">Compile the package:</para>
64
65<screen os="i"><userinput>make</userinput></screen>
66
67 <para os="j">Install the package:</para>
68
69<screen os="k"><userinput>make INSTALL=install install</userinput></screen>
70
71 <variablelist os="l">
72 <title>The meaning of the make install parameter:</title>
73 <varlistentry>
74 <term><parameter>INSTALL=install</parameter></term>
75 <listitem>
76 <para>Normally, <command>make install</command> will not install the binaries if they
77 already exist. This option overrides that behavior by calling
78 <command>install</command> instead of using the default wrapper
79 script.</para>
80 </listitem>
81 </varlistentry>
82 </variablelist>
83
84 </sect2>
85
86 <sect2 id="contents-module-init-tools" role="content">
87 <title>Contents of Module-Init-Tools</title>
88
89 <segmentedlist>
90 <segtitle>Installed programs</segtitle>
91
92 <seglistitem>
93 <seg>depmod, generate-modprobe.conf, insmod, insmod.static,
94 lsmod (link to insmod), modinfo, modprobe (link to insmod), and
95 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="generate-modprobe.conf">
118 <term><command>generate-modprobe.conf</command></term>
119 <listitem>
120 <para>Creates a modprobe.conf file from an existing 2.2 or 2.4
121 module setup</para>
122 <indexterm zone="ch-system-module-init-tools generate-modprobe.conf">
123 <primary sortas="b-generate-modprobe.conf">generate-modprobe.conf</primary>
124 </indexterm>
125 </listitem>
126 </varlistentry>
127
128 <varlistentry id="insmod">
129 <term><command>insmod</command></term>
130 <listitem>
131 <para>Installs a loadable module in the running kernel</para>
132 <indexterm zone="ch-system-module-init-tools insmod">
133 <primary sortas="b-insmod">insmod</primary>
134 </indexterm>
135 </listitem>
136 </varlistentry>
137
138 <varlistentry id="insmod.static">
139 <term><command>insmod.static</command></term>
140 <listitem>
141 <para>A statically compiled version of <command>insmod</command></para>
142 <indexterm zone="ch-system-module-init-tools insmod.static">
143 <primary sortas="b-insmod.static">insmod.static</primary>
144 </indexterm>
145 </listitem>
146 </varlistentry>
147
148 <varlistentry id="lsmod">
149 <term><command>lsmod</command></term>
150 <listitem>
151 <para>Lists currently loaded modules</para>
152 <indexterm zone="ch-system-module-init-tools lsmod">
153 <primary sortas="b-lsmod">lsmod</primary>
154 </indexterm>
155 </listitem>
156 </varlistentry>
157
158 <varlistentry id="modinfo">
159 <term><command>modinfo</command></term>
160 <listitem>
161 <para>Examines an object file associated with a kernel module and
162 displays any information that it can glean</para>
163 <indexterm zone="ch-system-module-init-tools modinfo">
164 <primary sortas="b-modinfo">modinfo</primary>
165 </indexterm>
166 </listitem>
167 </varlistentry>
168
169 <varlistentry id="modprobe">
170 <term><command>modprobe</command></term>
171 <listitem>
172 <para>Uses a dependency file, created by <command>depmod</command>,
173 to automatically load relevant modules</para>
174 <indexterm zone="ch-system-module-init-tools modprobe">
175 <primary sortas="b-modprobe">modprobe</primary>
176 </indexterm>
177 </listitem>
178 </varlistentry>
179
180 <varlistentry id="rmmod">
181 <term><command>rmmod</command></term>
182 <listitem>
183 <para>Unloads modules from the running kernel</para>
184 <indexterm zone="ch-system-module-init-tools rmmod">
185 <primary sortas="b-rmmod">rmmod</primary>
186 </indexterm>
187 </listitem>
188 </varlistentry>
189
190 </variablelist>
191
192 </sect2>
193
194</sect1>
Note: See TracBrowser for help on using the repository browser.