node-zoom

<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.78.1"><link rel="home" 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.�Windows"></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"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="installation.unix"></a>2.�UNIX</h2></div></div></div> We provide <a class="ulink" href="http://www.debian.org/" target="_top">Debian GNU/Linux</a> (i386 and amd64), <a class="ulink" href="http://www.ubuntu.com" target="_top">Ubuntu</a> (i386 and amd64) and <a class="ulink" href="http://www.centos.org/" target="_top">CentOS</a> (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 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> Solaris CSW: <a class="ulink" href="http://www.opencsw.org/packages/yaz/" target="_top">http://www.opencsw.org/packages/yaz/</a> </li><li class="listitem"> Solaris: <a class="ulink" href="http://unixpackages.com" target="_top">http://unixpackages.com</a> </li><li class="listitem"> FreeBSD: <a class="ulink" href="http://www.freshports.org/net/yaz" target="_top">http://www.freshports.org/net/yaz</a> </li><li class="listitem"> Debian: <a class="ulink" href="http://packages.debian.org/search?keywords=yaz" target="_top">http://packages.debian.org/search?keywords=yaz</a> </li><li class="listitem"> Ubuntu: <a class="ulink" href="https://launchpad.net/ubuntu/+source/yaz" target="_top">https://launchpad.net/ubuntu/+source/yaz</a> </li><li class="listitem"> NetBSD: <a class="ulink" href="http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/net/yaz/README.html" target="_top">http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/net/yaz/README.html</a> </li></ul></div><div class="sect2"><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> 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>. 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>. YAZ 3.0.16 and later includes a wrapper for the <a class="ulink" href="http://www.icu-project.org/" target="_top">ICU</a> (International Components for Unicode). In order to use this, the developer version of the ICU library must be available. ICU support is recommended for applications such as Pazpar2 and Zebra. 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/Solr. 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. 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 not these tools unless you're using the Git version of YAZ. 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 Git version of YAZ. 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 Git version of YAZ or you're using the compiler to built own codecs for private ASN.1. Generally it should be sufficient to run configure without options, like this: <pre class="screen"> ./configure </pre> 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: <pre class="screen"> CC=/opt/ccs/bin/cc CFLAGS=-O ./configure </pre> To customize YAZ, the configure script also accepts a set of options. The most important are: <div class="variablelist"><dl class="variablelist"><dt> <code class="literal">--prefix</code>=<code>prefix</code> </dt><dd>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. </dd><dt> <code class="literal">--enable-tcpd</code> </dt><dd>The front end server will be built using Wietse's <a class="ulink" href="http://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 hosts_access(5) and tcpd(8). </dd><dt> <code class="literal">--enable-threads</code> </dt><dd>YAZ will be built using POSIX threads. Specifically, <code class="constant">_REENTRANT</code> will be defined during compilation. </dd><dt> <code class="literal">--disable-shared</code> </dt><dd>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>. </dd><dt> <code class="literal">--disable-shared</code> </dt><dd>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>. </dd><dt> <code class="literal">--with-iconv</code>[=<code>prefix</code>] </dt><dd>Compile YAZ with iconv library in directory <code>prefix</code>. 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. </dd><dt> <code class="literal">--with-xslt</code>[=<code>prefix</code>] </dt><dd>Compile YAZ with <a class="ulink" href="http://xmlsoft.org/XSLT/" target="_top">libxslt</a> in directory <code>prefix</code>. 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. </dd><dt> <code class="literal">--with-xml2</code>[=<code>prefix</code>] </dt><dd>Compile YAZ with <a class="ulink" href="http://xmlsoft.org/" target="_top">libxml2</a> in directory <code>prefix</code>. Use this option if you want YAZ to use XML and support SRU/Solr. 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. Note that option <code class="literal">--with-xslt</code> also enables libxml2. </dd><dt> <code class="literal">--with-gnutls</code>[=<code>prefix</code>] </dt><dd>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. </dd><dt> <code class="literal">--with-icu</code>[=<code>prefix</code>] </dt><dd>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 icu-config will be used if found. </dd><dt> <code class="literal">--with-libgcrypt</code>[=<code>prefix</code>] </dt><dd>YAZ will be linked with <a class="ulink" href="http://www.gnu.org/software/libgcrypt/" target="_top">Libgcrypt</a> in the prefix if given. If prefix is not given, the libraries exposed by the script libgcrypt-config will be used if found. </dd><dt> <code class="literal">--with-memcached</code> </dt><dd>YAZ will be linked with <a class="ulink" href="http://libmemcached.org/" target="_top">libMemcached</a> to allow for result-set caching for ZOOM. The prefix can not be given. Note that YAZ will only search for libMemcached if Libgcrypt is also enabled. Note that 0.40 of libmemcached is required. </dd><dt> <code class="literal">--with-redis</code> </dt><dd>YAZ will be linked with the hiredis C library to allow for result-set caching for ZOOM on a <a class="ulink" href="http://redis.io/" target="_top">redis</a> server. The prefix can not be given. Note that YAZ will only search for hiredis if Libgcrypt is also enabled. </dd></dl></div> When configured, build the software by typing: <pre class="screen"> make </pre> The following files are generated by the make process: <div class="variablelist"><dl class="variablelist"><dt><code class="filename">src/libyaz.la</code></dt><dd> 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>. </dd><dt><code class="filename">src/libyaz_server.la</code></dt><dd> 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. </dd><dt><code class="filename">src/libyaz_icu.la</code></dt><dd> Functions that wrap the ICU library. </dd><dt><code class="filename">ztest/yaz-ztest</code></dt><dd>Test Z39.50 server. </dd><dt><code class="filename">client/yaz-client</code></dt><dd>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. </dd><dt><code class="filename">util/yaz-config</code></dt><dd>A Bourne-shell script, generated by configure, that specifies how external applications should compile - and link with YAZ. </dd><dt><code class="filename">util/yaz-asncomp</code></dt><dd>The ASN.1 compiler for YAZ. Requires the Tcl Shell, tclsh, in <code class="literal">PATH</code> to operate. </dd><dt><code class="filename">util/yaz-iconv</code></dt><dd>This program converts data in one character set to another. This command exercises the YAZ character set conversion API. </dd><dt><code class="filename">util/yaz-marcdump</code></dt><dd>This program parses ISO2709 encoded MARC records and prints them in line-format or XML. </dd><dt><code class="filename">util/yaz-icu</code></dt><dd>This program exposes the ICU wrapper library if that is enabled for YAZ. Only if ICU is available this program is useful. </dd><dt><code class="filename">util/yaz-url</code></dt><dd>This program is a simple HTTP page fetcher ala wget or curl. </dd><dt><code class="filename">zoom/zoomsh</code></dt><dd> 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. </dd><dt><code class="filename">zoom/zoomtst1</code>, <code class="filename">zoom/zoomtst2</code>, ..</dt><dd> Several small applications that demonstrates the ZOOM API. </dd></dl></div> 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: <pre class="screen"> make install </pre> 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>. If you wish to perform an un-installation of YAZ, use: <pre class="screen"> make uninstall </pre> 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>. </div><div class="sect2"><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> 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. 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. 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: <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> The CFLAGS variable consists of a C compiler directive that will set the include path to the parent 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 <pre class="screen"> #include <yaz/proto.h> </pre> and not <pre class="screen"> #include <proto.h> </pre> 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. 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: <pre class="screen"> CFLAGS=`$(YAZCONFIG) --cflags threads` LIBS=`$(YAZCONFIG) --libs threads` </pre> There is no need specify POSIX thread libraries in your Makefile. The <code class="literal">LIBS</code> variable includes that as well. </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.�Windows</td></tr></table></div></body></html>