From c1984a321c189f1996d117e88a5d70cf09926ba5 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Fri, 16 Jan 1998 11:01:17 +0000 Subject: [PATCH] Better doc. --- Makefile.in | 4 ++-- clientrc.tcl | 2 +- configure.in | 10 ++++++++-- doc/ir-tcl.sgml | 47 ++++++++++++++++++++++++++++++----------------- 4 files changed, 41 insertions(+), 22 deletions(-) diff --git a/Makefile.in b/Makefile.in index 3a2dd70..de05866 100644 --- a/Makefile.in +++ b/Makefile.in @@ -1,8 +1,8 @@ # IR toolkit for tcl/tk -# (c) Index Data 1995-1996 +# (c) Index Data 1995-1998 # See the file LICENSE for details. # Sebastian Hammer, Adam Dickmeiss -# $Id: Makefile.in,v 1.45 1998-01-16 09:24:17 adam Exp $ +# $Id: Makefile.in,v 1.46 1998-01-16 11:01:17 adam Exp $ SHELL=/bin/sh # IrTcl Version diff --git a/clientrc.tcl b/clientrc.tcl index 305d4c2..4bc62fa 100644 --- a/clientrc.tcl +++ b/clientrc.tcl @@ -23,7 +23,7 @@ set profile(AGRICOLA,smallSetUpperBound) 0 set profile(AGRICOLA,targetInfoName) {} set profile(AGRICOLA,timeDefine) 878567355 set profile(AGRICOLA,timeLastExplain) {} -set profile(AGRICOLA,timeLastInit) 879938261 +set profile(AGRICOLA,timeLastInit) 884946306 set profile(AGRICOLA,welcomeMessage) {} set profile(AGRICOLA,windowNumber) 2 set profile(AULS,authentication) {} diff --git a/configure.in b/configure.in index 8dde199..f6a6e87 100644 --- a/configure.in +++ b/configure.in @@ -1,7 +1,7 @@ dnl IR toolkit for tcl/tk dnl (c) Index Data 1996-1998 dnl See the file LICENSE for details. -dnl $Id: configure.in,v 1.22 1998-01-16 09:24:17 adam Exp $ +dnl $Id: configure.in,v 1.23 1998-01-16 11:01:17 adam Exp $ AC_INIT(ir-tcl.h) CC=${CC-cc} dnl ------ Substitutions @@ -27,11 +27,17 @@ dnl ------ Preliminary settings AC_PROG_INSTALL AC_PREFIX_PROGRAM(tclsh) if test "x$prefix" = xNONE; then + AC_PREFIX_PROGRAM(tclsh8.1) +fi +if test "x$prefix" = xNONE; then AC_PREFIX_PROGRAM(tclsh8.0) fi if test "x$prefix" = xNONE; then AC_PREFIX_PROGRAM(tclsh7.6) fi +if test "x$prefix" = xNONE; then + AC_PREFIX_PROGRAM(tclsh7.5) +fi AC_STDC_HEADERS if test "$ac_cv_header_stdc" = no; then AC_MSG_WARN(Your system doesn't seem to support ANSI C) @@ -42,7 +48,7 @@ dnl AC_MSG_CHECKING(for YAZ directory) AC_ARG_WITH(yazdir,[ --with-yazdir Yaz directory], [YAZDIR=$withval]) if test "$YAZDIR" = "yes"; then - YAZDIR="../yaz-1.2" + YAZDIR="../yaz-1.4" elif test "$YAZDIR" = ""; then YAZDIR=../yaz for i in ../yaz* ../yaz; do diff --git a/doc/ir-tcl.sgml b/doc/ir-tcl.sgml index 7a71169..2114ee3 100644 --- a/doc/ir-tcl.sgml +++ b/doc/ir-tcl.sgml @@ -1,14 +1,14 @@
IrTcl 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"></tt> -<date>$Revision: 1.24 $ +<date>$Revision: 1.25 $ <abstract> This document describes IrTcl -- an information retrieval toolkit for Tcl and Tk that provides access to the Z39.50/SR protocol. @@ -36,9 +36,10 @@ However, the mOSI transport is only an option, and hence it is not needed unless you wish to communicate within an OSI environment. See [ref 2] for more information about the XTI/mOSI implementation. -<sf/IrTcl/ is implemented as a <it/dynamic/ library (DLL) which is -dynamically loaded by using the <tt/load/ command. However, <sf/IrTcl/ -may also be compiled as a traditional <it/static/ library as well. +<sf/IrTcl/ is normally implemented as a <it/dynamic/ library (DLL) +which is dynamically loaded by using the Tcl command <tt/load/. +However, <sf/IrTcl/ can be compiled as a traditional <it/static/ +library as well. <sect>Compilation and installation @@ -47,7 +48,7 @@ In order to compile you need: <itemize> <item> An ANSI C compiler such as GNU C. <item> <htmlurl url="http://sunscript.sun.com/TclTkCore/" name="Tcl">. - Version 7.X and 8.0 has been tested. + Version 7.5, 7.6 and 8.0 has been tested. <item> <htmlurl url="http://www.indexdata.dk/yaz.html" name="YAZ"> version 1.4 or higher. </itemize> @@ -55,11 +56,11 @@ In order to compile you need: As an option you may want: <itemize> <item> <htmlurl url="http://sunscript.sun.com/TclTkCore/" name="Tk">. -Version 3.6, 4.X and 8.0 has been tested. +Version 4.1, 4.2 and 8.0 has been tested. <item> XTI/mOSI </itemize> -Unpack the <sf/IrTcl/ package at the same directory level as <bf/YAZ/. +Unpack the <sf/IrTcl/ package at the same directory level as <bf/YAZ/. Type: <tscreen><verb> @@ -69,11 +70,22 @@ $ ./configure This command tries to configure <sf/IrTcl/ for your system and creates a <tt>Makefile</tt>. -If the <tt>configure</tt> command cannot locate Tcl and Tk in your standard -locations for libraries searched by your C compiler it will guess -that the libraries are located in <tt>/usr/local/lib</tt> and that -the header files are located in <tt>/usr/local/include</tt>. -If this is incorrect you will have to modify the <tt>Makefile</tt> yourself. +The <tt>configure</tt> command tries to locate the file <tt/tclConfig.sh/ +which should be generated by Tcl's installation script. Configure +looks for your Tcl shell in order to locate this file. For example +if <tt/tclsh/ is located in <tt>/home/joe/bin</tt>, configure will +assume that <tt>tclConfig.sh</tt> is installed in <tt>/home/joe/lib</tt>, +in which case the prefix is <tt>/home/joe</tt>. If you have +more than one Tcl version installed on your system, or if configure +cannot find the Tcl shell in your path, you can specify the prefix +by adding <tt>--prefix=</tt>prefix to the configure command, i.e. +<tscreen><verb> +$ ./configure --prefix=/home/joe +</verb></tscreen> + +The prefix is also used to determine where <sf/IrTcl/ is installed. +The <sf/IrTcl/ executables are installed in prefix/bin and libraries +and support files are installed in prefix/irtcl. Compile <sf/IrTcl/ by typing: <tscreen><verb> @@ -85,7 +97,7 @@ will create the shared library, <tt/irtcl.so/, as well as the normal static library, <tt/libirtcl.a/. For Tcl versions that doesn't support dynamic libraries the -command will create two shells will build-in <sf/IrTcl/ support -- +make command will create two shells will build-in <sf/IrTcl/ support -- a Tcl shell called <tt/ir-tcl/ and a Tcl/Tk shell called <tt/ir-tk/. The traditional static library, <tt/libirtcl.a/, is build as well. @@ -173,8 +185,9 @@ and the dynamic version goes like: <p> If your Tcl/Tk supports dynamic libraries you can use the -<tt/load/ command as described in the previous section. If not, -you must use the <tt>ir-tk</tt> shell that acts as <tt>wish</tt> +<tt/load/ command from within <tt/wish/ as described in the previous +section. +If not, you must use the <tt>ir-tk</tt> shell that acts as <tt>wish</tt> except that it includes the <sf/IrTcl/ commands. The enclosed script <tt>client.tcl</tt> is a graphical client @@ -1120,7 +1133,7 @@ consists of 5 elements: <bf/Example/ -Consider the GRS-1 record below as shown by the Yaz client program: +Consider the GRS-1 record below as shown by the <bf/YAZ/ client program: <tscreen><verb> (1,1) OID: GILS-schema -- 1.7.10.4