File: installation.unix.html

package info (click to toggle)
yaz 3.0.34-2
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 13,404 kB
  • ctags: 12,108
  • sloc: xml: 116,075; ansic: 52,205; sh: 9,746; tcl: 2,043; makefile: 1,141; yacc: 347
file content (274 lines) | stat: -rw-r--r-- 17,945 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>2.�UNIX</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="YAZ User's Guide and Reference"><link rel="up" href="installation.html" title="Chapter�2.�Compilation and Installation"><link rel="prev" href="installation.html" title="Chapter�2.�Compilation and Installation"><link rel="next" href="installation.win32.html" title="3.�WIN32"></head><body><link rel="stylesheet" type="text/css" href="common/style1.css"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.�UNIX</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="installation.html">Prev</a>�</td><th width="60%" align="center">Chapter�2.�Compilation and Installation</th><td width="20%" align="right">�<a accesskey="n" href="installation.win32.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="installation.unix"></a>2.�UNIX</h2></div></div></div><p>
    We provide 
    <a class="ulink" href="http://www.debian.org/" target="_top">Debian GNU/Linux</a>
    and 
    <a class="ulink" href="http://www.redhat.com/" target="_top">Redhat</a> packages for YAZ. 
    Only i386 binary packages are available. You should be able to
    create packages for other CPUs by building them from the source
    package.
   </p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="installation.source.unix"></a>2.1.�Compiling from source on Unix</h3></div></div></div><p>
     Note that if your system doesn't have a native ANSI C compiler, you may
     have to acquire one separately. We recommend
     <a class="ulink" href="http://gcc.gnu.org/" target="_top">GCC</a>.
    </p><p>
     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 
     <a class="ulink" href="http://www.gnu.org/software/libiconv/" target="_top">GNU libiconv</a>.
    </p><p>
     YAZ 3.0.16 and later includes a wrapper for the 
     <a class="ulink" href="%url.icu;" target="_top">ICU</a> 
     (International Components for Unicode).
     In order to use this, the developer version of the ICU library
     must be available.
    </p><p>
     The <a class="ulink" href="http://xmlsoft.org/XSLT/" target="_top">libxslt</a>,
     <a class="ulink" href="http://xmlsoft.org/" target="_top">libxml2</a> librararies are required
     if YAZ is to support SRU.
     These libraries are very portable and should compile out-of-the
     box on virtually all Unix platforms. It is available in binary
     forms for Linux and others.
    </p><p>
     The GNU tools
     <a class="ulink" href="http://www.gnu.org/software/autoconf/" target="_top">Autoconf</a>,
     <a class="ulink" href="http://www.gnu.org/software/automake/" target="_top">Automake</a> and
     <a class="ulink" href="http://www.gnu.org/software/libtool/" target="_top">Libtool</a>
     are used to generate Makefiles and configure YAZ for the system.
     You do <span class="emphasis"><em>not</em></span> these tools unless you're using the
     CVS version of YAZ.
    </p><p>
     The CQL parser for YAZ is built using
     GNU <a class="ulink" href="http://www.gnu.org/software/bison/" target="_top">Bison</a>.
     This tool is only needed if you're using the CVS version of YAZ.
    </p><p>
     YAZ includes a tiny ASN.1 compiler. This compiler is
     written in <a class="ulink" href="http://www.tcl.tk/" target="_top">Tcl</a>.
     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. 
    </p><p>
     Generally it should be sufficient to run configure without options,
     like this:
    </p><pre class="screen">
     ./configure
    </pre><p>
     The configure script attempts to use use the C compiler specified by
     the <code class="literal">CC</code> environment variable. If not set, GNU C will be
     used if it is available. The <code class="literal">CFLAGS</code> environment
     variable holds options to be passed to the C compiler. If you're using
     Bourne-compatible shell you may pass something like this to use a
     particular C compiler with optimization enabled:
    </p><pre class="screen">
     CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
    </pre><p>
     To customize YAZ, the configure script also accepts a set of options.
     The most important are:
     
     </p><div class="variablelist"><dl><dt><span class="term">
        <code class="literal">--prefix</code>=<em class="replaceable"><code>prefix</code></em></span></dt><dd><p>Specifies installation prefix for YAZ. This is
         only needed if you run <code class="literal">make install</code> later to
         perform a "system" installation. The prefix is
         <code class="literal">/usr/local</code> if not specified.
        </p></dd><dt><span class="term"><code class="literal">--enable-tcpd</code></span></dt><dd><p>The front end server will be built using Wietse's
         <a class="ulink" href="ftp://ftp.porcupine.org/pub/security/index.html" target="_top">TCP wrapper library</a>.
	 It allows you to allow/deny clients depending on IP number.
	 The TCP wrapper library is often used in GNU/Linux and
	 BSD distributions.
         See
         <span class="citerefentry"><span class="refentrytitle">hosts_access</span>(5)</span>
         and 
         <span class="citerefentry"><span class="refentrytitle">tcpd</span>(8)</span>.
        </p></dd><dt><span class="term"><code class="literal">--enable-threads</code></span></dt><dd><p>YAZ will be built using POSIX threads.
	Specifically, <code class="constant">_REENTRANT</code> will be defined during
         compilation.
        </p></dd><dt><span class="term"><code class="literal">--disable-shared</code></span></dt><dd><p>The make process will not create shared
         libraries (also known as shared objects <code class="filename">.so</code>).
         By default, shared libraries are created -
         equivalent to <code class="literal">--enable-shared</code>.
        </p></dd><dt><span class="term"><code class="literal">--disable-shared</code></span></dt><dd><p>The make process will not create
         static libraries (<code class="filename">.a</code>).
         By default, static libraries are created -
         equivalent to <code class="literal">--enable-static</code>.
        </p></dd><dt><span class="term">
        <code class="literal">--with-iconv</code>[=<em class="replaceable"><code>prefix</code></em>]
       </span></dt><dd><p>Compile YAZ with iconv library in directory
         <em class="replaceable"><code>prefix</code></em>. By default configure will
         search for iconv on the system. Use this option if it
         doesn't find iconv. Alternatively, 
         <code class="literal">--without-iconv</code>, can be uset to force YAZ
	 not to use iconv.
        </p></dd><dt><span class="term">
        <code class="literal">--with-xslt</code>[=<em class="replaceable"><code>prefix</code></em>]
       </span></dt><dd><p>Compile YAZ with 
         <a class="ulink" href="http://xmlsoft.org/XSLT/" target="_top">libxslt</a> in directory
         <em class="replaceable"><code>prefix</code></em>. 
         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, 
         <code class="literal">--without-xslt</code>, can be used to force YAZ
	 not to use libxslt.
        </p></dd><dt><span class="term">
        <code class="literal">--with-xml2</code>[=<em class="replaceable"><code>prefix</code></em>]
       </span></dt><dd><p>Compile YAZ with 
         <a class="ulink" href="http://xmlsoft.org/" target="_top">libxml2</a> in directory
         <em class="replaceable"><code>prefix</code></em>. 
         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, 
         <code class="literal">--without-xml2</code>, can be used to force YAZ
	 not to use libxml2.
	 </p><p>
	   Note that option <code class="literal">--with-xslt</code>
	   also enables libxml2.
         </p></dd><dt><span class="term">
        <code class="literal">--with-gnutls</code>[=<em class="replaceable"><code>prefix</code></em>]
       </span></dt><dd><p>YAZ will be linked with the GNU TLS libraries and
         an SSL COMSTACK will be provided. By default configure enables
         SSL support for YAZ if the GNU TLS development libraries are found
         on the system.
        </p></dd><dt><span class="term">
        <code class="literal">--with-openssl</code>[=<em class="replaceable"><code>prefix</code></em>]
       </span></dt><dd><p>YAZ will be linked with the OpenSSL libraries and
         an SSL COMSTACK will be provided. If OpenSSL is enabled, GNU TLS
         is automatically disabled.
        </p></dd><dt><span class="term">
        <code class="literal">--with-icu</code>[=<em class="replaceable"><code>prefix</code></em>]
       </span></dt><dd><p>YAZ will be linked the 
	<a class="ulink" href="http://www.icu-project.org/" target="_top">ICU</a> library in the prefix if given.
	If prefix is not given, the libraries exposed by the script
	<span class="application">icu-config</span> will be used if found.
        </p></dd></dl></div><p>
     
    </p><p>
     When configured, build the software by typing:
     </p><pre class="screen">
      make
     </pre><p>
    </p><p>
     The following files are generated by the make process:
     </p><div class="variablelist"><dl><dt><span class="term"><code class="filename">src/libyaz.la</code></span></dt><dd><p>
         Main YAZ library. This is no ordinary library. It's
         a Libtool archive.
         By default, YAZ creates a static library in 
         <code class="filename">lib/.libs/libyaz.a</code>.
        </p></dd><dt><span class="term"><code class="filename">src/libyaz_server.la</code></span></dt><dd><p>
         Generic Frontend server. This is an add-on for libyaz.la.
         Code in this library uses POSIX threads functions - if POSIX
         threads are available on the platform.
        </p></dd><dt><span class="term"><code class="filename">src/libyaz_icu.la</code></span></dt><dd><p>
         Functions that wrap the ICU library.
        </p></dd><dt><span class="term"><code class="filename">ztest/yaz-ztest</code></span></dt><dd><p>Test Z39.50 server. 
        </p></dd><dt><span class="term"><code class="filename">client/yaz-client</code></span></dt><dd><p>Z39.50 client for testing the protocol.
         See chapter <a class="link" href="yaz-client.html" title="yaz-client">
          YAZ client</a> for more information.
        </p></dd><dt><span class="term"><code class="filename">util/yaz-config</code></span></dt><dd><p>A Bourne-shell script, generated by configure, that
         specifies how external applications should compile - and link with
         YAZ.
        </p></dd><dt><span class="term"><code class="filename">util/yaz-asncomp</code></span></dt><dd><p>The ASN.1 compiler for YAZ. Requires the
         Tcl Shell, <span class="application">tclsh</span>, in
         <code class="literal">PATH</code> to operate.
        </p></dd><dt><span class="term"><code class="filename">util/yaz-iconv</code></span></dt><dd><p>This program converts data in one character set to
	 another. This command exercises the YAZ character set
	 conversion API.
        </p></dd><dt><span class="term"><code class="filename">util/yaz-marcdump</code></span></dt><dd><p>This program parses ISO2709 encoded MARC records
	 and prints them in line-format or XML.
        </p></dd><dt><span class="term"><code class="filename">util/yaz-icu</code></span></dt><dd><p>This program exposes the ICU wrapper library if that
	 is enabled for YAZ. Only if ICU is available this program is
         useful.
        </p></dd><dt><span class="term"><code class="filename">zoom/zoomsh</code></span></dt><dd><p>
         A simple shell implemented on top of the 
         <a class="link" href="zoom.html" title="Chapter�3.�ZOOM">ZOOM</a> functions.
         The shell is a command line application that allows you to enter
         simple commands to perform ZOOM operations.
        </p></dd><dt><span class="term"><code class="filename">zoom/zoomtst1</code>, 
        <code class="filename">zoom/zoomtst2</code>, ..</span></dt><dd><p>
         Several small applications that demonstrates the ZOOM API.
        </p></dd></dl></div><p>
     
    </p><p>
     If you wish to install YAZ in system directories  
     <code class="filename">/usr/local/bin</code>,
     <code class="filename">/usr/local/lib</code> .. etc, you can type:
    </p><pre class="screen">
     make install
    </pre><p>
     You probably need to have root access in order to perform this.
     You must specify the <code class="literal">--prefix</code> option for configure if
     you wish to install YAZ in other directories than the default 
     <code class="filename">/usr/local/</code>.
    </p><p>
     If you wish to perform an un-installation of YAZ, use:
    </p><pre class="screen">
     make uninstall
    </pre><p>
     This will only work if you haven't reconfigured YAZ (and therefore
     changed installation prefix). Note that uninstall will not
     remove directories created by make install, e.g.
     <code class="filename">/usr/local/include/yaz</code>.
    </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="installation-linking-yaz-unix"></a>2.2.�How to make apps using YAZ on UNIX</h3></div></div></div><p>
     This section describes how to compile - and link your own
     applications using the YAZ toolkit.
     If you're used to Makefiles this shouldn't be hard. As for
     other libraries you have used before, you have to set a proper include
     path for your C/C++ compiler and specify the location of
     YAZ libraries. You can do it by hand, but generally we suggest
     you use the <code class="filename">yaz-config</code> that is generated
     by <code class="filename">configure</code>. This is especially
     important if you're using the threaded version of YAZ which
     require you to pass more options to your linker/compiler.
    </p><p>
     The <code class="filename">yaz-config</code> script accepts command line
     options that makes the <code class="filename">yaz-config</code> script print
     options that you should use in your make process.
     The most important ones are:
     <code class="literal">--cflags</code>, <code class="literal">--libs</code>
     which prints C compiler flags, and linker flags respectively.
     </p><p>
     A small and complete <code class="literal">Makefile</code> for a C
     application consisting of one source file,
     <code class="filename">myprog.c</code>, may look like this:
     </p><pre class="screen">
      YAZCONFIG=/usr/local/bin/yaz-config
      CFLAGS=`$(YAZCONFIG) --cflags`
      LIBS=`$(YAZCONFIG) --libs`
      myprog: myprog.o
         $(CC) $(CFLAGS) -o myprog myprog.o $(LIBS)
      </pre><p>
     </p><p>
     The CFLAGS variable consists of a C compiler directive that will set
     the include path to the <span class="emphasis"><em>parent</em></span> directory
     of <code class="filename">yaz</code>. That is, if YAZ header files were
     installed in <code class="filename">/usr/local/include/yaz</code>,
     then include path is set to <code class="filename">/usr/local/include</code>.
     Therefore, in your applications you should use
     </p><pre class="screen">
      #include &lt;yaz/proto.h&gt;
     </pre><p>
     and <span class="emphasis"><em>not</em></span>
     </p><pre class="screen">
      #include &lt;proto.h&gt;
     </pre><p>
    </p><p>
     For Libtool users, the <code class="filename">yaz-config</code> script provides
     a different variant of option <code class="literal">--libs</code>, called
     <code class="literal">--lalibs</code> that returns the name of the
     Libtool archive(s) for YAZ rather than the ordinary ones.
    </p><p>
     For applications using the threaded version of YAZ,
     specify <code class="literal">threads</code> after the
     other options. When <code class="literal">threads</code> is given,
     more flags and linker flags will be printed by
     <code class="filename">yaz-config</code>. If our previous example was
      using threads, you'd have to modify the lines that set
     <code class="literal">CFLAGS</code> and <code class="literal">LIBS</code> as
     follows:
     </p><pre class="screen">
      CFLAGS=`$(YAZCONFIG) --cflags threads`
      LIBS=`$(YAZCONFIG) --libs threads`
     </pre><p>
     There is no need specify POSIX thread libraries in your Makefile.
     The <code class="literal">LIBS</code> variable includes that as well.
    </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="installation.html">Prev</a>�</td><td width="20%" align="center"><a accesskey="u" href="installation.html">Up</a></td><td width="40%" align="right">�<a accesskey="n" href="installation.win32.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter�2.�Compilation and Installation�</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">�3.�WIN32</td></tr></table></div></body></html>