module-init-tools.xml 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183
  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-module-init-tools" role="wrap">
  8. <?dbhtml filename="module-init-tools.html"?>
  9. <sect1info condition="script">
  10. <productname>module-init-tools</productname>
  11. <productnumber>&module-init-tools-version;</productnumber>
  12. <address>&module-init-tools-url;</address>
  13. </sect1info>
  14. <title>Module-Init-Tools-&module-init-tools-version;</title>
  15. <indexterm zone="ch-system-module-init-tools">
  16. <primary sortas="a-Module-Init-Tools">Module-Init-Tools</primary>
  17. </indexterm>
  18. <sect2 role="package">
  19. <title/>
  20. <para>The Module-Init-Tools package contains programs for handling kernel
  21. modules in Linux kernels greater than or equal to version 2.5.47.</para>
  22. <segmentedlist>
  23. <segtitle>&buildtime;</segtitle>
  24. <segtitle>&diskspace;</segtitle>
  25. <seglistitem>
  26. <seg>&module-init-tools-ch6-sbu;</seg>
  27. <seg>&module-init-tools-ch6-du;</seg>
  28. </seglistitem>
  29. </segmentedlist>
  30. </sect2>
  31. <sect2 role="installation">
  32. <title>Installation of Module-Init-Tools</title>
  33. <para>To avoid a problem with regenerating the man pages when not needed,
  34. first rewrite a file that just points to another man page:</para>
  35. <screen><userinput remap="pre">echo '.so man5/modprobe.conf.5' > modprobe.d.5</userinput></screen>
  36. <para>The test suite of this package is geared towards the needs of its
  37. Maintainer. The command <command>make check</command> builds a specially
  38. wrapped version of modprobe which is useless for normal operation. To run
  39. this (about 0.2 SBU), issue the following commands (note that the
  40. <command>make clean</command> command is required to clean up the source
  41. tree before recompiling for normal use):</para>
  42. <screen><userinput remap="test">./configure
  43. make check
  44. ./tests/runtests
  45. make clean</userinput></screen>
  46. <para>Prepare Module-Init-Tools for compilation:</para>
  47. <screen><userinput remap="configure">./configure --prefix=/ --enable-zlib-dynamic --mandir=/usr/share/man</userinput></screen>
  48. <para>Compile the package:</para>
  49. <screen><userinput remap="make">make</userinput></screen>
  50. <para>Install the package:</para>
  51. <screen><userinput remap="install">make INSTALL=install install</userinput></screen>
  52. <variablelist>
  53. <title>The meaning of the make parameter:</title>
  54. <varlistentry>
  55. <term><parameter>INSTALL=install</parameter></term>
  56. <listitem>
  57. <para>Normally, <command>make install</command> will not install the
  58. binaries if they already exist. This option overrides that behavior by
  59. calling <command>install</command> instead of using the default
  60. wrapper script.</para>
  61. </listitem>
  62. </varlistentry>
  63. </variablelist>
  64. </sect2>
  65. <sect2 id="contents-module-init-tools" role="content">
  66. <title>Contents of Module-Init-Tools</title>
  67. <segmentedlist>
  68. <segtitle>Installed programs</segtitle>
  69. <seglistitem>
  70. <seg>depmod, insmod, insmod.static, lsmod, modinfo, modprobe, and rmmod</seg>
  71. </seglistitem>
  72. </segmentedlist>
  73. <variablelist>
  74. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  75. <?dbfo list-presentation="list"?>
  76. <?dbhtml list-presentation="table"?>
  77. <varlistentry id="depmod">
  78. <term><command>depmod</command></term>
  79. <listitem>
  80. <para>Creates a dependency file based on the symbols it finds in the
  81. existing set of modules; this dependency file is used by
  82. <command>modprobe</command> to automatically load the required
  83. modules</para>
  84. <indexterm zone="ch-system-module-init-tools depmod">
  85. <primary sortas="b-depmod">depmod</primary>
  86. </indexterm>
  87. </listitem>
  88. </varlistentry>
  89. <varlistentry id="insmod">
  90. <term><command>insmod</command></term>
  91. <listitem>
  92. <para>Installs a loadable module in the running kernel</para>
  93. <indexterm zone="ch-system-module-init-tools insmod">
  94. <primary sortas="b-insmod">insmod</primary>
  95. </indexterm>
  96. </listitem>
  97. </varlistentry>
  98. <varlistentry id="insmod.static">
  99. <term><command>insmod.static</command></term>
  100. <listitem>
  101. <para>A statically compiled version of <command>insmod</command></para>
  102. <indexterm zone="ch-system-module-init-tools insmod.static">
  103. <primary sortas="b-insmod.static">insmod.static</primary>
  104. </indexterm>
  105. </listitem>
  106. </varlistentry>
  107. <varlistentry id="lsmod">
  108. <term><command>lsmod</command></term>
  109. <listitem>
  110. <para>Lists currently loaded modules</para>
  111. <indexterm zone="ch-system-module-init-tools lsmod">
  112. <primary sortas="b-lsmod">lsmod</primary>
  113. </indexterm>
  114. </listitem>
  115. </varlistentry>
  116. <varlistentry id="modinfo">
  117. <term><command>modinfo</command></term>
  118. <listitem>
  119. <para>Examines an object file associated with a kernel module and
  120. displays any information that it can glean</para>
  121. <indexterm zone="ch-system-module-init-tools modinfo">
  122. <primary sortas="b-modinfo">modinfo</primary>
  123. </indexterm>
  124. </listitem>
  125. </varlistentry>
  126. <varlistentry id="modprobe">
  127. <term><command>modprobe</command></term>
  128. <listitem>
  129. <para>Uses a dependency file, created by
  130. <command>depmod</command>, to automatically load relevant modules</para>
  131. <indexterm zone="ch-system-module-init-tools modprobe">
  132. <primary sortas="b-modprobe">modprobe</primary>
  133. </indexterm>
  134. </listitem>
  135. </varlistentry>
  136. <varlistentry id="rmmod">
  137. <term><command>rmmod</command></term>
  138. <listitem>
  139. <para>Unloads modules from the running kernel</para>
  140. <indexterm zone="ch-system-module-init-tools rmmod">
  141. <primary sortas="b-rmmod">rmmod</primary>
  142. </indexterm>
  143. </listitem>
  144. </varlistentry>
  145. </variablelist>
  146. </sect2>
  147. </sect1>