[deployment-guide/comm-rel: 155/727] GenParams: mv indexterms to logical positions; format
Jaromir Hradilek
jhradile at fedoraproject.org
Tue Oct 19 12:37:19 UTC 2010
commit daa211480537e205949cd81b1393644d0ae2157a
Author: Douglas Silas <dhensley at redhat.com>
Date: Mon Jul 26 22:13:14 2010 +0200
GenParams: mv indexterms to logical positions; format
en-US/General_Parameters_and_Modules.xml | 171 +++++++++++++++++++++++-------
1 files changed, 132 insertions(+), 39 deletions(-)
---
diff --git a/en-US/General_Parameters_and_Modules.xml b/en-US/General_Parameters_and_Modules.xml
index 5cb69fc..f04f98a 100644
--- a/en-US/General_Parameters_and_Modules.xml
+++ b/en-US/General_Parameters_and_Modules.xml
@@ -24,13 +24,29 @@
<primary>kernel module</primary>
<secondary>types of</secondary>
</indexterm>
- <para>This chapter is provided to illustrate <emphasis>some</emphasis> of the possible parameters available for common hardware device <firstterm>drivers</firstterm><footnote><para>A <firstterm>driver</firstterm> is software that enables Linux to use a particular hardware device. Without a driver, the kernel cannot communicate with attached devices.</para></footnote>, which under &MAJOROS; are called <firstterm>kernel module</firstterm>s . In most cases, the default parameters do work. However, there may be times when extra module parameters are necessary for a device to function properly or to override the module's default parameters for the device.</para>
+ <para>This chapter is provided to illustrate <emphasis>some</emphasis> of the possible parameters available for common hardware device <firstterm>drivers</firstterm>
+ <footnote>
+ <para>A <firstterm>driver</firstterm> is software that enables Linux to use a particular hardware device. Without a driver, the kernel cannot communicate with attached devices.</para>
+ </footnote>, which under &MAJOROS; are called <firstterm>kernel module</firstterm>s . In most cases, the default parameters do work. However, there may be times when extra module parameters are necessary for a device to function properly or to override the module's default parameters for the device.</para>
<para>During installation, &MAJOROS; uses a limited subset of device drivers to create a stable installation environment. Although the installation program supports installation on many different types of hardware, some drivers (including those for SCSI adapters and network adapters) are not included in the installation kernel. Rather, they must be loaded as modules by the user at boot time.</para>
<para>Once installation is completed, support exists for a large number of devices through kernel modules.</para>
<section
id="s1-kernel-module-utils">
- <title>Kernel Module Utilities</title><indexterm><primary>kernel module</primary><secondary>utilities</secondary></indexterm>
- <para>A group of commands for managing kernel modules is available if the <filename>module-init-tools</filename><indexterm><primary>kernel module</primary><secondary>commands</secondary><tertiary>group of</tertiary></indexterm><indexterm><primary>kernel module</primary><secondary>module-init-tools</secondary></indexterm> package is installed. Use these commands to determine if a module has been loaded successfully or when trying different modules for a piece of new hardware.</para>
+ <title>Kernel Module Utilities</title>
+ <indexterm>
+ <primary>kernel module</primary>
+ <secondary>utilities</secondary>
+ </indexterm>
+ <para>A group of commands for managing kernel modules is available if the <filename>module-init-tools</filename>
+ <indexterm>
+ <primary>kernel module</primary>
+ <secondary>commands</secondary>
+ <tertiary>group of</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary>kernel module</primary>
+ <secondary>module-init-tools</secondary>
+ </indexterm> package is installed. Use these commands to determine if a module has been loaded successfully or when trying different modules for a piece of new hardware.</para>
<indexterm
significance="normal">
<primary>
@@ -113,8 +129,8 @@ dm_mod 73839 8 dm_mirror,dm_log</screen>
</screen>
<para>Output similar to the following is displayed:</para>
<screen>
-/sbin/insmod /lib/modules/2.6.9-5.EL/kernel/drivers/net/e100.ko
-Using /lib/modules/2.6.9-5.EL/kernel/drivers/net/e100.ko
+/sbin/insmod /lib/modules/2.6.33-5.EL/kernel/drivers/net/e100.ko
+Using /lib/modules/2.6.33-5.EL/kernel/drivers/net/e100.ko
Symbol version prefix 'smp_'
</screen>
<indexterm
@@ -151,8 +167,14 @@ Symbol version prefix 'smp_'
<section
id="s1-kernel-modules-persistant">
<title>Persistent Module Loading</title>
- <indexterm><primary>kernel module</primary><secondary>persistent loading</secondary></indexterm>
- <indexterm><primary>kernel module</primary><secondary>/etc/sysconfig/modules/</secondary></indexterm>
+ <indexterm>
+ <primary>kernel module</primary>
+ <secondary>persistent loading</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>kernel module</primary>
+ <secondary>/etc/sysconfig/modules/</secondary>
+ </indexterm>
<para>Many kernel modules are loaded automatically at boot time, as <command>/sbin/lsmod</command> shows. You can specify other modules to be loaded at boot time by creating a file in the <filename>/etc/sysconfig/modules/</filename> directory. You can use any name you like for the file that you create, but you must give it a <filename>.modules</filename> extension, and you must make it executable by running the following command:</para>
<screen>modules]# <command>chmod 755 <replaceable><filename.modules></replaceable>
</command>
@@ -168,7 +190,6 @@ Symbol version prefix 'smp_'
id="ex-bluez-uinput.modules">
<title>/etc/sysconfig/modules/bluez-uinput.modules</title>
<programlisting>#!/bin/sh
-
if [ ! -c /dev/input/uinput ] ; then
exec /sbin/modprobe uinput >/dev/null 2>&1
fi</programlisting>
@@ -181,9 +202,19 @@ fi</programlisting>
<section
id="s1-modules-parameters-specifying">
<title>Specifying Module Parameters</title>
- <indexterm><primary>kernel module</primary><secondary>module parameters</secondary><tertiary>specifying</tertiary></indexterm>
- <indexterm><primary>module parameters</primary><see>kernel module</see></indexterm>
- <para>In some situations, it may be necessary to supply parameters to a module<indexterm><primary>kernel module</primary><secondary>module parameters</secondary><tertiary>supplying</tertiary></indexterm> as it is loaded for it to function properly.</para>
+ <indexterm>
+ <primary>kernel module</primary>
+ <secondary>module parameters</secondary>
+ <tertiary>specifying</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary>module parameters</primary>
+ <see>kernel module</see>
+ </indexterm>
+ <para>In some situations, it may be necessary to supply parameters to a module<indexterm><primary>kernel module</primary>
+ <secondary>module parameters</secondary>
+ <tertiary>supplying</tertiary>
+ </indexterm> as it is loaded for it to function properly.</para>
<para>For instance, to enable full duplex at 100Mbps connection speed for an Intel Ether Express/100 card, load the <filename>e100</filename> driver with the <option>e100_speed_duplex=4</option> option.</para>
<important>
<title>Important: kernel module parameters separated by commas</title>
@@ -193,8 +224,15 @@ fi</programlisting>
<section
id="s1-modules-scsi">
<title>Storage parameters</title>
- <indexterm><primary>SCSI module</primary><see>kernel module</see></indexterm>
- <indexterm><primary>kernel module</primary><secondary>SCSImodule</secondary><tertiary>parameters</tertiary></indexterm>
+ <indexterm>
+ <primary>SCSI module</primary>
+ <see>kernel module</see>
+ </indexterm>
+ <indexterm>
+ <primary>kernel module</primary>
+ <secondary>SCSImodule</secondary>
+ <tertiary>parameters</tertiary>
+ </indexterm>
<table
id="tb-modules-scsiparameters">
<title>Storage Module Parameters</title>
@@ -415,11 +453,14 @@ fi</programlisting>
</entry>
</row>
<row>
+ <entry>NCR, Symbios and LSI 8xx and 1010</entry>
<entry>
- NCR, Symbios and LSI 8xx and 1010
- </entry>
- <entry>
- sym53c8xx <remark>DEPRECATED</remark>
+ <para>sym53c8xx</para>
+ <important
+ id="important-Important">
+ <title>Important</title>
+ <para>The sym53c8xx module is available in &MAJOROSVER;, but is deprecated, and will be removed in a future version of &MAJOROS;.</para>
+ </important>
</entry>
<entry>
<para>
@@ -459,11 +500,23 @@ fi</programlisting>
<section
id="s1-modules-ethernet">
<title>Ethernet Parameters</title>
- <indexterm><primary>Ethernet module</primary><see>kernel module</see></indexterm>
- <indexterm><primary>kernel module</primary><secondary>Ethernet module</secondary></indexterm>
- <indexterm><primary>NIC module</primary><secondary>kernel module</secondary></indexterm>
- <indexterm><primary>kernel module</primary><secondary>NIC module</secondary></indexterm>
- <para>Most modern Ethernet-based network interface cards (NICs), do not require module parameters to alter settings. Instead, they can be configured using <command>ethtool</command> or <command>mii-tool</command>. Only after these tools fail to work should module parameters be adjusted. Module paramaters can be viewed using the <command>modinfo</command> command.</para>
+ <indexterm>
+ <primary>Ethernet module</primary>
+ <see>kernel module</see>
+ </indexterm>
+ <indexterm>
+ <primary>kernel module</primary>
+ <secondary>Ethernet module</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>NIC module</primary>
+ <secondary>kernel module</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>kernel module</primary>
+ <secondary>NIC module</secondary>
+ </indexterm>
+ <para>Most modern Ethernet-based network interface cards (NICs), do not require module parameters to alter settings. Instead, they can be configured using <command>ethtool</command> or <command>mii-tool</command>. Only after these tools fail to work should module parameters be adjusted. Module parameters can be viewed using the <command>modinfo</command> command.</para>
<note>
<title>Note</title>
<para>For information about using these tools, consult the man pages for <command>ethtool</command>, <command>mii-tool</command>, and <command>modinfo</command>.</para>
@@ -857,8 +910,15 @@ fi</programlisting>
<section
id="s2-modules-multiple-eth">
<title>Using Multiple Ethernet Cards</title>
- <indexterm><primary>kernel module</primary><secondary>Ethernet module</secondary><tertiary>supporting multiple cards</tertiary></indexterm>
- <indexterm><primary>Ethernet module</primary><see>kernel module</see></indexterm>
+ <indexterm>
+ <primary>kernel module</primary>
+ <secondary>Ethernet module</secondary>
+ <tertiary>supporting multiple cards</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary>Ethernet module</primary>
+ <see>kernel module</see>
+ </indexterm>
<para>It is possible to use multiple Ethernet cards on a single machine. For each card there must be an <command>alias</command> and, possibly, <command>options</command> lines for each card in a user-created <filename><replaceable><module_name></replaceable>.conf</filename> file in the <filename>/etc/modprobe.d/</filename> directory.</para>
<para>For additional information about using multiple Ethernet cards, refer to the <citetitle>Linux Ethernet-HOWTO</citetitle> online at <ulink
url="http://www.redhat.com/mirrors/LDP/HOWTO/Ethernet-HOWTO.html">http://www.redhat.com/mirrors/LDP/HOWTO/Ethernet-HOWTO.html</ulink>.</para>
@@ -866,15 +926,31 @@ fi</programlisting>
<section
id="s2-modules-bonding">
<title>The Channel Bonding Module</title>
- <indexterm><primary>channel bonding</primary><secondary>bonding options</secondary></indexterm>
- <indexterm><primary>kernel module</primary><secondary>channel bonding</secondary></indexterm>
+ <indexterm>
+ <primary>channel bonding</primary>
+ <secondary>bonding options</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>kernel module</primary>
+ <secondary>channel bonding</secondary>
+ </indexterm>
<para>&MAJOROS; allows administrators to bind NICs
- <indexterm><primary>NIC</primary><secondary>binding into single channel</secondary></indexterm>
+ <indexterm><primary>NIC</primary>
+ <secondary>binding into single channel</secondary>
+ </indexterm>
together into a single channel using the <filename>bonding</filename> kernel module
- <indexterm><primary>kernel module</primary><secondary>bonding kernel module</secondary></indexterm>
+ <indexterm><primary>kernel module</primary>
+ <secondary>bonding kernel module</secondary>
+ </indexterm>
and a special network interface, called a <firstterm>channel bonding interface</firstterm>
- <indexterm><primary>kernel module</primary><secondary>channel bonding interface</secondary></indexterm>
- <indexterm><primary>channel bonding interface</primary><see>kernel module</see></indexterm>
+ <indexterm>
+ <primary>kernel module</primary>
+ <secondary>channel bonding interface</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>channel bonding interface</primary>
+ <see>kernel module</see>
+ </indexterm>
. Channel bonding enables two or more network interfaces to act as one, simultaneously increasing the bandwidth and providing redundancy.</para>
<para>To channel bond multiple network interfaces, the administrator must perform the following steps:</para>
<orderedlist
@@ -897,19 +973,38 @@ fi</programlisting>
<section
id="s3-modules-bonding-directives">
<title>Bonding Module Directives</title>
- <indexterm><primary>channel bonding</primary><secondary>bonding directives</secondary></indexterm>
- <indexterm><primary>kernel module</primary><secondary>bonding kernel module</secondary><tertiary>bonding directives</tertiary></indexterm>
+ <indexterm>
+ <primary>channel bonding</primary>
+ <secondary>bonding directives</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>kernel module</primary>
+ <secondary>bonding kernel module</secondary>
+ <tertiary>bonding directives</tertiary>
+ </indexterm>
<para>It is a good idea to test which channel bonding module parameters work best for your bonded interfaces before adding them to the <parameter
class="option">BONDING_OPTS="<replaceable><bonding parameters></replaceable>"</parameter> directive in your bonding interface configuration file (<filename>ifcfg-bond0</filename> for example). Parameters to bonded interfaces can be configured
- <indexterm><primary>channel bonding</primary><secondary>parameters to bonded interfaces</secondary></indexterm>
- <indexterm><primary>kernel module</primary><secondary>bonding kernel module</secondary><tertiary>parameters to bonded interfaces</tertiary></indexterm>
+ <indexterm><primary>channel bonding</primary>
+ <secondary>parameters to bonded interfaces</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>kernel module</primary>
+ <secondary>bonding kernel module</secondary>
+ <tertiary>parameters to bonded interfaces</tertiary>
+ </indexterm>
without unloading (and reloading) the bonding module by manipulating files in the <systemitem
class="filesystem">sysfs</systemitem> file system.</para>
<para>
<systemitem
class="filesystem">sysfs</systemitem>
- <indexterm><primary>bonding kernel module</primary><secondary>sysfs</secondary></indexterm>
- <indexterm><primary>kernel bonding</primary><secondary>sysfs</secondary></indexterm>
+ <indexterm>
+ <primary>bonding kernel module</primary>
+ <secondary>sysfs</secondary>
+ </indexterm>
+ <indexterm>
+ <primary>kernel bonding</primary>
+ <secondary>sysfs</secondary>
+ </indexterm>
is a virtual file system that represents kernel objects as directories, files and symbolic links. <systemitem
class="filesystem">sysfs</systemitem> can be used to query for information about kernel objects, and can also manipulate those objects through the use of normal file system commands. The <systemitem
class="filesystem">sysfs</systemitem> virtual file system has a line in <filename>/etc/fstab</filename>, and is mounted under <filename>/sys</filename>.</para>
@@ -928,7 +1023,6 @@ bond0 Link encap:Ethernet HWaddr 00:00:00:00:00:00
TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
collisions:0 txqueuelen:0
RX bytes:0 (0.0 b) TX bytes:0 (0.0 b)
-
eth0 Link encap:Ethernet HWaddr 52:54:00:26:9E:F1
inet addr:192.168.122.251 Bcast:192.168.122.255 Mask:255.255.255.0
inet6 addr: fe80::5054:ff:fe26:9ef1/64 Scope:Link
@@ -937,7 +1031,6 @@ eth0 Link encap:Ethernet HWaddr 52:54:00:26:9E:F1
TX packets:205 errors:0 dropped:0 overruns:0 carrier:0
collisions:0 txqueuelen:1000
RX bytes:70374 (68.7 KiB) TX bytes:25298 (24.7 KiB)
-
<lineannotation>[output truncated]</lineannotation>
</screen>
<para>To view all existing bonds, even if they are not up, run:</para>
More information about the docs-commits
mailing list