README.bin
1README.txt: Togl
2
3 This is a Togl 2.X binary distribution for both users and developers.
4 It is specific to a particular operating system (e.g., Windows, Mac
5 OS X, Linux, etc.). Since the C ABI should be same for all compilers
6 on the same system, using Togl via the Tcl interface should work
7 regardless of which compiler Tcl was compiled with.
8
9 The files are named:
10
11 ToglTOGL_VERSION-TCL_VERSION-OS.SUFFIX
12
13 For example, TOGL_VERSION=2.0, TCL_VERSION=8.4, OS=Linux,
14 and SUFFIX=.tar.gz gives:
15
16 Togl2.0-8.4-Linux.tar.gz
17
18 Togl is also available at:
19 http://sourceforge.net/projects/togl/
20
21 You can get any release of Togl from the file distributions
22 link at the above URL.
23
24 A copy of the online documentation is in the doc directory.
25
26For users:
27
28 Only the lib/Togl2.X directory (and its contents) need to be installed
29 in your Tcl library. Execute the following Tcl script to find the
30 directories Tcl looks for packages in:
31
32 puts $tcl_libPath
33
34 and then copy the lib/Togl2.X directory into one of those directories.
35
36For developers:
37
38 The lib/Togl2.X directory (and its contents) is all that needs to be
39 redistributed in your application distribution.
40
41 If you wish to link with Togl, then you will need the include files
42 and a link library for your compiler. The compilers used are (OS-
43 WINDOWING_SYSTEM):
44
45 MacOSX: gcc 4.0.1, Mac OS X 10.4, ppc/i386
46 Linux: gcc 3.3.6, Red Hat 7.1, i386
47 Linux64: gcc 4.2.3 -Wl,--hash-style=both, Red Hat Server 5.1, x86_64
48 Windows: Microsoft Visual Studio .NET 2003, Windows XP SP2, i386
49
50File hierarchy:
51
52 README.txt this file
53 bin/ unused (empty)
54 lib/
55 Togl2.X/ Tcl package (place on Tcl's autopath)
56 LICENSE redistribution license
57 pkgIndex.tcl Tcl package index
58 Togl2X.dll Windows Tcl package binary
59 Toglstub2X.a Windows gcc/mingw link library
60 Toglstub2X.lib Windows Visual Studio link library
61 libToglstub2X.a UNIX (Linux, IRIX, etc.) link library
62 include/
63 togl.h Main header file, includes others
64 toglDecls.h API function declarations
65 togl_ws.h Which windowing system togl was compiled with
66 doc/ Documentation
67 *.html Start with index.html
68
69The contents of the include and lib directories can be placed verbatim
70in the Tcl installataion hierachy.
71
72Documentation is in the doc directory. Start with doc/index.html in
73your web browser.
74
README.stubs
1This version of Togl is entirely free from
2dependencies on Tcl/Tk's internal functions. It uses the public stubs
3interface, witch means that the same binary works with any stubs-aware
4wish (i.e. version >= 8.1)
5
6It has been tested on Windows NT/2000 and Linux for several Tcl/Tk versions up
7to 8.4a3. I haven't been able to test the Mac port, it propably needs mending
8but I can't see why it shouldn't work in principle.
9
10Implementation wise, what differs from Togl 1.5 is that Togl_MakeWindowExist()
11is replaced by Togl_CreateWindow(), a function that gets registered in Tk as a callback for window creation. In Tk/Tk 8.4a3, there is a new public API call
12Tk_SetClassProcs() to register this callback, but for earlier versions of Tk
13one needs to do this using some pointer magic.
14There is a run-time check to determine which method to use, hence the
15same binary runs on all versions of Wish from 8.1 and up. For this to
16work you need to compile against the headers from Tcl/Tk 8.4a3 or later, or
17the binary will only work for Tcl/Tk 8.1-8.4a2.
18The tk8.4a3 public headers (tk8.4a3.h + tkDecls.h) are included for
19conveniance, and they are used if the flag -DUSE_LOCAL_TK_H is specified.
20
21Jonas Beskow, December 2001