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

clfs-1.2clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since 1e58202 was 1e58202, checked in by Joe Ciccone <jciccone@…>, 14 years ago

Fixed the configure command for module-init-tools so /share goes to /usr/share where it should be.

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