source: chapter08/kmod.xml@ c31e35b

11.0 11.0-rc1 11.0-rc2 11.0-rc3 11.1 11.1-rc1 arm ml-11.0 multilib s6-init trunk xry111/clfs-ng xry111/glibc-2.34 xry111/lfs-next xry111/tester-nohack
Last change on this file since c31e35b was c31e35b, checked in by Pierre Labastie <pierre.labastie@…>, 15 months ago

kmod: do not install lsmod both in /usr/sbin and /usr/bin

  • Property mode set to 100644
File size: 6.0 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 <sect1info condition="script">
12 <productname>kmod</productname>
13 <productnumber>&kmod-version;</productnumber>
14 <address>&kmod-url;</address>
15 </sect1info>
16
17 <title>Kmod-&kmod-version;</title>
18
19 <indexterm zone="ch-system-kmod">
20 <primary sortas="a-Kmod">Kmod</primary>
21 </indexterm>
22
23 <sect2 role="package">
24 <title/>
25
26 <para>The Kmod package contains libraries and utilities for loading kernel
27 modules</para>
28
29 <segmentedlist>
30 <segtitle>&buildtime;</segtitle>
31 <segtitle>&diskspace;</segtitle>
32
33 <seglistitem>
34 <seg>&kmod-fin-sbu;</seg>
35 <seg>&kmod-fin-du;</seg>
36 </seglistitem>
37 </segmentedlist>
38
39 </sect2>
40
41 <sect2 role="installation">
42 <title>Installation of Kmod</title>
43
44 <para>Prepare Kmod for compilation:</para>
45
46<screen><userinput remap="configure">./configure --prefix=/usr \
47 --sysconfdir=/etc \
48 --with-xz \
49 --with-zstd \
50 --with-zlib</userinput></screen>
51
52 <variablelist>
53 <title>The meaning of the configure options:</title>
54
55 <varlistentry>
56 <term><parameter>--with-xz, --with-zlib, --with-zstd</parameter></term>
57 <listitem>
58 <para>These options enable Kmod to handle compressed kernel modules.</para>
59 </listitem>
60 </varlistentry>
61
62 </variablelist>
63
64 <para>Compile the package:</para>
65
66<screen><userinput remap="make">make</userinput></screen>
67
68 <para>This package does not come with a test suite that can be run in the
69 LFS chroot environment. At a minimum the git program is required and
70 several tests will not run outside of a git repository. </para>
71
72 <para>Install the package and create symlinks for
73 compatibility with Module-Init-Tools (the package that previously handled
74 Linux kernel modules):</para>
75
76<screen><userinput remap="install">make install
77
78for target in depmod insmod modinfo modprobe rmmod; do
79 ln -sfv ../bin/kmod /usr/sbin/$target
80done
81
82ln -sfv kmod /usr/bin/lsmod</userinput></screen>
83
84 </sect2>
85
86 <sect2 id="contents-kmod" role="content">
87 <title>Contents of Kmod</title>
88
89 <segmentedlist>
90 <segtitle>Installed programs</segtitle>
91 <segtitle>Installed library</segtitle>
92
93 <seglistitem>
94 <seg>depmod (link to kmod), insmod (link to kmod), kmod,
95 lsmod (link to kmod), modinfo (link to kmod), modprobe (link to kmod),
96 and rmmod (link to kmod)</seg>
97 <seg>libkmod.so</seg>
98 </seglistitem>
99 </segmentedlist>
100
101 <variablelist>
102 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
103 <?dbfo list-presentation="list"?>
104 <?dbhtml list-presentation="table"?>
105
106 <varlistentry id="depmod">
107 <term><command>depmod</command></term>
108 <listitem>
109 <para>Creates a dependency file based on the symbols it finds in the
110 existing set of modules; this dependency file is used by
111 <command>modprobe</command> to automatically load the required
112 modules</para>
113 <indexterm zone="ch-system-kmod depmod">
114 <primary sortas="b-depmod">depmod</primary>
115 </indexterm>
116 </listitem>
117 </varlistentry>
118
119 <varlistentry id="insmod">
120 <term><command>insmod</command></term>
121 <listitem>
122 <para>Installs a loadable module in the running kernel</para>
123 <indexterm zone="ch-system-kmod insmod">
124 <primary sortas="b-insmod">insmod</primary>
125 </indexterm>
126 </listitem>
127 </varlistentry>
128
129 <varlistentry id="kmod">
130 <term><command>kmod</command></term>
131 <listitem>
132 <para>Loads and unloads kernel modules</para>
133 <indexterm zone="ch-system-kmod kmod">
134 <primary sortas="b-kmod">kmod</primary>
135 </indexterm>
136 </listitem>
137 </varlistentry>
138
139 <varlistentry id="lsmod">
140 <term><command>lsmod</command></term>
141 <listitem>
142 <para>Lists currently loaded modules</para>
143 <indexterm zone="ch-system-kmod lsmod">
144 <primary sortas="b-lsmod">lsmod</primary>
145 </indexterm>
146 </listitem>
147 </varlistentry>
148
149 <varlistentry id="modinfo">
150 <term><command>modinfo</command></term>
151 <listitem>
152 <para>Examines an object file associated with a kernel module and
153 displays any information that it can glean</para>
154 <indexterm zone="ch-system-kmod modinfo">
155 <primary sortas="b-modinfo">modinfo</primary>
156 </indexterm>
157 </listitem>
158 </varlistentry>
159
160 <varlistentry id="modprobe">
161 <term><command>modprobe</command></term>
162 <listitem>
163 <para>Uses a dependency file, created by
164 <command>depmod</command>, to automatically load relevant modules</para>
165 <indexterm zone="ch-system-kmod modprobe">
166 <primary sortas="b-modprobe">modprobe</primary>
167 </indexterm>
168 </listitem>
169 </varlistentry>
170
171 <varlistentry id="rmmod">
172 <term><command>rmmod</command></term>
173 <listitem>
174 <para>Unloads modules from the running kernel</para>
175 <indexterm zone="ch-system-kmod rmmod">
176 <primary sortas="b-rmmod">rmmod</primary>
177 </indexterm>
178 </listitem>
179 </varlistentry>
180
181 <varlistentry id="libkmod">
182 <term><filename class="libraryfile">libkmod</filename></term>
183 <listitem>
184 <para>This library is used by other programs to load and unload kernel
185 modules</para>
186 <indexterm zone="ch-system-kmod">
187 <primary sortas="c-libkmod">libkmod</primary>
188 </indexterm>
189 </listitem>
190 </varlistentry>
191
192 </variablelist>
193
194 </sect2>
195
196</sect1>
197
Note: See TracBrowser for help on using the repository browser.