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

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

r3371@server (orig r1554): chris | 2006-05-10 14:03:44 -0700
Removed dependency info from individual package instructions

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