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

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

r3915@server (orig r1761): ken | 2006-06-10 07:03:09 -0700
Fix the install of module-init-tools.

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