source: clfs-sysroot/BOOK/final-system/common/module-init-tools.xml @ 59fb197

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

r3817@server (orig r1719): jciccone | 2006-06-05 13:56:36 -0700
Brought the clfs-2.0 branch up to trunk.

  • Property mode set to 100644
File size: 5.4 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="a">Prepare Module-Init-Tools for compilation:</para>
29
30<screen os="b"><userinput>./configure --prefix=/ --enable-zlib --host=${LFS_TARGET}</userinput></screen>
31
32    <variablelist os="c">
33      <title>The meaning of the configure options:</title>
34
35      <varlistentry>
36        <term><parameter>--enable-zlib</parameter></term>
37        <listitem>
38          <para>This allows the Module-Init-Tools package to handle compressed
39          kernel modules.</para>
40        </listitem>
41      </varlistentry>
42
43    </variablelist>
44
45    <para os="d">Compile the package:</para>
46
47<screen os="e"><userinput>make</userinput></screen>
48
49    <para os="f">Install the package:</para>
50
51<screen os="g"><userinput>make DESTDIR=${LFS} install</userinput></screen>
52
53  </sect2>
54
55  <sect2 id="contents-module-init-tools" role="content">
56    <title>Contents of Module-Init-Tools</title>
57
58    <segmentedlist>
59      <segtitle>Installed programs</segtitle>
60
61      <seglistitem>
62        <seg>depmod, generate-modprobe.conf, insmod, insmod.static,
63        lsmod (link to insmod), modinfo, modprobe (link to insmod), and
64        rmmod (link to insmod)</seg>
65      </seglistitem>
66    </segmentedlist>
67
68    <variablelist>
69      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
70      <?dbfo list-presentation="list"?>
71      <?dbhtml list-presentation="table"?>
72
73      <varlistentry id="depmod">
74        <term><command>depmod</command></term>
75        <listitem>
76          <para>Creates a dependency file based on the symbols it finds in
77          the existing set of modules; this dependency file is used by
78          <command>modprobe</command> to automatically load the required
79          modules</para>
80          <indexterm zone="ch-system-module-init-tools depmod">
81            <primary sortas="b-depmod">depmod</primary>
82          </indexterm>
83        </listitem>
84      </varlistentry>
85
86      <varlistentry id="generate-modprobe.conf">
87        <term><command>generate-modprobe.conf</command></term>
88        <listitem>
89          <para>Creates a modprobe.conf file from an existing 2.2 or 2.4
90          module setup</para>
91          <indexterm zone="ch-system-module-init-tools generate-modprobe.conf">
92            <primary sortas="b-generate-modprobe.conf">generate-modprobe.conf</primary>
93          </indexterm>
94        </listitem>
95      </varlistentry>
96
97      <varlistentry id="insmod">
98        <term><command>insmod</command></term>
99        <listitem>
100          <para>Installs a loadable module in the running kernel</para>
101          <indexterm zone="ch-system-module-init-tools insmod">
102            <primary sortas="b-insmod">insmod</primary>
103          </indexterm>
104        </listitem>
105      </varlistentry>
106
107      <varlistentry id="insmod.static">
108        <term><command>insmod.static</command></term>
109        <listitem>
110          <para>A statically compiled version of <command>insmod</command></para>
111          <indexterm zone="ch-system-module-init-tools insmod.static">
112            <primary sortas="b-insmod.static">insmod.static</primary>
113          </indexterm>
114        </listitem>
115      </varlistentry>
116
117      <varlistentry id="lsmod">
118        <term><command>lsmod</command></term>
119        <listitem>
120          <para>Lists currently loaded modules</para>
121          <indexterm zone="ch-system-module-init-tools lsmod">
122            <primary sortas="b-lsmod">lsmod</primary>
123          </indexterm>
124        </listitem>
125      </varlistentry>
126
127      <varlistentry id="modinfo">
128        <term><command>modinfo</command></term>
129        <listitem>
130          <para>Examines an object file associated with a kernel module and
131          displays any information that it can glean</para>
132          <indexterm zone="ch-system-module-init-tools modinfo">
133            <primary sortas="b-modinfo">modinfo</primary>
134          </indexterm>
135        </listitem>
136      </varlistentry>
137
138      <varlistentry id="modprobe">
139        <term><command>modprobe</command></term>
140        <listitem>
141          <para>Uses a dependency file, created by <command>depmod</command>,
142          to automatically load relevant modules</para>
143          <indexterm zone="ch-system-module-init-tools modprobe">
144            <primary sortas="b-modprobe">modprobe</primary>
145          </indexterm>
146        </listitem>
147      </varlistentry>
148
149      <varlistentry id="rmmod">
150        <term><command>rmmod</command></term>
151        <listitem>
152          <para>Unloads modules from the running kernel</para>
153          <indexterm zone="ch-system-module-init-tools rmmod">
154            <primary sortas="b-rmmod">rmmod</primary>
155          </indexterm>
156        </listitem>
157      </varlistentry>
158
159    </variablelist>
160
161  </sect2>
162
163</sect1>
Note: See TracBrowser for help on using the repository browser.