From cbd3dfed0ab7919bf1deb0e8af5fed4ffb8bdf5d Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Wed, 19 Nov 2003 21:17:26 +0000 Subject: [PATCH] Mention yaz-iconv, yaz-marcdump in documentation --- doc/asn.xml | 10 +++++----- doc/installation.xml | 49 +++++++++++++++++++++++++++++++++++-------------- doc/introduction.xml | 8 ++++---- doc/odr.xml | 8 ++++---- doc/tools.xml | 4 ++-- 5 files changed, 50 insertions(+), 29 deletions(-) diff --git a/doc/asn.xml b/doc/asn.xml index 85d07c4..854bc0b 100644 --- a/doc/asn.xml +++ b/doc/asn.xml @@ -1,4 +1,4 @@ - + The Z39.50 ASN.1 Module Introduction @@ -54,8 +54,8 @@ structure before freeing the structure itself. - You can use the odr_malloc() function (see section - Using ODR for details). When you use + You can use the odr_malloc() function (see + for details). When you use odr_malloc(), you can release all of the allocated data in a single operation, independent of any pointers and relations between the data. odr_malloc() is based on a @@ -308,8 +308,8 @@ typedef struct Z_ext_typeent z_ext_gettypebyref to look for the provided direct-reference. If the return value is different from NULL, you can use the provided - function to decode the BER string (see section - Using ODR). + function to decode the BER string (see + ). diff --git a/doc/installation.xml b/doc/installation.xml index 0523298..7f55b56 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,4 +1,4 @@ - + Compilation and Installation Introduction @@ -248,56 +248,77 @@ The following files are generated by the make process: - lib/libyaz.la + src/libyaz.la Main &yaz; library. This is no ordinary library. It's a Libtool archive. By default, &yaz; creates a static library in lib/.libs/libyaz.a. - + + - lib/libyazthread.la + src/libyazthread.la When threading is supported/enabled by configure this Libtool library is created. It includes functions that allows &yaz; to use threads. - + + ztest/yaz-ztest Test Z39.50 server. - + + client/yaz-client Z39.50 client for testing the protocol. See chapter YAZ client for more information. - + + - yaz-config + util/yaz-config A Bourne-shell script, generated by configure, that specifies how external applications should compile - and link with &yaz;. - + + - yaz-asncomp + 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. + + - zoom/zoomsh + zoom/zoomsh 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/zoomtst2, .. Several small applications that demonstrates the ZOOM API. - + + diff --git a/doc/introduction.xml b/doc/introduction.xml index 3fbd789..82ed71c 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,4 +1,4 @@ - + Introduction @@ -136,7 +136,7 @@ goes through the details of the ODR module which is the work horse that encodes and decodes - BER packages. Implementors using ZOOM only do not + BER packages. Implementors using ZOOM only, do not need reading this. Most other Z39.50 implementors only need to read the first two sections ( and @@ -268,8 +268,8 @@ If you are using the premade definitions of the &asn; module, and you are not adding new protocol of your own, the only parts of &odr; that you - need to worry about are documented in section - Using ODR. + need to worry about are documented in + . diff --git a/doc/odr.xml b/doc/odr.xml index 9a7e8c6..3ae89c5 100644 --- a/doc/odr.xml +++ b/doc/odr.xml @@ -1,4 +1,4 @@ - + The ODR Module Introduction @@ -13,8 +13,8 @@ If you are only interested in writing a Z39.50 implementation based on the PDUs that are already provided with &yaz;, you only need to concern - yourself with the section on managing ODR streams (section - Using ODR). Only if you need to + yourself with the section on managing ODR streams + (). Only if you need to implement ASN.1 beyond that which has been provided, should you worry about the second half of the documentation (section Programming with ODR). @@ -37,7 +37,7 @@ - Using ODR + Using ODR ODR Streams diff --git a/doc/tools.xml b/doc/tools.xml index 2bed773..b5f220d 100644 --- a/doc/tools.xml +++ b/doc/tools.xml @@ -1,4 +1,4 @@ - + Supporting Tools @@ -1757,7 +1757,7 @@ typedef struct oident release the associated memory again. For the structures describing the Z39.50 PDUs and related structures, it is convenient to use the memory-management system of the &odr; subsystem (see - Using ODR). However, in some circumstances + ). However, in some circumstances where you might otherwise benefit from using a simple nibble memory management system, it may be impractical to use odr_malloc() and odr_reset(). -- 1.7.10.4