1How to install Tklib
2=====================
3
4Introduction
5------------
6
7The tklib distribution, whether a snapshot directly from CVS, or
8officially released, offers a single method for installing tklib,
9based on Tcl itself.
10
11This is based on the assumption that for tklib to be of use Tcl has
12to be present, and therefore can be used.
13
14This single method however can be used in a variety of ways.
15
160	For an unwrapped (= directory) distribution or CVS snapshot
17
18	a.	either call the application 'installer.tcl' directly,
19	b	or use
20
21			% configure ; make install
22
23		The latter is provided for people which are used to
24		this method and more comfortable with it. In end this
25		boils down into a call of 'installer.tcl' too.
26
271.	A starpack distribution (window-only) is a self-extracting
28	installer which internally uses the aforementioned installer.
29
302.	A starkit distribution is very much like a starpack, but
31	required an external interpreyter to run. This can be any tcl
32	interpreter which has all the packages to support starkits
33	(tclvfs, memchan, trf).
34
353.	A distribution in a tarball has to be unpacked first, then any
36	of the methods described in (0) can be used.
37
38
39Usage of the installer
40----------------------
41
42The installer selects automatically either a gui based mode, or a
43command line based mode. If the package Tk is present and can be
44loaded, then the GUI mode is entered, else the system falls back to
45the command line.
46
47Note that it is possible to specify options on the command line even
48if the installer ultimatively selects a gui mode. In that case the
49hardwired defaults and the options determine the data presented to the
50user for editing.
51
52Command line help can be asked for by using the option -help when
53running the installer (3) or the distribution itself in the case of
54(1) or (2).
55
56The installer will select a number of defaults for the locations of
57packages, examples, and documentation, and also the format of the
58documentation. The user can overide these defaults in the GUI, or by
59specifying additional options.
60
61The defaults depend on the platform detected (unix/windows) and the
62executable used to run the installer. In the case of a starpack
63distribution (1) this means that _no defaults_ are possible for the
64various locations as the executable is part of the distribution and
65has no knowledge of its environment.
66
67In all other cases the intepreter executable is outside of the
68distribution, which means that its location can be used to determine
69sensible defaults.
70
71Notes
72-----
73
74The installer will overwrite an existing installation of tklib 0.2
75without asking back after the initial confirmation is given. And if
76the user chooses the same directory as for tklib 0.1, or 0.0, etc.
77then the installer will overwrite that too.
78