From a996c33edb96a3273c81d799189b33437ad6ae18 Mon Sep 17 00:00:00 2001 From: David Crossley Date: Tue, 8 Sep 2015 14:10:10 +1000 Subject: [PATCH] Various minor text tweaks. --- doc/book.xml | 38 +++++++++++++++++++------------------- doc/gfs-options.xml | 10 +++++----- doc/gfs-virtual.xml | 26 +++++++++++++------------- 3 files changed, 37 insertions(+), 37 deletions(-) diff --git a/doc/book.xml b/doc/book.xml index eaa87ca..203dd7c 100644 --- a/doc/book.xml +++ b/doc/book.xml @@ -3171,7 +3171,7 @@ 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. @@ -3316,8 +3316,8 @@ int statserv_main(int argc, char **argv, 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). @@ -3334,7 +3334,7 @@ int statserv_main(int argc, char **argv, int inetd 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. @@ -3399,12 +3399,12 @@ int statserv_main(int argc, char **argv, 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. - 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. @@ -3415,7 +3415,7 @@ int statserv_main(int argc, char **argv, 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. @@ -3431,14 +3431,14 @@ int statserv_main(int argc, char **argv, The pointer returned by statserv_getcontrol 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 void statserv_setcontrol(statserv_options_block *block); - that you should generally update this structure before calling + You should generally update this structure before calling statserv_main(). @@ -3470,7 +3470,7 @@ bend_initresult (*bend_init)(bend_initrequest *r); Unlike previous versions of YAZ, the bend_init also serves as a handler that defines the Z39.50 services that the backend - wish to support. Pointers to all service handlers, + intends to support. Pointers to all service handlers, including search - and fetch must be specified here in this handler. @@ -3576,7 +3576,7 @@ typedef struct bend_initresult The auth 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. @@ -3632,7 +3632,7 @@ typedef struct { The bend_search 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 setname 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 { Delete - 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. @@ -3870,12 +3870,12 @@ typedef struct bend_scan_rr { 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 scanClause. - 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. @@ -3955,14 +3955,14 @@ typedef struct bend_scan_rr { - The above for the Apache 1.3 series. + The above is for the Apache 1.3 series. Running a server with local access only - 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 /tmp/mysocket start the server as follows: application unix:/tmp/mysocket diff --git a/doc/gfs-options.xml b/doc/gfs-options.xml index ed524ca..e3af38d 100644 --- a/doc/gfs-options.xml +++ b/doc/gfs-options.xml @@ -34,8 +34,8 @@ -T 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. @@ -99,8 +99,8 @@ -w dir - 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 inetd daemon (see -i). @@ -109,7 +109,7 @@ -p pidfile - Specifies that the server should write its Process ID to + Specifies that the server should write its Process ID to the file given by pidfile. A typical location would be /var/run/yaz-ztest.pid. diff --git a/doc/gfs-virtual.xml b/doc/gfs-virtual.xml index 66f0bd8..2c98df7 100644 --- a/doc/gfs-virtual.xml +++ b/doc/gfs-virtual.xml @@ -22,8 +22,8 @@ - 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). @@ -55,7 +55,7 @@ attribute id (optional) - identifier for this listener. This may be referred to from + Identifier for this listener. This may be referred to from server sections. @@ -107,7 +107,7 @@ 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). @@ -129,7 +129,7 @@ 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. @@ -139,7 +139,7 @@ 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. @@ -149,8 +149,8 @@ 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. @@ -170,7 +170,7 @@ 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 docpath are used for file access. For example, if the server is to offer access in directory xsl, the docpath would be xsl and all URLs of the form @@ -184,7 +184,7 @@ 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. @@ -194,7 +194,7 @@ Specifies maximum record size/message size, in bytes. This - value also servers as maximum size of incoming + value also serves as the maximum size of incoming packages (for Record Updates etc). It's the same value as that given by the -k option. @@ -204,7 +204,7 @@ element retrievalinfo (optional) - Enables the retrieval facility supporting conversions and + Enables the retrieval facility to support conversions and specifications of record formats/types. See for more information. @@ -259,7 +259,7 @@ listenref attribute is specified. "server2" 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 host + been specified for each server in the host elements. -- 1.7.10.4