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

clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 0a7edfb was 686839b, checked in by William Harrington <kb0iic@…>, 11 years ago

Add screen tags around userinput test commands and remap userinput for test commands as remap="test".

  • 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 --disable-manpages \
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
67make -C man install</userinput></screen>
68
69 <para os="i">Create symbolic links for programs that expect Module-Init-Tools.</para>
70
71<screen os="j"><userinput>ln -sfv kmod /bin/lsmod
72ln -sfv ../bin/kmod /sbin/depmod
73ln -sfv ../bin/kmod /sbin/insmod
74ln -sfv ../bin/kmod /sbin/modprobe
75ln -sfv ../bin/kmod /sbin/modinfo
76ln -sfv ../bin/kmod /sbin/rmmod</userinput></screen>
77
78 </sect2>
79
80 <sect2 id="contents-kmod" role="content">
81 <title>Contents of Kmod</title>
82
83 <segmentedlist>
84 <segtitle>Installed programs</segtitle>
85
86 <seglistitem>
87 <seg>depmod, insmod, kmod, lsmod, modinfo, modprobe, and
88 rmmod</seg>
89 </seglistitem>
90 </segmentedlist>
91
92 <variablelist>
93 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
94 <?dbfo list-presentation="list"?>
95 <?dbhtml list-presentation="table"?>
96
97 <varlistentry id="depmod">
98 <term><command>depmod</command></term>
99 <listitem>
100 <para>Creates a dependency file based on the symbols it finds in
101 the existing set of modules; this dependency file is used by
102 <command>modprobe</command> to automatically load the required
103 modules</para>
104 <indexterm zone="ch-system-kmod depmod">
105 <primary sortas="b-depmod">depmod</primary>
106 </indexterm>
107 </listitem>
108 </varlistentry>
109
110 <varlistentry id="insmod">
111 <term><command>insmod</command></term>
112 <listitem>
113 <para>Installs a loadable module in the running kernel</para>
114 <indexterm zone="ch-system-kmod insmod">
115 <primary sortas="b-insmod">insmod</primary>
116 </indexterm>
117 </listitem>
118 </varlistentry>
119
120 <varlistentry id="kmod">
121 <term><command>kmod</command></term>
122 <listitem>
123 <para>Loads and unloads kernel modules</para>
124 <indexterm zone="ch-system-kmod kmod">
125 <primary sortas="b-kmod">kmod</primary>
126 </indexterm>
127 </listitem>
128 </varlistentry>
129
130 <varlistentry id="lsmod">
131 <term><command>lsmod</command></term>
132 <listitem>
133 <para>Lists currently loaded modules</para>
134 <indexterm zone="ch-system-kmod lsmod">
135 <primary sortas="b-lsmod">lsmod</primary>
136 </indexterm>
137 </listitem>
138 </varlistentry>
139
140 <varlistentry id="modinfo">
141 <term><command>modinfo</command></term>
142 <listitem>
143 <para>Examines an object file associated with a kernel module and
144 displays any information that it can glean</para>
145 <indexterm zone="ch-system-kmod modinfo">
146 <primary sortas="b-modinfo">modinfo</primary>
147 </indexterm>
148 </listitem>
149 </varlistentry>
150
151 <varlistentry id="modprobe">
152 <term><command>modprobe</command></term>
153 <listitem>
154 <para>Uses a dependency file, created by <command>depmod</command>,
155 to automatically load relevant modules</para>
156 <indexterm zone="ch-system-kmod modprobe">
157 <primary sortas="b-modprobe">modprobe</primary>
158 </indexterm>
159 </listitem>
160 </varlistentry>
161
162 <varlistentry id="rmmod">
163 <term><command>rmmod</command></term>
164 <listitem>
165 <para>Unloads modules from the running kernel</para>
166 <indexterm zone="ch-system-kmod rmmod">
167 <primary sortas="b-rmmod">rmmod</primary>
168 </indexterm>
169 </listitem>
170 </varlistentry>
171
172 </variablelist>
173
174 </sect2>
175
176</sect1>
Note: See TracBrowser for help on using the repository browser.