New define: IR_TCL_VERSION.
[ir-tcl-moved-to-github.git] / README
1  
2  * Copyright (C) 1995, Index Data.
3  * See the file LICENSE for details.
4  * Sebastian Hammer, Adam Dickmeiss
5
6 $Revision: 1.4 $
7
8 Quick notes about IrTcl. 
9
10 Prerequisites
11 -------------
12
13 In order to compile you need:
14    
15   o  An ANSI-C compiler such as GNU C
16   o  Tcl version 7.3
17   o  YAZ version 0.2 beta or higher
18
19 You may also need:
20
21   o  Tk version 3.6 
22   o  The XTI/mosi package
23
24 Compilation
25 -----------
26
27    Compile/install yaz/tcl, etc.
28
29    Edit Makefile (in current directory)
30    Set MOSI to 1/0
31    Define include directory paths and libraries
32
33    Type 'make ir-tcl' to make the Tcl version or IrTcl.
34    Type 'make ir-tk' to make the Tk version of IrTcl.
35
36 Install/run
37 -----------
38
39    The resulting files are:
40      ir-tcl               Tcl version of IrTcl
41      ir-tk                Tk version of IrTcl.
42                               Options:
43                               -file <tclfile>
44                                  Tcl startup script. Default is client.tcl.
45                               -geometry <spec>
46                                  X11 geometry of main window.
47                               -display <spec>
48                                  X11 display.
49                               -name <name>
50                                  Name of top window.
51                               -logLevel <logLevel>
52                                  log level. (fatal, debug, warn, log, all).
53                               -logFile <fname>
54                                  log file. If omitted stderr is used.
55      formats/*.tcl        Small IrTcl scripts to display
56                           records in different formats.
57      client.tcl           Tk graphical client - normally
58                           executed by ir-tk.
59      clientrc.tcl         Startup script - read by client.tcl - holds
60                           user/target definitions.
61      clientg.tcl          User preferrences - read by client.tcl. 
62                           Holds geometry of windows, current display 
63                           format, and hot targets.
64      book[1-9]            book logo.
65      LICENSE              License info - read by client.tcl.
66
67    Type 'ir-tk' to run the Tk graphical client - client.tcl,
68    clientrc.tcl, book[1-9] and formats/*.tcl should exist!
69
70    Type 'ir-tcl' to run the Tcl client. Very similar to tclsh.
71
72