From: Mike Taylor Date: Tue, 22 Oct 2002 13:07:06 +0000 (+0000) Subject: Proofread installation documentation, fix a few minor typos, improve X-Git-Tag: YAZPP.0.5~37 X-Git-Url: http://git.indexdata.com/?p=yazpp-moved-to-github.git;a=commitdiff_plain;h=c3a3af5bfb7172956d9e362887e42181fbcf1c2a Proofread installation documentation, fix a few minor typos, improve markup, expand on some in-passing mentions, and add links forward to ZOOM-C++ and the proxy. I think this document can now be classified as "finished" (though I've not yet read the Proxy one.) --- diff --git a/doc/installation.xml b/doc/installation.xml index 4b24e4a..41fe797 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,5 +1,5 @@ - + Installation You need a C++ compiler to compile and use YAZ++. @@ -7,7 +7,7 @@ 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! + your system. YAZ++ is built on top of the @@ -17,17 +17,17 @@ For some platforms there are binary packages for YAZ.
- UNIX + Building on Unix On UNIX, the software is compiled as follows: - ./configure - make - su - make install + $ ./configure + $ make + $ su + # make install - You can supply options for the configure script. + You can supply options for the configure script. The most useful ones are: @@ -40,59 +40,68 @@ --with-yazconfig directory - Specifies location of yaz-config. - The yaz-config is generated in + 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 + If you don't supply this option, configure will look for yaz-config in directories of the - PATH environment. + PATH environment - which is nearly always + what you want. - For the whole list of configure options, refer to the help: + For the whole list of configure options, refer + to the help: ./configure --help. - This is a list of what you have after successful compilation: + This is what you have after successful compilation: - src/yaz-proxy + src/yaz-proxy - Z39.50 Proxy. This program gets installed in - your binaries directory (prefix/bin). + The Yaz Z39.50 Proxy utility. + This program gets installed in your binaries directory + (prefix/bin). + - lib/libyaz++.la + lib/libyaz++.la - YAZ++ library. This library gets installed in your - libraries directory (prefix/lib). + The YAZ++ library, including the + ZOOM-C++ classes. + This library gets installed in your libraries directory + (prefix/lib). - include/yaz++/*.h + include/yaz++/*.h - Various header files. All these are installed in - your header files area (prefix/include/yaz++). + 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 + 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). + 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/zclient ZOOM C++ demonstration client. This client does not get installed in the system directories. @@ -100,7 +109,7 @@ - src/yaz-my-client + src/yaz-my-client YAZ C++ demonstration client. This client does not get installed in the system directories. @@ -108,7 +117,7 @@ - src/yaz-my-server + src/yaz-my-server YAZ C++ demonstration server. This server does not get installed in the system directories.