-<!-- $Id: installation.xml,v 1.4 2001-10-24 12:50:44 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.5 2001-10-24 20:12:36 adam Exp $ -->
<chapter id="installation"><title>Compilation and Installation</title>
+ <sect1><title>Introduction</title>
<para>
- The latest version of the software will generally be found at
+ The latest version of the software will generally be found at:
</para>
<para>
<ulink url="http://ftp.indexdata.dk/pub/yaz/">
<listitem><para>HP/UX</para></listitem>
<listitem><para>SunOS/Solaris</para></listitem>
<listitem><para>DEC Unix</para></listitem>
+ <listitem><para>OpenBSD/FreeBSD</para></listitem>
<listitem><para>Linux</para></listitem>
<listitem><para>IBM AIX</para></listitem>
<listitem><para>Data General DG/UX (with some CFLAGS tinkering)
</ulink>, or the address given at the top of this document.
</para>
+ </sect1>
<sect1 id="installation.unix"><title>UNIX</title>
<para>
Note that if your system doesn't have a native ANSI C compiler, you may
- have to acquire one separately. We recommend gcc.
+ have to acquire one separately. We recommend
+ <ulink url="http://gcc.gnu.org">GCC</ulink>.
</para>
<para>
- For UNIX we use GNU configure to create Makefiles for &yaz;.
- Generally it should be sufficient to run configure without options:
+ For UNIX, the GNU tools
+ <ulink url="http://www.gnu.org/software/autoconf/">Autoconf</ulink>,
+ <ulink url="http://www.gnu.org/software/automake/">Automake</ulink> and
+ <ulink url="http://www.gnu.org/software/libtool/">Libtool</ulink>
+ is used to generate Makefiles and configure &yaz; for the system.
+ You do <emphasis>not</emphasis> these tools unless you're using the
+ CVS version of &yaz;.
+ Generally it should be sufficient to run configure without options,
+ like this:
</para>
<screen>
<para>
The following files are generated by the make process:
<variablelist>
- <varlistentry><term><filename>lib/libyaz.a</filename></term>
+ <varlistentry><term><filename>lib/libyaz.la</filename></term>
+ <listitem><para>
+ The main &yaz; library. This is no ordinary library. It's
+ a Libtool archive.
+ By default, &yaz; creates a static library in
+ <filename>lib/.libs/libyaz.a</filename>.
+ </para></listitem></varlistentry>
+
+ <varlistentry><term><filename>lib/libyazthread.la</filename></term>
<listitem><para>
- The &yaz; programmers' library.
+ When threading is supported/enabled by configure this GNU libtool
+ library is created. It include functions that allows &yaz;
+ to use threads.
</para></listitem></varlistentry>
<varlistentry><term><filename>ztest/yaz-ztest</filename></term>
- <listitem><para>A test Z39.50 server.
+ <listitem><para>A test Z39.50 server.
</para></listitem></varlistentry>
<varlistentry><term><filename>client/yaz-client</filename></term>
- <listitem><para>A command mode Z39.50 client.
+ <listitem><para>A YAZ Z39.50 client. See chapter <link linkend="client">
+ YAZ client</link> for more information.
</para></listitem></varlistentry>
<varlistentry><term><filename>yaz-config</filename></term>
- <listitem><para>A Bourne-shell script that holds build
- settings for &yaz;.
+ <listitem><para>A Bourne-shell script, generate by configure, that
+ specifies how external applications should compile - and link with
+ &yaz;.
</para></listitem></varlistentry>
<varlistentry><term><filename>yaz-comp</filename></term>
<listitem><para>The ASN.1 compiler for &yaz;. Requires the
- Tcl Shell, <application>tclsh</application>, in current path to work.
+ Tcl Shell, <application>tclsh</application>, in
+ <literal>PATH</literal> to operate.
+ </para></listitem></varlistentry>
+
+ <varlistentry><term><filename>zoom/zoomsh</filename></term>
+ <listitem><para>
+ A simple shell implemented on top of the
+ <link linkend="zoom">ZOOM</link> functions.
+ The shell is a command line application that allows you to enter
+ simple commands perform to perform ZOOM operations.
+ </para></listitem></varlistentry>
+
+ <varlistentry><term><filename>zoom/zoomtst1</filename>,
+ <filename>zoom/zoomtst2</filename>, ..</term>
+ <listitem><para>
+ Several small applications that demonstrates the use of ZOOM.
</para></listitem></varlistentry>
</variablelist>
<para>
&yaz; is shipped with "makefiles" for the NMAKE tool that comes
- with Visual C++.
-
- Start an MS-DOS prompt and switch the sub directory
+ with Microsoft Visual C++. Version 6 has been tested. We expect that
+ &yaz; should compile with version 5 as well.
+ </para>
+ <para>
+ Start a command prompt and switch the sub directory
<filename>WIN</filename> where the file <filename>makefile</filename>
is located. Customize the installation by editing the
<filename>makefile</filename> file (for example by using notepad).
The following summarises the most important settings in that file:
-
- <table frame="top"><title>WIN32 makefile settings</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Setting</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><literal>DEBUG</literal></entry>
- <entry> If set to 1, the software is
- compiled with debugging libraries. If set to 0, the software
- is compiled with release (non-debugging) libraries.
- </entry>
- </row>
-
- <row>
- <entry><literal>TCL</literal></entry>
- <entry> Specifies the name of the Tcl shell (EXE-file).
+
+ <variablelist>
+ <varlistentry><term><literal>DEBUG</literal></term>
+ <listitem><para>
+ If set to 1, the software is
+ compiled with debugging libraries (code generation is
+ multi-threaded debug DLL).
+ If set to 0, the software is compiled with release libraries
+ (code generation is multi-threaded DLL).
+ </para></listitem>
+ </varlistentry>
+ <varlistentry><term><literal>TCL</literal></term>
+ <listitem><para>
+ Specifies the name of the Tcl shell (EXE-file).
You do not need setting this or installing Tcl unless you wish
to change or add ASN.1 for &yaz;.
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
</para>
<para>
When satisfied with the settings in the makefile type
<screen>
nmake
</screen>
+ If command <filename>nmake</filename> is not found on your system
+ you probably haven't defined the environment variables required to
+ use that tool. To fix that, find and run the batch file
+ <filename>vcvars32.bat</filename>. You need to run it from within
+ the command prompt or set the environment variables "globally";
+ otherwise it doesn't work.
+ </para>
+ <para>
+ If you wish to recompile &yaz; - for example if you modify
+ settings in the <filename>makefile</filename> you can delete
+ object files, etc by running.
+ <screen>
+ nmake clean
+ </screen>
</para>
<para>
The following files are generated upon successful compilation:
<variablelist>
<varlistentry><term><filename>bin/yaz.dll</filename></term>
<listitem><para>
- the multi-threaded &yaz; DLL.
+ The multi-threaded &yaz; Dynamic Link Library.
</para></listitem></varlistentry>
- <varlistentry><term><filename>bin/yaz-ztest.exe</filename></term>
+ <varlistentry><term><filename>bin/yaz-client.exe</filename></term>
<listitem><para>
- A console Z39.50 client application.
+ The &yaz; Z39.50 client application. It's a WIN32 console application.
+ See chapter <link linkend="client">YAZ client</link> for more
+ information.
</para></listitem></varlistentry>
<varlistentry><term><filename>bin/yaz-ztest.exe</filename></term>
<listitem><para>
- A console Z39.50 multi threaded server.
+ The example/test Z39.50 multi threaded server. It's a WIN32
+ console application.
</para></listitem></varlistentry>
-
+
+ <varlistentry><term><filename>bin/zoomsh.exe</filename></term>
+ <listitem><para>
+ A simple console application implemented on top of the
+ <link linkend="zoom">ZOOM</link> functions.
+ The application is a command line shell that allows you to enter
+ simple commands perform to perform ZOOM operations.
+ </para></listitem></varlistentry>
+
+ <varlistentry><term><filename>bin/zoomtst1.exe</filename>,
+ <filename>bin/zoomtst2.exe</filename>, ..</term>
+ <listitem><para>
+ Several small applications that demonstrates the use of ZOOM.
+ </para></listitem></varlistentry>
+
</variablelist>
</para>
projects / yaz-moved-to-github.git / blobdiff