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

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

r2885@server (orig r1381): chris | 2006-04-14 08:51:02 -0700
Removed unneeded touch command from module-init-tools instructions

  • Property mode set to 100644
File size: 5.5 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    <segmentedlist>
24      <segtitle>&dependencies;</segtitle>
25
26      <seglistitem>
27        <seg>Bash, Binutils, Bison, Coreutils, Diffutils, Gawk, GCC,
28        Glibc, Grep, M4, Make, Sed, and Zlib</seg>
29      </seglistitem>
30    </segmentedlist>
31
32  </sect2>
33
34  <sect2 role="installation">
35    <title>Installation of Module-Init-Tools</title>
36
37    <para os="c">Issue the following commands to perform the tests
38    (note that the <command>make distclean</command> command is required
39    to clean up the source tree, as the source gets recompiled as part
40    of the testing process):</para>
41
42<screen os="d"><userinput>./configure &amp;&amp;
43make check &amp;&amp;
44make distclean</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</userinput></screen>
70
71  </sect2>
72
73  <sect2 id="contents-module-init-tools" role="content">
74    <title>Contents of Module-Init-Tools</title>
75
76    <segmentedlist>
77      <segtitle>Installed programs</segtitle>
78
79      <seglistitem>
80        <seg>depmod, insmod, insmod.static, lsmod (link to insmod),
81        modinfo, modprobe (link to insmod), and rmmod (link to insmod)</seg>
82      </seglistitem>
83    </segmentedlist>
84
85    <variablelist>
86      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
87      <?dbfo list-presentation="list"?>
88      <?dbhtml list-presentation="table"?>
89
90      <varlistentry id="depmod">
91        <term><command>depmod</command></term>
92        <listitem>
93          <para>Creates a dependency file based on the symbols it finds in
94          the existing set of modules; this dependency file is used by
95          <command>modprobe</command> to automatically load the required
96          modules</para>
97          <indexterm zone="ch-system-module-init-tools depmod">
98            <primary sortas="b-depmod">depmod</primary>
99          </indexterm>
100        </listitem>
101      </varlistentry>
102
103      <varlistentry id="insmod">
104        <term><command>insmod</command></term>
105        <listitem>
106          <para>Installs a loadable module in the running kernel</para>
107          <indexterm zone="ch-system-module-init-tools insmod">
108            <primary sortas="b-insmod">insmod</primary>
109          </indexterm>
110        </listitem>
111      </varlistentry>
112
113      <varlistentry id="insmod.static">
114        <term><command>insmod.static</command></term>
115        <listitem>
116          <para>A statically compiled version of <command>insmod</command></para>
117          <indexterm zone="ch-system-module-init-tools insmod.static">
118            <primary sortas="b-insmod.static">insmod.static</primary>
119          </indexterm>
120        </listitem>
121      </varlistentry>
122
123      <varlistentry id="lsmod">
124        <term><command>lsmod</command></term>
125        <listitem>
126          <para>Lists currently loaded modules</para>
127          <indexterm zone="ch-system-module-init-tools lsmod">
128            <primary sortas="b-lsmod">lsmod</primary>
129          </indexterm>
130        </listitem>
131      </varlistentry>
132
133      <varlistentry id="modinfo">
134        <term><command>modinfo</command></term>
135        <listitem>
136          <para>Examines an object file associated with a kernel module and
137          displays any information that it can glean</para>
138          <indexterm zone="ch-system-module-init-tools modinfo">
139            <primary sortas="b-modinfo">modinfo</primary>
140          </indexterm>
141        </listitem>
142      </varlistentry>
143
144      <varlistentry id="modprobe">
145        <term><command>modprobe</command></term>
146        <listitem>
147          <para>Uses a dependency file, created by <command>depmod</command>,
148          to automatically load relevant modules</para>
149          <indexterm zone="ch-system-module-init-tools modprobe">
150            <primary sortas="b-modprobe">modprobe</primary>
151          </indexterm>
152        </listitem>
153      </varlistentry>
154
155      <varlistentry id="rmmod">
156        <term><command>rmmod</command></term>
157        <listitem>
158          <para>Unloads modules from the running kernel</para>
159          <indexterm zone="ch-system-module-init-tools rmmod">
160            <primary sortas="b-rmmod">rmmod</primary>
161          </indexterm>
162        </listitem>
163      </varlistentry>
164
165    </variablelist>
166
167  </sect2>
168
169</sect1>
Note: See TracBrowser for help on using the repository browser.