source: BOOK/final-system/common/kmod.xml @ cf8ec94

clfs-3.0.0-sysvinitsysvinit
Last change on this file since cf8ec94 was c2102b28, checked in by Chris Staub <chris@…>, 8 years ago

Improve consistency in package installation lists, mainly removing 'and'

Conflicts:

BOOK/final-system/common/attr.xml

  • Property mode set to 100644
File size: 5.3 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-kmod" role="wrap">
9  <?dbhtml filename="kmod.html"?>
10
11  <title>Kmod-&kmod-version;</title>
12
13  <indexterm zone="ch-system-kmod">
14    <primary sortas="a-Kmod">Kmod</primary>
15  </indexterm>
16
17  <sect2 role="package">
18    <title/>
19
20    <para>The Kmod package contains programs for loading, inserting
21      and removing kernel modules for Linux. Kmod replaces the
22      Module-Init-tools package.</para>
23
24  </sect2>
25
26  <sect2 role="installation">
27    <title>Installation of Kmod</title>
28
29    <para os="a">Prepare Kmod for compilation:</para>
30
31<screen os="b"><userinput>./configure --prefix=/usr \
32    --bindir=/bin --sysconfdir=/etc \
33    --with-rootlibdir=/lib \
34    --with-zlib --with-xz</userinput></screen>
35
36    <variablelist os="c">
37      <title>The meaning of the configure option:</title>
38
39      <varlistentry>
40        <term><parameter>--with-rootlibdir=/lib</parameter></term>
41        <listitem>
42          <para>Install location for shared libraries.</para>
43        </listitem>
44      </varlistentry>
45
46      <varlistentry>
47        <term><parameter>--with-zlib --with-xz</parameter></term>
48        <listitem>
49          <para>This allows the Kmod package to handle zlib and XZ
50            compressed kernel modules.</para>
51        </listitem>
52      </varlistentry>
53
54    </variablelist>
55
56    <para os="d">Compile the package:</para>
57
58<screen os="e"><userinput>make</userinput></screen>
59
60    <para os="f">To test the results, issue:</para>
61
62<screen os="f2"><userinput remap="test">make check</userinput></screen>
63
64    <para os="g">Install the package:</para>
65
66<screen os="h"><userinput>make install</userinput></screen>
67
68    <para os="i">Create symbolic links for programs that expect Module-Init-Tools.</para>
69
70<screen os="j"><userinput>ln -sfv kmod /bin/lsmod
71for tool in depmod insmod modprobe modinfo rmmod; do
72    ln -sfv ../bin/kmod /sbin/${tool}
73done</userinput></screen>
74
75  </sect2>
76
77  <sect2 id="contents-kmod" role="content">
78    <title>Contents of Kmod</title>
79
80    <segmentedlist>
81      <segtitle>Installed programs</segtitle>
82
83      <seglistitem>
84        <seg>depmod (link to kmod), insmod (link to kmod), kmod,
85        lsmod (link to kmod), modinfo (link to kmod), modprobe (link to kmod),
86        rmmod (link to kmod) </seg>
87      </seglistitem>
88    </segmentedlist>
89
90    <variablelist>
91      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
92      <?dbfo list-presentation="list"?>
93      <?dbhtml list-presentation="table"?>
94
95      <varlistentry id="depmod">
96        <term><command>depmod</command></term>
97        <listitem>
98          <para>Creates a dependency file based on the symbols it finds in
99          the existing set of modules; this dependency file is used by
100          <command>modprobe</command> to automatically load the required
101          modules</para>
102          <indexterm zone="ch-system-kmod depmod">
103            <primary sortas="b-depmod">depmod</primary>
104          </indexterm>
105        </listitem>
106      </varlistentry>
107
108      <varlistentry id="insmod">
109        <term><command>insmod</command></term>
110        <listitem>
111          <para>Installs a loadable module in the running kernel</para>
112          <indexterm zone="ch-system-kmod insmod">
113            <primary sortas="b-insmod">insmod</primary>
114          </indexterm>
115        </listitem>
116      </varlistentry>
117
118      <varlistentry id="kmod">
119        <term><command>kmod</command></term>
120        <listitem>
121          <para>Loads and unloads kernel modules</para>
122          <indexterm zone="ch-system-kmod kmod">
123            <primary sortas="b-kmod">kmod</primary>
124          </indexterm>
125        </listitem>
126      </varlistentry>
127
128      <varlistentry id="lsmod">
129        <term><command>lsmod</command></term>
130        <listitem>
131          <para>Lists currently loaded modules</para>
132          <indexterm zone="ch-system-kmod lsmod">
133            <primary sortas="b-lsmod">lsmod</primary>
134          </indexterm>
135        </listitem>
136      </varlistentry>
137
138      <varlistentry id="modinfo">
139        <term><command>modinfo</command></term>
140        <listitem>
141          <para>Examines an object file associated with a kernel module and
142          displays any information that it can glean</para>
143          <indexterm zone="ch-system-kmod modinfo">
144            <primary sortas="b-modinfo">modinfo</primary>
145          </indexterm>
146        </listitem>
147      </varlistentry>
148
149      <varlistentry id="modprobe">
150        <term><command>modprobe</command></term>
151        <listitem>
152          <para>Uses a dependency file, created by <command>depmod</command>,
153          to automatically load relevant modules</para>
154          <indexterm zone="ch-system-kmod modprobe">
155            <primary sortas="b-modprobe">modprobe</primary>
156          </indexterm>
157        </listitem>
158      </varlistentry>
159
160      <varlistentry id="rmmod">
161        <term><command>rmmod</command></term>
162        <listitem>
163          <para>Unloads modules from the running kernel</para>
164          <indexterm zone="ch-system-kmod rmmod">
165            <primary sortas="b-rmmod">rmmod</primary>
166          </indexterm>
167        </listitem>
168      </varlistentry>
169
170    </variablelist>
171
172  </sect2>
173
174</sect1>
Note: See TracBrowser for help on using the repository browser.