module-init-tools.xml 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
  3. "http://www.oasis-open.org/docbook/xml/4.4/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. <title>Module-Init-Tools-&module-init-tools-version;</title>
  10. <indexterm zone="ch-system-module-init-tools">
  11. <primary sortas="a-Module-Init-Tools">Module-Init-Tools</primary>
  12. </indexterm>
  13. <sect2 role="package">
  14. <title/>
  15. <para>The Module-Init-Tools package contains programs for handling kernel
  16. modules in Linux kernels greater than or equal to version 2.5.47.</para>
  17. <segmentedlist>
  18. <segtitle>&buildtime;</segtitle>
  19. <segtitle>&diskspace;</segtitle>
  20. <seglistitem>
  21. <seg>&module-init-tools-ch6-sbu;</seg>
  22. <seg>&module-init-tools-ch6-du;</seg>
  23. </seglistitem>
  24. </segmentedlist>
  25. </sect2>
  26. <sect2 role="installation">
  27. <title>Installation of Module-Init-Tools</title>
  28. <para>Issue the following commands to perform the tests (note that the
  29. <command>make distclean</command> command is required to clean up the source
  30. tree, as the source gets recompiled as part of the testing process):</para>
  31. <screen><userinput>./configure &amp;&amp;
  32. make check &amp;&amp;
  33. make distclean</userinput></screen>
  34. <para>Prepare Module-Init-Tools for compilation:</para>
  35. <screen><userinput>./configure --prefix=/ --enable-zlib</userinput></screen>
  36. <para>Compile the package:</para>
  37. <screen><userinput>make</userinput></screen>
  38. <para>Install the package:</para>
  39. <screen><userinput>make INSTALL=install install</userinput></screen>
  40. <variablelist>
  41. <title>The meaning of the make parameter:</title>
  42. <varlistentry>
  43. <term><parameter>INSTALL=install</parameter></term>
  44. <listitem>
  45. <para>Normally, <command>make install</command> will not install the
  46. binaries if they already exist. This option overrides that behavior by
  47. calling <command>install</command> instead of using the default
  48. wrapper script.</para>
  49. </listitem>
  50. </varlistentry>
  51. </variablelist>
  52. </sect2>
  53. <sect2 id="contents-module-init-tools" role="content">
  54. <title>Contents of Module-Init-Tools</title>
  55. <segmentedlist>
  56. <segtitle>Installed programs</segtitle>
  57. <seglistitem>
  58. <seg>depmod, generate-modprobe.conf, insmod, insmod.static, lsmod,
  59. modinfo, modprobe, and rmmod</seg>
  60. </seglistitem>
  61. </segmentedlist>
  62. <variablelist>
  63. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  64. <?dbfo list-presentation="list"?>
  65. <?dbhtml list-presentation="table"?>
  66. <varlistentry id="depmod">
  67. <term><command>depmod</command></term>
  68. <listitem>
  69. <para>Creates a dependency file based on the symbols it finds in the
  70. existing set of modules; this dependency file is used by
  71. <command>modprobe</command> to automatically load the required
  72. modules</para>
  73. <indexterm zone="ch-system-module-init-tools depmod">
  74. <primary sortas="b-depmod">depmod</primary>
  75. </indexterm>
  76. </listitem>
  77. </varlistentry>
  78. <varlistentry id="generate-modprobe.conf">
  79. <term><command>generate-modprobe.conf</command></term>
  80. <listitem>
  81. <para>Creates a modprobe.conf file from an existing 2.2 or 2.4 module
  82. setup</para>
  83. <indexterm zone="ch-system-module-init-tools generate-modprobe.conf">
  84. <primary sortas="b-generate-modprobe.conf">generate-modprobe.conf</primary>
  85. </indexterm>
  86. </listitem>
  87. </varlistentry>
  88. <varlistentry id="insmod">
  89. <term><command>insmod</command></term>
  90. <listitem>
  91. <para>Installs a loadable module in the running kernel</para>
  92. <indexterm zone="ch-system-module-init-tools insmod">
  93. <primary sortas="b-insmod">insmod</primary>
  94. </indexterm>
  95. </listitem>
  96. </varlistentry>
  97. <varlistentry id="insmod.static">
  98. <term><command>insmod.static</command></term>
  99. <listitem>
  100. <para>A statically compiled version of <command>insmod</command></para>
  101. <indexterm zone="ch-system-module-init-tools insmod.static">
  102. <primary sortas="b-insmod.static">insmod.static</primary>
  103. </indexterm>
  104. </listitem>
  105. </varlistentry>
  106. <varlistentry id="lsmod">
  107. <term><command>lsmod</command></term>
  108. <listitem>
  109. <para>Lists currently loaded modules</para>
  110. <indexterm zone="ch-system-module-init-tools lsmod">
  111. <primary sortas="b-lsmod">lsmod</primary>
  112. </indexterm>
  113. </listitem>
  114. </varlistentry>
  115. <varlistentry id="modinfo">
  116. <term><command>modinfo</command></term>
  117. <listitem>
  118. <para>Examines an object file associated with a kernel module and
  119. displays any information that it can glean</para>
  120. <indexterm zone="ch-system-module-init-tools modinfo">
  121. <primary sortas="b-modinfo">modinfo</primary>
  122. </indexterm>
  123. </listitem>
  124. </varlistentry>
  125. <varlistentry id="modprobe">
  126. <term><command>modprobe</command></term>
  127. <listitem>
  128. <para>Uses a dependency file, created by
  129. <command>depmod</command>, to automatically load relevant modules</para>
  130. <indexterm zone="ch-system-module-init-tools modprobe">
  131. <primary sortas="b-modprobe">modprobe</primary>
  132. </indexterm>
  133. </listitem>
  134. </varlistentry>
  135. <varlistentry id="rmmod">
  136. <term><command>rmmod</command></term>
  137. <listitem>
  138. <para>Unloads modules from the running kernel</para>
  139. <indexterm zone="ch-system-module-init-tools rmmod">
  140. <primary sortas="b-rmmod">rmmod</primary>
  141. </indexterm>
  142. </listitem>
  143. </varlistentry>
  144. </variablelist>
  145. </sect2>
  146. </sect1>