X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Finstallation.xml;h=6d5c09f6c518b944cdba23ac753a60f8e21db28d;hp=cbd4abdfb09064519316afce388e6363b7ee5c43;hb=bc8b2eabc0fb24c32b0f69c67492edf454d52f7d;hpb=0f72f09a46621eb0aa9960b990dd35c221333e4d
diff --git a/doc/installation.xml b/doc/installation.xml
index cbd4abd..6d5c09f 100644
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,267 +1,286 @@
-
-Compilation and Installation
-
-
-The latest version of the software will generally be found at
-
-
-
-http://ftp.indexdata.dk/pub/yaz/
-
-
-We have tried our best to keep the software portable, and on many
-platforms, you should be able to compile everything with little or no changes.
-So far, the software has been ported
-to the following platforms with little or no difficulties.
-
-
-Unix systems
-
-HP/UX
-SunOS/Solaris
-DEC Unix
-Linux
-IBM AIX
-Data General DG/UX (with some CFLAGS tinkering)
-
-SGI/IRIX
-DDE Supermax
-
-Non-unix systems
-
-Apple Macintosh (using the Codewarrior programming
-environment and the GUSI socket libraries)
-MS Windows 95/98/NT/W2K (Win32)
-IBM AS/400
-
-
-
-
-
-If you move the software to other platforms, we'd be grateful if you'd
-let us know about it. If you run into difficulties, we will try to help if we
-can, and if you solve the problems, we would be happy to
-include your fixes in the next release. So far, we have mostly avoided
-#ifdefs for individual platforms, and we'd like to keep it that
-way as far as it makes sense.
-
-
-
-We maintain a mailing-list for the purpose of announcing new releases and
-bug-fixes, as well as general discussion. Subscribe by sending mail to
-yaz-request@indexdata.dk.
-General questions and problems can be directed at
-yaz-help@indexdata.dk, or
-the address given at the top of this document.
-
-
-UNIX
-
-
-Note that if your system doesn't have a native ANSI C compiler, you may
-have to acquire one separately. We recommend gcc.
-
-
-For UNIX we use GNU configure to create Makefiles for &yaz;.
-Generally it should be sufficient to run configure without options:
-
-
-
- ./configure
-
-
-
-The configure script attempts to use use the C compiler specified by
-the CC environment variable. If not set, GNU C will be
-used if it is available. The CFLAGS 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:
-
-
-
- CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
-
-
-
-To customize &yaz; the configure script also accepts a set of options.
-The most important are:
-
-
---prefix path
-Specifies installation prefix. This is
-only needed if you run make install later to perform a
-"system" installation. The prefix is /usr/local if not
-specified.
-
-
-
---enable-comp
- &yaz; will be built using the ASN.1 compiler for &yaz;
-(default). If you wish to use the old decoders (in sub directory asn)
-use --disable-comp instead.
-
-
---enable-threads
-&yaz; will be built using POSIX threads.
-Specifically, _REENTRANT will be defined during
-compilation.
-
-
-
-
-
-
-When configured, build the software by typing:
-
- make
-
-
-
-
-
-The following files are generated by the make process:
-
-lib/libyaz.a
-
-The &yaz; programmers' library.
-
-
-ztest/yaz-ztest
-A test Z39.50 server.
-
-
-client/yaz-client
-A command mode Z39.50 client.
-
-
-yaz-config
-A Bourne-shell script that holds build
-settings for &yaz;.
-
-
-yaz-comp
-The ASN.1 compiler for &yaz;. Requires the
-Tcl Shell, tclsh, in current path to work.
-
-
-
-
-
-
-If you wish to install &yaz; in system directories such as
-/usr/local/bin,
-/usr/local/lib you can type:
-
-
-
- make install
-
-
-
-You probably need to have root access in order to perform this.
-You must specify the --prefix option for configure if
-you wish to install &yaz; in other directories than the default
-/usr/local/.
-
-
-
-If you wish to perform an un-installation of &yaz; use:
-
-
-
- make uninstall
-
-
-
-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.
-/usr/local/include/yaz.
-
-
-
-WIN32
-
-
-&yaz; is shipped with "makefiles" for the NMAKE tool that comes
-with Visual C++.
-
-Start an MS-DOS prompt and switch the sub directory WIN
-where the file makefile is located. Customize the
-installation by editing the makefile file (for example
-by using notepad).
-
-The following summarises the most important settings in that file:
-
-WIN32 makefile settings
-
-
-
-Setting
-Description
-
-
-
-
-
-NEW_Z3950
- If 1, the auto-generated decoder/encoders
-for Z39.50 as written by the ASN.1 compiler will be used. If 0, the old
-decoders for Z39.50 will be used. Note, when 1, the setting TCL should
-point to the Tcl shell on your system.
-
-
-
-
-DEBUG
- If set to 1, the software is
-compiled with debugging libraries. If set to 0, the software
-is compiled with release (non-debugging) libraries.
-
-
-
-
-TCL
- 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;.
-
-
-
-
-
-
-
-
-
-When satisfied with the settings in the makefile type
-
- nmake
-
-
-
-The following files are generated upon successful compilation:
-
-
-bin/yaz.dll
-
-the multi-threaded &yaz; DLL.
-
-
-bin/yaz-ztest.exe
-
-A console Z39.50 client application.
-
-
-bin/yaz-ztest.exe
-
-A console Z39.50 multi threaded server.
-
-
-
-
-
-
-
-
+
+ Compilation and Installation
+
+
+ The latest version of the software will generally be found at
+
+
+
+ http://ftp.indexdata.dk/pub/yaz/
+
+
+ We have tried our best to keep the software portable, and on many
+ platforms, you should be able to compile everything with little or
+ no changes.
+ So far, the software has been ported to the following platforms with
+ little or no difficulties.
+
+
+ Unix systems
+
+ HP/UX
+ SunOS/Solaris
+ DEC Unix
+ Linux
+ IBM AIX
+ Data General DG/UX (with some CFLAGS tinkering)
+
+ SGI/IRIX
+ DDE Supermax
+
+ Non-unix systems
+
+ Apple Macintosh (using the Codewarrior programming
+ environment and the GUSI socket libraries)
+ MS Windows 95/98/NT/W2K (Win32)
+ IBM AS/400
+
+
+
+
+
+ If you move the software to other platforms, we'd be grateful if you'd
+ let us know about it. If you run into difficulties, we will try to help
+ if we can, and if you solve the problems, we would be happy to include
+ your fixes in the next release. So far, we have mostly avoided
+ #ifdefs for individual platforms, and we'd like to keep it that
+ way as far as it makes sense.
+
+
+
+ We maintain a mailing-list for the purpose of announcing new releases and
+ bug-fixes, as well as general discussion. Subscribe by sending mail to
+
+ yaz-request@indexdata.dk
+ .
+ General questions and problems can be directed at
+
+ yaz-help@indexdata.dk
+ , or the address given at the top of this document.
+
+
+ UNIX
+
+
+ Note that if your system doesn't have a native ANSI C compiler, you may
+ have to acquire one separately. We recommend gcc.
+
+
+ For UNIX we use GNU configure to create Makefiles for &yaz;.
+ Generally it should be sufficient to run configure without options:
+
+
+
+ ./configure
+
+
+
+ The configure script attempts to use use the C compiler specified by
+ the CC environment variable. If not set, GNU C will be
+ used if it is available. The CFLAGS 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:
+
+
+
+ CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
+
+
+
+ To customize &yaz; the configure script also accepts a set of options.
+ The most important are:
+
+
+ --prefix path
+ Specifies installation prefix. This is
+ only needed if you run make install later to
+ perform a "system" installation. The prefix is
+ /usr/local if not specified.
+
+
+
+ --enable-comp
+ &yaz; will be built using the ASN.1 compiler for &yaz;
+ (default). If you wish to use the old decoders (in sub directory asn)
+ use --disable-comp instead.
+
+
+ --enable-threads
+ &yaz; will be built using POSIX threads.
+ Specifically, _REENTRANT will be defined during
+ compilation.
+
+
+
+
+
+
+ When configured, build the software by typing:
+
+ make
+
+
+
+
+
+ The following files are generated by the make process:
+
+ lib/libyaz.a
+
+ The &yaz; programmers' library.
+
+
+ ztest/yaz-ztest
+ A test Z39.50 server.
+
+
+ client/yaz-client
+ A command mode Z39.50 client.
+
+
+ yaz-config
+ A Bourne-shell script that holds build
+ settings for &yaz;.
+
+
+ yaz-comp
+ The ASN.1 compiler for &yaz;. Requires the
+ Tcl Shell, tclsh, in current path to work.
+
+
+
+
+
+
+ If you wish to install &yaz; in system directories such as
+ /usr/local/bin,
+ /usr/local/lib you can type:
+
+
+
+ make install
+
+
+
+ You probably need to have root access in order to perform this.
+ You must specify the --prefix option for configure if
+ you wish to install &yaz; in other directories than the default
+ /usr/local/.
+
+
+
+ If you wish to perform an un-installation of &yaz; use:
+
+
+
+ make uninstall
+
+
+
+ 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.
+ /usr/local/include/yaz.
+
+
+
+ WIN32
+
+
+ &yaz; is shipped with "makefiles" for the NMAKE tool that comes
+ with Visual C++.
+
+ Start an MS-DOS prompt and switch the sub directory
+ WIN where the file makefile
+ is located. Customize the installation by editing the
+ makefile file (for example by using notepad).
+
+ The following summarises the most important settings in that file:
+
+ WIN32 makefile settings
+
+
+
+ Setting
+ Description
+
+
+
+
+
+ NEW_Z3950
+ If 1, the auto-generated decoder/encoders
+ for Z39.50 as written by the ASN.1 compiler will be used. If 0,
+ the old decoders for Z39.50 will be used. Note, when 1, the
+ setting TCL should point to the Tcl shell on your system.
+
+
+
+
+ DEBUG
+ If set to 1, the software is
+ compiled with debugging libraries. If set to 0, the software
+ is compiled with release (non-debugging) libraries.
+
+
+
+
+ TCL
+ 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;.
+
+
+
+
+
+
+
+
+
+ When satisfied with the settings in the makefile type
+
+ nmake
+
+
+
+ The following files are generated upon successful compilation:
+
+
+ bin/yaz.dll
+
+ the multi-threaded &yaz; DLL.
+
+
+ bin/yaz-ztest.exe
+
+ A console Z39.50 client application.
+
+
+ bin/yaz-ztest.exe
+
+ A console Z39.50 multi threaded server.
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file