X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Finstallation.xml;h=ae46e146824f632037edba627fee775e3ea1043e;hp=2394ed31e78d8703fcc0891c46e1c3fc393a21ec;hb=13671e7cc0f3dd4e4b02f94d64a50778c5696ba6;hpb=b340923765c14d2ba050a171bb557474044d7e6a diff --git a/doc/installation.xml b/doc/installation.xml index 2394ed3..ae46e14 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,4 +1,4 @@ - + Compilation and Installation Introduction @@ -138,7 +138,7 @@ --disable-shared - The make process will be not create + The make process will not create static libraries (.a). By default, static libraries are created - equivalent to --enable-static. @@ -168,7 +168,7 @@ lib/libyazthread.la - When threading is supported/enabled by configure this GNU libtool + When threading is supported/enabled by configure this Libtool library is created. It includes functions that allows &yaz; to use threads. @@ -184,7 +184,7 @@ yaz-config - A Bourne-shell script, generate by configure, that + A Bourne-shell script, generated by configure, that specifies how external applications should compile - and link with &yaz;. @@ -200,7 +200,7 @@ A simple shell implemented on top of the ZOOM functions. The shell is a command line application that allows you to enter - simple commands perform to perform ZOOM operations. + simple commands to perform ZOOM operations. zoom/zoomtst1, @@ -213,9 +213,9 @@ - If you wish to install &yaz; in system directories such as + If you wish to install &yaz; in system directories /usr/local/bin, - /usr/local/lib you can type: + /usr/local/lib .. etc, you can type: @@ -230,7 +230,7 @@ - If you wish to perform an un-installation of &yaz; use: + If you wish to perform an un-installation of &yaz;, use: @@ -258,8 +258,8 @@ require you to pass more options to your linker/compiler. - The yaz-config script accepts the options - that makes the yaz-config script print + The yaz-config script accepts command line + options that makes the yaz-config script print options that you should use in your make process. The most important ones are: --cflags, --libs @@ -267,8 +267,8 @@ A small and complete Makefile for a C - application consisting of one source file - myprog.c may look like this: + application consisting of one source file, + myprog.c, may look like this: YAZCONFIG=/usr/local/bin/yaz-config CFLAGS=`$(YAZCONFIG) --cflags` @@ -278,8 +278,8 @@ - The CFLAGS string will consists of an option that will set the - include path to the parent directory + The CFLAGS variable consists of a C compiler directive that will set + the include path to the parent directory of yaz. That is, if &yaz; header files were installed in /usr/local/include/yaz, then include path is set to /usr/local/include. @@ -299,9 +299,9 @@ Libtool acrhive(s) for &yaz; rather than the ordinary ones. - Applications that wish to use the threaded version of &yaz; - should specify threads after the - other options. When threads is given + For applications using the threaded version of &yaz;, + specify threads after the + other options. When threads is given, more flags and linker flags will be printed by yaz-config. If our previous example was using threads, you'd have to modify the lines that set @@ -312,7 +312,7 @@ LIBS=`$(YAZCONFIG) --libs threads` There is no need specify POSIX thread libraries in your Makefile. - The LIBS includes that as well. + The LIBS variable includes that as well. @@ -422,9 +422,9 @@ Some people are confused by the fact that we use the nmake tool to build &yaz;. They think they have to do that too - in order - to make WIN32 applications using &yaz;. The good news is that + to make their WIN32 applications work with &yaz;. The good news is that you don't have to. You can use the integrated environement of - Visual Studio if desired. + Visual Studio if desired for your own application. When setting up a project or Makefile you have to set the following: