Spell checking and markup refinement

Author: petere

doc/src/sgml/backup.sgml

@@ -818,8 +818,8 @@ SELECT pg_stop_backup();
     the equivalent of <function>pg_start_backup()</>, copy and
     <function>pg_stop_backup()</> steps automatically, and transfers the
     backup over a regular <productname>PostgreSQL</productname> connection
-    using the replication protocol, instead of requiring filesystem level
-    access. pg_basebackup does not interfere with filesystem level backups
+    using the replication protocol, instead of requiring file system level
+    access. <command>pg_basebackup</command> does not interfere with file system level backups
     taken using <function>pg_start_backup()</>/<function>pg_stop_backup()</>.
    </para>
 

doc/src/sgml/btree-gist.sgml

@@ -25,7 +25,7 @@
   standard B-tree code: the ability to enforce uniqueness.  However,
   they provide some other features that are not available with a B-tree
   index, as described below.  Also, these operator classes are useful
-  when a multi-column GiST index is needed, wherein some of the columns
+  when a multicolumn GiST index is needed, wherein some of the columns
   are of data types that are only indexable with GiST but other columns
   are just simple data types.  Lastly, these operator classes are useful for
   GiST testing and as a base for developing other GiST operator classes.
@@ -55,7 +55,7 @@
   <title>Example Usage</title>
 
   <para>
-   Simple example using btree_gist instead of btree:
+   Simple example using <literal>btree_gist</literal> instead of <literal>btree</literal>:
   </para>
 
 <programlisting>

doc/src/sgml/catalogs.sgml

@@ -1129,7 +1129,7 @@
       <entry><literal><link linkend="catalog-pg-collation"><structname>pg_collation</structname></link>.oid</literal></entry>
       <entry>
        The defined collation of the column, or zero if the column is
-       not of a collatable datatype.
+       not of a collatable data type.
       </entry>
      </row>
 
@@ -1294,7 +1294,7 @@
        Password (possibly encrypted); null if none.  If the password
        is encrypted, this column will begin with the string <literal>md5</>
        followed by a 32-character hexadecimal MD5 hash.  The MD5 hash
-       will be of the user's password concatenated to their username.
+       will be of the user's password concatenated to their user name.
        For example, if user <literal>joe</> has password <literal>xyzzy</>,
        <productname>PostgreSQL</> will store the md5 hash of
        <literal>xyzzyjoe</>.  A password that does not follow that

doc/src/sgml/config.sgml

@@ -3892,7 +3892,7 @@ FROM pg_stat_activity;
         This option emits log lines in comma-separated-values
         (<acronym>CSV</>) format,
         with these columns:
-        timestamp with milliseconds,
+        time stamp with milliseconds,
         user name,
         database name,
         process ID,
@@ -4936,7 +4936,7 @@ SET XML OPTION { DOCUMENT | CONTENT };
         Sets the collection of time zone abbreviations that will be accepted
         by the server for datetime input.  The default is <literal>'Default'</>,
         which is a collection that works in most of the world; there are
-        also 'Australia' and 'India', and other collections can be defined
+        also <literal>'Australia'</literal> and <literal>'India'</literal>, and other collections can be defined
         for a particular installation.  See <xref
         linkend="datetime-appendix"> for more information.
        </para>
@@ -6284,7 +6284,7 @@ LOG:  CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
         be present in the table.  It is useful for recovering data if
         corruption has occurred due to a hardware or software error.  You should
         generally not set this on until you have given up hope of recovering
-        data from the damaged pages of a table.  Zerod-out pages are not
+        data from the damaged pages of a table.  Zeroed-out pages are not
         forced to disk so it is recommended to recreate the table or
         the index before turning this parameter off again.  The
         default setting is <literal>off</>, and it can only be changed

doc/src/sgml/ecpg.sgml

@@ -407,7 +407,7 @@ EXEC SQL SELECT foo INTO :FooBar FROM table1 WHERE ascii = 'doodad';
   </para>
 
   <para>
-   Also, a configuration parameter can be retreived with the
+   Also, a configuration parameter can be retrieved with the
    <literal>SHOW</literal> command:
 <programlisting>
 EXEC SQL SHOW search_path INTO :var;
@@ -983,7 +983,7 @@ VARCHAR v2[128];
      the pgtypes library.  The pgtypes library, described in detail
      in <xref linkend="ecpg-pgtypes"> contains basic functions to deal
      with those types, such that you do not need to send a query to
-     the SQL server just for adding an interval to a timestamp for
+     the SQL server just for adding an interval to a time stamp for
      example.
     </para>
 
@@ -1038,9 +1038,9 @@ ts = 2010-06-27 18:03:56.949343
 
      <para>
       In addition, the DATE type can be handled in the same way. The
-      program has to include pg_types_date.h, declare a host variable
+      program has to include <filename>pg_types_date.h</filename>, declare a host variable
       as the date type and convert a DATE value into a text form using
-      PGTYPESdate_to_asc() function. For more details about the
+      <function>PGTYPESdate_to_asc()</function> function. For more details about the
       pgtypes library functions, see <xref linkend="ecpg-pgtypes">.
      </para>
     </sect4>
@@ -1173,12 +1173,12 @@ EXEC SQL END DECLARE SECTION;
       is a way to store some text string in <type>char[]</type>
       or <type>VARCHAR[]</type>, as
       explained <xref linkend="ecpg-char">.  The second use case is to
-      retreive multiple rows from a query result without using a
+      retrieve multiple rows from a query result without using a
       cursor.  Without an array, to process a query result consisting
       of multiple rows, it is required to use a cursor and
       the <command>FETCH</command> command.  But with array host
       variables, multiple rows can be received at once.  The length of
-      the array has to be defined to be able to accomodate all rows,
+      the array has to be defined to be able to accommodate all rows,
       otherwise a buffer overflow will likely occur.
      </para>
 
@@ -1239,7 +1239,7 @@ oid=0, dbname=
 
      <para>
       The following example retrieves OIDs, names, and sizes of the
-      avilable databases from the <literal>pg_database</literal>
+      available databases from the <literal>pg_database</literal>
       system table and using
       the <function>pg_database_size()</function> function.  In this
       example, a structure variable <varname>dbinfo_t</varname> with
@@ -3006,7 +3006,7 @@ int PGTYPEStimestamp_fmt_asc(timestamp *ts, char *output, int str_len, char *fmt
          <listitem>
           <para>
            <literal>%p</literal> - is replaced by national representation of
-           either "ante meridiem" or "post meridiem" as appropriate.
+           either <quote>ante meridiem</quote> or <quote>post meridiem</quote> as appropriate.
           </para>
          </listitem>
          <listitem>
@@ -3852,7 +3852,7 @@ EXEC SQL DESCRIBE prepared_statement INTO mysqlda;
     </procedure>
 
    <sect3>
-    <title>SQLDA Datac Structure</title>
+    <title>SQLDA Data Structure</title>
 
     <para>
      SQLDA uses three data structure
@@ -4080,7 +4080,7 @@ struct sqlname
    </sect3>
 
    <sect3 id="ecpg-sqlda-output">
-    <title>Retreiving a Result Set Using an SQLDA</title>
+    <title>Retrieving a Result Set Using an SQLDA</title>
 
     <procedure>
      <para>
@@ -4265,9 +4265,9 @@ free(sqlda2);
 
     <para>
      This application joins two system tables, pg_database and
-     pg_stat_database on the database oid, and also fetches and shows
-     the database statistics which are retreived by two input
-     parameters (a database "postgres", and oid "1").
+     pg_stat_database on the database OID, and also fetches and shows
+     the database statistics which are retrieved by two input
+     parameters (a database <literal>postgres</literal>, and OID <literal>1</literal>).
     </para>
 
     <para>
@@ -5832,7 +5832,7 @@ ECPG = ecpg
   <para>
    Large object functions have to be called in a transaction block, so
    when autocommit is off, <command>BEGIN</command> commands have to
-   be isssued explicitly.
+   be issued explicitly.
   </para>
 
   <para>
@@ -6616,7 +6616,7 @@ DECLARE <replaceable class="PARAMETER">cursor_name</replaceable> [ BINARY ] [ IN
       <term><replaceable class="PARAMETER">prepared_name</replaceable></term>
       <listitem>
        <para>
-        The name of a prepared query, either as an SQL identfier or a
+        The name of a prepared query, either as an SQL identifier or a
         host variable.
        </para>
       </listitem>
@@ -7477,7 +7477,7 @@ SET DESCRIPTOR <replaceable class="PARAMETER">descriptor_name</replaceable> VALU
       <term><replaceable class="PARAMETER">descriptor_item</replaceable></term>
       <listitem>
        <para>
-        A token identifiying which item of information to set in the
+        A token identifying which item of information to set in the
         descriptor.  See <xref linkend="ecpg-named-descriptors"> for a
         list of supported items.
        </para>
@@ -8461,7 +8461,7 @@ int dectoasc(decimal *np, char *cp, int len, int right)
         <literal>right</> to -1 indicates that all available decimal digits
         should be included in the output. If the length of the output buffer,
         which is indicated by <literal>len</> is not sufficient to hold the
-        textual representation including the trailing NUL character, only a
+        textual representation including the trailing zero byte, only a
         single <literal>*</> character is stored in the result and -1 is
         returned.
        </para>
@@ -8556,7 +8556,7 @@ int rdatestr(date d, char *str);
         The function receives two arguments, the first one is the date to
         convert (<literal>d</> and the second one is a pointer to the target
         string. The output format is always <literal>yyyy-mm-dd</>, so you need
-        to allocate at least 11 bytes (including the NUL-terminator) for the
+        to allocate at least 11 bytes (including the zero-byte terminator) for the
         string.
        </para>
        <para>

doc/src/sgml/extend.sgml

@@ -288,7 +288,7 @@
 
    <para>
     A useful extension to <productname>PostgreSQL</> typically includes
-    multiple SQL objects; for example, a new datatype will require new
+    multiple SQL objects; for example, a new data type will require new
     functions, new operators, and probably new index operator classes.
     It is helpful to collect all these objects into a single package
     to simplify database management.  <productname>PostgreSQL</> calls

doc/src/sgml/file-fdw.sgml

@@ -10,7 +10,7 @@
  <para>
   The <filename>file_fdw</> module provides the foreign-data wrapper
   <function>file_fdw</function>, which can be used to access data
-  files in the server's filesystem.  Data files must be in a format
+  files in the server's file system.  Data files must be in a format
   that can be read by <command>COPY FROM</command>;
   see <xref linkend="sql-copy"> for details.
  </para>

doc/src/sgml/func.sgml

@@ -9103,7 +9103,7 @@ SELECT xmlagg(x) FROM (SELECT * FROM test ORDER BY y DESC) AS tab;
     </para>
 
    <sect3>
-    <title>IS DOCUMENT</title>
+    <title><literal>IS DOCUMENT</literal></title>
 
     <indexterm>
      <primary>IS DOCUMENT</primary>
@@ -9123,7 +9123,7 @@ SELECT xmlagg(x) FROM (SELECT * FROM test ORDER BY y DESC) AS tab;
    </sect3>
 
    <sect3 id="xml-exists">
-    <title>XMLEXISTS</title>
+    <title><literal>XMLEXISTS</literal></title>
 
     <indexterm>
      <primary>XMLEXISTS</primary>
@@ -9165,7 +9165,7 @@ SELECT xmlexists('//town[text() = ''Toronto'']' PASSING BY REF '<towns><town>Tor
    </sect3>
 
    <sect3 id="xml-is-well-formed">
-    <title>xml_is_well_formed</title>
+    <title><literal>xml_is_well_formed</literal></title>
 
     <indexterm>
      <primary>xml_is_well_formed</primary>
@@ -9187,7 +9187,7 @@ SELECT xmlexists('//town[text() = ''Toronto'']' PASSING BY REF '<towns><town>Tor
 
     <para>
      These functions check whether a <type>text</> string is well-formed XML,
-     returning a boolean result.
+     returning a Boolean result.
      <function>xml_is_well_formed_document</function> checks for a well-formed
      document, while <function>xml_is_well_formed_content</function> checks
      for well-formed content.  <function>xml_is_well_formed</function> does
@@ -9324,7 +9324,7 @@ SELECT xpath('//mydefns:b/text()', '<a xmlns="http://example.com"><b>test</b></a
     The function <function>xpath_exists</function> is a specialized form
     of the <function>xpath</function> function.  Instead of returning the
     individual XML values that satisfy the XPath, this function returns a
-    boolean indicating whether the query was satisfied or not.  This
+    Boolean indicating whether the query was satisfied or not.  This
     function is equivalent to the standard <literal>XMLEXISTS</> predicate,
     except that it also offers support for a namespace mapping argument.
    </para>
@@ -13685,12 +13685,12 @@ SELECT typlen FROM pg_type WHERE oid = pg_typeof(33);
       <row>
        <entry><literal><function>txid_snapshot_xmax(<parameter>txid_snapshot</parameter>)</function></literal></entry>
        <entry><type>bigint</type></entry>
-       <entry>get xmax of snapshot</entry>
+       <entry>get <literal>xmax</literal> of snapshot</entry>
       </row>
       <row>
        <entry><literal><function>txid_snapshot_xmin(<parameter>txid_snapshot</parameter>)</function></literal></entry>
        <entry><type>bigint</type></entry>
-       <entry>get xmin of snapshot</entry>
+       <entry>get <literal>xmin</literal> of snapshot</entry>
       </row>
       <row>
        <entry><literal><function>txid_visible_in_snapshot(<parameter>bigint</parameter>, <parameter>txid_snapshot</parameter>)</function></literal></entry>
@@ -14218,7 +14218,7 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
         <literal><function>pg_last_xact_replay_timestamp()</function></literal>
         </entry>
        <entry><type>timestamp with time zone</type></entry>
-       <entry>Get timestamp of last transaction replayed during recovery.
+       <entry>Get time stamp of last transaction replayed during recovery.
         This is the time at which the commit or abort WAL record for that
         transaction was generated on the primary.
         If no transactions have been replayed during recovery, this function
@@ -14638,7 +14638,7 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
    </indexterm>
    <para>
     <function>pg_read_binary_file</> is similar to
-    <function>pg_read_file</>, except that the result is a bytea value;
+    <function>pg_read_file</>, except that the result is a <type>bytea</type> value;
     accordingly, no encoding checks are performed.
     In combination with the <function>convert_from</> function, this function
     can be used to read a file in a specified encoding:

doc/src/sgml/high-availability.sgml

@@ -1144,7 +1144,7 @@ primary_conninfo = 'host=192.168.1.50 port=5432 user=foo password=foopass'
    <para>
     To trigger failover of a log-shipping standby server,
     run <command>pg_ctl promote</> or create a trigger
-    file with the filename and path specified by the <varname>trigger_file</>
+    file with the file name and path specified by the <varname>trigger_file</>
     setting in <filename>recovery.conf</>. If you're planning to use
     <command>pg_ctl promote</> to fail over, <varname>trigger_file</> is
     not required. If you're setting up the reporting servers that are

doc/src/sgml/installation.sgml

@@ -1989,7 +1989,7 @@ kill `cat /usr/local/pgsql/data/postmaster.pid`
    <para>
     PostgreSQL works on AIX, but getting it installed properly can be
     challenging.  AIX versions from 4.3.3 to 6.1 are considered supported.
-    You can use GCC or the native IBM compiler xlc.  In
+    You can use GCC or the native IBM compiler <command>xlc</command>.  In
     general, using recent versions of AIX and PostgreSQL helps.  Check
     the build farm for up to date information about which versions of
     AIX are known to work.
@@ -2817,7 +2817,7 @@ MANPATH=/usr/lib/scohelp/%L/man:/usr/dt/man:/usr/man:/usr/share/man:scohelp:/usr
      You can build with either GCC or Sun's compiler suite.  For
      better code optimization, Sun's compiler is strongly recommended
      on the SPARC architecture.  We have heard reports of problems
-     when using GCC 2.95.1; gcc 2.95.3 or later is recommended.  If
+     when using GCC 2.95.1; GCC 2.95.3 or later is recommended.  If
      you are using Sun's compiler, be careful not to select
      <filename>/usr/ucb/cc</filename>;
      use <filename>/opt/SUNWspro/bin/cc</filename>.