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

sysvinit
Last change on this file since c7477f8e was b27081c4, checked in by Chris Staub <chris@…>, 9 years ago

Put one configure option per line

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