From: Adam Dickmeiss Date: Fri, 26 Oct 2001 20:13:44 +0000 (+0000) Subject: Indentation. Variable sgml-local-catalogs set to nil. X-Git-Tag: YAZ.1.8.1~3 X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=bd7e251dac1b07c54884d26295f66b90cfb23131;p=yaz-moved-to-github.git Indentation. Variable sgml-local-catalogs set to nil. --- diff --git a/doc/asn.xml b/doc/asn.xml index cf8cbb7..85d07c4 100644 --- a/doc/asn.xml +++ b/doc/asn.xml @@ -1,4 +1,4 @@ - + The Z39.50 ASN.1 Module Introduction @@ -1067,7 +1067,7 @@ typedef struct Z_ext_typeent sgml-indent-step:1 sgml-indent-data:t sgml-parent-document: "yaz.xml" - sgml-local-catalogs: "../../docbook/docbook.cat" + sgml-local-catalogs: nil sgml-namecase-general:t End: --> diff --git a/doc/client.xml b/doc/client.xml index 1c8df1c..5ec2cd4 100644 --- a/doc/client.xml +++ b/doc/client.xml @@ -1,4 +1,4 @@ - + The YAZ client Introduction @@ -438,7 +438,7 @@ sgml-indent-step:1 sgml-indent-data:t sgml-parent-document: "yaz.xml" - sgml-local-catalogs: "../../docbook/docbook.cat" + sgml-local-catalogs: nil sgml-namecase-general:t End: --> diff --git a/doc/comstack.xml b/doc/comstack.xml index 9ae8df0..741429c 100644 --- a/doc/comstack.xml +++ b/doc/comstack.xml @@ -1,4 +1,4 @@ - + The COMSTACK Module Synopsis (blocking mode) @@ -569,7 +569,7 @@ if (buf) sgml-indent-step:1 sgml-indent-data:t sgml-parent-document: "yaz.xml" - sgml-local-catalogs: "../../docbook/docbook.cat" + sgml-local-catalogs: nil sgml-namecase-general:t End: --> diff --git a/doc/frontend.xml b/doc/frontend.xml index 7dd7058..19729e1 100644 --- a/doc/frontend.xml +++ b/doc/frontend.xml @@ -1,4 +1,4 @@ - + Generic server Introduction @@ -847,7 +847,7 @@ typedef struct bend_scan_rr { sgml-indent-step:1 sgml-indent-data:t sgml-parent-document: "yaz.xml" - sgml-local-catalogs: "../../docbook/docbook.cat" + sgml-local-catalogs: nil sgml-namecase-general:t End: --> diff --git a/doc/future.xml b/doc/future.xml index 52be2dd..517ec3f 100644 --- a/doc/future.xml +++ b/doc/future.xml @@ -1,6 +1,6 @@ - + Future Directions - + We have a new and better version of the front-end server on the drawing board. Resources and external commitments will govern when we'll be @@ -8,14 +8,14 @@ flexibility, greater support for access/resource control, and easy support for Explain (possibly with Zebra as an extra database engine). - + The 'retrieval' module needs to be finalized and documented. We think it can form a useful resource for people dealing with complex record structures, but for now, you'll mostly have to chew through the code yourself to make use of it. Not acceptable. - + &yaz; is a BER toolkit and as such should support all protocols out there based on that. We'd like to see running ILL applications. @@ -23,7 +23,7 @@ LDAP. Maybe a generic framework for doing IR using both LDAP and Z39.50 transparently. - + Other than that, YAZ generally moves in the directions which appear to make the most people happy (including ourselves, as prime users of the @@ -31,7 +31,7 @@ us a note and let's see what we can come up with. - + diff --git a/doc/indexdata.xml b/doc/indexdata.xml index bc18a62..9e10b35 100644 --- a/doc/indexdata.xml +++ b/doc/indexdata.xml @@ -1,4 +1,4 @@ - + About Index Data @@ -56,7 +56,7 @@ sgml-indent-step:1 sgml-indent-data:t sgml-parent-document: "yaz.xml" - sgml-local-catalogs: "../../docbook/docbook.cat" + sgml-local-catalogs: nil sgml-namecase-general:t End: --> diff --git a/doc/installation.xml b/doc/installation.xml index f94122a..834358b 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,66 +1,66 @@ - + Compilation and Installation - Introduction - - The latest version of the software will generally be found at: - - - - http://ftp.indexdata.dk/pub/yaz/ - - - 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. - So far, the software has been ported to the following platforms with - little or no difficulties. + Introduction + + The latest version of the software will generally be found at: + + + + http://ftp.indexdata.dk/pub/yaz/ + + + 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. + So far, the software has been ported to the following platforms with + little or no difficulties. + + + Unix systems + + HP/UX + SunOS/Solaris + DEC Unix + OpenBSD/FreeBSD + Linux + IBM AIX + Data General DG/UX (with some CFLAGS tinkering) + + SGI/IRIX + DDE Supermax + + Non-unix systems + + Apple Macintosh (using the Codewarrior programming + environment and the GUSI socket libraries) + MS Windows 95/98/NT/W2K (Win32) + IBM AS/400 + + + + + + If you move the software to other platforms, we'd be grateful if you'd + let us know about it. If you run into difficulties, we will try to help + if we can, and if you solve the problems, we would be happy to include + your fixes in the next release. So far, we have mostly avoided + #ifdefs for individual platforms, and we'd like to keep it that + way as far as it makes sense. + - - Unix systems - - HP/UX - SunOS/Solaris - DEC Unix - OpenBSD/FreeBSD - Linux - IBM AIX - Data General DG/UX (with some CFLAGS tinkering) - - SGI/IRIX - DDE Supermax - - Non-unix systems - - Apple Macintosh (using the Codewarrior programming - environment and the GUSI socket libraries) - MS Windows 95/98/NT/W2K (Win32) - IBM AS/400 - - + + We maintain a mailing-list for the purpose of announcing new releases and + bug-fixes, as well as general discussion. Subscribe by sending mail to + + yaz-request@indexdata.dk + . + General questions and problems can be directed at + + yaz-help@indexdata.dk + , or the address given at the top of this document. + - - - If you move the software to other platforms, we'd be grateful if you'd - let us know about it. If you run into difficulties, we will try to help - if we can, and if you solve the problems, we would be happy to include - your fixes in the next release. So far, we have mostly avoided - #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 sending mail to - - yaz-request@indexdata.dk - . - General questions and problems can be directed at - - yaz-help@indexdata.dk - , or the address given at the top of this document. - - UNIX @@ -113,7 +113,7 @@ --enable-tcpd The front end server will be built using Wietse's - TCP wrapper library. It allows you to allow/deny + TCP wrapper library. It allows you to allow/deny clients depending on IP number. The TCP wrapper library is commonly used in Linux/BSD distributions. @@ -159,8 +159,8 @@ client/yaz-client Z39.50 client for testing the protocol. - See chapter - YAZ client for more information. + See chapter + YAZ client for more information. yaz-config @@ -178,13 +178,13 @@ zoom/zoomsh A simple shell implemented on top of the - ZOOM functions. + ZOOM functions. The shell is a command line application that allows you to enter simple commands perform to perform ZOOM operations. zoom/zoomtst1, - zoom/zoomtst2, .. + zoom/zoomtst2, .. Several small applications that demonstrates the use of ZOOM. @@ -243,18 +243,18 @@ DEBUG - If set to 1, the software is - compiled with debugging libraries (code generation is - multi-threaded debug DLL). - If set to 0, the software is compiled with release libraries - (code generation is multi-threaded DLL). + If set to 1, the software is + compiled with debugging libraries (code generation is + multi-threaded debug DLL). + If set to 0, the software is compiled with release libraries + (code generation is multi-threaded DLL). TCL - Specifies the name of the Tcl shell (EXE-file). - You do not need setting this or installing Tcl unless you wish - to change or add ASN.1 for &yaz;. + Specifies the name of the Tcl shell (EXE-file). + You do not need setting this or installing Tcl unless you wish + to change or add ASN.1 for &yaz;. @@ -267,7 +267,7 @@ If command nmake is not found on your system you probably haven't defined the environment variables required to use that tool. To fix that, find and run the batch file - vcvars32.bat. You need to run it from within + vcvars32.bat. You need to run it from within the command prompt or set the environment variables "globally"; otherwise it doesn't work. @@ -315,7 +315,7 @@ bin/zoomtst1.exe, - bin/zoomtst2.exe, .. + bin/zoomtst2.exe, .. Several small applications that demonstrates the use of ZOOM. @@ -336,7 +336,7 @@ sgml-indent-step:1 sgml-indent-data:t sgml-parent-document: "yaz.xml" - sgml-local-catalogs: "../../docbook/docbook.cat" + sgml-local-catalogs: nil sgml-namecase-general:t End: --> diff --git a/doc/introduction.xml b/doc/introduction.xml index b8f136b..f531c74 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,4 +1,4 @@ - + Introduction @@ -24,8 +24,8 @@ level APIs of &yaz;. - The basic low level modules, which are independent of the role (client or server), - consist of three primary interfaces: + The basic low level modules, which are independent of the role + (client or server), consist of three primary interfaces: &asn;, which provides a C representation of the Z39.50 @@ -48,7 +48,7 @@ provided by the &odr; (Open Data Representation) subsystem. - &odr; is a basic mechanism for representing an + &odr; is a basic mechanism for representing an ASN.1 type in the C programming language, and for implementing BER encoders and decoders for values of that type. The types defined in the &asn; module generally have the prefix Z_, and @@ -119,7 +119,7 @@ sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:"yaz.xml" - sgml-local-catalogs: "../../docbook/docbook.cat" + sgml-local-catalogs: nil sgml-namecase-general:t End: --> diff --git a/doc/license.xml b/doc/license.xml index 0762b36..428df32 100644 --- a/doc/license.xml +++ b/doc/license.xml @@ -1,4 +1,4 @@ - + License Index Data Copyright @@ -112,7 +112,7 @@ sgml-indent-step:1 sgml-indent-data:t sgml-parent-document: "yaz.xml" - sgml-local-catalogs: "../../docbook/docbook.cat" + sgml-local-catalogs: nil sgml-namecase-general:t End: --> diff --git a/doc/odr.xml b/doc/odr.xml index 4f0451b..9a8e406 100644 --- a/doc/odr.xml +++ b/doc/odr.xml @@ -1,4 +1,4 @@ - + The ODR Module Introduction @@ -1241,7 +1241,7 @@ void odr_choice_bias(ODR o, int what); sgml-indent-step:1 sgml-indent-data:t sgml-parent-document: "yaz.xml" - sgml-local-catalogs: "../../docbook/docbook.cat" + sgml-local-catalogs: nil sgml-namecase-general:t End: --> diff --git a/doc/tools.xml b/doc/tools.xml index 7f6de9d..f995950 100644 --- a/doc/tools.xml +++ b/doc/tools.xml @@ -1,4 +1,4 @@ - + Supporting Tools @@ -703,7 +703,7 @@ typedef struct oident sgml-indent-step:1 sgml-indent-data:t sgml-parent-document: "yaz.xml" - sgml-local-catalogs: "../../docbook/docbook.cat" + sgml-local-catalogs: nil sgml-namecase-general:t End: --> diff --git a/doc/yaz.xml b/doc/yaz.xml index 3638d46..f3f1e8d 100644 --- a/doc/yaz.xml +++ b/doc/yaz.xml @@ -21,7 +21,7 @@ COMSTACK"> ZOOM"> ]> - + YAZ User's Guide and Reference @@ -61,7 +61,6 @@ &app-indexdata; - diff --git a/doc/zoom.xml b/doc/zoom.xml index c748e96..cc03dbc 100644 --- a/doc/zoom.xml +++ b/doc/zoom.xml @@ -1,8 +1,8 @@ - + Building clients with ZOOM - &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is + &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is an initiative started by Mike Taylor (Mike is from the UK, which explains the peculiar name of the model). The goal of &zoom; is to provide a common Z39.50 client API not bound to a particular @@ -41,14 +41,14 @@ NULL pointer. Connections - + The Connection object is a session with a target. #include <yaz/zoom.h> - + Z3950_connection Z3950_connection_new (const char *host, int portnum); - + Z3950_connection Z3950_connection_create (Z3950_options options); void Z3950_connection_connect(Z3950_connection c, const char *host, @@ -96,68 +96,68 @@ - - - Option - Description - Default - - - - - implementationNameName of Your client - none - - userAuthentication user name - none - - groupAuthentication group name + + + Option + Description + Default + + + + + implementationNameName of Your client + none + + userAuthentication user name + none + + groupAuthentication group name + none + + passAuthentication password none - - passAuthentication password - none - - proxyProxy host - none - - asyncIf true (1) the connection operates in - asynchronous operation which means that all calls are non-blocking - except Z3950_event. - 0 - - maximumRecordSize Maximum size of single record. - 1 MB - - preferredMessageSize Maximum size of multiple records. - 1 MB - - + + proxyProxy host + none + + asyncIf true (1) the connection operates in + asynchronous operation which means that all calls are non-blocking + except Z3950_event. + 0 + + maximumRecordSize Maximum size of single record. + 1 MB + + preferredMessageSize Maximum size of multiple records. + 1 MB + + - Function Z3950_connection_host returns + Function Z3950_connection_host returns the host for the connection as specified in a call to - Z3950_connection_new or - Z3950_connection_connect. - This function returns NULL if host isn't - set for the connection. + Z3950_connection_new or + Z3950_connection_connect. + This function returns NULL if host isn't + set for the connection. int Z3950_connection_error (Z3950_connection c, const char **cp, const char **addinfo); - Use Z3950_connection_error to check for - errors for the last operation(s) performed. The function returns - zero if no errors occurred; non-zero otherwise indicating the error. - Pointers cp and addinfo - holds messages for the error and additional-info if passed as - non-NULL. + Use Z3950_connection_error to check for + errors for the last operation(s) performed. The function returns + zero if no errors occurred; non-zero otherwise indicating the error. + Pointers cp and addinfo + holds messages for the error and additional-info if passed as + non-NULL. Search objects - Search objects defines how result sets are obtained. They - act like queries. + Search objects defines how result sets are obtained. They + act like queries. Z3950_search Z3950_search_create(void); @@ -169,24 +169,23 @@ int Z3950_search_sortby(Z3950_search s, const char *criteria); - Create search objects using Z3950_search_create - and destroy them by calling Z3950_search_destroy. - RPN-queries can be specified in PQF - notation by using the - function Z3950_search_prefix. More - query types will be added later, such as - CCL to RPN-mapping, native CCL query, - etc. In addition to a search, a sort criteria may be set. Function - Z3950_search_sortby specifies a - sort criteria using the same string notation for sort as offered by - the YAZ client. + Create search objects using Z3950_search_create + and destroy them by calling Z3950_search_destroy. + RPN-queries can be specified in PQF + notation by using the + function Z3950_search_prefix. More + query types will be added later, such as + CCL to RPN-mapping, native CCL query, + etc. In addition to a search, a sort criteria may be set. Function + Z3950_search_sortby specifies a + sort criteria using the same string notation for sort as offered by + the YAZ client. Result sets - The result set object is a container for records returned from - a target. - search. + The result set object is a container for records returned from + a target. Z3950_resultset Z3950_connection_search(Z3950_connection, @@ -198,12 +197,12 @@ void Z3950_resultset_destroy(Z3950_resultset r); - Function Z3950_connection_search creates + Function Z3950_connection_search creates a result set given a connection - and search object. - Destroy a result set by calling - Z3950_resultset_destroy. - Simple clients using PQF only may use function - Z3950_connection_search_pqf instead. + Destroy a result set by calling + Z3950_resultset_destroy. + Simple clients using PQF only may use function + Z3950_connection_search_pqf instead. const char *Z3950_resultset_option (Z3950_resultset r, @@ -216,68 +215,68 @@ const char *type, int *len); - Function Z3950_resultset_options sets or - modifies an option for a result set similar to + Function Z3950_resultset_options sets or + modifies an option for a result set similar to Z3950_connection_option. - The number of hits also called result-count is returned by - function Z3950_resultset_size. + The number of hits also called result-count is returned by + function Z3950_resultset_size. - Function Z3950_resultset_get is similar to - + Function Z3950_resultset_get is similar to + Z3950_record_get but - instead of operating on a record object, it operates on a record on - a given offset within a result set. + instead of operating on a record object, it operates on a record on + a given offset within a result set. ZOOM Result set Options - - - Option - Description - Default - - - - - piggybackTrue (1) if piggyback should be - used in searches; false (0) if not. - 1 - - startOffset of first record we wish to - retrieve from the target. Note first record has offset 0 - unlike the protocol specifications where first record has position - 1. - 0 - - countNumber of records to be retrieved. - 0 - - elementSetNameElement-Set name of records. - Most targets should honor element set name B - and F for brief and full respectively. - none - - preferredRecordSyntaxPreferred Syntax, such as - USMARC, SUTRS, etc. - none - - databaseNameOne or more database names - separated by character plus (+). - Default - - + + + Option + Description + Default + + + + + piggybackTrue (1) if piggyback should be + used in searches; false (0) if not. + 1 + + startOffset of first record we wish to + retrieve from the target. Note first record has offset 0 + unlike the protocol specifications where first record has position + 1. + 0 + + countNumber of records to be retrieved. + 0 + + elementSetNameElement-Set name of records. + Most targets should honor element set name B + and F for brief and full respectively. + none + + preferredRecordSyntaxPreferred Syntax, such as + USMARC, SUTRS, etc. + none + + databaseNameOne or more database names + separated by character plus (+). + Default + +
Records - A record object is a retrival record on the client side - - created from result sets. + A record object is a retrival record on the client side - + created from result sets. void Z3950_resultset_records (Z3950_resultset r, @@ -291,45 +290,45 @@ void Z3950_record_destroy (Z3950_record rec); - Records are created by functions - Z3950_resultset_records or - Z3950_resultset_record - and destroyed by Z3950_record_destroy. + Records are created by functions + Z3950_resultset_records or + Z3950_resultset_record + and destroyed by Z3950_record_destroy. - A single record is created and returned by function - Z3950_resultset_record that takes a - position as argument. First record has position zero. - If no record could be obtained NULL is returned. + A single record is created and returned by function + Z3950_resultset_record that takes a + position as argument. First record has position zero. + If no record could be obtained NULL is returned. - Function Z3950_resultset_records retrieves - a number of records from a result set. Options start - and count specifies the range of records to - be returned. Upon completion recs[0], ..recs[*cnt] - holds record objects for the records. These array of records + Function Z3950_resultset_records retrieves + a number of records from a result set. Options start + and count specifies the range of records to + be returned. Upon completion recs[0], ..recs[*cnt] + holds record objects for the records. These array of records recs should be allocate prior to calling - Z3950_resultset_records. Note that for - records that couldn't be retrieved from the target - recs[ ..] is NULL. + Z3950_resultset_records. Note that for + records that couldn't be retrieved from the target + recs[ ..] is NULL. - In order to extract information about a single record, - Z3950_record_get is provided. The - function returns a pointer to certain record information. The - nature (type) of the pointer depends on the type - given. In addition for certain types, the length - len passed will be set to the size in bytes of - the returned information. The types database, - syntax and render are - supported. More will be added later. + In order to extract information about a single record, + Z3950_record_get is provided. The + function returns a pointer to certain record information. The + nature (type) of the pointer depends on the type + given. In addition for certain types, the length + len passed will be set to the size in bytes of + the returned information. The types database, + syntax and render are + supported. More will be added later. Options - Most objects in &zoom; allow you to specify options to change - default behaviour. From an implementation point of view a set of options - is just like an associate array / hash array, etc. + Most objects in &zoom; allow you to specify options to change + default behaviour. From an implementation point of view a set of options + is just like an associate array / hash array, etc. Z3950_options Z3950_options_create (void); @@ -356,26 +355,26 @@ Events - If you're developing non-blocking applications, you have to deal - with events. + If you're developing non-blocking applications, you have to deal + with events. - int Z3950_event (int no, Z3950_connection *cs); + int Z3950_event (int no, Z3950_connection *cs); - The Z3950_event executes pending events for - a number of connections. Supply the number of connections in - no and an array of connections in - cs (cs[0] ... cs[no-1]). - A pending event could be a sending a search, receiving a response, - etc. - When an event has a occured for one of the connections, this function - returns a positive integer n denoting that an event - occurred for connection cs[n-1]. - When no events are pending for the connections, a value of zero is - returned. - To make sure all outstanding requests are performed call this function - repeatedly until zero is returned. + The Z3950_event executes pending events for + a number of connections. Supply the number of connections in + no and an array of connections in + cs (cs[0] ... cs[no-1]). + A pending event could be a sending a search, receiving a response, + etc. + When an event has a occured for one of the connections, this function + returns a positive integer n denoting that an event + occurred for connection cs[n-1]. + When no events are pending for the connections, a value of zero is + returned. + To make sure all outstanding requests are performed call this function + repeatedly until zero is returned. @@ -390,7 +389,7 @@ sgml-indent-step:1 sgml-indent-data:t sgml-parent-document: "yaz.xml" - sgml-local-catalogs: "../../docbook/docbook.cat" + sgml-local-catalogs: nil sgml-namecase-general:t End: -->