1 <chapter id="installation">
2 <!-- $Id: installation.xml,v 1.11 2006-04-26 12:17:23 adam Exp $ -->
3 <title>Installation</title>
5 You need a C++ compiler to compile and use YAZ proxy.
6 The software was implemented using
7 <ulink url="&url.gcc;">GCC</ulink> so we know that works
8 well with YAZ proxy. From time to time the software has been
9 compiled on Windows using Visual C++. Other compilers should
10 work too. Let us know of portability problems, etc. with
14 YAZ proxy is built on top of the
15 <ulink url="&url.yaz;">YAZ</ulink> and
16 <ulink url="&url.yazplusplus;">YAZ++</ulink>
18 You need to install these first.
19 For some platforms there are binary packages available for YAZ/YAZ++.
22 We also highly recommend that
23 <ulink url="&url.libxml2;">libxml2</ulink> and
24 <ulink url="&url.libxslt;">libXSLT</ulink> are installed.
25 YAZ must be configured with libxml2 support.
27 <ulink url="&url.sru;">SRW/SRU</ulink>
29 The YAZ Proxy uses libXSLT for record conversions via XSLT.
32 YAZ proxy may also use USEMARCON to convert between MARC
33 formats. This is useful if you want the proxy to offer more
34 MARC record types than the backend target supports. Get USEMARCON
36 <ulink url="&url.usemarcon;">British Library USEMARCON page
40 <title>Building on Unix</title>
41 <para>On UNIX, the software is compiled as follows:
50 You can supply options for the <literal>configure</literal> script.
51 The most useful ones are:
54 <term><literal>--prefix </literal>directory</term>
56 Specifies installation prefix. By default
57 <literal>/usr/local</literal> is used.
61 <term><literal>--with-yazpp </literal>directory</term>
63 Specifies the location of <filename>yazpp-config</filename>.
64 The <filename>yazpp-config</filename> program is generated in
65 the source directory of YAZ++ as well as the binaries
66 directory when YAZ++ is installed (via make install).
69 If you don't supply this option, <literal>configure</literal> will
70 look for <filename>yazpp-config</filename> in directories of the
71 <envar>PATH</envar> environment - which is nearly always
76 <term><literal>--with-xslt </literal>directory</term>
78 Specifies prefix for libXSLT (and libxml2).
79 configure must be able to locate <command>xslt-config</command>
80 in PREFIX/bin. If this option is omitted, configure looks
81 for <command>xslt-config</command> in the current PATH.
85 <term><literal>--with-usemarcon </literal>directory</term>
87 Specifies USEMARCON installation prefix.
88 configure must be able to locate <command>usemarcon-config</command>
89 in PREFIX/bin. If this option is omitted, configure looks
90 for <command>usemarcon-config</command> in the current PATH.
94 For the whole list of <literal>configure</literal> options, refer
96 <literal>./configure --help</literal>.
99 Configure uses GCC's C/C++ compiler if available. To specify another
100 compiler, set <literal>CXX</literal>. To use other compiler flags,
101 specify <literal>CXXFLAGS</literal>. For example, to use
102 <literal>CC</literal> with debugging do:
104 CXXFLAGS="-g" CXX=CC ./configure
108 This is what you have after successful compilation:
111 <term><literal>src/yazproxy</literal></term>
113 The YAZ Proxy program.
114 It gets installed in your binaries directory
115 (<parameter>prefix</parameter><literal>/bin</literal>).
120 <term><literal>src/libyazproxy.la</literal></term>
122 The YAZ proxy library. This library gets installed in
123 the libraries directory
124 (<parameter>prefix</parameter><literal>/lib</literal>).
129 <term><literal>include/yazproxy/*.h</literal></term>
131 C++ header files, which you'll need for YAZ proxy
132 development. All these are installed in the header files area
133 (<parameter>prefix</parameter><literal>/include/yazproxy</literal>).
138 <term><literal>etc</literal></term>
140 Various files such as
141 configuration files, XSLT files, CQL to RPN conversion files,
142 a sample start/stop control script
143 <filename>yazproxy.ctl.sh</filename> that can be used as
144 template for an <filename>/etc/init.d</filename> script.
145 These files are installed in the YAZ proxy's data area
146 (<parameter>prefix</parameter><literal>/share/yazproxy</literal>).
153 <section id="windows">
154 <title>Building on Windows</title>
156 YAZ++ is shipped with "makefiles" for the NMAKE tool that comes
157 with <ulink url="&url.vstudio;">
158 Microsoft Visual Studio</ulink>.
159 Version 6 and .NET has been tested. We expect that YAZ++ compiles
160 with version 5 as well.
164 The YAZ proxy has never been used in production on Windows. Although
165 it compiles and runs, doesn't mean it scale on that platform.
167 YAZ proxy currently doesn't run as a Service - only as a Console
172 Start a command prompt and switch the sub directory
173 <filename>WIN</filename> where the file <filename>makefile</filename>
174 is located. Customize the installation by editing the
175 <filename>makefile</filename> file (for example by using notepad).
177 The following summarizes the most important settings in that file:
180 <varlistentry><term><literal>DEBUG</literal></term>
182 If set to 1, the software is
183 compiled with debugging libraries (code generation is
184 multi-threaded debug DLL).
185 If set to 0, the software is compiled with release libraries
186 (code generation is multi-threaded DLL).
190 <varlistentry><term><literal>YAZ_DIR</literal></term>
192 This must be set to the home of the YAZ source directory.
196 <varlistentry><term><literal>YAZPP_DIR</literal></term>
198 This must be set to the home of the YAZ++ source directory.
203 <term><literal>HAVE_XSLT</literal>,
204 <literal>LIBXSLT_DIR</literal></term>
207 If <literal>HAVE_LIBXSLT</literal> is set to 1, the proxy is compiled
208 with XSLT and XML support. In this configuration, set
209 <literal>LIBXSLT_DIR</literal> to the
210 <ulink url="&url.libxslt;">libXSLT</ulink> source
216 If you enable libXSLT you have to enable libxml2 and its
217 sub components zlib and iconv as well.
222 Windows versions of libXSLT, libxml2, zlib and iconv can be found
223 <ulink url="&url.libxml2.download.win32;">
230 <term><literal>HAVE_ICONV</literal>,
231 <literal>ICONV_DIR</literal></term>
233 If <literal>HAVE_ICONV</literal> is set to 1, the proxy is
234 compiled with iconv support. In this configuration, set
235 <literal>ICONV_DIR</literal> to the iconv source directory.
240 <term><literal>HAVE_LIBXML2</literal>,
241 <literal>LIBXML2_DIR</literal></term>
244 If <literal>HAVE_LIBXML2</literal> is set to 1, the proxy is compiled
245 with XML support. In this configuration, set
246 <literal>LIBXML2_DIR</literal> to the
247 <ulink url="&url.libxml2;">libxml2</ulink> source directory
249 <literal>ZLIB_DIR</literal> to the zlib directory.
254 YAZ++ is not using ZLIB. But libxml2 is.
263 When satisfied with the settings in the makefile, type
270 If the <filename>nmake</filename> command is not found on your system
271 you probably haven't defined the environment variables required to
272 use that tool. To fix that, find and run the batch file
273 <filename>vcvars32.bat</filename>. You need to run it from within
274 the command prompt or set the environment variables "globally";
275 otherwise it doesn't work.
279 If you wish to recompile YAZ++ - for example if you modify
280 settings in the <filename>makefile</filename> you can delete
281 object files, etc by running.
287 The following files are generated upon successful compilation:
290 <varlistentry><term><filename>bin/yazproxy.dll</filename></term>
293 </para></listitem></varlistentry>
295 <varlistentry><term><filename>lib/yazproxy.lib</filename></term>
297 Import library for <filename>yazproxy.dll</filename>.
298 </para></listitem></varlistentry>
300 <varlistentry><term><filename>bin/yazproxy.exe</filename></term>
302 YAZ proxy. It's a WIN32 console application.
303 </para></listitem></varlistentry>
311 <!-- Keep this comment at the end of the file
316 sgml-minimize-attributes:nil
317 sgml-always-quote-attributes:t
320 sgml-parent-document: "yazproxy.xml"
321 sgml-local-catalogs: nil
322 sgml-namecase-general:t