From c594394608a2d72bd7b73dfa20bbe5cde7187637 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Fri, 10 Dec 1999 10:36:13 +0000 Subject: [PATCH] Updated doc about WIN32. --- doc/ir-tcl.sgml | 63 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 48 insertions(+), 15 deletions(-) diff --git a/doc/ir-tcl.sgml b/doc/ir-tcl.sgml index 0c4e52b..4cdde11 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.30 $ +<date>$Revision: 1.31 $ <abstract> This document describes IrTcl -- an information retrieval toolkit for Tcl and Tk that provides access to the Z39.50/SR protocol. @@ -36,7 +36,7 @@ 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 usually build as a <it/dynamic/ library (Windows) +<sf/IrTcl/ is usually build as a <it/dynamic/ library (WIN32) or shared Object (Unix) which is dynamically loaded by using the Tcl's <tt/load/ command. However, <sf/IrTcl/ can be compiled as a traditional <it/static/ library as well. @@ -44,11 +44,13 @@ traditional <it/static/ library as well. <sect>Compilation and installation <p> -In order to compile you need: +<sect1>UNIX +<p> +In order to compile the software on UNIX you need: <itemize> <item> An ANSI C compiler such as GNU C. <item> <htmlurl url="http://www.scriptics.com" name="Tcl">. - Version 7.5, 7.6 and 8.0 has been tested. + Version 8.0 and 8.2 has been tested. <item> <htmlurl url="http://www.indexdata.dk/yaz/" name="YAZ"> version 1.5 or higher. </itemize> @@ -56,7 +58,7 @@ In order to compile you need: As an option you may want: <itemize> <item> <htmlurl url="http://www.scriptics.com" name="Tk">. -Version 4.1, 4.2 and 8.0 has been tested. +Version 8.0 and 8.2 has been tested. <item> XTI/mOSI </itemize> @@ -72,18 +74,17 @@ a <tt>Makefile</tt>. 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 +looks for ther Tcl shell on your system 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. +cannot find the <tt/tclConfig.sh/, you can specify in which directory +it is, by supplying option <tt>--with-tclconfig</tt> - for example: <tscreen><verb> -$ ./configure --prefix=/home/joe +$ ./configure --with-tclconfig=/home/joe/lib </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. @@ -160,8 +161,6 @@ This file is only generated when using newer versions of Tcl/Tk. in <tt>IRTCLDIR</tt> -- defaults to <tt>/usr/local/lib/irtcl</tt>. </descrip> -<sect1>Using Tcl - <p> Basic Tcl is handled by the program <tt/tclsh/. The script must use the <tt/load/ command to load the <sf/IrTcl/ dynamic @@ -181,6 +180,40 @@ and the dynamic version goes like: % </verb></tscreen> +<sect1>WIN32 +<p> + +<sf/IrTcl/ is shipped with a "makefile" for the NMAKE tool that comes +with Visual C++. + +Start an MS-DOS prompt and switch the sub directory <tt>WIN</tt> where +the file <tt>makefile</tt> is located. Customize the installation +by editing the <tt>makefile</tt> file (for example by using wordpad). + +The following summarises the most important settings in that +file. + +<descrip> +<tag><tt>YAZDIR</tt></tag> Specifies where YAZ is located. +<tag><tt>DEBUG</tt></tag> If set to 1, the software is +compiled with debugging libraries. If set to 0, the software +is compiled with release (non-debugging) libraries. +</descrip> + +When satisfied with the settings in the makefile type +<tscreen><verb> +nmake +</verb></tscreen> + +If compilation was successful the executables <tt>irtcl.dll</tt> +is put in directory <tt>BIN</tt>. + +To start the test client that comes with <sf/IrTcl/ make sure +both <tt/YAZ.DLL/ and <tt/IRTCL.DLL/ are in current directory +or in your PATH. Go to the top-level directory of <sf/IrTcl/ +and type "wish -f client.tcl". You might want to make a +short-cut to start this. + <sect1>Using Tk <p> @@ -1404,7 +1437,7 @@ been created. <sect>License <p> -Copyright © 1995-1998, Index Data. +Copyright © 1995-1999, 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, -- 1.7.10.4