svn commit: r40959 - head/en_US.ISO8859-1/books/handbook/config

Dru Lavigne dru at FreeBSD.org
Tue Feb 12 15:13:13 UTC 2013


Author: dru
Date: Tue Feb 12 15:13:12 2013
New Revision: 40959
URL: http://svnweb.freebsd.org/changeset/doc/40959

Log:
  This first patch addresses the following:
  
  - rewording to remove you/we/please/simply/etc./i.e./as well as
  
  - one &os; replacement
  
  - reword sections that mention ISA
  
  - some rewording for redundancy; some areas weren't touched as they need to be completely rewritten
  
  - some ACPI/APM fixups
  
  Approved by:  gjb (mentor)

Modified:
  head/en_US.ISO8859-1/books/handbook/config/chapter.xml

Modified: head/en_US.ISO8859-1/books/handbook/config/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/handbook/config/chapter.xml	Tue Feb 12 15:09:50 2013	(r40958)
+++ head/en_US.ISO8859-1/books/handbook/config/chapter.xml	Tue Feb 12 15:13:12 2013	(r40959)
@@ -38,25 +38,24 @@
     <indexterm><primary>system configuration</primary></indexterm>
     <indexterm><primary>system optimization</primary></indexterm>
 
-    <para>One of the important aspects of &os; is system
-      configuration.  Correct system configuration will help prevent
-      headaches during future upgrades.  This chapter will explain
-      much of the &os; configuration process, including some of the
-      parameters which can be set to tune a &os; system.</para>
+    <para>One of the important aspects of &os; is proper system
+      configuration.  This chapter explains much of the &os;
+      configuration process, including some of the parameters which
+      can be set to tune a &os; system.</para>
 
     <para>After reading this chapter, you will know:</para>
 
     <itemizedlist>
       <listitem>
-	<para>How to efficiently work with
-	  file systems and swap partitions.</para>
+	<para>How to efficiently work with file systems and swap
+	  partitions.</para>
       </listitem>
 
       <listitem>
 	<para>The basics of <filename>rc.conf</filename> configuration
 	  and <filename
 	    class="directory">/usr/local/etc/rc.d</filename> startup
-	  systems.</para>
+	  scripts.</para>
       </listitem>
 
       <listitem>
@@ -64,7 +63,7 @@
       </listitem>
 
       <listitem>
-	<para>How to configure virtual hosts on your network
+	<para>How to configure virtual hosts on network
 	  devices.</para>
       </listitem>
 
@@ -93,9 +92,8 @@
       </listitem>
 
       <listitem>
-	<para>Be familiar with the basics of kernel
-	  configuration/compilation
-	  (<xref linkend="kernelconfig"/>).</para>
+	<para>Be familiar with the basics of kernel configuration and
+	  compilation (<xref linkend="kernelconfig"/>).</para>
       </listitem>
     </itemizedlist>
   </sect1>
@@ -133,13 +131,12 @@
 
 	<para>The size of the
 	  <filename class="directory">/var</filename> partition
-	  reflects the intended machine usage.  The
-	  <filename class="directory">/var</filename> file system is
-	  used to hold mailboxes, log files, and printer spools.
-	  Mailboxes and log files can grow to unexpected sizes
-	  depending on how many users exist and how long log files are
-	  kept.  Most users will rarely need more than about a
-	  gigabyte of free disk space in
+	  reflects the intended machine's usage.  This partition
+	  <filename class="directory">/var</filename> is used to hold
+	  mailboxes, log files, and printer spools.  Mailboxes and log
+	  files can grow to unexpected sizes depending on how many
+	  users exist and how long log files are kept.  Most users
+	  rarely need more than about a gigabyte of free disk space in
 	  <filename class="directory">/var</filename>.</para>
 
 	<note>
@@ -158,11 +155,10 @@
 	</note>
 
 	<para>The <filename class="directory">/usr</filename>
-	  partition holds many of the files required to support the
-	  system, including the &man.ports.7; collection (recommended)
-	  and the source code (optional).  Both the ports and the
-	  sources of the base system are optional at install time, but
-	  we recommend at least 2 gigabytes for this partition.</para>
+	  partition holds many of the files which support the system,
+	  including the &os; Ports Collection and system source code.
+	  At least 2 gigabytes is recommended for this
+	  partition.</para>
 
 	<para>When selecting partition sizes, keep the space
 	  requirements in mind.  Running out of space in
@@ -186,20 +182,17 @@
 	<indexterm><primary>swap partition</primary></indexterm>
 
 	<para>As a rule of thumb, the swap partition should be about
-	  double the size of system memory (RAM).  For example, if the
-	  machine has 128 megabytes of memory, the swap file
-	  should be 256 megabytes.  Systems with less memory may
-	  perform better with more swap.  Less than 256 megabytes
-	  of swap is not recommended and memory expansion should be
-	  considered.  The kernel's VM paging algorithms are tuned to
-	  perform best when the swap partition is at least two times
-	  the size of main memory.  Configuring too little swap can
-	  lead to inefficiencies in the VM page scanning code and
+	  double the size of physical memory (RAM) as the kernel's
+	  virtual memory (VM) paging algorithms are tuned to perform
+	  best when the swap partition is at least two times
+	  the size of main memory.  Systems with minimal RAM may
+	  perform better with more swap.  Configuring too little swap
+	  can lead to inefficiencies in the VM page scanning code and
 	  might create issues later if more memory is added.</para>
 
-	<para>On larger systems with multiple SCSI disks (or multiple
-	  IDE disks operating on different controllers), it is
-	  recommend that a swap is configured on each drive (up to
+	<para>On larger systems with multiple SCSI disks or multiple
+	  IDE disks operating on different controllers, it is
+	  recommended that swap be configured on each drive (up to
 	  four drives).  The swap partitions should be approximately
 	  the same size.  The kernel can handle arbitrary sizes but
 	  internal data structures scale to 4 times the largest swap
@@ -219,8 +212,8 @@
 	  characteristics and separating them allows the file system
 	  to tune accordingly.  For example, the root and
 	  <filename class="directory">/usr</filename> partitions are
-	  read-mostly, without much writing.  While a lot of reading
-	  and writing could occur in
+	  read-mostly, with few writes, while a lot of reads and
+	  writes could occur in
 	  <filename class="directory">/var</filename> and
 	  <filename class="directory">/var/tmp</filename>.</para>
 
@@ -250,20 +243,18 @@
     </indexterm>
 
     <para>The principal location for system configuration information
-      is within <filename>/etc/rc.conf</filename>.  This file contains
-      a wide range of configuration information, principally used at
-      system startup to configure the system.  Its name directly
-      implies this; it is configuration information for the
-      <filename>rc*</filename> files.</para>
-
-    <para>An administrator should make entries in
-      <filename>rc.conf</filename> to override the default
-      settings from <filename>/etc/defaults/rc.conf</filename>.  The
-      defaults file should not be copied verbatim to
-      <filename class="directory">/etc</filename> - it contains
-      default values, not examples.  All system-specific changes
-      should be made in the <filename>rc.conf</filename> file
-      itself.</para>
+      is <filename>/etc/rc.conf</filename>.  This file contains
+      a wide range of configuration information and it is read at
+      system startup to configure the system.  It provides the
+      configuration information for the <filename>rc*</filename>
+      files.</para>
+
+    <para>The entries in <filename>/etc/rc.conf</filename> override
+      the default settings in
+      <filename>/etc/defaults/rc.conf</filename>.  The file containing
+      the default settings should not be edited.  Instead, all
+      system-specific changes should be made to
+      <filename>/etc/rc.conf</filename>.</para>
 
     <para>A number of strategies may be applied in clustered
       applications to separate site-wide configuration from
@@ -306,7 +297,7 @@ ifconfig_fxp0="inet 10.1.1.1/8"</program
       <para>The <filename>/etc/rc.conf</filename> configuration file
 	is parsed by &man.sh.1;.  This allows system operators to
 	add a certain amount of logic to this file, which may help to
-	create very complex configuration scenarios.  Please see
+	create very complex configuration scenarios.  Refer to
 	&man.rc.conf.5; for further information on this topic.</para>
     </tip>
   </sect1>
@@ -315,10 +306,10 @@ ifconfig_fxp0="inet 10.1.1.1/8"</program
     <title>Application Configuration</title>
 
     <para>Typically, installed applications have their own
-      configuration files, with their own syntax, etc.  It is
-      important that these files be kept separate from the base
-      system, so that they may be easily located and managed by the
-      package management tools.</para>
+      configuration files and syntax.  It is important that these
+      files be kept separate from the base system, so that they may be
+      easily located and managed by the package management
+      tools.</para>
 
     <indexterm><primary>/usr/local/etc</primary></indexterm>
 
@@ -370,10 +361,9 @@ ifconfig_fxp0="inet 10.1.1.1/8"</program
 
     <indexterm><primary>services</primary></indexterm>
 
-    <para>Many users choose to install third party software on &os;
-      from the Ports Collection.  In many of these situations it may
-      be necessary to configure the software in a manner which will
-      allow it to be started upon system initialization.  Services,
+    <para>Many users install third party software on &os; from the
+      Ports Collection and require the installed services to be
+      started upon system initialization.  Services,
       such as <filename role="package">mail/postfix</filename> or
       <filename role="package">www/apache22</filename> are just two of
       the many software packages which may be started during system
@@ -381,24 +371,20 @@ ifconfig_fxp0="inet 10.1.1.1/8"</program
       for starting third party software.</para>
 
     <para>In &os;, most included services, such as &man.cron.8;, are
-      started through the system start up scripts.  These scripts may
-      differ depending on &os; or vendor version; however, the most
-      important aspect to consider is that their start up
-      configuration can be handled through simple startup
-      scripts.</para>
+      started through the system start up scripts.</para>
 
     <sect2>
       <title>Extended Application Configuration</title>
 
       <para>Now that &os; includes <filename>rc.d</filename>,
-	configuration of application startup has become easier, and
-	more featureful.  Using the key words discussed in the
+	configuration of application startup is easier and provides
+	more features.  Using the key words discussed in the
 	<link linkend="configtuning-rcd">rc.d</link> section,
-	applications may now be set to start after certain other
-	services for example <acronym>DNS</acronym>; may permit extra
-	flags to be passed through <filename>rc.conf</filename> in
-	place of hard coded flags in the start up script, etc.  A
-	basic script may look similar to the following:</para>
+	applications can be set to start after certain other services
+	and extra flags can be passed through
+	<filename>/etc/rc.conf</filename> in place of hard coded flags
+	in the start up script.  A basic script may look similar to
+	the following:</para>
 
       <programlisting>#!/bin/sh
 #
@@ -445,8 +431,8 @@ run_rc_command "$1"</programlisting>
     <sect2>
       <title>Using Services to Start Services</title>
 
-      <para>Other services, such as <acronym>POP</acronym>3 server
-	daemons, <acronym>IMAP</acronym>, etc. could be started using
+      <para>Other services, such as the <acronym>POP</acronym>3 server
+	daemons or <acronym>IMAP</acronym>, could be started using
 	&man.inetd.8;.  This involves installing the service utility
 	from the Ports Collection with a configuration line added to
 	<filename>/etc/inetd.conf</filename>, or by
@@ -487,14 +473,14 @@ run_rc_command "$1"</programlisting>
       <secondary>configuration</secondary></indexterm>
 
     <para>One of the most useful utilities in &os; is &man.cron.8;.
-      The <command>cron</command> utility runs in the background and
-      constantly checks the <filename>/etc/crontab</filename> file.
-      The <command>cron</command> utility also checks the
-      <filename class="directory">/var/cron/tabs</filename> directory,
-      in search of new <filename>crontab</filename> files.  These
-      <filename>crontab</filename> files store information about
-      specific functions which <command>cron</command> is supposed to
-      perform at certain times.</para>
+      This utility runs in the background and regularly checks
+      <filename>/etc/crontab</filename> for tasks to execute and
+      searches
+      <filename class="directory">/var/cron/tabs</filename> for custom
+      <filename>crontab</filename> files.  These files store
+      information about specific functions which
+      <command>cron</command> is supposed to perform at certain
+      times.</para>
 
     <para>The <command>cron</command> utility uses two different types
       of configuration files, the system crontab and user crontabs.
@@ -580,23 +566,22 @@ HOME=/var/log
 	  stands for day of the week.  All these fields must be
 	  numeric values, and follow the twenty-four hour clock.  The
 	  <literal>who</literal> field is special, and only exists in
-	  the <filename>/etc/crontab</filename> file.  This field
-	  specifies which user the command should be run as.  The last
-	  field is the command to be executed.</para>
+	  <filename>/etc/crontab</filename>.  This field specifies
+	  which user the command should be run as.  The last field is
+	  the command to be executed.</para>
       </callout>
 
       <callout arearefs="co-main">
 	<para>This last line will define the values discussed above.
-	  Notice here we have a <literal>*/5</literal> listing,
-	  followed by several more <literal>*</literal> characters.
-	  These <literal>*</literal> characters mean
+	  This example has a <literal>*/5</literal> listing,followed
+	  by several more <literal>*</literal> characters.  These
+	  <literal>*</literal> characters mean
 	  <quote>first-last</quote>, and can be interpreted as
-	  <emphasis>every</emphasis> time.  So, judging by this line,
-	  it is apparent that <command>atrun</command> is
-	  to be invoked by <username>root</username> every five
-	  minutes regardless of what day or month it is.  For more
-	  information on <command>atrun</command>, see
-	  &man.atrun.8;.</para>
+	  <emphasis>every</emphasis> time.  In this example,
+	  <command>atrun</command> is invoked by
+	  <username>root</username> every five minutes regardless of
+	  the day or month.  For more information on
+	  <command>atrun</command>, refer to &man.atrun.8;.</para>
 
 	<para>Commands can have any number of flags passed to them;
 	  however, commands which extend to multiple lines need to be
@@ -606,8 +591,8 @@ HOME=/var/log
     </calloutlist>
 
     <para>This is the basic setup for every
-      <filename>crontab</filename> file, although there is one thing
-      different about this one.  Field number six, where we specified
+      <filename>crontab</filename>, although there is one thing
+      different about this one.  Field number six, which specifies
       the username, only exists in the system
       <filename>crontab</filename>.  This field should be omitted for
       individual user <filename>crontab</filename> files.</para>
@@ -618,19 +603,18 @@ HOME=/var/log
       <important>
 	<para>Do not use the procedure described here to edit and
 	  install the system crontab,
-	  <filename>/etc/crontab</filename>.  Just use your favorite
-	  editor: the <command>cron</command> utility will notice that
-	  the file has changed and immediately begin using the updated
-	  version.  See <ulink
+	  <filename>/etc/crontab</filename>.  Instead, use an
+	  editor: <command>cron</command> will notice that the file
+	  has changed and immediately begin using the updated version.
+	  See <ulink
 	    url="&url.books.faq;/admin.html#ROOT-NOT-FOUND-CRON-ERRORS">
 	    this FAQ entry</ulink> for more information.</para>
       </important>
 
       <para>To install a freshly written user
-	<filename>crontab</filename>, first use your favorite editor
-	to create a file in the proper format, and then use the
-	<command>crontab</command> utility.  The most common usage
-	is:</para>
+	<filename>crontab</filename>, first use an editor to create
+	and save a file in the proper format.  Then, specify the file
+	name with <command>crontab</command>:</para>
 
       <screen>&prompt.user; <userinput>crontab crontab-file</userinput></screen>
 
@@ -638,21 +622,18 @@ HOME=/var/log
 	filename of a <filename>crontab</filename> that was previously
 	created.</para>
 
-      <para>There is also an option to list installed
-	<filename>crontab</filename> files: just pass the
-	<option>-l</option> option to <command>crontab</command> and
-	look over the output.</para>
+      <para>To list installed <filename>crontab</filename> files, pass
+	<option>-l</option> to <command>crontab</command>.</para>
 
       <para>For users who wish to begin their own crontab file from
 	scratch, without the use of a template, the
 	<command>crontab -e</command> option is available.  This will
 	invoke the selected editor with an empty file.  When the file
-	is saved, it will be automatically installed by the
-	<command>crontab</command> command.</para>
+	is saved, it will be automatically installed by
+	<command>crontab</command>.</para>
 
       <para>In order to remove a user <filename>crontab</filename>
-	completely, use <command>crontab</command> with the
-	<option>-r</option> option.</para>
+	completely, use <command>crontab -r</command>.</para>
     </sect2>
   </sect1>
 
@@ -700,13 +681,13 @@ HOME=/var/log
       the standard <option>start</option>, <option>stop</option> and
       <option>restart</option> options will only perform their action
       if the appropriate <filename>/etc/rc.conf</filename> variables
-      are set.  For instance the above <command>sshd restart</command>
-      command will only work if <varname>sshd_enable</varname> is set
-      to <option>YES</option> in <filename>/etc/rc.conf</filename>.
+      are set.  For instance, <command>sshd restart</command> will
+      only work if <varname>sshd_enable</varname> is set to
+      <option>YES</option> in <filename>/etc/rc.conf</filename>.
       To <option>start</option>, <option>stop</option> or
       <option>restart</option> a service regardless of the settings in
       <filename>/etc/rc.conf</filename>, the commands should be
-      prefixed with <quote>one</quote>.  For instance to restart
+      prefixed with <quote>one</quote>.  For instance, to restart
       <command>sshd</command> regardless of the current
       <filename>/etc/rc.conf</filename> setting, execute the following
       command:</para>
@@ -730,9 +711,9 @@ $sshd_enable=YES</screen>
 	<username>root</username> console.</para>
     </note>
 
-    <para>To determine if a service is running, a
-      <option>status</option> option is available.  For instance to
-      verify that <command>sshd</command> is actually started:</para>
+    <para>To determine if a service is running, use
+      <option>status</option>.  For instance, to verify that
+      <command>sshd</command> is running:</para>
 
     <screen>&prompt.root; <userinput>service sshd status</userinput>
 sshd is running as pid 433.</screen>
@@ -746,9 +727,9 @@ sshd is running as pid 433.</screen>
 
     <para>The <filename>rc.d</filename> system is not only used for
       network services, it also contributes to most of the system
-      initialization.  For instance, consider the
-      <filename>bgfsck</filename> file.  When this script is executed,
-      it will print out the following message:</para>
+      initialization.  For instance, when the
+      <filename>bgfsck</filename> script is executed, it will print
+      out the following message:</para>
 
     <screen>Starting background file system checks in 60 seconds.</screen>
 
@@ -802,11 +783,10 @@ sshd is running as pid 433.</screen>
       systems.</para>
 
     <para>Additional information about the <filename>rc.d</filename>
-      system can be found in the &man.rc.8; and &man.rc.subr.8; manual
-      pages.  If you are interested in writing your own
-      <filename>rc.d</filename> scripts or improving the existing
-      ones, you may find <ulink url="&url.articles.rc-scripting">this
-	article</ulink> also useful.</para>
+      system can be found in &man.rc.8; and &man.rc.subr.8;.  Refer to
+      <ulink url="&url.articles.rc-scripting">this article</ulink> for
+      instructions on how to create custom <filename>rc.d</filename>
+      scripts.</para>
   </sect1>
 
   <sect1 id="config-network-setup">
@@ -828,9 +808,8 @@ sshd is running as pid 433.</screen>
       <secondary>configuration</secondary>
     </indexterm>
 
-    <para>Nowadays we can not think about a computer without thinking
-      about a network connection.  Adding and configuring a network
-      card is a common task for any &os; administrator.</para>
+    <para>Adding and configuring a network card is a common task for
+      any &os; administrator.</para>
 
     <sect2>
       <title>Locating the Correct Driver</title>
@@ -840,28 +819,24 @@ sshd is running as pid 433.</screen>
 	<secondary>driver</secondary>
       </indexterm>
 
-      <para>Before you begin, you should know the model of the card
-	you have, the chip it uses, and whether it is a PCI or ISA
-	card.  &os; supports a wide variety of both PCI and ISA cards.
-	Check the Hardware Compatibility List for your release to see
-	if your card is supported.</para>
+      <para>First, determine the model of the network interface card
+	and the chip it uses.  &os; supports a wide variety of network
+	interface cards.  Check the Hardware Compatibility List for
+	the &os; release to see if the card is supported.</para>
 
-      <para>Once you are sure your card is supported, you need to
-	determine the proper driver for the card.
+      <para>If the card is supported, determine the name of the &os;
+	driver for the card.  Refer to
 	<filename>/usr/src/sys/conf/NOTES</filename> and
 	<filename>/usr/src/sys/<replaceable>arch</replaceable>/conf/NOTES</filename>
-	will give you the list of network interface drivers with some
-	information about the supported chipsets/cards.  If you have
-	doubts about which driver is the correct one, read the manual
-	page of the driver.  The manual page will give you more
-	information about the supported hardware and even the possible
-	problems that could occur.</para>
-
-      <para>If you own a common card, most of the time you will not
-	have to look very hard for a driver.  Drivers for common
-	network cards are present in the <filename>GENERIC</filename>
-	kernel, so your card should show up during boot, like
-	so:</para>
+	for the list of network interface drivers with some
+	information about the supported chipsets.  When in doubt, read
+	the manual page of the driver as it will provide more
+	information about the supported hardware and any known
+	limitations of the driver.</para>
+
+      <para>The drivers for common network cards are already present
+	in the <filename>GENERIC</filename> kernel, meaning the card
+	should show up during boot, as in this example:</para>
 
       <screen>dc0: <82c169 PNIC 10/100BaseTX> port 0xa000-0xa0ff mem 0xd3800000-0xd38
 000ff irq 15 at device 11.0 on pci0
@@ -878,19 +853,20 @@ bmtphy1:  10baseT, 10baseT-FDX, 100baseT
 dc1: Ethernet address: 00:a0:cc:da:da:db
 dc1: [ITHREAD]</screen>
 
-      <para>In this example, we see that two cards using the
-	&man.dc.4; driver are present on the system.</para>
+      <para>In this example, two cards using the &man.dc.4; driver are
+	present on the system.</para>
 
-      <para>If the driver for your NIC is not present in
-	<filename>GENERIC</filename>, you will need to load the proper
-	driver to use your NIC.  This may be accomplished in one of
-	two ways:</para>
+      <para>If the driver for the interface is not present in
+	<filename>GENERIC</filename>, but a driver is available, the
+	driver will need to be loaded before the interface can be
+	configured and used.  This may be accomplished in one of two
+	ways:</para>
 
       <itemizedlist>
 	<listitem>
-	  <para>The easiest way is to simply load a kernel module for
-	    your network card with &man.kldload.8;, or automatically
-	    at boot time by adding the appropriate line to the file
+	  <para>The easiest way is to load a kernel module for the
+	    network card with &man.kldload.8;.  To also automatically
+	    load the driver at boot time, add the appropriate line to
 	    <filename>/boot/loader.conf</filename>.  Not all NIC
 	    drivers are available as modules; notable examples of
 	    devices for which modules do not exist are ISA
@@ -898,16 +874,15 @@ dc1: [ITHREAD]</screen>
 	</listitem>
 
 	<listitem>
-	  <para>Alternatively, you may statically compile the support
-	    for your card into your kernel.  Check
+	  <para>Alternatively, statically compile support for the card
+	    into a custom kernel.  Refer to
 	    <filename>/usr/src/sys/conf/NOTES</filename>,
 	    <filename>/usr/src/sys/<replaceable>arch</replaceable>/conf/NOTES</filename>
-	    and the manual page of the driver to know what to add in
-	    your kernel configuration file.  For more information
-	    about recompiling your kernel, please see
-	    <xref linkend="kernelconfig"/>.  If your card was detected
-	    at boot by your kernel (<filename>GENERIC</filename>) you
-	    do not have to build a new kernel.</para>
+	    and the manual page of the driver to determine which line
+	    to add to the custom kernel configuration file.  For more
+	    information about recompiling the kernel, refer to
+	    <xref linkend="kernelconfig"/>.  If the card was detected
+	    at boot, the kernel does not need to be recompiled.</para>
 	</listitem>
       </itemizedlist>
 
@@ -968,9 +943,9 @@ linuxemu/chapter.xml -->
 	  </listitem>
 	</orderedlist>
 
-	<para>Locate the files for your specific card.  Generally,
+	<para>Locate the files for the specific card.  Generally,
 	  they can be found on the included CDs or at the vendor's
-	  website.  In the following examples, we will use
+	  website.  The following examples use
 	  <filename>W32DRIVER.SYS</filename> and
 	  <filename>W32DRIVER.INF</filename>.</para>
 
@@ -991,12 +966,12 @@ linuxemu/chapter.xml -->
 
 	<screen>&prompt.root; <userinput>kldload <replaceable>./W32DRIVER_SYS.ko</replaceable></userinput></screen>
 
-	<para>In addition to the generated kernel module, you must
-	  load the <filename>ndis.ko</filename> and
-	  <filename>if_ndis.ko</filename> modules.  This should be
-	  automatically done when you load any module that depends on
-	  &man.ndis.4;.  If you want to load them manually, use the
-	  following commands:</para>
+	<para>In addition to the generated kernel module, the
+	  <filename>ndis.ko</filename> and
+	  <filename>if_ndis.ko</filename> modules must be loaded.
+	  This should happen automatically when any module that
+	  depends on &man.ndis.4; is loaded.  If not, load them
+	  manually, using the following commands:</para>
 
 	<screen>&prompt.root; <userinput>kldload ndis</userinput>
 &prompt.root; <userinput>kldload if_ndis</userinput></screen>
@@ -1006,7 +981,7 @@ linuxemu/chapter.xml -->
 	  interface.</para>
 
 	<para>Now, check &man.dmesg.8; to see if there were any errors
-	  loading.  If all went well, you should get output resembling
+	  loading.  If all went well, the output should be similar to
 	  the following:</para>
 
 	<screen>ndis0: <Wireless-G PCI Adapter> mem 0xf4100000-0xf4101fff irq 3 at device 8.0 on pci1
@@ -1019,9 +994,8 @@ ndis0: 11g rates: 6Mbps 9Mbps 12Mbps 18M
 	  <devicename>ndis0</devicename> device like any other network
 	  interface (e.g., <devicename>dc0</devicename>).</para>
 
-	<para>You can configure the system to load the NDIS modules at
-	  boot time in the same way as with any other module.  First,
-	  copy the generated module,
+	<para>To configure the system to load the NDIS modules at
+	  boot time, copy the generated module,
 	  <filename>W32DRIVER_SYS.ko</filename>, to the <filename
 	  class="directory">/boot/modules</filename> directory.  Then,
 	  add the following line to
@@ -1044,8 +1018,8 @@ ndis0: 11g rates: 6Mbps 9Mbps 12Mbps 18M
 	network card may have been configured at installation time by
 	<application>sysinstall</application>.</para>
 
-      <para>To display the configuration for the network interfaces on
-	your system, enter the following command:</para>
+      <para>To display the configuration for the network interfaces,
+	enter the following command:</para>
 
       <screen>&prompt.user; <userinput>ifconfig</userinput>
 dc0: flags=8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST> metric 0 mtu 1500
@@ -1128,18 +1102,18 @@ lo0: flags=8049<UP,LOOPBACK,RUNNING,M
 	<listitem>
 	  <para>The physical media selection is on autoselection mode
 	    (<literal>media: Ethernet autoselect (100baseTX
-	      <full-duplex>)</literal>).  We see that
+	      <full-duplex>)</literal>).  In this example,
 	    <devicename>dc1</devicename> was configured to run with
 	    <literal>10baseT/UTP</literal> media.  For more
-	    information on available media types for a driver, please
-	    refer to its manual page.</para>
+	    information on available media types for a driver, refer
+	    to its manual page.</para>
 	</listitem>
 
 	<listitem>
 	  <para>The status of the link (<literal>status</literal>) is
-	    <literal>active</literal>, i.e., the carrier is detected.
-	    For <devicename>dc1</devicename>, we see
-	    <literal>status: no carrier</literal>.  This is normal
+	    <literal>active</literal>, indicating that the carrier is
+	    detected.  For <devicename>dc1</devicename>, the
+	    <literal>status: no carrier</literal> status is normal
 	    when an Ethernet cable is not plugged into the
 	    card.</para>
 	</listitem>
@@ -1156,44 +1130,40 @@ lo0: flags=8049<UP,LOOPBACK,RUNNING,M
 
       <para>it would indicate the card has not been configured.</para>
 
-      <para>To configure your card, you need <username>root</username>
-	privileges.  The network card configuration can be done from
-	the command line with &man.ifconfig.8; but you would have to
-	do it after each reboot of the system.  The file
-	<filename>/etc/rc.conf</filename> is where to add the network
-	card's configuration.</para>
-
-      <para>Open <filename>/etc/rc.conf</filename> in your favorite
-	editor.  You need to add a line for each network card present
-	on the system, for example in our case, we added these
-	lines:</para>
+      <para>To configure the card, you will need
+	<username>root</username> privileges.  The network card
+	configuration can be performed from the command line with
+	&man.ifconfig.8; but will not persist after a reboot.
+	Instead, add the network card's configuration to
+	<filename>/etc/rc.conf</filename> using an editor.  Add a
+	line for each network card present on the system, as seen in
+	this example:</para>
 
       <programlisting>ifconfig_dc0="inet 192.168.1.3 netmask 255.255.255.0"
 ifconfig_dc1="inet 10.0.0.1 netmask 255.255.255.0 media 10baseT/UTP"</programlisting>
 
-      <para>You have to replace <devicename>dc0</devicename>,
-	<devicename>dc1</devicename>, and so on, with the correct
-	device for your cards, and the addresses with the proper ones.
-	You should read the card driver and &man.ifconfig.8; manual
-	pages for more details about the allowed options and also
-	&man.rc.conf.5; manual page for more information on the syntax
-	of <filename>/etc/rc.conf</filename>.</para>
+      <para>Replace <devicename>dc0</devicename> and
+	<devicename>dc1</devicename> and the IP address information
+	with the correct values for the system.
+	Refer to the man page for the driver, &man.ifconfig.8; and
+	&man.rc.conf.5; for more details about the allowed options and
+	the syntax of <filename>/etc/rc.conf</filename>.</para>
 
-      <para>If you configured the network during installation, some
+      <para>If the network was configured during installation, some
 	lines about the network card(s) may be already present.
 	Double check <filename>/etc/rc.conf</filename> before adding
 	any lines.</para>
 
-      <para>You will also have to edit the file
+      <para>If the network is not using DNS, edit
 	<filename>/etc/hosts</filename> to add the names and the IP
 	addresses of various machines of the LAN, if they are not
-	already there.  For more information please refer to
-	&man.hosts.5; and to
+	already there.  For more information, refer to &man.hosts.5;
+	and to
 	<filename>/usr/share/examples/etc/hosts</filename>.</para>
 
       <note>
-	<para>If access to the Internet is planned with the machine,
-	  you also have to manually set up the default gateway and the
+	<para>If there is no DHCP server and access to the Internet is
+	  needed, manually configure the default gateway and the
 	  nameserver:</para>
 
 	<screen>&prompt.root; <userinput>echo 'defaultrouter="<replaceable>your_default_router</replaceable>"' >> /etc/rc.conf</userinput>
@@ -1204,12 +1174,12 @@ ifconfig_dc1="inet 10.0.0.1 netmask 255.
     <sect2>
       <title>Testing and Troubleshooting</title>
 
-      <para>Once you have made the necessary changes in
-	<filename>/etc/rc.conf</filename>, you should reboot your
-	system.  This will allow the change(s) to the interface(s) to
-	be applied, and verify that the system restarts without any
-	configuration errors.  Alternatively you can just relaunch the
-	networking system:</para>
+      <para>Once the necessary changes in
+	<filename>/etc/rc.conf</filename> are saved, a reboot can be
+	used to test the network configuration and to verify that the
+	system restarts without any configuration errors.
+	Alternatively, apply the settings to the networking system
+	with this command:</para>
 
       <screen>&prompt.root; <userinput>service netif restart</userinput></screen>
 
@@ -1221,8 +1191,8 @@ ifconfig_dc1="inet 10.0.0.1 netmask 255.
 	<screen>&prompt.root; <userinput>service routing restart</userinput></screen>
       </note>
 
-      <para>Once the networking system has been relaunched, you should
-	test the network interfaces.</para>
+      <para>Once the networking system has been relaunched, test the
+	network interfaces.</para>
 
       <sect3>
 	<title>Testing the Ethernet Card</title>
@@ -1233,10 +1203,8 @@ ifconfig_dc1="inet 10.0.0.1 netmask 255.
 	</indexterm>
 
 	<para>To verify that an Ethernet card is configured correctly,
-	  you have to try two things.  First, ping the interface
-	  itself, and then ping another machine on the LAN.</para>
-
-	<para>First test the local interface:</para>
+	  ping the interface itself, and then ping another machine on
+	  the LAN:</para>
 
 	<screen>&prompt.user; <userinput>ping -c5 192.168.1.3</userinput>
 PING 192.168.1.3 (192.168.1.3): 56 data bytes
@@ -1250,8 +1218,6 @@ PING 192.168.1.3 (192.168.1.3): 56 data 
 5 packets transmitted, 5 packets received, 0% packet loss
 round-trip min/avg/max/stddev = 0.074/0.083/0.108/0.013 ms</screen>
 
-	<para>Now we have to ping another machine on the LAN:</para>
-
 	<screen>&prompt.user; <userinput>ping -c5 192.168.1.2</userinput>
 PING 192.168.1.2 (192.168.1.2): 56 data bytes
 64 bytes from 192.168.1.2: icmp_seq=0 ttl=64 time=0.726 ms
@@ -1264,9 +1230,11 @@ PING 192.168.1.2 (192.168.1.2): 56 data 
 5 packets transmitted, 5 packets received, 0% packet loss
 round-trip min/avg/max/stddev = 0.700/0.729/0.766/0.025 ms</screen>
 
-	<para>You could also use the machine name instead of
-	  <hostid role="ipaddr">192.168.1.2</hostid> if you have set
-	  up <filename>/etc/hosts</filename>.</para>
+	<para>To test network resolution, use the machine name instead
+	  of <hostid role="ipaddr">192.168.1.2</hostid>.  If there is
+	  no DNS server on the network,
+	  <filename>/etc/hosts</filename> must first be
+	  configured.</para>
       </sect3>
 
       <sect3>
@@ -1279,30 +1247,29 @@ round-trip min/avg/max/stddev = 0.700/0.
 
 	<para>Troubleshooting hardware and software configurations is
 	  always a pain, and a pain which can be alleviated by
-	  checking the simple things first.  Is your network cable
-	  plugged in? Have you properly configured the network
-	  services?  Did you configure the firewall correctly?  Is the
-	  card you are using supported by &os;?  Always check the
-	  hardware notes before sending off a bug report.  Update your
-	  version of &os; to the latest STABLE version.  Check the
-	  mailing list archives, or perhaps search the
-	  Internet.</para>
+	  checking the simple things first.  Is the network cable
+	  plugged in?  Are the network services properly configured?
+	  Is the firewall configured correctly?  Is the network card
+	  supported by &os;?  Always before sending a bug report,
+	  check the hardware notes, update the version of &os; to the
+	  latest STABLE version, check the mailing list archives, and
+	  search the Internet.</para>
 
 	<para>If the card works, yet performance is poor, it would be
-	  worthwhile to read over the &man.tuning.7; manual page.  You
-	  can also check the network configuration as incorrect
-	  network settings can cause slow connections.</para>
+	  worthwhile to read over the &man.tuning.7; manual page.
+	  Also, check the network configuration as incorrect network
+	  settings can cause slow connections.</para>
 
 	<para>Some users experience one or two
 	  <errorname>device timeout</errorname> messages, which is
 	  normal for some cards.  If they continue, or are bothersome,
-	  you may wish to be sure the device is not conflicting with
-	  another device.  Double check the cable connections.
-	  Perhaps you may just need to get another card.</para>
+	  determine if the device is conflicting with another device.
+	  Double check the cable connections.  Consider trying another
+	  card.</para>
 
 	<para>At times, users see a few
 	  <errorname>watchdog timeout</errorname> errors.  The first
-	  thing to do here is to check your network cable.  Many cards
+	  thing to do is to check the network cable.  Many cards
 	  require a PCI slot which supports Bus Mastering.  On some
 	  old motherboards, only one PCI slot allows it (usually slot
 	  0).  Check the network card and the motherboard
@@ -1314,8 +1281,7 @@ round-trip min/avg/max/stddev = 0.700/0.
 	  host.  This can happen if no default route is specified, or
 	  if a cable is unplugged.  Check the output of
 	  <command>netstat -rn</command> and make sure there is a
-	  valid route to the host you are trying to reach.  If there
-	  is not, read on to
+	  valid route to the host.  If there is not, read on to
 	  <xref linkend="advanced-networking"/>.</para>
 
 	<para><errorname>ping: sendto: Permission denied</errorname>
@@ -1373,19 +1339,18 @@ round-trip min/avg/max/stddev = 0.700/0.
 
     <para>For example, consider the case where the
       <devicename>fxp0</devicename> interface is connected to two
-      networks, the <hostid role="ipaddr">10.1.1.0</hostid> network
+      networks:  the <hostid role="ipaddr">10.1.1.0</hostid> network
       with a netmask of <hostid role="netmask">255.255.255.0</hostid>
       and the <hostid role="ipaddr">202.0.75.16</hostid> network with
       a netmask of <hostid role="netmask">255.255.255.240</hostid>.
-      We want the system to appear at
+      The system is to be configured to appear in the
+      range
       <hostid role="ipaddr">10.1.1.1</hostid> through
-      <hostid role="ipaddr">10.1.1.5</hostid> and at
+      <hostid role="ipaddr">10.1.1.5</hostid> and
       <hostid role="ipaddr">202.0.75.17</hostid> through
-      <hostid role="ipaddr">202.0.75.20</hostid>.  As noted above,
-      only the first address in a given network range (in this case,
-      <hostid role="ipaddr">10.0.1.1</hostid> and
-      <hostid role="ipaddr">202.0.75.17</hostid>) should have a real
-      netmask; all the rest (<hostid role="ipaddr">10.1.1.2</hostid>
+      <hostid role="ipaddr">202.0.75.20</hostid>.  Only the first
+      address in a given network range should have a real
+      netmask.  All the rest (<hostid role="ipaddr">10.1.1.2</hostid>
       through <hostid role="ipaddr">10.1.1.5</hostid> and
       <hostid role="ipaddr">202.0.75.18</hostid> through
       <hostid role="ipaddr">202.0.75.20</hostid>) must be configured
@@ -1433,8 +1398,8 @@ ifconfig_fxp0_alias7="inet 202.0.75.20 n
       information to a system logging facility or other log
       file.</para>
 
-    <para>This section will describe how to configure and use the &os;
-      system logger, &man.syslogd.8;, as well as discuss log rotation
+    <para>This section describes how to configure and use the &os;
+      system logger, &man.syslogd.8;, and how to perform log rotation
       and log management using &man.newsyslog.8;.  Focus
       will be on setting up and using <command>syslogd</command> on
       a local machine.  For more advanced setups using a separate
@@ -1608,17 +1573,16 @@ cron.*                                  
 
       <para>Log files tend to grow quickly and accumulate steadily.
 	This leads to the files being full of less immediately useful
-	information, as well as filling up the hard drive.  To
-	mitigate this, log management comes into play.  In &os;,
-	&man.newsyslog.8; is the tool used to manage log files.  This
-	program is used to periodically rotate and compress log files,
-	as well as optionally create missing log files and signal
-	programs when log files are moved.  The log files do not
-	necessarily have to come from syslog; &man.newsyslog.8; works
-	with any logs written from any program.  It is important to
-	note that <command>newsyslog</command> is normally run from
+	information while filling up the hard drive.  Log management
+	attempts to mitigate this.  In &os;, &man.newsyslog.8; is used
+	to manage log files.  This program periodically rotates and
+	compresses log files, and optionally creates missing log files
+	and signals programs when log files are moved.  The log files
+	are not necessarily generated by syslog as &man.newsyslog.8;
+	works with any logs written from any program.  Note that
+	<command>newsyslog</command> is normally run from
 	&man.cron.8; and is not a system daemon.  In the default
-	configuration it is run every hour.</para>
+	configuration, it is run every hour.</para>
 
       <sect3>
 	<title>Configuring
@@ -1629,11 +1593,10 @@ cron.*                                  
 	  <filename>/etc/newsyslog.conf</filename>.  This
 	  configuration file contains one line for each file that
 	  &man.newsyslog.8; manages.  Each line states the file
-	  owner, permissions, and when to rotate that file, as well as
-	  optional flags that affect the log rotation (such as
-	  compression) and programs to signal when the log is
-	  rotated.  As an example, here is the default configuration
-	  in &os;:</para>
+	  owner, permissions, when to rotate that file, optional flags
+	  that affect log rotation, such as compression, and programs
+	  to signal when the log is rotated.  Here is the default
+	  configuration in &os;:</para>
 
 	<programlisting># configuration file for newsyslog
 # $&os;$
@@ -1676,7 +1639,7 @@ cron.*                                  
 /var/log/xferlog                        600  7     100  *     JC</programlisting>
 
 	<para>Each line starts with the name of the file to be
-	  rotated, optionally followrd by an owner
+	  rotated, optionally followed by an owner
 	  and group for both rotated and newly created files.
 	  The next field, <literal>mode</literal> is the mode of the
 	  files and <literal>count</literal> denotes how many rotated
@@ -1841,7 +1804,7 @@ nameserver 147.11.100.30</programlisting
 	    <literal>domain</literal> options should be used.</para>
 	</note>
 
-	<para>If you are using DHCP, &man.dhclient.8; usually rewrites
+	<para>When using DHCP, &man.dhclient.8; usually rewrites
 	  <filename>resolv.conf</filename> with information received
 	  from the DHCP server.</para>
       </sect3>
@@ -1943,12 +1906,12 @@ security.bsd.see_other_uids=0</programli
       <secondary>with sysctl</secondary>
     </indexterm>
 
-    <para>&man.sysctl.8; is an interface that allows you to make
-      changes to a running &os; system.  This includes many advanced
-      options of the TCP/IP stack and virtual memory system that can
-      dramatically improve performance for an experienced system
-      administrator.  Over five hundred system variables can be read
-      and set using &man.sysctl.8;.</para>
+    <para>&man.sysctl.8; is used to make changes to a running &os;
+      system.  This includes many advanced options of the TCP/IP stack
+      and virtual memory system that can dramatically improve
+      performance for an experienced system administrator.  Over five
+      hundred system variables can be read and set using
+      &man.sysctl.8;.</para>
 
     <para>At its core, &man.sysctl.8; serves two functions: to read
       and to modify system settings.</para>
@@ -1974,11 +1937,10 @@ kern.maxfiles: 2088 -> 5000</screen>
       numbers, or booleans (a boolean being <literal>1</literal> for
       yes or a <literal>0</literal> for no).</para>
 
-    <para>If you want to automatically set some variables each time
-      the machine boots, add them to
-      <filename>/etc/sysctl.conf</filename>.  For more
-      information see the &man.sysctl.conf.5; manual page and
-      <xref linkend="configtuning-sysctlconf"/>.</para>
+    <para>To automatically set some variables each time the machine
+      boots, add them to <filename>/etc/sysctl.conf</filename>.  For
+      more information refer to &man.sysctl.conf.5; and <xref
+	linkend="configtuning-sysctlconf"/>.</para>
 
     <sect2 id="sysctl-readonly">
       <sect2info>
@@ -2039,15 +2001,15 @@ device_probe_and_attach: cbb0 attach ret
 	  fragment (typically 1 K) in the file system and less
 	  (typically 512 bytes) in the buffer cache.  With this
 	  variable turned off (to 0), the buffer cache will only cache
-	  a fixed number of directories even if you have a huge amount
-	  of memory.  When turned on (to 1), this sysctl allows the
-	  buffer cache to use the VM Page Cache to cache the
+	  a fixed number of directories even if the system has a huge
+	  amount of memory.  When turned on (to 1), this sysctl allows
+	  the buffer cache to use the VM Page Cache to cache the
 	  directories, making all the memory available for caching
 	  directories.  However, the minimum in-core memory used to
 	  cache a directory is the physical page size (typically
-	  4 K) rather than 512  bytes.  We recommend keeping
-	  this option on if you are running any services which
-	  manipulate large numbers of files.  Such services can
+	  4 K) rather than 512  bytes.  Keeping this option
+	  enabled is recommended if the system is running any services
+	  which manipulate large numbers of files.  Such services can
 	  include web caches, large mail systems, and news systems.
 	  Keeping this option on will generally not reduce performance
 	  even with the wasted memory but you should experiment to
@@ -2067,8 +2029,8 @@ device_probe_and_attach: cbb0 attach ret
 	  which typically occurs when writing large sequential files.
 	  The idea is to avoid saturating the buffer cache with dirty
 	  buffers when it would not benefit I/O performance.  However,
-	  this may stall processes and under certain circumstances you
-	  may wish to turn it off.</para>
+	  this may stall processes and under certain circumstances
+	  should be turned off.</para>
       </sect3>
 
       <sect3>
@@ -2082,17 +2044,17 @@ device_probe_and_attach: cbb0 attach ret
 	  variable determines how much outstanding write I/O may be
 	  queued to disk controllers system-wide at any given
 	  instance.  The default is usually sufficient but on machines
-	  with lots of disks you may want to bump it up to four or
-	  five <emphasis>megabytes</emphasis>.  Note that setting too
+	  with lots of disks, try bumping it up to four or five
+	  <emphasis>megabytes</emphasis>.  Note that setting too
 	  high a value (exceeding the buffer cache's write threshold)
 	  can lead to extremely bad clustering performance.  Do not
 	  set this value arbitrarily high!  Higher write values may
 	  add latency to reads occurring at the same time.</para>
 
 	<para>There are various other buffer-cache and VM page cache
-	  related sysctls.  We do not recommend modifying these
-	  values, the VM system does an extremely good job of
-	  automatically tuning itself.</para>

*** DIFF OUTPUT TRUNCATED AT 1000 LINES ***


More information about the svn-doc-all mailing list