Various minor text tweaks.
authorDavid Crossley <dcrossley@indexgeo.com.au>
Tue, 8 Sep 2015 04:10:10 +0000 (14:10 +1000)
committerAdam Dickmeiss <adam@indexdata.dk>
Tue, 8 Sep 2015 07:00:37 +0000 (09:00 +0200)
doc/book.xml
doc/gfs-options.xml
doc/gfs-virtual.xml

index eaa87ca..203dd7c 100644 (file)
    </para>
    <para>
     If you have a database system that you would like to make available by
    </para>
    <para>
     If you have a database system that you would like to make available by
-    means of Z39.50 or SRU, &yaz; basically offers your two options. You
+    means of Z39.50 or SRU, &yaz; basically offers two options. You
     can use the APIs provided by the &asn;, &odr;, and &comstack;
     modules to
     create and decode PDUs, and exchange them with a client.
     can use the APIs provided by the &asn;, &odr;, and &comstack;
     modules to
     create and decode PDUs, and exchange them with a client.
@@ -3316,8 +3316,8 @@ int statserv_main(int argc, char **argv,
       <listitem><para>
        A boolean value, which determines whether the server
        will fork on each incoming request (TRUE), or not (FALSE). Default is
       <listitem><para>
        A boolean value, which determines whether the server
        will fork on each incoming request (TRUE), or not (FALSE). Default is
-       TRUE. This flag is only read by UNIX-based servers (WIN32 based servers
-       doesn't fork).
+       TRUE. This flag is only read by UNIX-based servers (WIN32-based servers
+       do not fork).
      </para></listitem>
      </varlistentry>
      <varlistentry>
      </para></listitem>
      </varlistentry>
      <varlistentry>
@@ -3334,7 +3334,7 @@ int statserv_main(int argc, char **argv,
       <term><literal>int inetd</literal></term>
       <listitem><para>
        A boolean value, which determines whether the server
       <term><literal>int inetd</literal></term>
       <listitem><para>
        A boolean value, which determines whether the server
-       will operates under a UNIX INET daemon (inetd). Default is FALSE.
+       will operate under a UNIX INET daemon (inetd). Default is FALSE.
      </para></listitem>
      </varlistentry>
      <varlistentry>
      </para></listitem>
      </varlistentry>
      <varlistentry>
@@ -3399,12 +3399,12 @@ int statserv_main(int argc, char **argv,
       <listitem><para>Pointer to function which is called after the
       command line options have been parsed - but before the server
       starts listening.
       <listitem><para>Pointer to function which is called after the
       command line options have been parsed - but before the server
       starts listening.
-      For forked UNIX servers this handler is called in the mother
-      process; for threaded servers this handler is called in the
+      For forked UNIX servers, this handler is called in the mother
+      process; for threaded servers, this handler is called in the
       main thread.
       The default value of this pointer is NULL in which case it
       isn't invoked by the frontend server.
       main thread.
       The default value of this pointer is NULL in which case it
       isn't invoked by the frontend server.
-      When the server operates as an NT service this handler is called
+      When the server operates as an NT service, this handler is called
       whenever the service is started.
       </para></listitem>
      </varlistentry>
       whenever the service is started.
       </para></listitem>
      </varlistentry>
@@ -3415,7 +3415,7 @@ int statserv_main(int argc, char **argv,
       <listitem><para>Pointer to function which is called whenever the server
       has stopped listening for incoming connections. This function pointer
       has a default value of NULL in which case it isn't called.
       <listitem><para>Pointer to function which is called whenever the server
       has stopped listening for incoming connections. This function pointer
       has a default value of NULL in which case it isn't called.
-      When the server operates as an NT service this handler is called
+      When the server operates as an NT service, this handler is called
       whenever the service is stopped.
       </para></listitem>
      </varlistentry>
       whenever the service is stopped.
       </para></listitem>
      </varlistentry>
@@ -3431,14 +3431,14 @@ int statserv_main(int argc, char **argv,
    <para>
     The pointer returned by <literal>statserv_getcontrol</literal> points to
     a static area. You are allowed to change the contents of the structure,
    <para>
     The pointer returned by <literal>statserv_getcontrol</literal> points to
     a static area. You are allowed to change the contents of the structure,
-    but the changes will not take effect before you call
+    but the changes will not take effect until you call
    </para>
    <synopsis>
 void statserv_setcontrol(statserv_options_block *block);
    </synopsis>
    <note>
     <para>
    </para>
    <synopsis>
 void statserv_setcontrol(statserv_options_block *block);
    </synopsis>
    <note>
     <para>
-     that you should generally update this structure before calling
+     You should generally update this structure before calling
      <function>statserv_main()</function>.
     </para>
    </note>
      <function>statserv_main()</function>.
     </para>
    </note>
@@ -3470,7 +3470,7 @@ bend_initresult (*bend_init)(bend_initrequest *r);
     <para>
      Unlike previous versions of YAZ, the <function>bend_init</function> also
      serves as a handler that defines the Z39.50 services that the backend
     <para>
      Unlike previous versions of YAZ, the <function>bend_init</function> also
      serves as a handler that defines the Z39.50 services that the backend
-     wish to support. Pointers to <emphasis>all</emphasis> service handlers,
+     intends to support. Pointers to <emphasis>all</emphasis> service handlers,
      including search - and fetch must be specified here in this handler.
     </para>
     <para>
      including search - and fetch must be specified here in this handler.
     </para>
     <para>
@@ -3576,7 +3576,7 @@ typedef struct bend_initresult
     </para>
     <para>
      The <literal>auth</literal> member holds the authentication information
     </para>
     <para>
      The <literal>auth</literal> member holds the authentication information
-     part of the Z39.50 Initialize Request. Interpret this if your serves
+     part of the Z39.50 Initialize Request. Interpret this if your server
      requires authentication.
     </para>
     <para>
      requires authentication.
     </para>
     <para>
@@ -3632,7 +3632,7 @@ typedef struct {
     </synopsis>
     <para>
      The <function>bend_search</function> handler is a fairly close
     </synopsis>
     <para>
      The <function>bend_search</function> handler is a fairly close
-     approximation of a protocol Z39.50 Search Request - and Response PDUs
+     approximation of a protocol Z39.50 Search Request - and Response PDUs.
      The <literal>setname</literal> is the resultSetName from the protocol.
      You are required to establish a mapping between the set name and whatever
      your backend database likes to use.
      The <literal>setname</literal> is the resultSetName from the protocol.
      You are required to establish a mapping between the set name and whatever
      your backend database likes to use.
@@ -3803,7 +3803,7 @@ typedef struct {
    <sect2 id="server.delete">
     <title>Delete</title>
     <para>
    <sect2 id="server.delete">
     <title>Delete</title>
     <para>
-     For back-ends that supports delete of a result set only one handler
+     For back-ends that supports delete of a result set, only one handler
      must be defined.
     </para>
     <synopsis>
      must be defined.
     </para>
     <synopsis>
@@ -3870,12 +3870,12 @@ typedef struct bend_scan_rr {
    <para>
     This backend server handles both Z39.50 scan
     and SRU scan. In order for a handler to distinguish between SRU (CQL) scan
    <para>
     This backend server handles both Z39.50 scan
     and SRU scan. In order for a handler to distinguish between SRU (CQL) scan
-    Z39.50 Scan , it must check for a non-NULL value of
+    Z39.50 Scan, it must check for a non-NULL value of
     <literal>scanClause</literal>.
    </para>
    <note>
     <para>
     <literal>scanClause</literal>.
    </para>
    <note>
     <para>
-     if designed today, it would be a choice using a union or similar,
+     If designed today, it would be a choice using a union or similar,
      but that would break binary compatibility with existing servers.
     </para>
     </note>
      but that would break binary compatibility with existing servers.
     </para>
     </note>
@@ -3955,14 +3955,14 @@ typedef struct bend_scan_rr {
      </screen>
     </para>
     <para>
      </screen>
     </para>
     <para>
-     The above for the Apache 1.3 series.
+     The above is for the Apache 1.3 series.
     </para>
    </example>
    <example id="server.example.local.access">
     <title>Running a server with local access only</title>
     <para>
     </para>
    </example>
    <example id="server.example.local.access">
     <title>Running a server with local access only</title>
     <para>
-     Servers that is only being accessed from the local host should listen
-     on UNIX file socket rather than a Internet socket. To listen on
+     A server that is only being accessed from the local host should listen
+     on UNIX file socket rather than an Internet socket. To listen on
      <filename>/tmp/mysocket</filename> start the server as follows:
      <screen>
       application unix:/tmp/mysocket
      <filename>/tmp/mysocket</filename> start the server as follows:
      <screen>
       application unix:/tmp/mysocket
index ed524ca..e3af38d 100644 (file)
@@ -34,8 +34,8 @@
   <term><literal>-T</literal></term>
   <listitem><para>
    Operate the server in threaded mode. The server creates a thread
   <term><literal>-T</literal></term>
   <listitem><para>
    Operate the server in threaded mode. The server creates a thread
-   for each connection rather than a fork a process. Only available
-   on UNIX systems that offers POSIX threads.
+   for each connection rather than fork a process. Only available
+   on UNIX systems that offer POSIX threads.
   </para></listitem>
  </varlistentry>
  <varlistentry>
   </para></listitem>
  </varlistentry>
  <varlistentry>
@@ -99,8 +99,8 @@
  <varlistentry>
   <term><literal>-w </literal><replaceable>dir</replaceable></term>
   <listitem><para>
  <varlistentry>
   <term><literal>-w </literal><replaceable>dir</replaceable></term>
   <listitem><para>
-   The server changes to this directory during before listening
-   on incoming connections. This option is useful
+   The server changes to this directory before listening
+   to incoming connections. This option is useful
    when the server is operating from the <application>inetd</application>
    daemon (see <literal>-i</literal>).
   </para></listitem>
    when the server is operating from the <application>inetd</application>
    daemon (see <literal>-i</literal>).
   </para></listitem>
   <literal>-p </literal><replaceable>pidfile</replaceable>
  </term>
  <listitem><para>
   <literal>-p </literal><replaceable>pidfile</replaceable>
  </term>
  <listitem><para>
-  Specifies that the server should write its Process ID to
+  Specifies that the server should write its Process ID to the
   file given by <replaceable>pidfile</replaceable>.
   A typical location would be <filename>/var/run/yaz-ztest.pid</filename>.
  </para></listitem>
   file given by <replaceable>pidfile</replaceable>.
   A typical location would be <filename>/var/run/yaz-ztest.pid</filename>.
  </para></listitem>
index 66f0bd8..2c98df7 100644 (file)
@@ -22,8 +22,8 @@
 </para>
 <note>
  <para>
 </para>
 <note>
  <para>
-  Not all Z39.50 clients allows the VHOST information to be set.
-  For those the selection of the backend must rely on the
+  Not all Z39.50 clients allow the VHOST information to be set.
+  For those, the selection of the backend must rely on the
   TCP/IP information alone (port and address).
  </para>
 </note>
   TCP/IP information alone (port and address).
  </para>
 </note>
@@ -55,7 +55,7 @@
   <varlistentry><term>attribute <literal>id</literal> (optional)</term>
     <listitem>
      <para>
   <varlistentry><term>attribute <literal>id</literal> (optional)</term>
     <listitem>
      <para>
-      identifier for this listener. This may be referred to from
+      Identifier for this listener. This may be referred to from
       server sections.
      </para>
     </listitem>
       server sections.
      </para>
     </listitem>
    <listitem>
     <para>
      Specifies a working directory for this backend server. If
    <listitem>
     <para>
      Specifies a working directory for this backend server. If
-     specifid, the YAZ fronend changes current working directory
+     specified, the YAZ frontend changes current working directory
      to this directory whenever a backend of this type is
      started (backend handler bend_start), stopped (backend handler hand_stop)
      and initialized (bend_init).
      to this directory whenever a backend of this type is
      started (backend handler bend_start), stopped (backend handler hand_stop)
      and initialized (bend_init).
    <listitem>
     <para>
      Specifies a filename that includes CQL to RPN conversion for this
    <listitem>
     <para>
      Specifies a filename that includes CQL to RPN conversion for this
-     backend server. See &reference-tools-cql-map;
+     backend server. See &reference-tools-cql-map;.
      If given, the backend server will only "see" a Type-1/RPN query.
     </para>
    </listitem>
      If given, the backend server will only "see" a Type-1/RPN query.
     </para>
    </listitem>
    <listitem>
     <para>
      Specifies a filename that includes CCL to RPN conversion for this
    <listitem>
     <para>
      Specifies a filename that includes CCL to RPN conversion for this
-     backend server. See &reference-tools-ccl-qualifiers;
+     backend server. See &reference-tools-ccl-qualifiers;.
      If given, the backend server will only "see" a Type-1/RPN query.
     </para>
    </listitem>
      If given, the backend server will only "see" a Type-1/RPN query.
     </para>
    </listitem>
    <listitem>
     <para>
      Specifies the stylesheet reference to be part of SRU HTTP responses
    <listitem>
     <para>
      Specifies the stylesheet reference to be part of SRU HTTP responses
-     when the client does not specify one. If neither this is given, nor
-     the client specifies one, no stylesheet reference is part of the
+     when the client does not specify one. If none is given, then if
+     the client does not specify one, then no stylesheet reference is part of the
      SRU HTTP response.
     </para>
    </listitem>
      SRU HTTP response.
     </para>
    </listitem>
    <listitem>
     <para>
      Specifies a path for local file access using HTTP. All URLs with
    <listitem>
     <para>
      Specifies a path for local file access using HTTP. All URLs with
-     a leading prefix (/ exluded) that matches the value of docpath
+     a leading prefix (/ excluded) that matches the value of <literal>docpath</literal>
      are used for file access. For example, if the server is to offer
      access in directory <literal>xsl</literal>, the docpath would be
      <literal>xsl</literal> and all URLs of the form
      are used for file access. For example, if the server is to offer
      access in directory <literal>xsl</literal>, the docpath would be
      <literal>xsl</literal> and all URLs of the form
     <para>
      Specifies SRW/SRU ZeeRex content for this server. Copied verbatim
      to the client. As things are now, some of the Explain content
     <para>
      Specifies SRW/SRU ZeeRex content for this server. Copied verbatim
      to the client. As things are now, some of the Explain content
-     seeem redundant because host information, etc. is also stored
+     seem redundant because host information, etc. is also stored
      elsewhere.
     </para>
    </listitem>
      elsewhere.
     </para>
    </listitem>
    <listitem>
     <para>
      Specifies maximum record size/message size, in bytes. This
    <listitem>
     <para>
      Specifies maximum record size/message size, in bytes. This
-     value also servers as maximum size of <emphasis>incoming</emphasis>
+     value also serves as the maximum size of <emphasis>incoming</emphasis>
      packages (for Record Updates etc). It's the same value as that
      given by the <literal>-k</literal> option.
     </para>
      packages (for Record Updates etc). It's the same value as that
      given by the <literal>-k</literal> option.
     </para>
   <varlistentry><term>element <literal>retrievalinfo</literal> (optional)</term>
    <listitem>
     <para>
   <varlistentry><term>element <literal>retrievalinfo</literal> (optional)</term>
    <listitem>
     <para>
-     Enables the retrieval facility supporting conversions and
+     Enables the retrieval facility to support conversions and
      specifications of record formats/types.
      See <xref linkend="tools.retrieval"/> for
      more information.
      specifications of record formats/types.
      See <xref linkend="tools.retrieval"/> for
      more information.
   <literal>listenref</literal> attribute is specified.
  <literal>"server2"</literal> is reached by the two listeners specified.
  In order to distinguish between the two, a virtual host has
   <literal>listenref</literal> attribute is specified.
  <literal>"server2"</literal> is reached by the two listeners specified.
  In order to distinguish between the two, a virtual host has
- been specified for each of server in the <literal>host</literal>
+ been specified for each server in the <literal>host</literal>
  elements.
 </para>
 <para>
  elements.
 </para>
 <para>