From: Adam Dickmeiss Date: Fri, 23 Nov 2012 09:52:58 +0000 (+0100) Subject: Doc: strip-trailing-whitespace X-Git-Tag: v4.2.47~3 X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=commitdiff_plain;h=c91efbe35fe8ff53aeafedf0ffb8f1b90841ecdc Doc: strip-trailing-whitespace --- diff --git a/doc/asn.xml b/doc/asn.xml index c787d4f..78ee814 100644 --- a/doc/asn.xml +++ b/doc/asn.xml @@ -15,12 +15,12 @@ The &asn; module is located in sub directory z39.50. There you'll find C files that implements encoders and decoders for the Z39.50 types. You'll also find the protocol definitions: - z3950v3.asn, esupdate.asn, + z3950v3.asn, esupdate.asn, and others. Preparing PDUs - + A structure representing a complex ASN.1 type doesn't in itself contain the members of that type. Instead, the structure contains @@ -38,7 +38,7 @@ taste, there are at least three different approaches that you may take when you allocate the structures. - + You can use static or automatic local variables in the function that prepares the PDU. This is a simple approach, and it provides the most @@ -73,7 +73,7 @@ some of its elements, while you leave other elements pointing to global or per-session default variables. - + The &asn; module provides an important aid in creating new PDUs. For each of the PDU types (say, Z_InitRequest), a @@ -101,11 +101,11 @@ Z_<type> *zget_<type>(ODR o); - + eg.: - + Z_InitRequest *zget_InitRequest(ODR o); @@ -119,21 +119,21 @@ zget_APDU() is provided, which allocates a top-level Z-APDU of the type requested: - + Z_APDU *zget_APDU(ODR o, int which); - + The which parameter is (of course) the discriminator belonging to the Z_APDU CHOICE type. All of the interface described here is provided by the &asn; module, and you access it through the proto.h header file. - + EXTERNAL Data - + In order to achieve extensibility and adaptability to different application domains, the new version of the protocol defines many @@ -143,7 +143,7 @@ specialized version of the EXTERNAL construct, called Z_External.It is defined thus: - + typedef struct Z_External { @@ -184,7 +184,7 @@ typedef struct Z_External } u; } Z_External; - + When decoding, the &asn; module will attempt to determine which syntax describes the data by looking at the reference fields @@ -198,7 +198,7 @@ typedef struct Z_External For non-ASN.1 data such as MARC records, use the octet_aligned arm of the union. - + Some servers return ASN.1 structured data values (eg. database records) as BER-encoded records placed in the @@ -207,7 +207,7 @@ typedef struct Z_External these records. To help you decode the records in the application, the function - + Z_ext_typeent *z_ext_gettypebyref(const oid *oid); @@ -219,7 +219,7 @@ typedef struct Z_External Z_ext_typeent is defined as: - + typedef struct Z_ext_typeent { @@ -228,7 +228,7 @@ typedef struct Z_ext_typeent Odr_fun fun; /* decoder function */ } Z_ext_typeent; - + The what member contains the Z_External union discriminator value for the @@ -239,7 +239,7 @@ typedef struct Z_ext_typeent record syntax, the value of fun would be z_SUTRS (a function pointer). - + If you receive an EXTERNAL which contains an octet-string value that you suspect of being an ASN.1-structured data value, you can use @@ -249,7 +249,7 @@ typedef struct Z_ext_typeent function to decode the BER string (see ). - + If you want to send EXTERNALs containing ASN.1-structured values in the occtet-aligned branch of the CHOICE, this @@ -266,7 +266,7 @@ typedef struct Z_ext_typeent is necessary to tell the different, structured types apart on decoding. - + Eventually, the EXTERNAL processing will most likely @@ -276,15 +276,15 @@ typedef struct Z_ext_typeent various modules. - + PDU Contents Table - + We include, for reference, a listing of the fields of each top-level PDU, as well as their default settings. - + Default settings for PDU Initialize Request @@ -465,7 +465,7 @@ typedef struct Z_ext_typeent - + referenceIdZ_ReferenceIdNULL @@ -554,7 +554,7 @@ typedef struct Z_ext_typeent
- + Default settings for PDU Present Response @@ -590,7 +590,7 @@ typedef struct Z_ext_typeent
- + Default settings for Delete Result Set Request @@ -732,7 +732,7 @@ typedef struct Z_ext_typeent - + referenceIdZ_ReferenceIdNULL @@ -775,7 +775,7 @@ typedef struct Z_ext_typeent - + referenceIdZ_ReferenceIdNULL @@ -792,7 +792,7 @@ typedef struct Z_ext_typeent otherInfoZ_OtherInformationNULL - +
@@ -811,7 +811,7 @@ typedef struct Z_ext_typeent - + referenceIdZ_ReferenceIdNULL @@ -851,7 +851,7 @@ typedef struct Z_ext_typeent - + referenceIdZ_ReferenceIdNULL @@ -867,7 +867,7 @@ typedef struct Z_ext_typeent - + Default settings for Access Control Request @@ -882,7 +882,7 @@ typedef struct Z_ext_typeent - + referenceIdZ_ReferenceIdNULL @@ -913,7 +913,7 @@ typedef struct Z_ext_typeent - + referenceIdZ_ReferenceIdNULL @@ -947,7 +947,7 @@ typedef struct Z_ext_typeent - + referenceIdZ_ReferenceIdNULL @@ -999,7 +999,7 @@ typedef struct Z_ext_typeent otherInfoZ_OtherInformationNULL - +
diff --git a/doc/bib1-attr-man.xml b/doc/bib1-attr-man.xml index c38ff9b..78e1464 100644 --- a/doc/bib1-attr-man.xml +++ b/doc/bib1-attr-man.xml @@ -1,4 +1,4 @@ - @@ -14,18 +14,18 @@ &version; Index Data - + Bib-1 Attribute Set 7 Conventions and miscellaneous - + bib1-attr Bib-1 Attribute Set - + DESCRIPTION This reference entry lists the Bib-1 attribute set types and values. @@ -38,7 +38,7 @@ Position (3), Structure (4), Truncation (5) and completeness (6). - + USE (1) @@ -144,7 +144,7 @@ - + RELATION (2) @@ -161,7 +161,7 @@ - + POSITION (3) @@ -171,7 +171,7 @@ - + STRUCTURE (4) @@ -217,7 +217,7 @@ - + COMPLETENSS (6) @@ -227,7 +227,7 @@ - + SORTING (7) @@ -240,7 +240,7 @@ embedding a sort critieria into a query. - + SEE ALSO diff --git a/doc/comstack.xml b/doc/comstack.xml index 65e3d1d..fe2d937 100644 --- a/doc/comstack.xml +++ b/doc/comstack.xml @@ -1,7 +1,7 @@ The COMSTACK Module - + Synopsis (blocking mode) - + - + There hasn't been interest in the XTImOSI stack for some years. @@ -111,20 +111,20 @@ COMSTACK cs_create(CS_TYPE type, int blocking, int protocol); - + Creates an instance of the protocol stack - a communications endpoint. The type parameter determines the mode of communication. At present the following values are supported: - + tcpip_type TCP/IP (BER over TCP/IP or HTTP over TCP/IP) ssl_type - Secure Socket Layer (SSL). This COMSTACK + Secure Socket Layer (SSL). This COMSTACK is experimental and is not fully implemented. If HTTP is used, this effectively is HTTPS. @@ -136,7 +136,7 @@ - + The cs_create function returns a null-pointer if a system error occurs. @@ -454,7 +454,7 @@ For UNIX sockets, the format of an address is the socket filename. - + When a connection has been established, you can use @@ -535,7 +535,7 @@ - + Diagnostics @@ -567,39 +567,39 @@ const char *cs_errmsg(int n); - + It is also possible to get straight to the textual represenataion - without the error code by using + without the error code by using cs_strerror. - + const char *cs_strerror(COMSTACK h); - + Summary and Synopsis - + #include /* this is for TCP/IP and SSL support */ #include /* this is for UNIX socket support */ - + COMSTACK cs_create(CS_TYPE type, int blocking, int protocol); - + COMSTACK cs_createbysocket(int s, CS_TYPE type, int blocking, int protocol); COMSTACK cs_create_host(const char *str, int blocking, void **vp); - + int cs_bind(COMSTACK handle, int mode); - + int cs_connect(COMSTACK handle, void *address); - + int cs_rcvconnect(COMSTACK handle); - + int cs_listen(COMSTACK handle); COMSTACK cs_accept(COMSTACK handle); diff --git a/doc/credits.xml b/doc/credits.xml index e015d83..222a1f9 100644 --- a/doc/credits.xml +++ b/doc/credits.xml @@ -5,7 +5,7 @@ fixes or suggestions. If we're missing somebody, of if you, for whatever reason, don't like to be listed here, let us know. - + Gary Anderson @@ -102,7 +102,7 @@ - + - + -a file @@ -12,7 +12,7 @@ The special name - (dash) sends output to stderr. - + -S Don't fork or make threads on connection requests. This is good for @@ -21,13 +21,13 @@ a software malfunction (okay then, a crash) from affecting all current users. - + -1 Like -S but after one session the server exits. This mode is for debugging only. - + -T Operate the server in threaded mode. The server creates a thread @@ -94,7 +94,7 @@ -w dir - The server changes to this directory during before listening + The server changes to this directory during before listening on incoming connections. This option is useful when the server is operating from the inetd daemon (see -i). @@ -104,7 +104,7 @@ pidfile Specifies that the server should write its Process ID to - file given by pidfile. + file given by pidfile. A typical location would be /var/run/yaz-ztest.pid. @@ -113,40 +113,40 @@ Use this to make the the server run from the inetd server (UNIX only). - + -D Use this to make the server put itself in the background and - run as a daemon. If neither -i nor + run as a daemon. If neither -i nor -D is given, the server starts in the foreground. - + -install Use this to install the server as an NT service - (Windows NT/2000/XP only). + (Windows NT/2000/XP only). Control the server by going to the Services in the Control Panel. - + -installa Use this to install and activate the server as an NT service - (Windows NT/2000/XP only). + (Windows NT/2000/XP only). Control the server by going to the Services in the Control Panel. - + -remove Use this to remove the server from the NT services - (Windows NT/2000/XP only). + (Windows NT/2000/XP only). - + -t minutes Idle session timeout, in minutes. - + -k size @@ -180,7 +180,7 @@ hosts_access 5 - and + and tcpd 8 @@ -195,7 +195,7 @@ the input format to strftime(). - + diff --git a/doc/gfs-virtual.xml b/doc/gfs-virtual.xml index 56b2cc3..18d68dd 100644 --- a/doc/gfs-virtual.xml +++ b/doc/gfs-virtual.xml @@ -1,4 +1,4 @@ - @@ -29,7 +29,7 @@ The YAZ frontend server uses XML to describe the backend - configurations. Command-line option -f + configurations. Command-line option -f specifies filename of the XML configuration. @@ -39,14 +39,14 @@ The listen describes listener (transport end point), - such as TCP/IP, Unix file socket or SSL server. Content for + such as TCP/IP, Unix file socket or SSL server. Content for a listener: CDATA (required) The CDATA for the listen element holds the - listener string, such as tcp:@:210, + listener string, such as tcp:@:210, tcp:server1:2100, etc. @@ -129,7 +129,7 @@ Specifies a filename that includes CQL to RPN conversion for this backend server. See &reference-tools-cql-map; - If given, the backend server will only "see" a Type-1/RPN query. + 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; - If given, the backend server will only "see" a Type-1/RPN query. + If given, the backend server will only "see" a Type-1/RPN query. @@ -154,7 +154,7 @@ - + element docpath (optional) @@ -167,7 +167,7 @@ - + element explain (optional) @@ -200,10 +200,10 @@ - + - + The XML below configures a server that accepts connections from two ports, TCP/IP port 9900 and a local UNIX file socket. diff --git a/doc/installation.xml b/doc/installation.xml index 25c0ef1..4e61cbe 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,5 +1,5 @@ Compilation and Installation - + Introduction The latest version of the software will generally be found at: @@ -10,7 +10,7 @@ We have tried our best to keep the software portable, and on many platforms, you should be able to compile everything with little or - no changes. + no changes. @@ -23,7 +23,7 @@ SunOS 5.10 (sparc), Windows 7, Windows Xp. - + Some versions have be known to work on HP/UX, DEC Unix, NetBSD, @@ -43,33 +43,33 @@ #ifdefs for individual platforms, and we'd like to keep it that way as far as it makes sense. - + We maintain a mailing-list for the purpose of announcing new releases and - bug-fixes, as well as general discussion. Subscribe by + bug-fixes, as well as general discussion. Subscribe by filling-in the form here. - General questions and problems can be directed at + General questions and problems can be directed at , or the address given at the top of this document. - + UNIX - We provide + We provide Debian GNU/Linux (i386 and amd64), Ubuntu (i386 and amd64) - and - CentOS (amd64 only) packages for &yaz;. + and + CentOS (amd64 only) packages for &yaz;. You should be able to create packages for other CPUs by building them from the source package. - + YAZ is also part of several packages repositories. Some of them are - + @@ -110,10 +110,10 @@ - + Compiling from source on Unix - + Note that if your system doesn't have a native ANSI C compiler, you may have to acquire one separately. We recommend @@ -124,13 +124,13 @@ If you wish to use character set conversion facilities in &yaz; or if you are compiling &yaz; for use with Zebra it is a good idea to ensure that the iconv library is installed. Some Unixes today already have it - - if not, we suggest + - if not, we suggest GNU libiconv. - YAZ 3.0.16 and later includes a wrapper for the - ICU + YAZ 3.0.16 and later includes a wrapper for the + ICU (International Components for Unicode). In order to use this, the developer version of the ICU library must be available. @@ -160,24 +160,24 @@ GNU Bison. This tool is only needed if you're using the CVS version of &yaz;. - + &yaz; includes a tiny ASN.1 compiler. This compiler is written in Tcl. But as for Bison you do not need it unless you're using CVS version of &yaz; or you're using the compiler to built own codecs - for private ASN.1. + for private ASN.1. - + Generally it should be sufficient to run configure without options, like this: - + ./configure - + The configure script attempts to use use the C compiler specified by the CC environment variable. If not set, GNU C will be @@ -186,15 +186,15 @@ Bourne-compatible shell you may pass something like this to use a particular C compiler with optimization enabled: - + CC=/opt/ccs/bin/cc CFLAGS=-O ./configure - + To customize &yaz;, the configure script also accepts a set of options. The most important are: - + --prefix=prefix @@ -215,7 +215,7 @@ hosts_access 5 - and + and tcpd 8 @@ -245,14 +245,14 @@ equivalent to --enable-static. - + --with-iconv[=prefix] Compile &yaz; with iconv library in directory prefix. By default configure will search for iconv on the system. Use this option if it - doesn't find iconv. Alternatively, + doesn't find iconv. Alternatively, --without-iconv, can be uset to force &yaz; not to use iconv. @@ -261,13 +261,13 @@ --with-xslt[=prefix] - Compile &yaz; with + Compile &yaz; with libxslt in directory - prefix. + prefix. Use this option if you want XSLT and XML support. By default, configure will search for libxslt on the system. Use this option if it - libxslt is not found automatically. Alternatively, + libxslt is not found automatically. Alternatively, --without-xslt, can be used to force &yaz; not to use libxslt. @@ -277,13 +277,13 @@ --with-xml2[=prefix] - Compile &yaz; with + Compile &yaz; with libxml2 in directory - prefix. + prefix. Use this option if you want &yaz; to use XML and support SRU. By default, configure will search for libxml2 on the system. Use this option if it - libxml2 is not found automatically. Alternatively, + libxml2 is not found automatically. Alternatively, --without-xml2, can be used to force &yaz; not to use libxml2. @@ -316,7 +316,7 @@ --with-icu[=prefix] - &yaz; will be linked the + &yaz; will be linked the ICU library in the prefix if given. If prefix is not given, the libraries exposed by the script icu-config will be used if found. @@ -324,7 +324,7 @@ - + When configured, build the software by typing: @@ -332,7 +332,7 @@ make - + The following files are generated by the make process: @@ -340,11 +340,11 @@ Main &yaz; library. This is no ordinary library. It's a Libtool archive. - By default, &yaz; creates a static library in + By default, &yaz; creates a static library in lib/.libs/libyaz.a. - + src/libyaz_server.la Generic Frontend server. This is an add-on for libyaz.la. @@ -352,18 +352,18 @@ threads are available on the platform. - + src/libyaz_icu.la Functions that wrap the ICU library. - + ztest/yaz-ztest - Test Z39.50 server. + Test Z39.50 server. - + client/yaz-client Z39.50 client for testing the protocol. See chapter @@ -377,78 +377,78 @@ &yaz;. - + util/yaz-asncomp The ASN.1 compiler for &yaz;. Requires the Tcl Shell, tclsh, in PATH to operate. - + util/yaz-iconv This program converts data in one character set to another. This command exercises the YAZ character set conversion API. - + util/yaz-marcdump This program parses ISO2709 encoded MARC records and prints them in line-format or XML. - + util/yaz-icu This program exposes the ICU wrapper library if that is enabled for YAZ. Only if ICU is available this program is useful. - + zoom/zoomsh - A simple shell implemented on top of the + A simple shell implemented on top of the ZOOM functions. The shell is a command line application that allows you to enter simple commands to perform ZOOM operations. - - zoom/zoomtst1, + + zoom/zoomtst1, zoom/zoomtst2, .. Several small applications that demonstrates the ZOOM API. - + - + - If you wish to install &yaz; in system directories + If you wish to install &yaz; in system directories /usr/local/bin, /usr/local/lib .. etc, you can type: - + make install - + You probably need to have root access in order to perform this. You must specify the --prefix option for configure if - you wish to install &yaz; in other directories than the default + you wish to install &yaz; in other directories than the default /usr/local/. - + If you wish to perform an un-installation of &yaz;, use: - + make uninstall - + This will only work if you haven't reconfigured &yaz; (and therefore changed installation prefix). Note that uninstall will not @@ -505,7 +505,7 @@ #include <proto.h> - + For Libtool users, the yaz-config script provides a different variant of option --libs, called @@ -531,14 +531,14 @@ WIN32 - + The easiest way to install YAZ on Windows is by downloading - an installer from + an installer from here. The installer comes with source too - in case you wish to - compile YAZ with different Compiler options etc. + compile YAZ with different Compiler options etc. - + Compiling from Source on WIN32 @@ -553,9 +553,9 @@ WIN where the file makefile is located. Customize the installation by editing the makefile file (for example by using notepad). - + The following summarizes the most important settings in that file: - + DEBUG @@ -591,7 +591,7 @@ (cql.y). - A Windows version of GNU Bison is part of + A Windows version of GNU Bison is part of unxutils. @@ -601,19 +601,19 @@ ICONV_DIR If HAVE_ICONV is set to 1, YAZ is compiled - with iconv support. In this configuration, set + with iconv support. In this configuration, set ICONV_DIR to the iconv source directory. - + HAVE_LIBXML2, LIBXML2_DIR If HAVE_LIBXML2 is set to 1, YAZ is compiled - with SRU support. In this configuration, set - LIBXML2_DIR to the + with SRU support. In this configuration, set + LIBXML2_DIR to the libxml2 source directory and ZLIB_DIR to the zlib directory. @@ -639,8 +639,8 @@ If HAVE_LIBXSLT is set to 1, YAZ is compiled - with XSLT support. In this configuration, set - LIBXSLT_DIR to the + with XSLT support. In this configuration, set + LIBXSLT_DIR to the libxslt source directory. @@ -659,8 +659,8 @@ If HAVE_ICU is set to 1, YAZ is compiled with ICU support. - In this configuration, set - ICU_DIR to the + In this configuration, set + ICU_DIR to the ICU source directory. @@ -695,61 +695,61 @@ The following files are generated upon successful compilation: - + - bin/yaz4.dll / + bin/yaz4.dll / bin/yaz4d.dll &yaz; Release/Debug DLL. - - lib/yaz4.lib / + + lib/yaz4.lib / lib/yaz4d.lib Import library for yaz4.dll / yaz4d.dll. - - bin/yaz_cond4.dll / + + bin/yaz_cond4.dll / bin/yaz_cond4d.dll Release/Debug DLL for condition variable utilities (condvar.c). - - lib/yaz_cond4.lib / + + lib/yaz_cond4.lib / lib/yaz_cond4d.lib Import library for yaz_cond4.dll / yaz_cond4d.dll. - + bin/yaz_icu4.dll / bin/yaz_icu4d.dll Release/Debug DLL for the ICU wrapper utility. Only build if HAVE_ICU is 1. - + lib/yaz_icu4.lib / lib/yaz_icu4d.lib Import library for yaz_icu4.dll / yaz_icu4d.dll. - + bin/yaz-ztest.exe Z39.50 multi-threaded test/example server. It's a WIN32 console application. - + bin/yaz-client.exe &yaz; Z39.50 client application. It's a WIN32 console application. See chapter YAZ client for more information. - + bin/yaz-icu.exe This program exposes the ICU wrapper library if that is enabled for YAZ. Only if ICU is available this program is @@ -763,15 +763,15 @@ The application is a command line shell that allows you to enter simple commands to perform ZOOM operations. - - bin/zoomtst1.exe, + + bin/zoomtst1.exe, bin/zoomtst2.exe, .. Several small applications that demonstrates the ZOOM API. - + - + @@ -796,7 +796,7 @@ import library yaz4.lib - You must link with this library. It's located in the + You must link with this library. It's located in the sub directory lib of &yaz;. If you want to link with the debug version of &yaz;, you must link against yaz4d.lib instead. @@ -812,7 +812,7 @@ - + - + diff --git a/doc/introduction.xml b/doc/introduction.xml index fc9a628..7b2baae 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -4,33 +4,33 @@ &yaz; is a C/C++ library for information retrieval applications using the Z39.50/SRU/SOLR protocols for information retrieval. - + Properties of &yaz;: - Complete + Complete Z39.50 version 3 support. Amendments and Z39.50-2002 revision is supported. - Supports + Supports SRU GET/POST/SOAP version 1.2 (over HTTP and HTTPS). - Includes BER encoders/decoders for the + Includes BER encoders/decoders for the ISO ILL protocol. - Supports + Supports SOLR Web Service version 1.4.x (client side only) Supports the following transports: BER over TCP/IP (RFC1729), - BER over unix local socket, and + BER over unix local socket, and HTTP 1.1. @@ -41,14 +41,14 @@ "Secure BER" (for Z39.50). - Offers + Offers ZOOM C API implementing Z39.50, SRU and SOLR Web Service. The &yaz; library offers a set of useful utilities related to the protocols, such as MARC (ISO2709) parser, - CCL (ISO8777) parser, + CCL (ISO8777) parser, CQL parser, memory management routines, character set conversion. @@ -74,7 +74,7 @@ - contains installation + contains installation instructions for &yaz;. You don't need reading this if you expect to download &yaz; binaries. However, the chapter contains information about how @@ -90,7 +90,7 @@ client. - + describes the generic frontend server @@ -118,7 +118,7 @@ - describes how SRU and SOAP is used + describes how SRU and SOAP is used in &yaz;. Only if you're developing SRU applications this section is a must. @@ -158,7 +158,7 @@ The API - + The &yaz; toolkit offers several different levels of access to the @@ -171,7 +171,7 @@ If you're developing a client application you should consider the ZOOM API. It is, by far, the easiest way to develop clients in C. - Server implementers should consider the + Server implementers should consider the generic frontend server. None of those high-level APIs support the whole protocol, but they do include most facilities used in existing Z39.50 applications. @@ -206,7 +206,7 @@ - The second layer provides a C represenation of the + The second layer provides a C represenation of the protocol units (packages) for Z39.50 ASN.1, ILL ASN.1, SRU. @@ -251,7 +251,7 @@ The &asn; library also provides functions (which are, in turn, defined using &odr; primitives) for encoding and decoding data values. Their general form is - + int z_xxx ODR o @@ -262,7 +262,7 @@ (note the lower-case "z" in the function name) - + If you are using the premade definitions of the &asn; module, and you @@ -271,7 +271,7 @@ . - + When you have created a BER-encoded buffer, you can use the &comstack; subsystem to transmit (or receive) data over the network. The &comstack; diff --git a/doc/license.xml b/doc/license.xml index 188b64f..1505799 100644 --- a/doc/license.xml +++ b/doc/license.xml @@ -36,7 +36,7 @@ - + THIS SOFTWARE IS PROVIDED BY INDEX DATA ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED diff --git a/doc/odr.xml b/doc/odr.xml index 45f8326..770ad9c 100644 --- a/doc/odr.xml +++ b/doc/odr.xml @@ -1,5 +1,5 @@ The ODR Module - + Introduction @@ -258,12 +258,12 @@ data you wish to decode (eg, odr_integer() odr z_APDU()). - + Encoding and decoding functions int odr_integer(ODR o, Odr_int **p, int optional, const char *name); - + int z_APDU(ODR o, Z_APDU **p, int optional, const char *name); @@ -293,7 +293,7 @@ free(2) to release the memory. You can decode several data elements (by repeated calls to odr_setbuf() and your decoding function), and - new memory will be allocated each time. When you do call + new memory will be allocated each time. When you do call odr_reset(), everything decoded since the last call to odr_reset() will be released. @@ -314,7 +314,7 @@ void do_nothing_useful(Odr_int value) Odr_int *valp, *resvalp; char *bufferp; int len; - + /* allocate streams */ if (!(encode = odr_createmem(ODR_ENCODE))) return; @@ -354,7 +354,7 @@ void do_nothing_useful(Odr_int value) program, so the overhead is quite manageable. - + Printing @@ -378,11 +378,11 @@ void do_nothing_useful(Odr_int value) Here the user provides an opaque handle and two handlers, stream_write for writing, and stream_close which is supposed - to close/free resources associated with handle. + to close/free resources associated with handle. The stream_close handler is optional and if NULL for the function is provided, it will not be invoked. The stream_write takes the ODR handle - as parameter, the user defined handle, a type + as parameter, the user defined handle, a type ODR_OCTETSTRING, ODR_VISIBLESTRING which indicates the type of contents is being written. @@ -392,8 +392,8 @@ void do_nothing_useful(Odr_int value) const char **odr_get_element_path(ODR o); - which returns a list of current elements that ODR deals with at the - moment. For the returned array, say ar, + 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, ar[n] is the last. The last element has the property that ar[n+1] == NULL. @@ -403,7 +403,7 @@ void do_nothing_useful(Odr_int value) For a database record part of a PresentResponse the array returned by odr_get_element - is presentResponse, databaseOrSurDiagnostics, ?, record, ?, databaseRecord . The question mark appears due to + is presentResponse, databaseOrSurDiagnostics, ?, record, ?, databaseRecord . The question mark appears due to unnamed constructions. @@ -543,11 +543,11 @@ void do_nothing_useful(Odr_int value) There is an ASN.1 tutorial available at this site. - This site also has standards for ASN.1 (X.680) and BER (X.690) + This site also has standards for ASN.1 (X.680) and BER (X.690) online. - + The ODR interface is based loosely on that of the Sun Microsystems XDR routines. @@ -560,9 +560,9 @@ void do_nothing_useful(Odr_int value) definition for a type once - and you have the functionality of encoding, decoding (and pretty-printing) all in one unit. The resulting C source code is quite compact, and is a pretty - straightforward representation of the source ASN.1 specification. + straightforward representation of the source ASN.1 specification. - + In many cases, the model of the XDR functions works quite well in this role. @@ -592,7 +592,7 @@ void do_nothing_useful(Odr_int value) The Odr_int is just a simple integer. - + This form is typical of the primitive &odr; functions. They are named after the type of data that they encode or decode. They take an &odr; @@ -769,7 +769,7 @@ int odr_oid(ODR o, Odr_oid **p, int optional, const char *name); The simplest way of tagging a type is to use the - odr_implicit_tag() or + odr_implicit_tag() or odr_explicit_tag() macros: @@ -870,7 +870,7 @@ typedef struct MySequence Odr_int *intval; Odr_bool *boolval; } MySequence; - + int mySequence(ODR o, MySequence **p, int optional, const char *name) { if (odr_sequence_begin(o, p, sizeof(**p), name) == 0) diff --git a/doc/server.xml b/doc/server.xml index 02557e2..b4b0fbe 100644 --- a/doc/server.xml +++ b/doc/server.xml @@ -1,6 +1,6 @@ Generic server Introduction - + If you aren't into documentation, a good way to learn how the back end interface works is to look at the backend.h @@ -47,7 +47,7 @@ - + The Database Frontend @@ -89,7 +89,7 @@ Extended Services (optional). - + Result-Set Delete (optional). @@ -97,11 +97,11 @@ Result-Set Sort (optional). - + Return Explain for SRU (optional). - + @@ -157,9 +157,9 @@ int statserv_main(int argc, char **argv, connection. If you do use global variables and forking, you should be aware, then, that these cannot be shared between associations, unless you explicitly - disable forking by command line parameters. + disable forking by command line parameters. - + The server provides a mechanism for controlling some of its behavior without using command-line options. The function @@ -173,7 +173,7 @@ int statserv_main(int argc, char **argv, will return a pointer to a struct statserv_options_block describing the current default settings of the server. The structure contains these elements: - + int dynamic @@ -182,7 +182,7 @@ int statserv_main(int argc, char **argv, TRUE. This flag is only read by UNIX-based servers (WIN32 based servers doesn't fork). - + int threads A boolean value, which determines whether the server @@ -191,18 +191,18 @@ int statserv_main(int argc, char **argv, that offer POSIX Threads support. WIN32-based servers always operate in threaded mode. - + int inetd A boolean value, which determines whether the server will operates under a UNIX INET daemon (inetd). Default is FALSE. - + char logfile[ODR_MAXNAME+1] File for diagnostic output ("": stderr). - + char apdufile[ODR_MAXNAME+1] @@ -225,13 +225,13 @@ int statserv_main(int argc, char **argv, PROTO_SR. Default is PROTO_Z39_50. - + int idle_timeout; Maximum session idle-time, in minutes. Zero indicates no (infinite) timeout. Default is 15 minutes. - + int maxrecordsize; Maximum permissible record (message) size. Default @@ -252,7 +252,7 @@ int statserv_main(int argc, char **argv, Set user id to the user specified, after binding the listener addresses. - + void (*bend_start)(struct statserv_options_block *p) @@ -265,9 +265,9 @@ int statserv_main(int argc, char **argv, 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 - whenever the service is started. + whenever the service is started. - + void (*bend_stop)(struct statserv_options_block *p) @@ -293,7 +293,7 @@ int statserv_main(int argc, char **argv, a static area. You are allowed to change the contents of the structure, but the changes will not take effect before you call - + void statserv_setcontrol(statserv_options_block *block); @@ -348,35 +348,35 @@ bend_initresult (*bend_init)(bend_initrequest *r); typedef struct bend_initrequest { /** \brief user/name/password to be read */ - Z_IdAuthentication *auth; + Z_IdAuthentication *auth; /** \brief encoding stream (for results) */ ODR stream; /** \brief printing stream */ ODR print; /** \brief decoding stream (use stream for results) */ - ODR decode; + ODR decode; /** \brief reference ID */ Z_ReferenceId *referenceId; /** \brief peer address of client */ - char *peer_name; - - /** \brief character set and language negotiation + char *peer_name; + + /** \brief character set and language negotiation - see include/yaz/z-charneg.h + see include/yaz/z-charneg.h */ Z_CharSetandLanguageNegotiation *charneg_request; /** \brief character negotiation response */ Z_External *charneg_response; - /** \brief character set (encoding) for query terms - + /** \brief character set (encoding) for query terms + This is NULL by default. It should be set to the native character set that the backend assumes for query terms */ - char *query_charset; + char *query_charset; + + /** \brief whehter query_charset also applies to recors - /** \brief whehter query_charset also applies to recors - Is 0 (No) by default. Set to 1 (yes) if records is in the same character set as queries. If in doubt, use 0 (No). */ @@ -448,7 +448,7 @@ typedef struct bend_initresult The auth member holds the authentication information part of the Z39.50 Initialize Request. Interpret this if your serves - requires authentication. + requires authentication. @@ -556,7 +556,7 @@ typedef struct { For SRU operation, a Bib-1 diagnostic code is mapped to SRU diagnostic. - + int (*bend_fetch) (void *handle, bend_fetch_rr *rr); @@ -686,7 +686,7 @@ typedef struct { Note that this is handler serves as a supplement for bend_fetch and need not to be defined in order to - support search - and retrieve. + support search - and retrieve. @@ -709,7 +709,7 @@ typedef struct bend_delete_rr { int delete_status; /* status for the whole operation */ int *statuses; /* status each set - indexed as setnames */ ODR stream; - ODR print; + ODR print; } bend_delete_rr; @@ -764,9 +764,9 @@ typedef struct bend_scan_rr { } 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 + 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 scanClause. @@ -786,21 +786,21 @@ typedef struct bend_scan_rr { &gfs-synopsis; - + The options are: &gfs-options; - + A listener specification consists of a transport mode followed by a colon (:) followed by a listener address. The transport mode is either tcp, unix: or ssl. - + For TCP and SSL, an address has the form @@ -808,7 +808,7 @@ typedef struct bend_scan_rr { hostname | IP-number [: portnumber] - + The port number defaults to 210 (standard Z39.50 port). @@ -819,10 +819,10 @@ typedef struct bend_scan_rr { For TCP/IP and SSL, the special hostnames @ and - @6 are mapped to the addresses + @6 are mapped to the addresses INADDR_ANY (IPV4) and IN6ADDR_ANY_INIT (IPV6) - respectively. + respectively. Running the GFS on Unix @@ -845,7 +845,7 @@ typedef struct bend_scan_rr { as your public web server and want to offer HTTP port 80 access to the YAZ server on 210, you can use the - ProxyPass + ProxyPass directive. If you have virtual host srw.mydomain you can use the following directives @@ -878,7 +878,7 @@ typedef struct bend_scan_rr { &gfs-virtual; - + @@ -149,7 +149,7 @@ If no = is in the criterion it is treated as a sortfield of type InternationalString. The flags word of each sort specification must consist of - s + s for case sensitive or i for case insensitive, and < for ascending order or > for descending order. @@ -171,7 +171,7 @@ Sets up a authentication string if a server requires authentication (v2 OpenStyle). The authentication string is first - sent to the server when the + sent to the server when the open command is issued and the Z39.50 Initialize Request is sent, so this command must be used before open in order to be effective. @@ -191,7 +191,7 @@ GET, SOAP (default) or SOLR. Version should be either 1.1 or 1.2 for SRU. Other versions are allowed - for testing - purposes (version negotiation with SRU server). + purposes (version negotiation with SRU server). The version is currently not used for SOLR Web Services @@ -205,7 +205,7 @@ - + lslb n @@ -236,7 +236,7 @@ - + mspn n @@ -315,7 +315,7 @@ querytype type - Sets the query type as used by command + Sets the query type as used by command find. The following is supported: prefix for @@ -351,7 +351,7 @@ type no - Sends an Item Order Request using the ILL External. + Sends an Item Order Request using the ILL External. type is either 1 or 2 which corresponds to ILL-Profile 1 and 2 respectively. The no is the Result Set position of the record to be ordered. @@ -368,10 +368,10 @@ Sends Item Update Request. The action argument must be the action type: one of insert, replace, delete and - update. The second argument, + update. The second argument, recid, is the record identifier (any string). Third argument which is optional is - the record document for the request. If doc is preceded with + 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. @@ -456,7 +456,7 @@ 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 + These will have to be manually received when command wait_response is used. @@ -559,7 +559,7 @@ Specifies character set for output (display). The - argument is the same as second argument for command + argument is the same as second argument for command charset. @@ -594,7 +594,7 @@ - + set_cclfile filename @@ -676,7 +676,7 @@ This command makes YAZ client wait for a number of response packages from target. If number is - omitted, 1 is assumed. + omitted, 1 is assumed. This command is rarely used and is only useful if command @@ -702,8 +702,8 @@ ver - This command sets Z39.50 version for negotiation. - Should be used before + This command sets Z39.50 version for negotiation. + Should be used before open. By default 3 (version 3) is used. @@ -715,37 +715,37 @@ op1 op2.. - This command sets Z39.50 options for negotiation. - Should be used before + This command sets Z39.50 options for negotiation. + Should be used before open. The following options are supported: - search, - present, - delSet, - resourceReport, - triggerResourceCtrl, - resourceCtrl, - accessCtrl, - scan, - sort, - extendedServices, - level_1Segmentation, - level_2Segmentation, - concurrentOperations, - namedResultSets, - encapsulation, - resultCount, - negotiationModel, - duplicationDetection, - queryType104, - pQESCorrection, + search, + present, + delSet, + resourceReport, + triggerResourceCtrl, + resourceCtrl, + accessCtrl, + scan, + sort, + extendedServices, + level_1Segmentation, + level_2Segmentation, + concurrentOperations, + namedResultSets, + encapsulation, + resultCount, + negotiationModel, + duplicationDetection, + queryType104, + pQESCorrection, stringSchema. - + - + diff --git a/doc/zoomsh-man.xml b/doc/zoomsh-man.xml index bf55813..aafe716 100644 --- a/doc/zoomsh-man.xml +++ b/doc/zoomsh-man.xml @@ -14,13 +14,13 @@ &version; Index Data - + zoomsh 1 Commands - + zoomsh ZOOM shell @@ -43,7 +43,7 @@ You may pass one or more commands to zoomsh. - These commands are invoked first. + These commands are invoked first. @@ -76,11 +76,11 @@ ZOOM>search computer localhost:9999: 7 hits ZOOM>show 0 1 1 Default USmarc -001 11224466 +001 11224466 003 DLC 005 00000000000000.0 -008 910710c19910701nju 00010 eng -010 $a 11224466 +008 910710c19910701nju 00010 eng +010 $a 11224466 040 $a DLC $c DLC 050 00 $a 123-xyz 100 10 $a Jack Collins @@ -103,13 +103,13 @@ ZOOM>quit COMMANDS - + connect zurl Connects to the target given by zurl. - + close [zurl] @@ -117,7 +117,7 @@ ZOOM>quit zurl or all targets if zurl was omitted. - + show [start [count]] @@ -127,13 +127,13 @@ ZOOM>quit by start. First records has offset 0 (unlike the Z39.50 protocol). - + quit Quits zoomsh. - + set name [value] @@ -142,22 +142,22 @@ ZOOM>quit Sets option name to value. - + get name Prints value of option name. - + help Prints list of available commands. - + - + SEE ALSO