Documentation no longer made when doing 'make all'.

[yaz-moved-to-github.git] / doc / yaz.sgml

diff --git a/doc/yaz.sgml b/doc/yaz.sgml
index 0fc454b..050344e 100644 (file)
--- a/doc/yaz.sgml
+++ b/doc/yaz.sgml
@@ -2,7 +2,7 @@
 <article>
 <title>YAZ User's Guide and Reference
 <author><htmlurl url="http://www.indexdata.dk/" name="Index Data">, <tt><htmlurl url="mailto:info@indexdata.dk" name="info@indexdata.dk"></>
 <article>
 <title>YAZ User's Guide and Reference
 <author><htmlurl url="http://www.indexdata.dk/" name="Index Data">, <tt><htmlurl url="mailto:info@indexdata.dk" name="info@indexdata.dk"></>

-<date>$Revision: 1.1 $
+<date>$Revision: 1.6 $

 <abstract>
 This document is the programmer's guide and reference to the YAZ
 package. YAZ is a compact toolkit that provides access to the
 <abstract>
 This document is the programmer's guide and reference to the YAZ
 package. YAZ is a compact toolkit that provides access to the

@@ -171,30 +171,26 @@ To customize <bf/YAZ/ the configure script also accepts a set of options.
 The most important are:
 
 <descrip>
 The most important are:
 
 <descrip>

-<tag><tt>--prefix </tt>path</tag> Specifies installation prefix. This is
+<tag><tt>-</tt><tt>-prefix </tt>path</tag> Specifies installation prefix. This is

 only needed if you run <tt>make install</tt> later to perform a
 "system" installation. The prefix is <tt>/usr/local</tt> if not
 specified.
 
 only needed if you run <tt>make install</tt> later to perform a
 "system" installation. The prefix is <tt>/usr/local</tt> if not
 specified.
 

-<tag><tt>--enable-yc </tt></tag> YAZ will be built using
+<tag><tt>-</tt><tt>-enable-comp </tt></tag> YAZ will be built using

 the ASN.1 compiler for YAZ (default). If you wish to use the
 the ASN.1 compiler for YAZ (default). If you wish to use the

-old decoders (in sub directory asn) use <tt>--disable-yc</tt> instead.
+old decoders (in sub directory asn) use <tt>--disable-comp</tt> instead.

 
 

-<tag><tt>--enable-threads</tt></tag> YAZ will be built using
+<tag><tt>-</tt><tt>-enable-threads</tt></tag> YAZ will be built using

 POSIX threads. Specifically, <tt>_REENTRANT</tt> will be defined
 during compilation.
 </descrip>
 
 POSIX threads. Specifically, <tt>_REENTRANT</tt> will be defined
 during compilation.
 </descrip>
 

-When configured build the software by typing:
+When configured, build the software by typing:

 <tscreen><verb>
   make
 </verb></tscreen>
 
 <tscreen><verb>
   make
 </verb></tscreen>
 

-Developers that do modifications to <bf/YAZ/ may wish to run
-<tt>make depend</tt> as well to generate object-header file
-dependencies.
-
-The following files are generated by make
+The following files are generated by the make process:

 <descrip>
 <tag><tt>lib/libyaz.a</tt></tag> The <bf/YAZ/ programmers' library.
 
 <descrip>
 <tag><tt>lib/libyaz.a</tt></tag> The <bf/YAZ/ programmers' library.
 

@@ -205,6 +201,9 @@ The following files are generated by make
 <tag><tt>yaz-config</tt></tag> A Bourne-shell script that holds build
 settings for <bf/YAZ/.
 
 <tag><tt>yaz-config</tt></tag> A Bourne-shell script that holds build
 settings for <bf/YAZ/.
 

+<tag><tt>yaz-comp</tt></tag> The ASN.1 compiler for YAZ. Requires the
+Tcl Shell, tclsh, in current path to work. 
+

 </descrip>
 
 If you wish to install <bf/YAZ/ in system directories such as /usr/local/bin,
 </descrip>
 
 If you wish to install <bf/YAZ/ in system directories such as /usr/local/bin,

@@ -215,9 +214,20 @@ If you wish to install <bf/YAZ/ in system directories such as /usr/local/bin,
 </verb></tscreen>
 
 You probably need to have root access in order to perform this.
 </verb></tscreen>
 
 You probably need to have root access in order to perform this.

-You must to specify the <tt>--prefix</tt> option for configure if you
+You must specify the <tt>--prefix</tt> option for configure if you

 going to install in anything but /usr/local/.
 
 going to install in anything but /usr/local/.
 

+If you wish to perform an un-installation of YAZ you use:
+
+<tscreen><verb>
+  make uninstall
+</verb></tscreen>
+
+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.
+<tt>/usr/local/include/yaz</tt>.
+

 <sect1>WIN32
 
 <p>
 <sect1>WIN32
 
 <p>

@@ -3425,7 +3435,7 @@ us a note and let's see what we can come up with.
 <sect1>Index Data Copyright
 
 <p>
 <sect1>Index Data Copyright
 
 <p>

-Copyright &copy; 1995-1999 Index Data.
+Copyright &copy; 1995-2000 Index Data.

 
 Permission to use, copy, modify, distribute, and sell this software and
 its documentation, in whole or in part, for any purpose, is hereby granted,
 
 Permission to use, copy, modify, distribute, and sell this software and
 its documentation, in whole or in part, for any purpose, is hereby granted,