module-init-tools.xml 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  3. <!ENTITY % general-entities SYSTEM "../general.ent">
  4. %general-entities;
  5. ]>
  6. <sect1 id="ch-system-module-init-tools" xreflabel="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>Module-Init-Tools installation depends on</segtitle>
  20. <seglistitem><seg>Bash, Binutils, Bison,
  21. Coreutils, Diffutils, Flex, GCC, Glibc, Grep, M4, Make, 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</userinput></screen>
  30. <para>To test the results, issue:
  31. <userinput>make check</userinput>.</para>
  32. <para>Install it:</para>
  33. <screen><userinput>make install</userinput></screen>
  34. </sect2>
  35. <sect2 id="contents-module-init-tools" role="content"><title>Contents of Module-Init-Tools</title>
  36. <segmentedlist>
  37. <segtitle>Installed programs</segtitle>
  38. <seglistitem><seg>depmod, genksyms, insmod,
  39. insmod_ksymoops_clean, kallsyms (link to insmod), kernelversion, ksyms
  40. (link to insmod), lsmod (link to insmod), modinfo, modprobe (link to insmod)
  41. and rmmod (link to insmod)</seg></seglistitem>
  42. </segmentedlist>
  43. <variablelist><title>Short descriptions</title>
  44. <varlistentry>
  45. <term id="depmod"><command>depmod</command></term>
  46. <listitem>
  47. <indexterm zone="ch-system-module-init-tools depmod"><primary sortas="b-depmod">depmod</primary></indexterm>
  48. <para>creates a dependency file, based on the
  49. symbols it finds in the existing set of modules. This dependency file is used
  50. by modprobe to automatically load the required modules.</para>
  51. </listitem>
  52. </varlistentry>
  53. <varlistentry>
  54. <term id="genksyms"><command>genksyms</command></term>
  55. <listitem>
  56. <indexterm zone="ch-system-module-init-tools genksyms"><primary sortas="b-genksyms">genksyms</primary></indexterm>
  57. <para>generates symbol version information.</para>
  58. </listitem>
  59. </varlistentry>
  60. <varlistentry>
  61. <term id="insmod"><command>insmod</command></term>
  62. <listitem>
  63. <indexterm zone="ch-system-module-init-tools insmod"><primary sortas="b-insmod">insmod</primary></indexterm>
  64. <para>installs a loadable module in the running kernel.</para>
  65. </listitem>
  66. </varlistentry>
  67. <varlistentry>
  68. <term id="insmod_ksymoops_clean"><command>insmod_ksymoops_clean</command></term>
  69. <listitem>
  70. <indexterm zone="ch-system-module-init-tools insmod_ksymoops_clean"><primary sortas="b-insmod_ksymoops_clean">insmod_ksymoops_clean</primary></indexterm>
  71. <para>deletes saved ksyms and modules not accessed for two days.</para>
  72. </listitem>
  73. </varlistentry>
  74. <varlistentry>
  75. <term id="kallsyms"><command>kallsyms</command></term>
  76. <listitem>
  77. <indexterm zone="ch-system-module-init-tools kallsyms"><primary sortas="b-kallsyms">kallsyms</primary></indexterm>
  78. <para>extracts all kernel symbols for debugging.</para>
  79. </listitem>
  80. </varlistentry>
  81. <varlistentry>
  82. <term id="kernelversion"><command>kernelversion</command></term>
  83. <listitem>
  84. <indexterm zone="ch-system-module-init-tools kernelversion"><primary sortas="b-kernelversion">kernelversion</primary></indexterm>
  85. <para>reports the major version of the running kernel.</para>
  86. </listitem>
  87. </varlistentry>
  88. <varlistentry>
  89. <term id="ksyms"><command>ksyms</command></term>
  90. <listitem>
  91. <indexterm zone="ch-system-module-init-tools ksyms"><primary sortas="b-ksyms">ksyms</primary></indexterm>
  92. <para>displays exported kernel symbols.</para>
  93. </listitem>
  94. </varlistentry>
  95. <varlistentry>
  96. <term id="lsmod"><command>lsmod</command></term>
  97. <listitem>
  98. <indexterm zone="ch-system-module-init-tools lsmod"><primary sortas="b-lsmod">lsmod</primary></indexterm>
  99. <para>shows which modules are loaded.</para>
  100. </listitem>
  101. </varlistentry>
  102. <varlistentry>
  103. <term id="modinfo"><command>modinfo</command></term>
  104. <listitem>
  105. <indexterm zone="ch-system-module-init-tools modinfo"><primary sortas="b-modinfo">modinfo</primary></indexterm>
  106. <para>examines an object file associated with
  107. a kernel module and displays any information that it can glean.</para>
  108. </listitem>
  109. </varlistentry>
  110. <varlistentry>
  111. <term id="modprobe"><command>modprobe</command></term>
  112. <listitem>
  113. <indexterm zone="ch-system-module-init-tools modprobe"><primary sortas="b-modprobe">modprobe</primary></indexterm>
  114. <para>uses a dependency file, created by
  115. depmod, to automatically load the relevant modules.</para>
  116. </listitem>
  117. </varlistentry>
  118. <varlistentry>
  119. <term id="rmmod"><command>rmmod</command></term>
  120. <listitem>
  121. <indexterm zone="ch-system-module-init-tools rmmod"><primary sortas="b-rmmod">rmmod</primary></indexterm>
  122. <para>unloads modules from the running kernel.</para>
  123. </listitem>
  124. </varlistentry>
  125. </variablelist>
  126. </sect2>
  127. </sect1>