[9dfc02f] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[b06ca36] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[9dfc02f] | 4 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 | ]>
|
---|
[2fa922f] | 7 |
|
---|
[81fd230] | 8 | <sect1 id="ch-system-module-init-tools" role="wrap">
|
---|
[2fa922f] | 9 | <?dbhtml filename="module-init-tools.html"?>
|
---|
| 10 |
|
---|
[e747759] | 11 | <sect1info condition="script">
|
---|
| 12 | <productname>module-init-tools</productname>
|
---|
| 13 | <productnumber>&module-init-tools-version;</productnumber>
|
---|
| 14 | <address>&module-init-tools-url;</address>
|
---|
| 15 | </sect1info>
|
---|
| 16 |
|
---|
[2fa922f] | 17 | <title>Module-Init-Tools-&module-init-tools-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="ch-system-module-init-tools">
|
---|
| 20 | <primary sortas="a-Module-Init-Tools">Module-Init-Tools</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect2 role="package">
|
---|
| 24 | <title/>
|
---|
[9dfc02f] | 25 |
|
---|
[2fa922f] | 26 | <para>The Module-Init-Tools package contains programs for handling kernel
|
---|
| 27 | modules in Linux kernels greater than or equal to version 2.5.47.</para>
|
---|
[9dfc02f] | 28 |
|
---|
[2fa922f] | 29 | <segmentedlist>
|
---|
| 30 | <segtitle>&buildtime;</segtitle>
|
---|
| 31 | <segtitle>&diskspace;</segtitle>
|
---|
[9dfc02f] | 32 |
|
---|
[2fa922f] | 33 | <seglistitem>
|
---|
[e4a5635] | 34 | <seg>&module-init-tools-ch6-sbu;</seg>
|
---|
| 35 | <seg>&module-init-tools-ch6-du;</seg>
|
---|
[2fa922f] | 36 | </seglistitem>
|
---|
| 37 | </segmentedlist>
|
---|
[9dfc02f] | 38 |
|
---|
[2fa922f] | 39 | </sect2>
|
---|
| 40 |
|
---|
| 41 | <sect2 role="installation">
|
---|
| 42 | <title>Installation of Module-Init-Tools</title>
|
---|
| 43 |
|
---|
[d6e3415] | 44 | <para>The tarball only contains sgml source for the manpages. The following
|
---|
| 45 | patch contains the result of processing this through <command>docbook2man</command>
|
---|
| 46 | (see <ulink url="&blfs-root;view/svn/pst/docbook-utils.html"/>)
|
---|
| 47 | which we do not build as part of a basic LFS installation:</para>
|
---|
[48206b3] | 48 |
|
---|
[d6e3415] | 49 | <screen><userinput remap="pre">patch -Np1 -i ../&module-init-manpages-patch;</userinput></screen>
|
---|
[48206b3] | 50 |
|
---|
[d6e3415] | 51 | <para>The testsuite of this package is geared towards the needs of its
|
---|
| 52 | Maintainer. The command <command>make check</command> builds a specially
|
---|
| 53 | wrapped version of modprobe which is useless for normal operation. To run
|
---|
| 54 | this, issue the following commands (note that the <command>make clean</command>
|
---|
| 55 | command is required to clean up the source tree before recompiling for
|
---|
| 56 | normal use):</para>
|
---|
[aa8363a] | 57 |
|
---|
[0445a3d] | 58 | <screen><userinput remap="test">./configure
|
---|
[ad83f72] | 59 | make check
|
---|
[d6e3415] | 60 | make clean</userinput></screen>
|
---|
[89cca6e] | 61 |
|
---|
[2fa922f] | 62 | <para>Prepare Module-Init-Tools for compilation:</para>
|
---|
[9dfc02f] | 63 |
|
---|
[0445a3d] | 64 | <screen><userinput remap="configure">./configure --prefix=/ --enable-zlib</userinput></screen>
|
---|
[e5846ef] | 65 |
|
---|
[2fa922f] | 66 | <para>Compile the package:</para>
|
---|
[9dfc02f] | 67 |
|
---|
[0445a3d] | 68 | <screen><userinput remap="make">make</userinput></screen>
|
---|
[81fd230] | 69 |
|
---|
[2fa922f] | 70 | <para>Install the package:</para>
|
---|
[9dfc02f] | 71 |
|
---|
[0445a3d] | 72 | <screen><userinput remap="install">make INSTALL=install install</userinput></screen>
|
---|
[0d9735e4] | 73 |
|
---|
| 74 | <variablelist>
|
---|
| 75 | <title>The meaning of the make parameter:</title>
|
---|
| 76 | <varlistentry>
|
---|
| 77 | <term><parameter>INSTALL=install</parameter></term>
|
---|
| 78 | <listitem>
|
---|
[efa4a64] | 79 | <para>Normally, <command>make install</command> will not install the
|
---|
| 80 | binaries if they already exist. This option overrides that behavior by
|
---|
| 81 | calling <command>install</command> instead of using the default
|
---|
| 82 | wrapper script.</para>
|
---|
[0d9735e4] | 83 | </listitem>
|
---|
| 84 | </varlistentry>
|
---|
| 85 | </variablelist>
|
---|
[9dfc02f] | 86 |
|
---|
[2fa922f] | 87 | </sect2>
|
---|
| 88 |
|
---|
| 89 | <sect2 id="contents-module-init-tools" role="content">
|
---|
| 90 | <title>Contents of Module-Init-Tools</title>
|
---|
| 91 |
|
---|
| 92 | <segmentedlist>
|
---|
| 93 | <segtitle>Installed programs</segtitle>
|
---|
| 94 |
|
---|
| 95 | <seglistitem>
|
---|
| 96 | <seg>depmod, generate-modprobe.conf, insmod, insmod.static, lsmod,
|
---|
| 97 | modinfo, modprobe, and rmmod</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-module-init-tools depmod">
|
---|
| 114 | <primary sortas="b-depmod">depmod</primary>
|
---|
| 115 | </indexterm>
|
---|
| 116 | </listitem>
|
---|
| 117 | </varlistentry>
|
---|
| 118 |
|
---|
| 119 | <varlistentry id="generate-modprobe.conf">
|
---|
| 120 | <term><command>generate-modprobe.conf</command></term>
|
---|
| 121 | <listitem>
|
---|
| 122 | <para>Creates a modprobe.conf file from an existing 2.2 or 2.4 module
|
---|
| 123 | setup</para>
|
---|
| 124 | <indexterm zone="ch-system-module-init-tools generate-modprobe.conf">
|
---|
| 125 | <primary sortas="b-generate-modprobe.conf">generate-modprobe.conf</primary>
|
---|
| 126 | </indexterm>
|
---|
| 127 | </listitem>
|
---|
| 128 | </varlistentry>
|
---|
| 129 |
|
---|
| 130 | <varlistentry id="insmod">
|
---|
| 131 | <term><command>insmod</command></term>
|
---|
| 132 | <listitem>
|
---|
| 133 | <para>Installs a loadable module in the running kernel</para>
|
---|
| 134 | <indexterm zone="ch-system-module-init-tools insmod">
|
---|
| 135 | <primary sortas="b-insmod">insmod</primary>
|
---|
| 136 | </indexterm>
|
---|
| 137 | </listitem>
|
---|
| 138 | </varlistentry>
|
---|
| 139 |
|
---|
| 140 | <varlistentry id="insmod.static">
|
---|
| 141 | <term><command>insmod.static</command></term>
|
---|
| 142 | <listitem>
|
---|
| 143 | <para>A statically compiled version of <command>insmod</command></para>
|
---|
| 144 | <indexterm zone="ch-system-module-init-tools insmod.static">
|
---|
| 145 | <primary sortas="b-insmod.static">insmod.static</primary>
|
---|
| 146 | </indexterm>
|
---|
| 147 | </listitem>
|
---|
| 148 | </varlistentry>
|
---|
| 149 |
|
---|
| 150 | <varlistentry id="lsmod">
|
---|
| 151 | <term><command>lsmod</command></term>
|
---|
| 152 | <listitem>
|
---|
| 153 | <para>Lists currently loaded modules</para>
|
---|
| 154 | <indexterm zone="ch-system-module-init-tools lsmod">
|
---|
| 155 | <primary sortas="b-lsmod">lsmod</primary>
|
---|
| 156 | </indexterm>
|
---|
| 157 | </listitem>
|
---|
| 158 | </varlistentry>
|
---|
| 159 |
|
---|
| 160 | <varlistentry id="modinfo">
|
---|
| 161 | <term><command>modinfo</command></term>
|
---|
| 162 | <listitem>
|
---|
| 163 | <para>Examines an object file associated with a kernel module and
|
---|
| 164 | displays any information that it can glean</para>
|
---|
| 165 | <indexterm zone="ch-system-module-init-tools modinfo">
|
---|
| 166 | <primary sortas="b-modinfo">modinfo</primary>
|
---|
| 167 | </indexterm>
|
---|
| 168 | </listitem>
|
---|
| 169 | </varlistentry>
|
---|
| 170 |
|
---|
| 171 | <varlistentry id="modprobe">
|
---|
| 172 | <term><command>modprobe</command></term>
|
---|
| 173 | <listitem>
|
---|
| 174 | <para>Uses a dependency file, created by
|
---|
| 175 | <command>depmod</command>, to automatically load relevant modules</para>
|
---|
| 176 | <indexterm zone="ch-system-module-init-tools modprobe">
|
---|
| 177 | <primary sortas="b-modprobe">modprobe</primary>
|
---|
| 178 | </indexterm>
|
---|
| 179 | </listitem>
|
---|
| 180 | </varlistentry>
|
---|
| 181 |
|
---|
| 182 | <varlistentry id="rmmod">
|
---|
| 183 | <term><command>rmmod</command></term>
|
---|
| 184 | <listitem>
|
---|
| 185 | <para>Unloads modules from the running kernel</para>
|
---|
| 186 | <indexterm zone="ch-system-module-init-tools rmmod">
|
---|
| 187 | <primary sortas="b-rmmod">rmmod</primary>
|
---|
| 188 | </indexterm>
|
---|
| 189 | </listitem>
|
---|
| 190 | </varlistentry>
|
---|
| 191 |
|
---|
| 192 | </variablelist>
|
---|
| 193 |
|
---|
| 194 | </sect2>
|
---|
[9dfc02f] | 195 |
|
---|
| 196 | </sect1>
|
---|