[deployment-guide/comm-rel: 508/727] Minor corrections in the Kernel Module Utilities section.
Jaromir Hradilek
jhradile at fedoraproject.org
Tue Oct 19 13:07:37 UTC 2010
commit 3197cf924f2dea8e95e0eda70b4b70064d654d36
Author: Jaromir Hradilek <jhradile at redhat.com>
Date: Sat Aug 28 13:22:13 2010 +0200
Minor corrections in the Kernel Module Utilities section.
en-US/Working_with_Kernel_Modules.xml | 52 ++++++++++++++++----------------
1 files changed, 26 insertions(+), 26 deletions(-)
---
diff --git a/en-US/Working_with_Kernel_Modules.xml b/en-US/Working_with_Kernel_Modules.xml
index 84d5377..7b09205 100644
--- a/en-US/Working_with_Kernel_Modules.xml
+++ b/en-US/Working_with_Kernel_Modules.xml
@@ -37,12 +37,6 @@
<primary>kernel module</primary>
<secondary>utilities</secondary>
</indexterm>
- <note>
- <title>Note: Make Sure You Have <package>module-init-tools</package> Installed</title>
- <para>
- To use utilities described in this section, you must have the <package>module-init-tools</package> package installed. Refer to <xref linkend="sec-Installing" /> for more information on how to install new packages in &MAJOROS;.
- </para>
- </note>
<indexterm>
<primary>kernel module</primary>
<secondary>commands</secondary>
@@ -52,7 +46,13 @@
<primary>kernel module</primary>
<secondary>module-init-tools</secondary>
</indexterm>
- <para>To determine of a module has been loaded successfully, or when trying different modules for a piece of new hardware, you can use the following utilities.</para>
+ <para>To determine if a module has been loaded successfully, or when trying different modules for a piece of new hardware, you can use the following utilities.</para>
+ <note>
+ <title>Note: Make Sure You Have <package>module-init-tools</package> Installed</title>
+ <para>
+ To use utilities described in this section, you must have the <package>module-init-tools</package> package installed. Refer to <xref linkend="sec-Installing" /> for more information on how to install new packages in &MAJOROS;.
+ </para>
+ </note>
<section
id="s2-kernel-module-utils-lsmod">
<title>Listing Currently Loaded Modules</title>
@@ -67,9 +67,9 @@
<primary>kernel module</primary>
<secondary>listing</secondary>
</indexterm>
- <para>To display a list of currently loaded modules, use the <command>/sbin/lsmod</command> command. For example:</para>
+ <para>To display a list of currently loaded modules, use the <command>lsmod</command> command. For example:</para>
<screen>
-~]$ <command>/sbin/lsmod</command>
+~]$ <command>lsmod</command>
Module Size Used by
autofs4 25618 3
sunrpc 231823 1
@@ -129,13 +129,13 @@ dm_mod 73839 8 dm_mirror,dm_log</screen>
<secondary>loading</secondary>
</indexterm>
<para>To load a kernel module, use the <command>modprobe</command> command in the following form:</para>
- <screen><command>/sbin/modprobe <replaceable><module></replaceable></command></screen>
+ <screen><command>modprobe <replaceable><module></replaceable></command></screen>
<para>For example, to load the <systemitem class="resource">wacom</systemitem> module, type:</para>
- <screen>~]# <command>/sbin/modprobe wacom</command></screen>
+ <screen>~]# <command>modprobe wacom</command></screen>
<para>By default, <command>modprobe</command> attempts to load the module from <filename class="directory">/lib/modules/<replaceable><kernel-version></replaceable>/kernel/drivers/</filename>. In this directory, each type of module has its own subdirectory, such as <filename class="directory">net/</filename> for network interface drivers.</para>
- <para>Some kernel modules have module dependencies, which means that other modules must be loaded first for them to load successfully. The <command>modprobe</command> command checks for these dependencies, and loads the required modules automatically so that you do not have to resolve the dependencies manually. This way, typing the <command>/sbin/modprobe e100</command> command first loads all dependencies of <systemitem class="resource">e100</systemitem>, and then the module itself.</para>
+ <para>Some kernel modules have module dependencies, which means that other modules must be loaded first for them to load successfully. The <command>modprobe</command> command checks for these dependencies, and loads the required modules automatically so that you do not have to resolve the dependencies manually. This way, typing the <command>modprobe e100</command> command first loads all dependencies of <systemitem class="resource">e100</systemitem>, and then the module itself.</para>
<para>To display all commands as <command>modprobe</command> executes them, use the <option>-v</option> option. For example:</para>
- <screen>~]# <command>/sbin/modprobe -v e100</command>
+ <screen>~]# <command>modprobe -v e100</command>
insmod /lib/modules/2.6.32-54.el6.i686/kernel/drivers/net/mii.ko
insmod /lib/modules/2.6.32-54.el6.i686/kernel/drivers/net/e100.ko</screen>
<indexterm
@@ -146,7 +146,7 @@ insmod /lib/modules/2.6.32-54.el6.i686/kernel/drivers/net/e100.ko</screen>
</indexterm>
<important>
<title>Important: Do Not Use <command>insmod</command> Directly</title>
- <para>Although the <command>/sbin/insmod</command> command can also be used to load kernel modules, it does not resolve dependencies. Because of this, you should always use <command>modprobe</command> instead.</para>
+ <para>Although the <command>insmod</command> command can also be used to load kernel modules, it does not resolve dependencies. Because of this, you should always use <command>modprobe</command> instead.</para>
</important>
<indexterm>
<primary>kernel module</primary>
@@ -163,9 +163,9 @@ insmod /lib/modules/2.6.32-54.el6.i686/kernel/drivers/net/e100.ko</screen>
<tertiary>supplying</tertiary>
</indexterm>
<para>In some situations, it may be desirable to customize the module behavior by supplying additional parameters to it. To do so, use the <command>modprobe</command> command in the following form:</para>
- <screen><command>/sbin/modprobe <replaceable><module></replaceable> <replaceable><parameter></replaceable>...</command></screen>
+ <screen><command>modprobe <replaceable><module></replaceable> <replaceable><parameter></replaceable>...</command></screen>
<para>For example, to allow bad eeprom checksums and set the debug level to maximum for an Intel Ether Express/100 driver, type:</para>
- <screen>~]# <command>/sbin/modprobe e100 eeprom_bad_csum_allow=1 debug=16</command></screen>
+ <screen>~]# <command>modprobe e100 eeprom_bad_csum_allow=1 debug=16</command></screen>
<para>Note that when a module parameter expects comma-separated values, you should <emphasis>not</emphasis> use speces after the commas. Refer to <xref linkend="s1-modules-parameters" /> for a list of common module parameters.</para>
</section>
<section
@@ -183,12 +183,12 @@ insmod /lib/modules/2.6.32-54.el6.i686/kernel/drivers/net/e100.ko</screen>
<secondary>unloading</secondary>
</indexterm>
<para>To unload a kernel module, use the <command>modprobe</command> command in the following form:</para>
- <screen><command>/sbin/modprobe -r <replaceable><module></replaceable></command></screen>
+ <screen><command>modprobe -r <replaceable><module></replaceable></command></screen>
<para>For example, to unload the <systemitem class="resource">wacom</systemitem> module, type:</para>
- <screen>~]# <command>/sbin/modprobe -r wacom</command></screen>
+ <screen>~]# <command>modprobe -r wacom</command></screen>
<para>The <command>modprobe -r</command> command only unloads modules that are not in use and that are not a dependency of other modules in use. On the other hand, it checks for dependencies and unloads all modules that were previously required, but that are no longer necessary.</para>
<para>To display all commands as <command>modprobe</command> executes them, use the <option>-v</option> option. For example:</para>
- <screen>~]# <command>/sbin/modprobe -v -r e100</command>
+ <screen>~]# <command>modprobe -v -r e100</command>
rmmod /lib/modules/2.6.32-54.el6.i686/kernel/drivers/net/e100.ko
rmmod /lib/modules/2.6.32-54.el6.i686/kernel/drivers/net/mii.ko</screen>
<indexterm
@@ -199,7 +199,7 @@ rmmod /lib/modules/2.6.32-54.el6.i686/kernel/drivers/net/mii.ko</screen>
</indexterm>
<important>
<title>Important: Do Not Use <command>rmmod</command> Directly</title>
- <para>Although the <command>/sbin/rmmod</command> command can also be used to unload kernel modules, it is recommended that you use <command>modprobe</command> instead.</para>
+ <para>Although the <command>rmmod</command> command can also be used to unload kernel modules, it is recommended that you use <command>modprobe</command> instead.</para>
</important>
</section>
<section
@@ -217,9 +217,9 @@ rmmod /lib/modules/2.6.32-54.el6.i686/kernel/drivers/net/mii.ko</screen>
<secondary>examining</secondary>
</indexterm>
<para>To display detailed information about a kernel module, use the <command>modinfo</command> in the following form:</para>
- <screen><command>/sbin/modinfo <replaceable><module></replaceable></command></screen>
+ <screen><command>modinfo <replaceable><module></replaceable></command></screen>
<para>For example, to display information about the <systemitem class="resource">e100</systemitem> module, type:</para>
- <screen>~]# <command>/sbin/modinfo e100</command>
+ <screen>~]# <command>modinfo e100</command>
filename: /lib/modules/2.6.32-54.el6.i686/kernel/drivers/net/e100.ko
firmware: e100/d102e_ucode.bin
firmware: e100/d101s_ucode.bin
@@ -239,15 +239,15 @@ parm: debug:Debug level (0=none,...,16=all) (int)
parm: eeprom_bad_csum_allow:Allow bad eeprom checksums (int)
parm: use_io:Force use of i/o access mode (int)</screen>
<para>To display only a brief description of the module, use the <option>-d</option> option. For example:</para>
- <screen>~]# <command>/sbin/modinfo -d e100</command>
+ <screen>~]# <command>modinfo -d e100</command>
Intel(R) PRO/100 Network Driver</screen>
<para>To list the supported parameters, use the <option>-p</option> option:</para>
- <screen>~]# <command>/sbin/modinfo -p e100</command>
+ <screen>~]# <command>modinfo -p e100</command>
use_io:Force use of i/o access mode
eeprom_bad_csum_allow:Allow bad eeprom checksums
debug:Debug level (0=none,...,16=all)</screen>
<para>Finally, to display the corresponding module filename, use the <option>-n</option> option like this:</para>
- <screen>~]# <command>/sbin/modinfo -n e100</command>
+ <screen>~]# <command>modinfo -n e100</command>
/lib/modules/2.6.32-54.el6.i686/kernel/drivers/net/e100.ko</screen>
</section>
<section
@@ -277,7 +277,7 @@ if [ ! -c /dev/input/uinput ] ; then
exec /sbin/modprobe uinput >/dev/null 2>&1
fi</programlisting>
</example>
- <para>The <literal>if</literal> conditional statement on the third line ensures that the <filename>/dev/input/uinput</filename> file does <emphasis>not</emphasis> exist (the <literal>!</literal> symbol negates the condition), and, if that is the case, then executes <command>/sbin/modprobe</command> with the name of the kernel module to load—<systemitem class="resource">uinput</systemitem> in this example. The remainder of the line redirects any output to <filename>/dev/null</filename> so that the <command>modprobe</command> command remains quiet.</para>
+ <para>The <literal>if</literal> conditional statement on the third line ensures that the <filename>/dev/input/uinput</filename> file does <emphasis>not</emphasis> exist (the <literal>!</literal> symbol negates the condition), and, if that is the case, then executes <command>modprobe</command> with the name of the kernel module to load—<systemitem class="resource">uinput</systemitem> in this example. The remainder of the line redirects any output to <filename>/dev/null</filename> so that the <command>modprobe</command> command remains quiet.</para>
<note
id="note-No_Need_to_Load_Network_and_SCSI_Modules">
<title>Note: Do Not Load Network and SCSI Modules</title>
More information about the docs-commits
mailing list