module-init-tools.xml 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  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>650 KB</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>Prepare Module-Init-Tools for compilation:</para>
  29. <screen><userinput>./configure --prefix="" --enable-zlib</userinput></screen>
  30. <para>Compile the package:</para>
  31. <screen><userinput>make DOCBOOKTOMAN=""</userinput></screen>
  32. <!-- Edit me -->
  33. <para>The <envar>DOCBOOKTOMAN</envar> option allows the compile process to
  34. complete without regenerating the man pages.</para>
  35. <para>To test the results, issue:
  36. <userinput>make check</userinput>.</para>
  37. <para>Install the package:</para>
  38. <screen><userinput>make install</userinput></screen>
  39. </sect2>
  40. <sect2 id="contents-module-init-tools" role="content"><title>Contents of Module-Init-Tools</title>
  41. <segmentedlist>
  42. <segtitle>Installed programs</segtitle>
  43. <seglistitem><seg>depmod, genksyms, insmod,
  44. insmod_ksymoops_clean, kallsyms (link to insmod), kernelversion, ksyms
  45. (link to insmod), lsmod (link to insmod), modinfo, modprobe (link to
  46. insmod), and rmmod (link to insmod)</seg></seglistitem>
  47. </segmentedlist>
  48. <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
  49. <?dbfo list-presentation="list"?>
  50. <?dbhtml list-presentation="table"?>
  51. <varlistentry id="depmod">
  52. <term><command>depmod</command></term>
  53. <listitem>
  54. <para>Creates a dependency file based on the symbols it finds in the
  55. existing set of modules; this dependency file is used by <command>modprobe</command> to
  56. automatically load the required modules</para>
  57. <indexterm zone="ch-system-module-init-tools depmod"><primary sortas="b-depmod">depmod</primary></indexterm>
  58. </listitem>
  59. </varlistentry>
  60. <varlistentry id="genksyms">
  61. <term><command>genksyms</command></term>
  62. <listitem>
  63. <para>Generates symbol version information</para>
  64. <indexterm zone="ch-system-module-init-tools genksyms"><primary sortas="b-genksyms">genksyms</primary></indexterm>
  65. </listitem>
  66. </varlistentry>
  67. <varlistentry id="insmod">
  68. <term><command>insmod</command></term>
  69. <listitem>
  70. <para>Installs a loadable module in the running kernel</para>
  71. <indexterm zone="ch-system-module-init-tools insmod"><primary sortas="b-insmod">insmod</primary></indexterm>
  72. </listitem>
  73. </varlistentry>
  74. <varlistentry id="insmod_ksymoops_clean">
  75. <term><command>insmod_ksymoops_clean</command></term>
  76. <listitem>
  77. <para>Deletes saved ksyms and modules not accessed for two days</para>
  78. <indexterm zone="ch-system-module-init-tools insmod_ksymoops_clean"><primary sortas="b-insmod_ksymoops_clean">insmod_ksymoops_clean</primary></indexterm>
  79. </listitem>
  80. </varlistentry>
  81. <varlistentry id="kallsyms">
  82. <term><command>kallsyms</command></term>
  83. <listitem>
  84. <para>Extracts all kernel symbols for debugging</para>
  85. <indexterm zone="ch-system-module-init-tools kallsyms"><primary sortas="b-kallsyms">kallsyms</primary></indexterm>
  86. </listitem>
  87. </varlistentry>
  88. <varlistentry id="kernelversion">
  89. <term><command>kernelversion</command></term>
  90. <listitem>
  91. <para>Reports the major version of the running kernel</para>
  92. <indexterm zone="ch-system-module-init-tools kernelversion"><primary sortas="b-kernelversion">kernelversion</primary></indexterm>
  93. </listitem>
  94. </varlistentry>
  95. <varlistentry id="ksyms">
  96. <term><command>ksyms</command></term>
  97. <listitem>
  98. <para>Displays exported kernel symbols</para>
  99. <indexterm zone="ch-system-module-init-tools ksyms"><primary sortas="b-ksyms">ksyms</primary></indexterm>
  100. </listitem>
  101. </varlistentry>
  102. <varlistentry id="lsmod">
  103. <term><command>lsmod</command></term>
  104. <listitem>
  105. <para>Lists currently loaded modules</para>
  106. <indexterm zone="ch-system-module-init-tools lsmod"><primary sortas="b-lsmod">lsmod</primary></indexterm>
  107. </listitem>
  108. </varlistentry>
  109. <varlistentry id="modinfo">
  110. <term><command>modinfo</command></term>
  111. <listitem>
  112. <para>Examines an object file associated with a kernel module and
  113. displays any information that it can glean</para>
  114. <indexterm zone="ch-system-module-init-tools modinfo"><primary sortas="b-modinfo">modinfo</primary></indexterm>
  115. </listitem>
  116. </varlistentry>
  117. <varlistentry id="modprobe">
  118. <term><command>modprobe</command></term>
  119. <listitem>
  120. <para>Uses a dependency file, created by
  121. <command>depmod</command>, to automatically load relevant modules</para>
  122. <indexterm zone="ch-system-module-init-tools modprobe"><primary sortas="b-modprobe">modprobe</primary></indexterm>
  123. </listitem>
  124. </varlistentry>
  125. <varlistentry id="rmmod">
  126. <term><command>rmmod</command></term>
  127. <listitem>
  128. <para>Unloads modules from the running kernel</para>
  129. <indexterm zone="ch-system-module-init-tools rmmod"><primary sortas="b-rmmod">rmmod</primary></indexterm>
  130. </listitem>
  131. </varlistentry>
  132. </variablelist>
  133. </sect2>
  134. </sect1>