X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Finstallation.xml;h=4b24e4af1d153560c78c9df6e8d8220031bbae64;hb=fc357a11b8c9b87534b3baa8c2c4d5b656f0998a;hp=b6a9aaba10955bd7ed26a0984db54a49a0e6852f;hpb=2ad40f2e15a4d6927833231b8dc6874b747fed2e;p=yazpp-moved-to-github.git
diff --git a/doc/installation.xml b/doc/installation.xml
index b6a9aab..4b24e4a 100644
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,10 +1,123 @@
-
- Installation
-
- How to compile this software.
-
-
+
+
Installation
+
+ You need a C++ compiler to compile and use YAZ++.
+ The software was implemented using GCC so we know that works
+ well with YAZ++. From time to time the software has been
+ compiled on Windows using Visual C++. Other compilers should
+ work too. Let us know of portability problems, etc. with
+ your system!
+
+
+ YAZ++ is built on top of the
+ YAZ
+ toolkit.
+ You need to install that first.
+ For some platforms there are binary packages for YAZ.
+
+
+ UNIX
+ On UNIX, the software is compiled as follows:
+
+ ./configure
+ make
+ su
+ make install
+
+
+
+ You can supply options for the configure script.
+ The most useful ones are:
+
+
+ --prefix directory
+
+ Specifies installation prefix. By default
+ /usr/local is used.
+
+
+
+ --with-yazconfig directory
+
+ Specifies location of yaz-config.
+ The yaz-config is generated in
+ the source directory of YAZ as well as the binaries
+ directory when YAZ is installed (via make install).
+
+
+ If you don't supply this option, configure, will
+ look for yaz-config in directories of the
+ PATH environment.
+
+
+
+ For the whole list of configure options, refer to the help:
+ ./configure --help.
+
+
+ This is a list of what you have after successful compilation:
+
+
+ src/yaz-proxy
+
+ Z39.50 Proxy. This program gets installed in
+ your binaries directory (prefix/bin).
+
+
+
+ lib/libyaz++.la
+
+ YAZ++ library. This library gets installed in your
+ libraries directory (prefix/lib).
+
+
+
+
+ include/yaz++/*.h
+
+ Various header files. All these are installed in
+ your header files area (prefix/include/yaz++).
+
+
+
+
+ yaz++-config
+
+ Bourne shell script utility that returns CFLAGS/LIBS
+ needed in order to compile with the YAZ++ library.
+ This script gets installed in your binaries directory
+ (prefix/bin).
+
+
+
+
+ zoom/zclient
+
+ ZOOM C++ demonstration client. This client does not
+ get installed in the system directories.
+
+
+
+
+ src/yaz-my-client
+
+ YAZ C++ demonstration client. This client does not
+ get installed in the system directories.
+
+
+
+
+ src/yaz-my-server
+
+ YAZ C++ demonstration server. This server does not
+ get installed in the system directories.
+
+
+
+
+
+