kmod.xml 6.4 KB

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