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

Last change on this file since db27842 was cec581c, checked in by Joe Ciccone <jciccone@…>, 16 years ago

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