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="a1">The tarball only contains sgml source for the manual pages. The |
---|
29 | following patch contains the result of processing this through |
---|
30 | <command>docbook2man</command> which we do not build as part of a basic clfs |
---|
31 | install :</para> |
---|
32 | |
---|
33 | <screen os="a2"><userinput>patch -Np1 -i ../&module-init-tools-manpages-patch;</userinput></screen> |
---|
34 | |
---|
35 | <para os="c">Issue the following commands to perform the tests</para> |
---|
36 | |
---|
37 | <note os="cc"> |
---|
38 | <para>note that the <command>make clean</command> |
---|
39 | command is required to clean up the source tree, otherwise the code |
---|
40 | built for testing will be installed, and the test version of |
---|
41 | <command>modprobe</command> does not function outside the test |
---|
42 | environment.</para> |
---|
43 | </note> |
---|
44 | |
---|
45 | <screen os="d"><userinput>./configure && |
---|
46 | make check && |
---|
47 | make clean</userinput></screen> |
---|
48 | |
---|
49 | <para os="e">Prepare Module-Init-Tools for compilation:</para> |
---|
50 | |
---|
51 | <screen os="f"><userinput>./configure --prefix=/ --enable-zlib</userinput></screen> |
---|
52 | |
---|
53 | <variablelist os="g"> |
---|
54 | <title>The meaning of the configure options:</title> |
---|
55 | |
---|
56 | <varlistentry> |
---|
57 | <term><parameter>--enable-zlib</parameter></term> |
---|
58 | <listitem> |
---|
59 | <para>This allows the Module-Init-Tools package to handle compressed |
---|
60 | kernel modules.</para> |
---|
61 | </listitem> |
---|
62 | </varlistentry> |
---|
63 | |
---|
64 | </variablelist> |
---|
65 | |
---|
66 | <para os="h">Compile the package:</para> |
---|
67 | |
---|
68 | <screen os="i"><userinput>make</userinput></screen> |
---|
69 | |
---|
70 | <para os="j">Install the package:</para> |
---|
71 | |
---|
72 | <screen os="k"><userinput>make INSTALL=install install</userinput></screen> |
---|
73 | |
---|
74 | <variablelist os="l"> |
---|
75 | <title>The meaning of the make install parameter:</title> |
---|
76 | <varlistentry> |
---|
77 | <term><parameter>INSTALL=install</parameter></term> |
---|
78 | <listitem> |
---|
79 | <para>Normally, <command>make install</command> will not install the binaries if they |
---|
80 | already exist. This option overrides that behavior by calling |
---|
81 | <command>install</command> instead of using the default wrapper |
---|
82 | script.</para> |
---|
83 | </listitem> |
---|
84 | </varlistentry> |
---|
85 | </variablelist> |
---|
86 | |
---|
87 | </sect2> |
---|
88 | |
---|
89 | <sect2 id="contents-module-init-tools" role="content"> |
---|
90 | <title>Contents of Module-Init-Tools</title> |
---|
91 | |
---|
92 | <segmentedlist> |
---|
93 | <segtitle>Installed programs</segtitle> |
---|
94 | |
---|
95 | <seglistitem> |
---|
96 | <seg>depmod, generate-modprobe.conf, insmod, insmod.static, |
---|
97 | lsmod (link to insmod), modinfo, modprobe (link to insmod), and |
---|
98 | rmmod (link to insmod)</seg> |
---|
99 | </seglistitem> |
---|
100 | </segmentedlist> |
---|
101 | |
---|
102 | <variablelist> |
---|
103 | <bridgehead renderas="sect3">Short Descriptions</bridgehead> |
---|
104 | <?dbfo list-presentation="list"?> |
---|
105 | <?dbhtml list-presentation="table"?> |
---|
106 | |
---|
107 | <varlistentry id="depmod"> |
---|
108 | <term><command>depmod</command></term> |
---|
109 | <listitem> |
---|
110 | <para>Creates a dependency file based on the symbols it finds in |
---|
111 | the existing set of modules; this dependency file is used by |
---|
112 | <command>modprobe</command> to automatically load the required |
---|
113 | modules</para> |
---|
114 | <indexterm zone="ch-system-module-init-tools depmod"> |
---|
115 | <primary sortas="b-depmod">depmod</primary> |
---|
116 | </indexterm> |
---|
117 | </listitem> |
---|
118 | </varlistentry> |
---|
119 | |
---|
120 | <varlistentry id="generate-modprobe.conf"> |
---|
121 | <term><command>generate-modprobe.conf</command></term> |
---|
122 | <listitem> |
---|
123 | <para>Creates a modprobe.conf file from an existing 2.2 or 2.4 |
---|
124 | module setup</para> |
---|
125 | <indexterm zone="ch-system-module-init-tools generate-modprobe.conf"> |
---|
126 | <primary sortas="b-generate-modprobe.conf">generate-modprobe.conf</primary> |
---|
127 | </indexterm> |
---|
128 | </listitem> |
---|
129 | </varlistentry> |
---|
130 | |
---|
131 | <varlistentry id="insmod"> |
---|
132 | <term><command>insmod</command></term> |
---|
133 | <listitem> |
---|
134 | <para>Installs a loadable module in the running kernel</para> |
---|
135 | <indexterm zone="ch-system-module-init-tools insmod"> |
---|
136 | <primary sortas="b-insmod">insmod</primary> |
---|
137 | </indexterm> |
---|
138 | </listitem> |
---|
139 | </varlistentry> |
---|
140 | |
---|
141 | <varlistentry id="insmod.static"> |
---|
142 | <term><command>insmod.static</command></term> |
---|
143 | <listitem> |
---|
144 | <para>A statically compiled version of <command>insmod</command></para> |
---|
145 | <indexterm zone="ch-system-module-init-tools insmod.static"> |
---|
146 | <primary sortas="b-insmod.static">insmod.static</primary> |
---|
147 | </indexterm> |
---|
148 | </listitem> |
---|
149 | </varlistentry> |
---|
150 | |
---|
151 | <varlistentry id="lsmod"> |
---|
152 | <term><command>lsmod</command></term> |
---|
153 | <listitem> |
---|
154 | <para>Lists currently loaded modules</para> |
---|
155 | <indexterm zone="ch-system-module-init-tools lsmod"> |
---|
156 | <primary sortas="b-lsmod">lsmod</primary> |
---|
157 | </indexterm> |
---|
158 | </listitem> |
---|
159 | </varlistentry> |
---|
160 | |
---|
161 | <varlistentry id="modinfo"> |
---|
162 | <term><command>modinfo</command></term> |
---|
163 | <listitem> |
---|
164 | <para>Examines an object file associated with a kernel module and |
---|
165 | displays any information that it can glean</para> |
---|
166 | <indexterm zone="ch-system-module-init-tools modinfo"> |
---|
167 | <primary sortas="b-modinfo">modinfo</primary> |
---|
168 | </indexterm> |
---|
169 | </listitem> |
---|
170 | </varlistentry> |
---|
171 | |
---|
172 | <varlistentry id="modprobe"> |
---|
173 | <term><command>modprobe</command></term> |
---|
174 | <listitem> |
---|
175 | <para>Uses a dependency file, created by <command>depmod</command>, |
---|
176 | to automatically load relevant modules</para> |
---|
177 | <indexterm zone="ch-system-module-init-tools modprobe"> |
---|
178 | <primary sortas="b-modprobe">modprobe</primary> |
---|
179 | </indexterm> |
---|
180 | </listitem> |
---|
181 | </varlistentry> |
---|
182 | |
---|
183 | <varlistentry id="rmmod"> |
---|
184 | <term><command>rmmod</command></term> |
---|
185 | <listitem> |
---|
186 | <para>Unloads modules from the running kernel</para> |
---|
187 | <indexterm zone="ch-system-module-init-tools rmmod"> |
---|
188 | <primary sortas="b-rmmod">rmmod</primary> |
---|
189 | </indexterm> |
---|
190 | </listitem> |
---|
191 | </varlistentry> |
---|
192 | |
---|
193 | </variablelist> |
---|
194 | |
---|
195 | </sect2> |
---|
196 | |
---|
197 | </sect1> |
---|