1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2008 Index Data.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Index Data nor the names of its contributors
13 * may be used to endorse or promote products derived from this
14 * software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 /* $Id: yaz-util.h,v 1.19 2007-01-12 21:41:53 adam Exp $ */
31 * \brief Header for common YAZ utilities
37 #include <yaz/yconfig.h>
38 #include <yaz/yaz-version.h>
39 #include <yaz/xmalloc.h>
43 #include <yaz/tpath.h>
44 #include <yaz/options.h>
45 #include <yaz/wrbuf.h>
47 #include <yaz/readconf.h>
48 #include <yaz/marcdisp.h>
49 #include <yaz/yaz-iconv.h>
52 \section intro_sec Introduction
54 For a general introduction to YAZ, read the
55 YAZ User's Guide and Reference at
56 http://www.indexdata.com/yaz/doc/
57 This is also located in the doc directory of the YAZ distribution.
59 The following sections is just a summary of the most important
60 header files and where they belong.
62 \section utilities Utilies
63 Logging (syslog-like) utility \ref log.h .
65 Memory management for small blocks \ref nmem.h .
67 Write string buffer \ref wrbuf.h .
69 Options handling \ref options.h .
71 Character conversion \ref yaz-iconv.h .
73 MARC / MARCXML \ref marcdisp.h .
75 Testing framework: \ref test.h .
77 Record conversion: \ref record_conv.h .
79 Record retrieval: \ref retrieval.h .
81 \section queryparsers Query parsers
83 PQF parsing: \ref pquery.h .
85 CCL parsing: \ref ccl.h .
87 CQL parsing and conversion: \ref cql.h .
89 Z39.50 sort: \ref sortspec.h .
91 \section ber BER handling
93 BER utilities (ODR): \ref odr.h .
97 Z39.50 common header: \ref proto.h .
99 Z39.50 core codecs: \ref z-core.h.
101 Z39.50 related formats:
102 \ref z-accdes1.h , \ref z-core.h ,
103 \ref z-estask.h , \ref z-oclcui.h , \ref z-sum.h
104 \ref z-accform1.h , \ref z-date.h ,
105 \ref z-exp.h , \ref z-opac.h , \ref z-sutrs.h
106 \ref z-acckrb1.h , \ref z-diag1.h ,
107 \ref z-grs.h , \ref z-rrf1.h , \ref z-uifr1.h
108 \ref z-charneg.h , \ref z-espec1.h
109 \ref z-mterm2.h , \ref z-rrf2.h , \ref z-univ.h .
111 Z39.50 extended services:
112 \ref zes-admin.h , \ref zes-exps.h , \ref zes-pquery.h ,
113 \ref zes-pset.h , \ref zes-update.h ,
114 \ref zes-expi.h , \ref zes-order.h , \ref zes-psched.h ,
117 Z39.50 diagnostics: \ref diagbib1.h .
119 Z39.50 externals: \ref prt-ext.h .
121 \section GDU Generic Data Unit (HTTP and BER)
123 Definitions for GDU and HTTP: \ref zgdu.h .
127 SRU/SRW definitions: \ref srw.h .
129 SRW diagnostics: \ref diagsrw.h .
133 Common header: \ref ill.h .
135 Codecs: \ref ill-core.h
139 Common header: \ref zoom.h .
141 \section GFS Generic Frontend Server (GFS)
143 Header: \ref backend.h .
151 * indent-tabs-mode: nil
153 * vim: shiftwidth=4 tabstop=8 expandtab