[2442205] | 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-ch6-sbu;</seg>
|
---|
| 35 | <seg>&kmod-ch6-du;</seg>
|
---|
| 36 | </seglistitem>
|
---|
| 37 | </segmentedlist>
|
---|
| 38 |
|
---|
| 39 | </sect2>
|
---|
| 40 |
|
---|
| 41 | <sect2 role="installation">
|
---|
| 42 | <title>Installation of Kmod</title>
|
---|
| 43 |
|
---|
[f8ffb960] | 44 | <para>Apply the following patch to fix a problem when running the testsuite
|
---|
| 45 | on x86 hosts:</para>
|
---|
| 46 |
|
---|
| 47 | <screen><userinput remap="pre">patch -Np1 -i ../&kmod-testsuite-patch;</userinput></screen>
|
---|
| 48 |
|
---|
[2442205] | 49 | <para>Prepare Kmod for compilation:</para>
|
---|
| 50 |
|
---|
[450e682e] | 51 | <screen><userinput remap="configure">./configure --prefix=/usr \
|
---|
[9f5aaf7] | 52 | --bindir=/bin \
|
---|
| 53 | --libdir=/lib \
|
---|
| 54 | --sysconfdir=/etc \
|
---|
| 55 | --with-xz \
|
---|
| 56 | --with-zlib</userinput></screen>
|
---|
[2442205] | 57 |
|
---|
| 58 | <variablelist>
|
---|
| 59 | <title>The meaning of the configure options:</title>
|
---|
| 60 |
|
---|
| 61 | <varlistentry>
|
---|
| 62 | <term><parameter>lib* and --with-*</parameter></term>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>These options enable Kmod to handle compressed kernel modules.
|
---|
| 65 | The shell variables are required in order for the xz and zlib headers
|
---|
| 66 | and libraries to be found in the absence of pkg-config.</para>
|
---|
| 67 | </listitem>
|
---|
| 68 | </varlistentry>
|
---|
| 69 |
|
---|
| 70 | </variablelist>
|
---|
| 71 |
|
---|
| 72 | <para>Compile the package:</para>
|
---|
| 73 |
|
---|
| 74 | <screen><userinput remap="make">make</userinput></screen>
|
---|
| 75 |
|
---|
| 76 | <para>To test the results, issue:</para>
|
---|
| 77 |
|
---|
[661b744] | 78 | <screen><userinput remap="test">make check</userinput></screen>
|
---|
[2442205] | 79 |
|
---|
| 80 | <para>Install the package, and create symlinks for compatibility with
|
---|
| 81 | Module-Init-Tools, the package that previously handled Linux kernel modules:
|
---|
| 82 | </para>
|
---|
| 83 |
|
---|
[f365e1e] | 84 | <screen><userinput remap="install">make pkgconfigdir=/usr/lib/pkgconfig install
|
---|
[9f5aaf7] | 85 |
|
---|
[9a4c854] | 86 | for target in depmod insmod modinfo modprobe rmmod; do
|
---|
[2442205] | 87 | ln -sv ../bin/kmod /sbin/$target
|
---|
| 88 | done
|
---|
[9f5aaf7] | 89 |
|
---|
[2442205] | 90 | ln -sv kmod /bin/lsmod</userinput></screen>
|
---|
| 91 |
|
---|
| 92 | </sect2>
|
---|
| 93 |
|
---|
| 94 | <sect2 id="contents-kmod" role="content">
|
---|
| 95 | <title>Contents of Kmod</title>
|
---|
| 96 |
|
---|
| 97 | <segmentedlist>
|
---|
| 98 | <segtitle>Installed programs</segtitle>
|
---|
| 99 | <segtitle>Installed libraries</segtitle>
|
---|
| 100 |
|
---|
| 101 | <seglistitem>
|
---|
| 102 | <seg>depmod (link to kmod), insmod (link to kmod), kmod, kmod-nolib,
|
---|
| 103 | lsmod (link to kmod), modinfo (link to kmod), modprobe (link to kmod),
|
---|
| 104 | and rmmod (link to kmod)</seg>
|
---|
| 105 | <seg>/lib/kmod.so</seg>
|
---|
| 106 | </seglistitem>
|
---|
| 107 | </segmentedlist>
|
---|
| 108 |
|
---|
| 109 | <variablelist>
|
---|
| 110 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 111 | <?dbfo list-presentation="list"?>
|
---|
| 112 | <?dbhtml list-presentation="table"?>
|
---|
| 113 |
|
---|
| 114 | <varlistentry id="depmod">
|
---|
| 115 | <term><command>depmod</command></term>
|
---|
| 116 | <listitem>
|
---|
| 117 | <para>Creates a dependency file based on the symbols it finds in the
|
---|
| 118 | existing set of modules; this dependency file is used by
|
---|
| 119 | <command>modprobe</command> to automatically load the required
|
---|
| 120 | modules</para>
|
---|
| 121 | <indexterm zone="ch-system-kmod depmod">
|
---|
| 122 | <primary sortas="b-depmod">depmod</primary>
|
---|
| 123 | </indexterm>
|
---|
| 124 | </listitem>
|
---|
| 125 | </varlistentry>
|
---|
| 126 |
|
---|
| 127 | <varlistentry id="insmod">
|
---|
| 128 | <term><command>insmod</command></term>
|
---|
| 129 | <listitem>
|
---|
| 130 | <para>Installs a loadable module in the running kernel</para>
|
---|
| 131 | <indexterm zone="ch-system-kmod insmod">
|
---|
| 132 | <primary sortas="b-insmod">insmod</primary>
|
---|
| 133 | </indexterm>
|
---|
| 134 | </listitem>
|
---|
| 135 | </varlistentry>
|
---|
| 136 |
|
---|
| 137 | <varlistentry id="kmod">
|
---|
| 138 | <term><command>kmod</command></term>
|
---|
| 139 | <listitem>
|
---|
| 140 | <para>Loads and unloads kernel modules</para>
|
---|
| 141 | <indexterm zone="ch-system-kmod kmod">
|
---|
| 142 | <primary sortas="b-kmod">kmod</primary>
|
---|
| 143 | </indexterm>
|
---|
| 144 | </listitem>
|
---|
| 145 | </varlistentry>
|
---|
| 146 |
|
---|
| 147 | <varlistentry id="libkmod">
|
---|
| 148 | <term><filename class="libraryfile">libkmod</filename></term>
|
---|
| 149 | <listitem>
|
---|
| 150 | <para>This library is used by other programs to load and unload kernel
|
---|
| 151 | modules</para>
|
---|
| 152 | <indexterm zone="ch-system-kmod">
|
---|
| 153 | <primary sortas="c-libkmod">libkmod</primary>
|
---|
| 154 | </indexterm>
|
---|
| 155 | </listitem>
|
---|
| 156 | </varlistentry>
|
---|
| 157 |
|
---|
| 158 | <varlistentry id="lsmod">
|
---|
| 159 | <term><command>lsmod</command></term>
|
---|
| 160 | <listitem>
|
---|
| 161 | <para>Lists currently loaded modules</para>
|
---|
| 162 | <indexterm zone="ch-system-kmod lsmod">
|
---|
| 163 | <primary sortas="b-lsmod">lsmod</primary>
|
---|
| 164 | </indexterm>
|
---|
| 165 | </listitem>
|
---|
| 166 | </varlistentry>
|
---|
| 167 |
|
---|
| 168 | <varlistentry id="modinfo">
|
---|
| 169 | <term><command>modinfo</command></term>
|
---|
| 170 | <listitem>
|
---|
| 171 | <para>Examines an object file associated with a kernel module and
|
---|
| 172 | displays any information that it can glean</para>
|
---|
| 173 | <indexterm zone="ch-system-kmod modinfo">
|
---|
| 174 | <primary sortas="b-modinfo">modinfo</primary>
|
---|
| 175 | </indexterm>
|
---|
| 176 | </listitem>
|
---|
| 177 | </varlistentry>
|
---|
| 178 |
|
---|
| 179 | <varlistentry id="modprobe">
|
---|
| 180 | <term><command>modprobe</command></term>
|
---|
| 181 | <listitem>
|
---|
| 182 | <para>Uses a dependency file, created by
|
---|
| 183 | <command>depmod</command>, to automatically load relevant modules</para>
|
---|
| 184 | <indexterm zone="ch-system-kmod modprobe">
|
---|
| 185 | <primary sortas="b-modprobe">modprobe</primary>
|
---|
| 186 | </indexterm>
|
---|
| 187 | </listitem>
|
---|
| 188 | </varlistentry>
|
---|
| 189 |
|
---|
| 190 | <varlistentry id="rmmod">
|
---|
| 191 | <term><command>rmmod</command></term>
|
---|
| 192 | <listitem>
|
---|
| 193 | <para>Unloads modules from the running kernel</para>
|
---|
| 194 | <indexterm zone="ch-system-kmod rmmod">
|
---|
| 195 | <primary sortas="b-rmmod">rmmod</primary>
|
---|
| 196 | </indexterm>
|
---|
| 197 | </listitem>
|
---|
| 198 | </varlistentry>
|
---|
| 199 |
|
---|
| 200 | </variablelist>
|
---|
| 201 |
|
---|
| 202 | </sect2>
|
---|
| 203 |
|
---|
| 204 | </sect1>
|
---|
| 205 |
|
---|