From 323805b6779bcf1befdc7cdd7f10c23b06885e0d Mon Sep 17 00:00:00 2001 From: David Crossley Date: Wed, 7 Oct 2015 12:57:33 +1100 Subject: [PATCH] Various minor text tweaks. --- doc/bib1-attr-man.xml | 6 ++--- doc/book.xml | 58 ++++++++++++++++++++++---------------------- doc/yaz-asncomp-man.xml | 6 ++--- doc/yaz-client-man.xml | 40 +++++++++++++++--------------- doc/yaz-iconv-man.xml | 14 +++++------ doc/yaz-icu-man.xml | 20 +++++++-------- doc/yaz-illclient-man.xml | 4 +-- doc/yaz-json-parse-man.xml | 10 ++++---- doc/yaz-log-man.xml | 10 ++++---- doc/yaz-marcdump-man.xml | 10 ++++---- doc/yaz-url-man.xml | 4 +-- doc/yaz-ztest-man.xml | 14 +++++------ 12 files changed, 98 insertions(+), 98 deletions(-) diff --git a/doc/bib1-attr-man.xml b/doc/bib1-attr-man.xml index d61542e..8050297 100644 --- a/doc/bib1-attr-man.xml +++ b/doc/bib1-attr-man.xml @@ -34,8 +34,8 @@ TYPES - The Bib-1 attribute defines six attribute types: Use (1), Relation (2), - Position (3), Structure (4), Truncation (5) and completeness (6). + The Bib-1 attribute set defines six attribute types: Use (1), Relation (2), + Position (3), Structure (4), Truncation (5) and Completeness (6). @@ -218,7 +218,7 @@ - COMPLETENSS (6) + COMPLETENESS (6) 1 Incomplete subfield diff --git a/doc/book.xml b/doc/book.xml index f61011c..bb99baa 100644 --- a/doc/book.xml +++ b/doc/book.xml @@ -7883,7 +7883,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct, Introduction - &odr; is the BER-encoding/decoding subsystem of &yaz;. Care as been taken + &odr; is the BER-encoding/decoding subsystem of &yaz;. Care has been taken to isolate &odr; from the rest of the package - specifically from the transport interface. &odr; may be used in any context where basic ASN.1/BER representations are used. @@ -8207,7 +8207,7 @@ void do_nothing_useful(Odr_int value) odr_setprint(ODR o, FILE *file); before encoders or decoders are being invoked. - It is also possible to direct the output to a buffer (of indeed + It is also possible to direct the output to a buffer (or indeed another file), by using the more generic mechanism: void odr_set_stream(ODR o, void *handle, @@ -8224,7 +8224,7 @@ void do_nothing_useful(Odr_int value) The stream_write takes the ODR handle as parameter, the user-defined handle, a type ODR_OCTETSTRING, ODR_VISIBLESTRING - which indicates the type of contents is being written. + which indicates the type of contents being written. Another utility useful for diagnostics (error handling) or as @@ -8234,7 +8234,7 @@ void do_nothing_useful(Odr_int value) which returns a list of current elements that ODR deals with at the moment. For the returned array, say ar, - ar[0] is the top level element, + then ar[0] is the top level element, ar[n] is the last. The last element has the property that ar[n+1] == NULL. @@ -8484,7 +8484,7 @@ int odr_octetstring(ODR o, Odr_oct **p, int optional, The buf field should point to the character array that holds the octetstring. The len field holds the actual length. - The character array need not be null terminated. + The character array need not be null-terminated. To make things a little easier, an alternative is given for string @@ -8495,8 +8495,8 @@ int odr_octetstring(ODR o, Odr_oct **p, int optional, int odr_cstring(ODR o, char **p, int optional, const char *name); - Which encoded or decodes between OCTETSTRING representations and - null-terminates C strings. + which encodes or decodes between OCTETSTRING representations and + null-terminated C strings. Functions are provided for the derived string types, e.g.: @@ -8626,7 +8626,7 @@ int odr_sequence_end(ODR o); parameter is ignored. On decoding, it returns 1 if the type is found in the data stream. size bytes of memory are allocated, and *p is set to point to this space. - odr_sequence_end() is called at the end of the + The odr_sequence_end() is called at the end of the complex function. Assume that a type is defined like this: @@ -8752,7 +8752,7 @@ int odr_constructed_end(ODR o); Assume that the IMPLICIT in the type definition above were replaced - with EXPLICIT (or that the IMPLICIT keyword were simply deleted, which + with EXPLICIT (or that the IMPLICIT keyword was simply deleted, which would be equivalent). The structure definition would look the same, but the function would look like this: @@ -8779,7 +8779,7 @@ int mySequence(ODR o, MySequence **p, int optional, const char *name) Notice that the interface here gets kind of nasty. The reason is simple: Explicitly tagged, constructed types are fairly rare in the protocols that we care about, so the - esthetic annoyance (not to mention the dangers of a cluttered + aesthetic annoyance (not to mention the dangers of a cluttered interface) is less than the time that would be required to develop a better interface. Nevertheless, it is far from satisfying, and it's a point that will be worked on in the future. One option for you would @@ -8976,7 +8976,7 @@ int myChoice(ODR o, MyChoice **p, int optional, const char *name) declaring sequence elements (including CHOICEs) optional. - The ASN.1 specifications naturally requires that each member of a + The ASN.1 specifications naturally require that each member of a CHOICE have a distinct tag, so they can be told apart on decoding. Sometimes it can be useful to define a CHOICE that has multiple types that share the same tag. You'll need some other mechanism, perhaps @@ -8993,7 +8993,7 @@ void odr_choice_bias(ODR o, int what); provides this functionality. When called, it leaves a notice for the next call to odr_choice() to be called on the decoding - stream o that only the arm entry with + stream o, that only the arm entry with a which field equal to what should be tried. @@ -9163,8 +9163,8 @@ void odr_choice_bias(ODR o, int what); The cs_create function returns a null-pointer if a system error occurs. - The blocking parameter should be one if - you wish the association to operate in blocking mode, zero otherwise. + The blocking parameter should be '1' if + you wish the association to operate in blocking mode, and '0' otherwise. The protocol field should be PROTO_Z3950 or PROTO_HTTP. Protocol PROTO_SR is no longer supported. @@ -9201,7 +9201,7 @@ void odr_choice_bias(ODR o, int what); should call it repeatedly with the same values of buf and len, until the buffer has been transmitted. When a full buffer has been sent, the function will return 0 for - success. -1 indicates an error condition (see below). + success. The return value -1 indicates an error condition (see below). int cs_get(COMSTACK handle, char **buf, int *size); @@ -9217,12 +9217,12 @@ void odr_choice_bias(ODR o, int what); around internally by the subsystem when partial packages are read. Before calling cs_get - for the fist time, the buffer can be initialized to the null pointer, - and the length should also be set to 0 - cs_get will perform a + for the first time, the buffer can be initialized to the null pointer, + and the length should also be set to 0 (cs_get will perform a malloc(2) - on the buffer for you. When a full buffer has been read, the size of - the package is returned (which will always be greater than 1). -1 - indicates an error condition. + on the buffer for you). When a full buffer has been read, the size of + the package is returned (which will always be greater than 1). + The return value -1 indicates an error condition. See also the cs_more() function below. @@ -9325,7 +9325,7 @@ void odr_choice_bias(ODR o, int what); int cs_fileno(COMSTACK h); - Returns the file descriptor of the association. Use this when + returns the file descriptor of the association. Use this when file-level operations on the endpoint are required (select(2) operations, specifically). @@ -9411,7 +9411,7 @@ void odr_choice_bias(ODR o, int what); You may need to use this function with some care if your - name server service is slow or unreliable + name server service is slow or unreliable. @@ -9471,8 +9471,8 @@ void odr_choice_bias(ODR o, int what); cs_straddr. The str is similar to that described for cs_straddr but with a prefix denoting the &comstack; type. Prefixes supported - are tcp:, unix: and - ssl: for TCP/IP, UNIX and SSL respectively. + are tcp: and unix: and + ssl: for TCP/IP and UNIX and SSL respectively. If no prefix is given, then TCP/IP is used. The blocking is passed to function cs_create. The third parameter @@ -9489,7 +9489,7 @@ void odr_choice_bias(ODR o, int what); void *cs_get_ssl(COMSTACK cs); Returns the SSL handle, SSL * for comstack. If comstack - is not of type SSL, NULL is returned. + is not of type SSL, then NULL is returned. @@ -9539,15 +9539,15 @@ void odr_choice_bias(ODR o, int what); You can the textual representation of the error code - by using cs_errmsg - which - works like strerror(3) + by using cs_errmsg, which + works like strerror(3). const char *cs_errmsg(int n); - It is also possible to get straight to the textual represenataion - without the error code by using + It is also possible to get straight to the textual representation + without the error code, by using cs_strerror. diff --git a/doc/yaz-asncomp-man.xml b/doc/yaz-asncomp-man.xml index e551a56..18b6146 100644 --- a/doc/yaz-asncomp-man.xml +++ b/doc/yaz-asncomp-man.xml @@ -52,7 +52,7 @@ which is a library that encodes/decodes/prints BER packages. yaz-asncomp allows you to specify name of resulting source via options. Alternatively, you can specify - a DEFINISIONS file, which provides customized output to + a DEFINITIONS file, which provides customized output to many output files - if the ASN.1 specification file consists of many modules. @@ -135,7 +135,7 @@ The definitions file is really a Tcl script but follows traditional rules for Shell like configuration files. That is # denotes the beginning of a comment. Definitions - are line oriented. The definitions files usually consists of + are line oriented. The definitions files usually consist of a series of variable assignments of the form: @@ -221,7 +221,7 @@ Maps member member in CHOICE of name in module module to value. - Value consists of to or three tokens. The first token + Value consists of two or three tokens. The first token is name of the integer in the union that is used as selector for the union itself. The second token is name of the union. diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml index eb3137b..7b72019 100644 --- a/doc/yaz-client-man.xml +++ b/doc/yaz-client-man.xml @@ -90,7 +90,7 @@ -a filename If specified, logging of protocol packages will be appended - file given. If filename is + to the file given. If filename is specified as -, the output is written to stdout. @@ -150,7 +150,7 @@ given. YAZ client will connect to a proxy on the address and port given. The actual target will be specified as part of the InitRequest - to inform the proxy about actual target. + to inform the proxy about the actual target. @@ -256,7 +256,7 @@ Sets the name(s) of the database(s) to search. One or more - databases may be specified separated by blanks. This commands overrides + databases may be specified, separated by blanks. This command overrides the database given in zurl. @@ -269,9 +269,9 @@ Fetches records by sending a Present Request from the start position given by start - a number of records given by number. If + and a number of records given by number. If start is not given, then the client - will fetch from position of the last retrieved record plus 1. If + will fetch from the position of the last retrieved record plus 1. If number is not given, then one record will be fetched at a time. @@ -313,7 +313,7 @@ Sets preferred position for scan. This value - is used in next scan. By default position is 1. + is used in the next scan. By default, position is 1. @@ -332,7 +332,7 @@ - Set step-size for scan. This value is used in next scan + Set step-size for scan. This value is used in the next scan sent to the target. By default step-size is 0. @@ -376,7 +376,7 @@ authentication openauth - Sets up a authentication string if a server requires + Sets up an authentication string if a server requires authentication (v2 OpenStyle). The authentication string is first sent to the server when the open command is @@ -449,7 +449,7 @@ mspn n - Sets the number of records should be returned if the + Sets the number of records that should be returned if the number of records in the result set is between the values of lslb and ssub. See the @@ -507,7 +507,7 @@ Sets the element set name for the records. Many targets support - element sets are B (for brief) and F (for full). + element sets B (for brief) and F (for full). @@ -531,7 +531,7 @@ ccl for CCL search (Type-2 Query), cql for CQL (Type-104 search with CQL OID), ccl2rpn for - CCL to RPN conversion (Type-1 Query). + CCL to RPN conversion (Type-1 Query), cql2rpn for CQL to RPN conversion (Type-1 Query). @@ -582,7 +582,7 @@ the record document for the request. If doc is preceded with "<", then the following characters are treated as a filename with the records to be updated. Otherwise doc is treated as - a document itself. The doc may also be quited in double quotes. + a document itself. The doc may also be quoted in double quotes. If doc is omitted, the last received record (as part of present response or piggybacked search response) is used for the update. @@ -595,7 +595,7 @@ Executes list of commands from - file filename, just like source on + file filename, just like 'source' on most UNIX shells. A single dot (.) can be used as an alternative. @@ -644,7 +644,7 @@ flag - Specifies whether YAZ client automatically reconnect if + Specifies whether YAZ client automatically reconnects if the target closes connection (Z39.50 only). @@ -661,7 +661,7 @@ Specifies whether YAZ client should wait for response protocol packages after a request. - By default YAZ client waits (on) for response packages immediately + By default YAZ client waits (on) for response packages immediately after a command (find, show) has been issued. If off is used, YAZ client does not attempt to receive packages automatically. These will have to be manually received when command @@ -727,9 +727,9 @@ terminal as returned by nl_langinfo call. - If marcharset is given, it specifies name + If marccharset is given, it specifies name of the character set of retrieved MARC records from server. See - also marcharset command. + also marccharset command. @@ -840,7 +840,7 @@ The name is your name for the OID, class is the class, and OID is the raw OID in - dot notation. Class is one appctx, + dot notation. Class is one of: appctx, absyn, attet, transyn, diagset, recsyn, resform, @@ -966,9 +966,9 @@ f "donald knuth" - In those queries no attributes was specified. + In those queries, no attributes were specified. This leaves it up to the server what fields to search but - most servers will search in all fields. Some servers does not + most servers will search in all fields. Some servers do not support this feature though, and require that some attributes are defined. To add one attribute you could do: diff --git a/doc/yaz-iconv-man.xml b/doc/yaz-iconv-man.xml index 9952d2e..a920109 100644 --- a/doc/yaz-iconv-man.xml +++ b/doc/yaz-iconv-man.xml @@ -38,12 +38,12 @@ DESCRIPTION - yaz-iconv converts data in file in character + yaz-iconv converts data in the character set specified by from to output in - character set as specified by to. + the character set as specified by to. - This yaz-iconv utility similar to the + This yaz-iconv utility is similar to the iconv found on many POSIX systems (Glibc, Solaris, etc). @@ -88,11 +88,11 @@ The yaz-iconv command and the API as defined in yaz/yaz-iconv.h is a wrapper for the library system call iconv. But YAZ' iconv utility also implements - conversions on its own. The table below lists characters sets (or encodings). + conversions on its own. The table below lists characters sets (or encodings) that are supported by YAZ. Each character set is marked with either encode or decode. If - an encoding is encode-enabled YAZ may convert to - to the designated encoding. If an encoding is decode-enabled, YAZ + an encoding is encode-enabled, YAZ may convert to + the designated encoding. If an encoding is decode-enabled, YAZ may convert from the designated encoding. @@ -109,7 +109,7 @@ marc8s (encode, decode) - Like MARC8 but with conversion prefers non-combined characters + Like MARC8 but conversion prefers non-combined characters in the Latin-1 plane over combined characters. diff --git a/doc/yaz-icu-man.xml b/doc/yaz-icu-man.xml index a32826f..d0fd43c 100644 --- a/doc/yaz-icu-man.xml +++ b/doc/yaz-icu-man.xml @@ -39,13 +39,13 @@ DESCRIPTION - yaz-icu is utility which demonstrates + yaz-icu is a utility which demonstrates the ICU chain module of yaz. (yaz/icu.h). The utility can be used in two ways. It may read some text using an XML configuration for configuring ICU and show text analysis. - This mode is triggered by option -c which specififies + This mode is triggered by option -c which specifies the configuration to be used. The input file is read from standard input or from a file if infile is specified. @@ -71,10 +71,10 @@ Specifies extra information to be printed about the ICU system. If type is c then ICU converters are printed. - If type is l - available locales are printed. - If type is t - available transliterators are printed. + If type is l, + then available locales are printed. + If type is t, + then available transliterators are printed. @@ -98,7 +98,7 @@ ICU chain configuration - The ICU chain configuration speicifies one or more rules to convert + The ICU chain configuration specifies one or more rules to convert text data into tokens. The configuration format is XML based. @@ -121,13 +121,13 @@ casemap - Converts case and rule specifies how: + Converts case (and rule specifies how): l - Lowercase using ICU function u_strToLower. + Lower case using ICU function u_strToLower. @@ -141,7 +141,7 @@ t - To title using UCU function u_strToTitle. + To title using ICU function u_strToTitle. diff --git a/doc/yaz-illclient-man.xml b/doc/yaz-illclient-man.xml index 71e2a74..5599a0a 100644 --- a/doc/yaz-illclient-man.xml +++ b/doc/yaz-illclient-man.xml @@ -42,7 +42,7 @@ DESCRIPTION - yaz-illclient is an client which sends an ISO + yaz-illclient is a client which sends an ISO ILL request to a remote server and decodes the response from it. Exactly one server address ( server-addr ) must be specified. @@ -62,7 +62,7 @@ -v loglevel] - Specify the log level + Specify the log level. diff --git a/doc/yaz-json-parse-man.xml b/doc/yaz-json-parse-man.xml index 11d31e4..1df0a22 100644 --- a/doc/yaz-json-parse-man.xml +++ b/doc/yaz-json-parse-man.xml @@ -35,14 +35,14 @@ DESCRIPTION - yaz-json-parse is utility which demonstrates + yaz-json-parse is a utility which demonstrates the JSON API of YAZ. (yaz/json.h). The program attempts to parse a JSON from standard input (stdin). It will return exit code 1 if parsing fails and the parsing error message will be printed to standard error (stderr). The program returns exit code - 0 parsing succeeds and return no output, unless -p is given (see below). + 0 if parsing succeeds, and returns no output unless -p is given (see below). @@ -51,9 +51,9 @@ -p - Makes the JSON parser echo the JSON result string to standard output - - if parsing from stdin was successful. If -p is given twice the - output is a multi line output with indentation (pretty print). + Makes the JSON parser echo the JSON result string to standard output, + if parsing from stdin was successful. If -p is given twice, then the + output is a multi-line output with indentation (pretty print). diff --git a/doc/yaz-log-man.xml b/doc/yaz-log-man.xml index aa37be9..367712b 100644 --- a/doc/yaz-log-man.xml +++ b/doc/yaz-log-man.xml @@ -168,14 +168,14 @@ request logs a one-liner for each request (init, search, - etc). + etc.). requestdetail logs the details of every request, before it is passed to the back-end, and the results received from it. - Each server program (zebra, etc) is supposed to define its own log levels + Each server program (zebra, etc.) is supposed to define its own log levels in addition to these. As they depend on the server in question, they can not be described here. See above how to find out about them. @@ -237,10 +237,10 @@ LOG FILENAME EXAMPLES - A file with format my_YYYYMMDD.log is where Y, M, D is year, month, and day - digits is given as follows + A file with format my_YYYYMMDD.log (where Y, M, D is year, month, and day + digits) is given as follows: -l my_%Y%m%d.log . And since the filename - is depending on day, rotaion will occur on midnight. + is depending on day, rotation will occur on midnight. A weekly log could be specified as diff --git a/doc/yaz-marcdump-man.xml b/doc/yaz-marcdump-man.xml index a44dde0..a96fc1a 100644 --- a/doc/yaz-marcdump-man.xml +++ b/doc/yaz-marcdump-man.xml @@ -110,7 +110,7 @@ -f from - Specify the character set from + Specify the character set of the input MARC record. Should be used in conjunction with option -t. Refer to the yaz-iconv man page for supported character sets. @@ -120,7 +120,7 @@ -t to - Specify the character set of + Specify the character set of the output. Should be used in conjunction with option -f. Refer to the yaz-iconv man page for supported character sets. @@ -144,7 +144,7 @@ Writes a chunk of records to a separate file with prefix given, i.e. splits a record batch into files with only at most - "chunk" ISO2709 record per file. By default chunk is 1 (one record + "chunk" ISO2709 records per file. By default chunk is 1 (one record per file). See option -C. @@ -160,7 +160,7 @@ -p - Makes yaz-marcdump prints record number and input file offset + Makes yaz-marcdump print record number and input file offset of each record read. @@ -168,7 +168,7 @@ -n - MARC output is omitted so that MARC input is only checkecd. + MARC output is omitted so that MARC input is only checked. diff --git a/doc/yaz-url-man.xml b/doc/yaz-url-man.xml index a1bc290..c389de8 100644 --- a/doc/yaz-url-man.xml +++ b/doc/yaz-url-man.xml @@ -47,7 +47,7 @@ limited in functionality compared to programs such as curl, wget. - The options must be precede the URL given on the command line to take + The options must precede the URL given on the command line, to take effect. @@ -101,7 +101,7 @@ Specifies a user and a password to be uesd in HTTP basic authentication in the following URL fetch. The user - and password must be separated by a slash (this it is not + and password must be separated by a slash (thus it is not possible to specify a user with a slash in it). diff --git a/doc/yaz-ztest-man.xml b/doc/yaz-ztest-man.xml index 30bcba1..6d1cc23 100644 --- a/doc/yaz-ztest-man.xml +++ b/doc/yaz-ztest-man.xml @@ -53,7 +53,7 @@ - For UNIX local socket the address is the filename of the local socket. + For UNIX local socket, the address is the filename of the local socket. @@ -68,18 +68,18 @@ integer value of that term is used as hit count. This allows testers to return any number of hits. yaz-ztest includes 24 MARC records for testing. Hit counts exceeding 24 will make - yaz-ztest return the same record batch over and over.. - So record at position 1, 25, 49, etc .. are equivalent. + yaz-ztest return the same record batch over and over. + So record at position 1, 25, 49, etc. are equivalent. - For XML if no element set is given or element has value "marcxml", + For XML, if no element set is given or element has value "marcxml", MARCXML is returned (each of the 24 dummy records converted from - ISO2709 to XML). For element set OP, OPAC XML is returned. + ISO2709 to XML). For element set OP, then OPAC XML is returned. yaz-ztest may also return predefined XML records (for testing). This is enabled if YAZ_ZTEST_XML_FETCH environment - variable is defined. A record is fetched form a file (one record per file). + variable is defined. A record is fetched from a file (one record per file). The path for the filename is FE.d.xml where F is the YAZ_ZTEST_XML_FETCH value @@ -108,7 +108,7 @@ The value of the delay may either be a fixed floating point value which specifies the delay in seconds. Alternatively the value may be given as two floating point numbers - separated by colon, which wil make yaz-ztest perform + separated by colon, which will make yaz-ztest perform a random sleep between the first and second number. -- 1.7.10.4