module-init-tools.xml 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  3. <!ENTITY % general-entities SYSTEM "../general.ent">
  4. <!ENTITY % patches-entities SYSTEM "../patches.ent">
  5. %general-entities;
  6. %patches-entities;
  7. ]>
  8. <sect1 id="ch-system-module-init-tools" role="wrap">
  9. <title>Module-Init-Tools-&module-init-tools-version;</title>
  10. <?dbhtml filename="module-init-tools.html"?>
  11. <indexterm zone="ch-system-module-init-tools"><primary sortas="a-Module-Init-Tools">Module-Init-Tools</primary></indexterm>
  12. <sect2 role="package"><title/>
  13. <para>The Module-Init-Tools package contains programs for handling kernel
  14. modules in Linux kernels greater than or equal to version 2.5.47.</para>
  15. <segmentedlist>
  16. <segtitle>&buildtime;</segtitle>
  17. <segtitle>&diskspace;</segtitle>
  18. <seglistitem><seg>0.1 SBU</seg><seg>4.9 MB</seg></seglistitem>
  19. </segmentedlist>
  20. <segmentedlist>
  21. <segtitle>&dependencies;</segtitle>
  22. <seglistitem><seg>Bash, Binutils, Bison,
  23. Coreutils, Diffutils, Flex, GCC, Glibc, Grep, M4, Make, and Sed</seg></seglistitem>
  24. </segmentedlist>
  25. </sect2>
  26. <sect2 role="installation">
  27. <title>Installation of Module-Init-Tools</title>
  28. <para>Module-Init-Tools attempts to rewrite its
  29. <filename>modprobe.conf</filename> man page during the build process. This is
  30. unnecessary and also relies on <command>docbook2man</command> &mdash; which is not
  31. installed in LFS. Run the following command to avoid this:</para>
  32. <screen><userinput>touch modprobe.conf.5</userinput></screen>
  33. <para>Prepare Module-Init-Tools for compilation:</para>
  34. <screen><userinput>./configure --prefix="" --enable-zlib</userinput></screen>
  35. <para>Compile the package:</para>
  36. <screen><userinput>make</userinput></screen>
  37. <para>To test the results, issue:
  38. <userinput>make check</userinput>.</para>
  39. <para>Install the package:</para>
  40. <screen><userinput>make install</userinput></screen>
  41. </sect2>
  42. <sect2 id="contents-module-init-tools" role="content"><title>Contents of Module-Init-Tools</title>
  43. <segmentedlist>
  44. <segtitle>Installed programs</segtitle>
  45. <seglistitem><seg>depmod, genksyms, insmod,
  46. insmod_ksymoops_clean, kallsyms (link to insmod), kernelversion, ksyms
  47. (link to insmod), lsmod (link to insmod), modinfo, modprobe (link to
  48. insmod), and rmmod (link to insmod)</seg></seglistitem>
  49. </segmentedlist>
  50. <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
  51. <?dbfo list-presentation="list"?>
  52. <?dbhtml list-presentation="table"?>
  53. <varlistentry id="depmod">
  54. <term><command>depmod</command></term>
  55. <listitem>
  56. <para>Creates a dependency file based on the symbols it finds in the
  57. existing set of modules; this dependency file is used by <command>modprobe</command> to
  58. automatically load the required modules</para>
  59. <indexterm zone="ch-system-module-init-tools depmod"><primary sortas="b-depmod">depmod</primary></indexterm>
  60. </listitem>
  61. </varlistentry>
  62. <varlistentry id="genksyms">
  63. <term><command>genksyms</command></term>
  64. <listitem>
  65. <para>Generates symbol version information</para>
  66. <indexterm zone="ch-system-module-init-tools genksyms"><primary sortas="b-genksyms">genksyms</primary></indexterm>
  67. </listitem>
  68. </varlistentry>
  69. <varlistentry id="insmod">
  70. <term><command>insmod</command></term>
  71. <listitem>
  72. <para>Installs a loadable module in the running kernel</para>
  73. <indexterm zone="ch-system-module-init-tools insmod"><primary sortas="b-insmod">insmod</primary></indexterm>
  74. </listitem>
  75. </varlistentry>
  76. <varlistentry id="insmod_ksymoops_clean">
  77. <term><command>insmod_ksymoops_clean</command></term>
  78. <listitem>
  79. <para>Deletes saved ksyms and modules not accessed for two days</para>
  80. <indexterm zone="ch-system-module-init-tools insmod_ksymoops_clean"><primary sortas="b-insmod_ksymoops_clean">insmod_ksymoops_clean</primary></indexterm>
  81. </listitem>
  82. </varlistentry>
  83. <varlistentry id="kallsyms">
  84. <term><command>kallsyms</command></term>
  85. <listitem>
  86. <para>Extracts all kernel symbols for debugging</para>
  87. <indexterm zone="ch-system-module-init-tools kallsyms"><primary sortas="b-kallsyms">kallsyms</primary></indexterm>
  88. </listitem>
  89. </varlistentry>
  90. <varlistentry id="kernelversion">
  91. <term><command>kernelversion</command></term>
  92. <listitem>
  93. <para>Reports the major version of the running kernel</para>
  94. <indexterm zone="ch-system-module-init-tools kernelversion"><primary sortas="b-kernelversion">kernelversion</primary></indexterm>
  95. </listitem>
  96. </varlistentry>
  97. <varlistentry id="ksyms">
  98. <term><command>ksyms</command></term>
  99. <listitem>
  100. <para>Displays exported kernel symbols</para>
  101. <indexterm zone="ch-system-module-init-tools ksyms"><primary sortas="b-ksyms">ksyms</primary></indexterm>
  102. </listitem>
  103. </varlistentry>
  104. <varlistentry id="lsmod">
  105. <term><command>lsmod</command></term>
  106. <listitem>
  107. <para>Lists currently loaded modules</para>
  108. <indexterm zone="ch-system-module-init-tools lsmod"><primary sortas="b-lsmod">lsmod</primary></indexterm>
  109. </listitem>
  110. </varlistentry>
  111. <varlistentry id="modinfo">
  112. <term><command>modinfo</command></term>
  113. <listitem>
  114. <para>Examines an object file associated with a kernel module and
  115. displays any information that it can glean</para>
  116. <indexterm zone="ch-system-module-init-tools modinfo"><primary sortas="b-modinfo">modinfo</primary></indexterm>
  117. </listitem>
  118. </varlistentry>
  119. <varlistentry id="modprobe">
  120. <term><command>modprobe</command></term>
  121. <listitem>
  122. <para>Uses a dependency file, created by
  123. <command>depmod</command>, to automatically load relevant modules</para>
  124. <indexterm zone="ch-system-module-init-tools modprobe"><primary sortas="b-modprobe">modprobe</primary></indexterm>
  125. </listitem>
  126. </varlistentry>
  127. <varlistentry id="rmmod">
  128. <term><command>rmmod</command></term>
  129. <listitem>
  130. <para>Unloads modules from the running kernel</para>
  131. <indexterm zone="ch-system-module-init-tools rmmod"><primary sortas="b-rmmod">rmmod</primary></indexterm>
  132. </listitem>
  133. </varlistentry>
  134. </variablelist>
  135. </sect2>
  136. </sect1>