svn commit: r44827 - head/en_US.ISO8859-1/books/faq

Dru Lavigne dru at FreeBSD.org
Wed May 14 11:59:37 UTC 2014


Author: dru
Date: Wed May 14 11:59:36 2014
New Revision: 44827
URL: http://svnweb.freebsd.org/changeset/doc/44827

Log:
  Put acronym tags around FAQ.
  Start to remove "you/we" usage.
  Many more commits to come.
  
  Sponsored by:	iXsystems

Modified:
  head/en_US.ISO8859-1/books/faq/book.xml

Modified: head/en_US.ISO8859-1/books/faq/book.xml
==============================================================================
--- head/en_US.ISO8859-1/books/faq/book.xml	Wed May 14 09:58:21 2014	(r44826)
+++ head/en_US.ISO8859-1/books/faq/book.xml	Wed May 14 11:59:36 2014	(r44827)
@@ -69,8 +69,9 @@
     <releaseinfo>$FreeBSD$</releaseinfo>
 
     <abstract>
-      <para>This is the FAQ for &os; versions &rel3.relx;, &rel2.relx;
-	and &rel.relx;.  Every effort has been made to make this FAQ
+      <para>This is the Frequently Asked Questions
+	<acronym>FAQ</acronym> for &os; versions &rel3.relx;, &rel2.relx;
+	and &rel.relx;.  Every effort has been made to make this <acronym>FAQ</acronym>
 	as informative as possible; if you have any suggestions as to
 	how it may be improved, send them to the
 	&a.doc;.</para>
@@ -138,12 +139,12 @@
 	</question>
 
 	<answer>
-	  <para>Yes.  Those restrictions do not control how you use
-	    the code, merely how you treat the &os; Project itself.
-	    If you have serious license concerns, read the actual
+	  <para>Yes.  Those restrictions do not control how
+	    the code is used, but how to treat the &os; Project itself.
+	    The license itself is available at
 	    <link
-	      xlink:href="http://www.FreeBSD.org/copyright/freebsd-license.html">license</link>.
-	    The license can be summarized like
+	      xlink:href="http://www.FreeBSD.org/copyright/freebsd-license.html">license</link>
+	    and can be summarized like
 	    this:</para>
 
 	  <itemizedlist>
@@ -202,15 +203,15 @@
 	    robust and full-featured environment for applications.  It
 	    supports a wide variety of web browsers, office suites,
 	    email readers, graphics programs, programming
-	    environments, network servers, and just about everything
-	    else you might want.  Most of these applications can be
+	    environments, network servers, and much more.
+	    Most of these applications can be
 	    managed through the <link
 	      xlink:href="http://www.FreeBSD.org/ports/">Ports
 	      Collection</link>.</para>
 
-	  <para>If you need to use an application that is only
-	    available on one operating system, you simply cannot
-	    replace that operating system.  Chances are there is a
+	  <para>If an application is only
+	    available on one operating system, you cannot just
+	    replace that operating system.  Chances are, there is a
 	    very similar application on &os;, however.  If you want a
 	    solid office or Internet server, a reliable workstation,
 	    or just the ability to do your job without interruptions,
@@ -219,15 +220,14 @@
 	    and experienced &unix; administrators, use &os; as their
 	    only desktop operating system.</para>
 
-	  <para>If you are migrating to &os; from some other &unix;
-	    environment, you already know most of what you need to.
-	    If your background is in graphic-driven operating systems
-	    such as &windows; and &macos;, you may be interested in
+	  <para>Users migrating to &os; from another &unix;-like
+	    environment will find &os; to be similar.
+	    &windows; and &macos; users may be interested in instead
 	    using <link
-	      xlink:href="http://www.pcbsd.org/">PC-BSD</link>, a &os;
-	    based distribution, instead.  If you have not used &unix;
-	    before expect to invest additional time learning the
-	    &unix; way of doing things.  This FAQ and the <link
+	      xlink:href="http://www.pcbsd.org/">PC-BSD</link>, a
+	    &os;-based desktop distribution.  Non-&unix; users should
+	    expect to invest some additional time learning the
+	    &unix; way of doing things.  This <acronym>FAQ</acronym> and the <link
 	      xlink:href="&url.books.handbook;/index.html">&os;
 	      Handbook</link> are excellent places to start.</para>
 	</answer>
@@ -262,9 +262,9 @@
 	  </itemizedlist>
 
 	  <para>It is worth pointing out that the word
-	    <quote>free</quote> is being used in two ways here, one
-	    meaning <quote>at no cost</quote>, the other meaning
-	    <quote>you can do whatever you like</quote>.  Apart from
+	    <quote>free</quote> is being used in two ways here: one
+	    meaning <quote>at no cost</quote> and the other meaning
+	    <quote>do whatever you like</quote>.  Apart from
 	    one or two things you <emphasis>cannot</emphasis> do with
 	    the &os; code, for example pretending you wrote it, you
 	    can really do whatever you like with it.</para>
@@ -354,9 +354,8 @@
 	    possibly unstable) features of the latest
 	    <emphasis>-CURRENT</emphasis> snapshot.  Releases can come
 	    from either branch, but <emphasis>-CURRENT</emphasis>
-	    should only be used if you are prepared for its increased
-	    volatility (relative to <emphasis>-STABLE</emphasis>, that
-	    is).</para>
+	    is meant for users who are prepared for its increased
+	    volatility, relative to <emphasis>-STABLE</emphasis>.</para>
 
 	  <para>Releases are made <link linkend="release-freq">every
 	      few months</link>.  While many people stay more
@@ -391,7 +390,7 @@
 	    for details on running
 	    <emphasis>-CURRENT</emphasis>.</para>
 
-	  <para>If you are not familiar with &os; you should not use
+	  <para>Users not familiar with &os; should not use
 	    &os.current;.  This branch sometimes evolves quite quickly
 	    and due to mistake can be un-buildable at times.  People
 	    that use &os.current; are expected to be able to analyze,
@@ -435,9 +434,9 @@
 
 	  <para>No claims are made that any
 	    <emphasis>-CURRENT</emphasis> snapshot can be considered
-	    <quote>production quality</quote> for any purpose.  If you
-	    want to run a stable and fully tested system, you will
-	    have to stick to full releases, or use the
+	    <quote>production quality</quote> for any purpose.
+	    If a stable and fully tested system is needed,
+	    stick to full releases or use the
 	    <emphasis>-STABLE</emphasis> snapshots.</para>
 
 	  <para>Snapshot releases are directly available from <link
@@ -629,7 +628,7 @@
 	      xlink:href="http://www.FreeBSD.org/docs.html">http://www.FreeBSD.org/docs.html</uri>.
 	    In addition, <link
 	      linkend="bibliography">the Bibliography</link> at the
-	    end of this FAQ, and <link
+	    end of this <acronym>FAQ</acronym>, and <link
 	      xlink:href="&url.books.handbook;/bibliography.html">the
 	      one in the Handbook</link> reference other recommended
 	    books.</para>
@@ -661,10 +660,10 @@
 
 	    <listitem>
 	      <para>The document's language and encoding.  These are
-		based on the locale names you will find under
-		<filename>/usr/share/locale</filename> on your &os;
-		system.  The current languages and encodings that we
-		have for documentation are as follows:</para>
+		based on the locale names found under
+		<filename>/usr/share/locale</filename> on a &os;
+		system.  The current languages and encodings
+		are as follows:</para>
 
 	      <informaltable frame="none" pgwide="1">
 		<tgroup cols="2">
@@ -920,16 +919,15 @@
 	    </listitem>
 	  </itemizedlist>
 
-	  <para>After choosing the format and compression mechanism
-	    that you want to download, you will have to download the
-	    compressed files yourself, uncompress them, and then copy
+	  <para>After choosing the format and compression mechanism,
+	    download the
+	    compressed files, uncompress them, and then copy
 	    the appropriate documents into place.</para>
 
-	  <para>For example, the split HTML version of the FAQ,
+	  <para>For example, the split HTML version of the <acronym>FAQ</acronym>,
 	    compressed using &man.bzip2.1;, can be found in
 	    <filename>doc/en_US.ISO8859-1/books/faq/book.html-split.tar.bz2</filename>
-	    To download and uncompress that file you would have to do
-	    this:</para>
+	    To download and uncompress that file, type:</para>
 
 	  <screen>&prompt.root; <userinput>fetch ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/en_US.ISO8859-1/books/faq/book.html-split.tar.bz2</userinput>
 &prompt.root; <userinput>tar xvf book.html-split.tar.bz2</userinput></screen>
@@ -986,14 +984,14 @@
 		a general help channel with many users at any time.
 		The conversations have been known to run off-topic for
 		a while, but priority is given to users with &os;
-		questions.  We are good about helping you understand
+		questions.  Other users can help you understand
 		the basics, referring to the Handbook whenever
-		possible, and directing you where to learn more about
-		the topic you need help with.  We are a primarily
-		English speaking channel, though we have users from
-		all over the world.  If you would like to speak in
-		your native language, try to ask the question in
-		English and then relocate to another channel
+		possible and providing links for learning more about
+		the topic you need help with.  This is primarily an
+		English speaking channel, though it does have users from
+		all over the world.  Non-native English speakers should
+		try to ask the question in
+		English first and then relocate to
 		<literal>##freebsd-lang</literal> as
 		appropriate.</para>
 	    </listitem>
@@ -1039,13 +1037,9 @@
 	      list</link> of IRC channels.</para>
 
 	  <para>Each of these channels are distinct and are not
-	    connected to each other.  Their chat styles also differ,
-	    so you may need to try each to find one suited to your
-	    chat style.  As with <emphasis>all</emphasis> types of IRC
-	    traffic, if you are easily offended or cannot deal with
-	    lots of young people (and more than a few older ones)
-	    doing the verbal equivalent of jello wrestling, do not
-	    even bother with it.</para>
+	    connected to each other.  Since their chat styles differ,
+	    try each to find one suited to your
+	    chat style.</para>
 	</answer>
       </qandaentry>
 
@@ -1077,10 +1071,9 @@
 
 	  <para>BSD Certification Group, Inc. provides system
 	    administration certifications for DragonFly BSD,
-	    &os;, NetBSD, and OpenBSD.  If you are interested in them,
-	    visit <link
+	    &os;, NetBSD, and OpenBSD.  Refer to <link
 	      xlink:href="http://www.BSDCertification.org">their
-	      site</link>.</para>
+	      site</link> for more information.</para>
 
 	  <para>Any other organizations providing training and support
 	    should contact the Project to be listed here.</para>
@@ -1111,10 +1104,9 @@
 	  <para>&arch.amd64; is the term &os; uses for 64-bit
 	    compatible x86 architectures (also known as "x86-64" or
 	    "x64").  Most modern computers should use &arch.amd64;.
-	    Older hardware should use &arch.i386;.  If you are
-	    installing on a non-x86-compatible architecture select the
-	    platform which best matches the architecture you are
-	    using.</para>
+	    Older hardware should use &arch.i386;.  When
+	    installing on a non-x86-compatible architecture, select the
+	    platform which best matches the hardware.</para>
 	</answer>
       </qandaentry>
 
@@ -1126,8 +1118,8 @@
 	<answer>
 	  <para>On the <link
 	      xlink:href="http://www.freebsd.org/where.html">Getting
-	      &os;</link> page select <literal>[iso]</literal> next to
-	    the architecture you want to use.</para>
+	      &os;</link> page, select <literal>[iso]</literal> next to
+	    the architecture that matches the hardware.</para>
 
 	  <para>Any of the following can be used:</para>
 
@@ -1258,8 +1250,8 @@
 	</question>
 
 	<answer>
-	  <para>For &os; you will need a 486 or better PC, with
-	    64 MB or more of RAM and at least 1 GB of hard
+	  <para>&os; requires a 486 or better PC,
+	    64 MB or more of RAM, and at least 1 GB of hard
 	    disk space.</para>
 
 	  <para>See also <xref linkend="hardware"/>.</para>
@@ -1289,8 +1281,8 @@
 	<answer>
 	  <para>If &windows; is installed first, then yes.  &os;'s
 	    boot manager will then manage to boot &windows; and &os;.
-	    If you install &windows; second, it will boorishly
-	    overwrite your boot manager without even asking.  If that
+	    If &windows; is installed afterwards, it will
+	    overwrite the boot manager.  If that
 	    happens, see the next section.</para>
 	</answer>
       </qandaentry>
@@ -1302,9 +1294,8 @@
 	</question>
 
 	<answer>
-	  <para>This depends on what boot manager you have installed.
-	    The &os; boot selection menu (likely what you are using
-	    if you end up in this situation) can be reinstalled using
+	  <para>This depends upon the boot manager.
+	    The &os; boot selection menu can be reinstalled using
 	    &man.boot0cfg.8;.  For example, to restore the boot menu
 	    onto the disk <replaceable>ada0</replaceable>:</para>
 
@@ -1337,7 +1328,7 @@
 	    see the CD-ROM to boot from it, but why &os; cannot see it
 	    to complete the install.</para>
 
-	  <para>Reconfigure your system so that the CD-ROM is either
+	  <para>Reconfigure the system so that the CD-ROM is either
 	    the master device on the IDE controller it is attached to,
 	    or make sure that it is the slave on an IDE controller
 	    that also has a master device.</para>
@@ -1388,10 +1379,10 @@
 	    default.  These are believed to be more secure than the
 	    traditional &unix; password format, which used a scheme
 	    based on the <emphasis>DES</emphasis> algorithm.  DES
-	    passwords are still available if you need to share your
-	    password file with legacy operating systems which still
-	    use the less secure password format.  &os; also allows you
-	    to use the Blowfish and MD5 password formats.  Which
+	    passwords are still available for backwards compatibility
+	    with legacy operating systems which still
+	    use the less secure password format.  &os; also supports
+	    the Blowfish and MD5 password formats.  Which
 	    password format to use for new passwords is controlled by
 	    the <literal>passwd_format</literal> login capability in
 	    <filename>/etc/login.conf</filename>, which takes values
@@ -1459,12 +1450,12 @@
 	</question>
 
 	<answer>
-	  <para>Because your world and kernel are out of sync.  This
-	    is not supported.  Be sure you use <command>make
+	  <para>The world and kernel are out of sync.  This
+	    is not supported.  Be sure to use <command>make
 	      buildworld</command> and <command>make
-	      buildkernel</command> to update your kernel.</para>
+	      buildkernel</command> to update the kernel.</para>
 
-	  <para>You can boot by specifying the kernel directly at the
+	  <para>Boot the system by specifying the kernel directly at the
 	    second stage, pressing any key when the
 	    <literal>|</literal> shows up before loader is
 	    started.</para>
@@ -1503,9 +1494,8 @@
 
 	  <answer>
 	    <para>This is discussed continually on the &os; mailing
-	      lists.  Since hardware changes so quickly, however, we
-	      expect this.  We <emphasis>still</emphasis> strongly
-	      recommend that you read through the Hardware Notes
+	      lists but is to be expected since hardware changes so quickly.
+	      Read through the Hardware Notes
 	      for &os; <link
 		xlink:href="&rel.current.hardware;">&rel.current;</link>
 	      or <link
@@ -1513,12 +1503,11 @@
 	      and search the mailing list <link
 		xlink:href="http://www.FreeBSD.org/search/#mailinglists">archives</link>
 	      before asking about the latest and greatest hardware.
-	      Chances are a discussion about the type of hardware you
-	      are looking for took place just last week.</para>
+	      Chances are a discussion about that type of hardware
+	      took place just last week.</para>
 
-	    <para>If you are looking for a laptop, check the
-	      &a.mobile; archives.  Otherwise, you probably want the
-	      archives for the &a.questions;, or possibly a specific
+	    <para>Before purchasing a laptop, check the archives for
+	      &a.mobile; and &a.questions;, or possibly a specific
 	      mailing list for a particular hardware type.</para>
 	  </answer>
 	</qandaentry>
@@ -1587,9 +1576,8 @@
 	      to be used with PAE are actually usable.  A rule of
 	      thumb is that if the driver is usable on 64-bit
 	      architectures (like AMD64), it is also usable with PAE.
-	      If you wish to create your own kernel configuration
-	      file, you can enable PAE by adding the following line to
-	      your configuration:</para>
+	      When creating a custom kernel configuration
+	      file, PAE can be enabled by adding the following line:</para>
 
 	    <programlisting>options       PAE</programlisting>
 
@@ -1729,11 +1717,11 @@
 	      you actually control the changer can be found in the
 	      &man.chio.1; manual page.</para>
 
-	    <para>If you are not using
-	      <application>AMANDA</application> or some other product
-	      that already understands changers, remember that they
-	      only know how to move a tape from one point to another,
-	      so you need to keep track of which slot a tape is in,
+	    <para>While
+	      <application>AMANDA</application> and some other products
+	      already understands changers, other applications
+	      only know how to move a tape from one point to another/
+	      In this case, keep track of which slot a tape is in
 	      and which slot the tape currently in the drive needs to
 	      go back to.</para>
 	  </answer>
@@ -1811,7 +1799,7 @@
 
 	    <para>When the mouse daemon is running, access to the
 	      mouse must be coordinated between the mouse daemon and
-	      other programs such as X Windows.  Refer to the FAQ
+	      other programs such as X Windows.  Refer to the <acronym>FAQ</acronym>
 	      <link linkend="x-and-moused">Why does my mouse not work
 		with X?</link> for more details on this issue.</para>
 	  </answer>
@@ -2003,7 +1991,7 @@ bindkey ^[[3~ delete-char # for xterm</p
 	      <para>If it is a problem with part of the base &os;
 		system, it may also be buggy code, but more often than
 		not these problems are found and fixed long before us
-		general FAQ readers get to use these bits of code
+		general <acronym>FAQ</acronym> readers get to use these bits of code
 		(that is what -CURRENT is for).</para>
 	    </listitem>
 	  </orderedlist>
@@ -2092,7 +2080,7 @@ bindkey ^[[3~ delete-char # for xterm</p
 	    </listitem>
 	  </orderedlist>
 
-	  <para>You should also read the SIG11 FAQ (listed below)
+	  <para>You should also read the SIG11 <acronym>FAQ</acronym> (listed below)
 	    which has excellent explanations of all these problems,
 	    albeit from a &linux; viewpoint.  It also discusses how
 	    memory testing software or hardware can still pass faulty
@@ -2102,9 +2090,9 @@ bindkey ^[[3~ delete-char # for xterm</p
 	    that you have just found a bug in &os;, and you should
 	    follow the instructions to send a problem report.</para>
 
-	  <para>There is an extensive FAQ on this at <link
+	  <para>There is an extensive <acronym>FAQ</acronym> on this at <link
 	      xlink:href="http://www.bitwizard.nl/sig11/">the SIG11
-	      problem FAQ</link>.</para>
+	      problem <acronym>FAQ</acronym></link>.</para>
 	</answer>
       </qandaentry>
 
@@ -2120,7 +2108,7 @@ bindkey ^[[3~ delete-char # for xterm</p
 	  <para>The &os; developers are very interested in these
 	    errors, but need some more information than just the error
 	    you see.  Copy your full crash message.  Then consult the
-	    FAQ section on <link
+	    <acronym>FAQ</acronym> section on <link
 	      linkend="kernel-panic-troubleshooting">kernel
 	      panics</link>, build a debugging kernel, and get a
 	    backtrace.  This might sound difficult, but you do not
@@ -2180,7 +2168,8 @@ bindkey ^[[3~ delete-char # for xterm</p
 	<answer>
 	  <para>This is answered in the <link
 	      xlink:href="http://www.sendmail.org/faq/">Sendmail
-	      FAQ</link> as follows.  This FAQ is recommended reading
+	      <acronym>FAQ</acronym></link> as follows.  This
+	    <acronym>FAQ</acronym> is recommended reading
 	    when <quote>tweaking</quote> the mail setup.</para>
 
 	  <programlisting>I'm getting these error messages:
@@ -4557,7 +4546,7 @@ options    SYSVMSG          # enable for
 	<answer>
 	  <para>You are running a securelevel greater than 0.
 	    Lower the securelevel and try again.  For
-	    more information, see <link linkend="securelevel">the FAQ
+	    more information, see <link linkend="securelevel">the <acronym>FAQ</acronym>
 	      entry on securelevel</link> and the &man.init.8; manual
 	    page.</para>
 	</answer>
@@ -5665,7 +5654,7 @@ Key F15        A        A        Menu Wo
 	    way the user expects.  This behavior is a feature and not
 	    a bug.</para>
 
-	  <para>See the <link linkend="service-redirect">FAQ about
+	  <para>See the <link linkend="service-redirect"><acronym>FAQ</acronym> about
 	      redirecting services</link>, the &man.natd.8; manual, or
 	    one of the several port redirecting utilities in the <link
 	      xlink:href="&url.base;/ports/index.html">Ports
@@ -7424,7 +7413,7 @@ hint.sio.7.irq="12"</programlisting>
 	<answer>
 	  <para>See the <link
 	      xlink:href="&url.books.fdp-primer;/translations.html">Translation
-	      FAQ</link> in the &os; Documentation Project
+	      <acronym>FAQ</acronym></link> in the &os; Documentation Project
 	    Primer.</para>
 	</answer>
       </qandaentry>
@@ -8301,7 +8290,7 @@ panic: page fault</programlisting>
     <para>We wish to thank every one of the people responsible, and we
       encourage you to <link
 	xlink:href="&url.articles.contributing;/article.html">join
-	them</link> in making this FAQ even better.</para>
+	them</link> in making this <acronym>FAQ</acronym> even better.</para>
   </chapter>
 
   &bibliography;


More information about the svn-doc-head mailing list