module-init-tools.xml 5.5 KB

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