X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Finstallation.xml;h=7ee630096d80e888aac4e0dcac887013243c3450;hb=1ae786339f81e9c5e1f5ead9f141be6f2b2ee1a6;hp=b6a9aaba10955bd7ed26a0984db54a49a0e6852f;hpb=2ad40f2e15a4d6927833231b8dc6874b747fed2e;p=yazpp-moved-to-github.git
diff --git a/doc/installation.xml b/doc/installation.xml
index b6a9aab..7ee6300 100644
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,10 +1,184 @@
-
- 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.
+
+
+ Building on 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 the location of yaz-config.
+ The yaz-config program 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 - which is nearly always
+ what you want.
+
+
+
+ For the whole list of configure options, refer
+ to the help:
+ ./configure --help.
+
+
+ This is what you have after successful compilation:
+
+
+ src/yaz-proxy
+
+ The YAZ Z39.50 Proxy utility.
+ This program gets installed in your binaries directory
+ (prefix/bin).
+
+
+
+
+ lib/libyaz++.la
+
+ The YAZ++ library, including the
+ ZOOM-C++ classes.
+ This library gets installed in your libraries directory
+ (prefix/lib).
+
+
+
+
+ include/yaz++/*.h
+
+ Various C++ header files, which you'll need for YAZ
+ development. All these are installed in your header files area
+ (prefix/include/yaz++).
+
+
+
+
+ yaz++-config
+
+ A Bourne shell-script utility that returns the values of the
+ CFLAGS and LIBS
+ environment variables
+ needed in order to compile your applications 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.
+
+
+
+
+
+
+ Building on Windows
+
+ You'll find Visual Studio project files in sub directory
+ win. Open workspace yazxx.dsw
+ which includes the following projects:
+
+
+ yazxx.dsp
+
+ Builds the yazxx.dll.
+
+
+
+ yazclient.dsp
+
+ Builds the sample client yazmyclient.exe.
+
+
+
+ yazserver.dsp
+
+ Builds the sample server yazmyserver.exe.
+
+
+
+ yazserver.dsp
+
+ Builds the proxy yazproxy.exe.
+
+
+
+ zoomxxclient.dsp
+
+ Builds the ZOOM C++ demo client zoomxxclient.exe.
+
+
+
+
+
+ By default, the include path and library path for the projects assumes
+ that YAZ is located in ..\yaz
+ (i.e. same prefix as the YAZ++ source).
+ If YAZ is in a different directory you'll have to modify
+ the include path in
+ Project | Settings | C/C++ | Preprocessor | Additional include
+ directories
+ and library path in
+ Project | Settings | Link | Input | Additional library
+ path.
+
+
+