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

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

r3633@server (orig r1649): jciccone | 2006-05-25 16:48:42 -0700
Added the Initial clfs-2.0 branch using sysroot builds.

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