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

clfs-3.0.0-systemd systemd
Last change on this file since d23c4f9 was d23c4f9, checked in by Chris Staub <chris@…>, 10 years ago

More consistent indentation on kmod page

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