[system-administrators-guide] Markup improvements to Network_Interfaces.xml
stephenw
stephenw at fedoraproject.org
Fri Jul 26 10:24:36 UTC 2013
commit 8276165b81ca6b09ed5b99cbd89b2c52caac1db0
Author: Stephen Wadeley <swadeley at redhat.com>
Date: Fri Jul 26 12:02:04 2013 +0200
Markup improvements to Network_Interfaces.xml
en-US/Network_Interfaces.xml | 44 +++++++++++++++++++++---------------------
1 files changed, 22 insertions(+), 22 deletions(-)
---
diff --git a/en-US/Network_Interfaces.xml b/en-US/Network_Interfaces.xml
index 25198ec..e078f18 100644
--- a/en-US/Network_Interfaces.xml
+++ b/en-US/Network_Interfaces.xml
@@ -254,16 +254,16 @@ ONBOOT=yes</programlisting>
<itemizedlist>
<listitem>
<para>
- <literal>yes</literal> — Use DHCP to obtain an IPv6 address for this interface.
+ <literal>yes</literal> — Use DHCP to obtain an <systemitem class="protocol">IPv6</systemitem> address for this interface.
</para>
</listitem>
<listitem>
<para>
- <literal>no</literal> — Do not use DHCP to obtain an IPv6 address for this interface. This is the default value.
+ <literal>no</literal> — Do not use DHCP to obtain an <systemitem class="protocol">IPv6</systemitem> address for this interface. This is the default value.
</para>
</listitem>
</itemizedlist>
- <para>An IPv6 link-local address will still be assigned by default. The link-local address is based on the MAC address of the interface as per <citetitle pubwork="webpage">RFC 4862</citetitle>.</para>
+ <para>An <systemitem class="protocol">IPv6</systemitem> link-local address will still be assigned by default. The link-local address is based on the MAC address of the interface as per <citetitle pubwork="webpage">RFC 4862</citetitle>.</para>
</listitem>
</varlistentry>
@@ -275,7 +275,7 @@ ONBOOT=yes</programlisting>
<itemizedlist>
<listitem>
<para>
- <option>-P</option> — Enable IPv6 prefix delegation.
+ <option>-P</option> — Enable <systemitem class="protocol">IPv6</systemitem> prefix delegation.
</para>
</listitem>
<listitem>
@@ -290,7 +290,7 @@ ONBOOT=yes</programlisting>
</listitem>
<listitem>
<para>
- <option>-T</option> — Use DHCP to obtain a temporary IPv6 address for this interface.
+ <option>-T</option> — Use DHCP to obtain a temporary <systemitem class="protocol">IPv6</systemitem> address for this interface.
</para>
</listitem>
@@ -301,8 +301,8 @@ ONBOOT=yes</programlisting>
</para>
<para>
- By default, the DHCPv6 client (dhclient) creates a DHCP Unique Identifier (DUID) based on the link-layer address (DUID-LL) if it is
- running in stateless mode (with the -S option, to not request an address), or it creates an identifier based on the link-layer address plus a timestamp (DUID-LLT) if it is running in stateful mode (without -S, requesting an address). The -D option overrides this default, with a value of either LL or LLT.</para>
+ By default, the <systemitem class="protocol">DHCPv6</systemitem> client (dhclient) creates a <firstterm>DHCP Unique Identifier</firstterm> (<acronym>DUID</acronym>) based on the link-layer address (DUID-LL) if it is
+ running in stateless mode (with the <option>-S</option> option, to not request an address), or it creates an identifier based on the link-layer address plus a timestamp (DUID-LLT) if it is running in stateful mode (without <option>-S</option>, requesting an address). The <option>-D</option> option overrides this default, with a value of either <literal>LL</literal> or <literal>LLT</literal>.</para>
</listitem>
</itemizedlist>
</listitem>
@@ -333,10 +333,10 @@ ONBOOT=yes</programlisting>
<important>
<title>Set <quote>autoneg off</quote> before changing speed or duplex settings</title>
<para>
- Changing speed or duplex settings almost always requires disabling autonegotiation with the <option>autoneg off</option> option. This option needs to be stated first, as the option entries are order-dependent.
+ Changing speed or duplex settings almost always requires disabling auto-negotiation with the <option>autoneg off</option> option. This option needs to be stated first, as the option entries are order-dependent.
</para>
</important>
- <para>Refer to <xref linkend="s2-ethtool"/> for more Ethtool options.</para>
+ <para>Refer to <xref linkend="s2-ethtool"/> for more <application>ethtool</application> options.</para>
</listitem>
</varlistentry>
<!-- Suppress this directive as its better to put this in the Global Config file called /etc/sysconfig/network
@@ -398,7 +398,7 @@ ONBOOT=yes</programlisting>
</term>
<listitem>
<para>
- where <replaceable>address</replaceable> is the IPv4 address.
+ where <replaceable>address</replaceable> is the <systemitem class="protocol">IPv4</systemitem> address.
</para>
</listitem>
</varlistentry>
@@ -409,9 +409,9 @@ ONBOOT=yes</programlisting>
</term>
<listitem>
<para>
- where <replaceable>address</replaceable> is the first static, or primary, IPv6 address on an interface.
+ where <replaceable>address</replaceable> is the first static, or primary, <systemitem class="protocol">IPv6</systemitem> address on an interface.
</para>
- <para>The format is Address/Prefix-length. If no prefix length is specified, /64 is assumed. Note that this setting depends on IPV6INIT being enabled.</para>
+ <para>The format is Address/Prefix-length. If no prefix length is specified, <literal>/64</literal> is assumed. Note that this setting depends on <option>IPV6INIT</option> being enabled.</para>
</listitem>
</varlistentry>
@@ -421,9 +421,9 @@ ONBOOT=yes</programlisting>
</term>
<listitem>
<para>
- where <replaceable>address</replaceable> is one or more, space separated, additional IPv6 addresses.
+ where <replaceable>address</replaceable> is one or more, space separated, additional <systemitem class="protocol">IPv6</systemitem> addresses.
</para>
- <para>The format is Address/Prefix-length. If no prefix length is specified, /64 is assumed. Note that this setting depends on IPV6INIT being enabled.</para>
+ <para>The format is Address/Prefix-length. If no prefix length is specified, <literal>/64</literal> is assumed. Note that this setting depends on <option>IPV6INIT</option> being enabled.</para>
</listitem>
</varlistentry>
@@ -1998,7 +1998,7 @@ VLAN=yes</screen>
</para>
</note>
<para>
- For new installations, users should select the <guilabel>Manual</guilabel> method on the IPv4 or IPv6 tab in <application>NetworkManager</application> to assign multiple IP address to the same interface. For more information on using this tool, refer to <xref linkend="ch-NetworkManager" />.
+ For new installations, users should select the <guilabel>Manual</guilabel> method on the <systemitem class="protocol">IPv4</systemitem> or <systemitem class="protocol">IPv6</systemitem> tab in <application>NetworkManager</application> to assign multiple IP address to the same interface. For more information on using this tool, refer to <xref linkend="ch-NetworkManager" />.
</para>
<para>
Alias interface configuration files, which are used to bind multiple addresses to a single interface, use the <filename>ifcfg-<replaceable>if-name</replaceable>:<replaceable>alias-value</replaceable></filename> naming scheme.
@@ -2026,7 +2026,7 @@ BOOTPROTO=dhcp</programlisting>
This way a user can bring up the <systemitem class="etheraddress">eth0</systemitem> interface using the <command>/sbin/ifup eth0-user</command> command because the configuration options from <filename>ifcfg-eth0</filename> and <filename>ifcfg-eth0-user</filename> are combined. While this is a very basic example, this method can be used with a variety of options and interfaces.
</para>
<para>
- It is no longer possible to create alias and clone interface configuration files using a graphical tool. However, as explained at the beginning of this section, it is no longer necessary to use this method as it is now possible to directly assign multiple IP address to the same interface. For new installations, users should select the <guilabel>Manual</guilabel> method on the IPv4 or IPv6 tab in <application>NetworkManager</application> to assign multiple IP address to the same interface. For more information on using this tool, refer to <xref linkend="ch-NetworkManager" />.
+ It is no longer possible to create alias and clone interface configuration files using a graphical tool. However, as explained at the beginning of this section, it is no longer necessary to use this method as it is now possible to directly assign multiple IP address to the same interface. For new installations, users should select the <guilabel>Manual</guilabel> method on the <systemitem class="protocol">IPv4</systemitem> or <systemitem class="protocol">IPv6</systemitem> tab in <application>NetworkManager</application> to assign multiple IP address to the same interface. For more information on using this tool, refer to <xref linkend="ch-NetworkManager" />.
</para>
</section>
@@ -2324,7 +2324,7 @@ IDLETIMEOUT=600
<filename>ifup-ipv6</filename> and <filename>ifdown-ipv6</filename>
</term>
<listitem>
- <para>Brings IPv6 interfaces up and down.</para>
+ <para>Brings <systemitem class="protocol">IPv6</systemitem> interfaces up and down.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -2372,7 +2372,7 @@ IDLETIMEOUT=600
<filename>ifdown-sit</filename> and <filename>ifup-sit</filename>
</term>
<listitem>
- <para>Contains function calls related to bringing up and down an IPv6 tunnel within an IPv4 connection.</para>
+ <para>Contains function calls related to bringing up and down an <systemitem class="protocol">IPv6</systemitem> tunnel within an <systemitem class="protocol">IPv4</systemitem> connection.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -2665,10 +2665,10 @@ GATEWAY0=10.10.10.1</programlisting>
&MAJOROS; makes use of several files that contain important common functions used to bring interfaces up and down. Rather than forcing each interface control file to contain these functions, they are grouped together in a few files that are called upon when necessary.
</para>
<para>
- The <filename>/etc/sysconfig/network-scripts/network-functions</filename> file contains the most commonly used IPv4 functions, which are useful to many interface control scripts. These functions include contacting running programs that have requested information about changes in the status of an interface, setting hostnames, finding a gateway device, verifying whether or not a particular device is down, and adding a default route.
+ The <filename>/etc/sysconfig/network-scripts/network-functions</filename> file contains the most commonly used <systemitem class="protocol">IPv4</systemitem> functions, which are useful to many interface control scripts. These functions include contacting running programs that have requested information about changes in the status of an interface, setting hostnames, finding a gateway device, verifying whether or not a particular device is down, and adding a default route.
</para>
<para>
- As the functions required for IPv6 interfaces are different from IPv4 interfaces, a <filename>/etc/sysconfig/network-scripts/network-functions-ipv6</filename> file exists specifically to hold this information. The functions in this file configure and delete static IPv6 routes, create and remove tunnels, add and remove IPv6 addresses to an interface, and test for the existence of an IPv6 address on an interface.
+ As the functions required for <systemitem class="protocol">IPv6</systemitem> interfaces are different from <systemitem class="protocol">IPv4</systemitem> interfaces, a <filename>/etc/sysconfig/network-scripts/network-functions-ipv6</filename> file exists specifically to hold this information. The functions in this file configure and delete static <systemitem class="protocol">IPv6</systemitem> routes, create and remove tunnels, add and remove <systemitem class="protocol">IPv6</systemitem> addresses to an interface, and test for the existence of an <systemitem class="protocol">IPv6</systemitem> address on an interface.
</para>
</section>
@@ -2690,7 +2690,7 @@ GATEWAY0=10.10.10.1</programlisting>
</term>
<listitem>
<para>
- A guide to available options for network configuration files, including IPv6 options not covered in this chapter.
+ A guide to available options for network configuration files, including <systemitem class="protocol">IPv6</systemitem> options not covered in this chapter.
</para>
</listitem>
</varlistentry>
@@ -2703,7 +2703,7 @@ GATEWAY0=10.10.10.1</programlisting>
<term><ulink url="http://linux-ip.net/gl/ip-cref/"/></term>
<listitem>
<para>
- This document contains a wealth of information about the ip command, which can be used to manipulate routing tables, among other things.
+ This document contains a wealth of information about the <command>ip</command> command, which can be used to manipulate routing tables, among other things. The information can also be found in the <filename>ip-cref.ps</filename> file by installing the <package>iproute-doc</package> sub-package from the optional content channel.
</para>
</listitem>
</varlistentry>
More information about the docs-commits
mailing list