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

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

r3795@server (orig r1715): chris | 2006-05-31 21:54:59 -0700
Updated lists of installed programs

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