INSTALLING XF

Requirements:
-------------
This program is written for Tk 2.3, Tk 3.0, Tk 3.1 and Tk
3.2. So you need this package, especially the wish
interpreter. The support for Tk 2.3 may be not complete at
some points.  Testing is mainly done with Tk 3.2.

The manual page was written for groff. With another troff I
got terrible output, but that was probably an exotic one
:-).

Installation:
-------------
Please unpack the XF distribution inside the directory where
XF should be "officially" located (i.e. /usr/local/lib, or
any other directory). The compressed tar file contains a
directory tree named "xf2.2/...". The installation procedure
will not copy the XF files to another location. When the
distribution is unpacked, you have to configure the
Makefile. The Makefile contains some file and path names
that must correspond to your system. You only have to adapt
the Makefile at the top of the distribution directory tree.

Now you can type:

	make install

with a running X11 server. During the installation, the
installation procedure needs access to the program
"xlsfonts" (part of the X11 core distribution). It is also
necessary that it finds:

	"rgb.txt" (usually under /usr/lib/X11/),
	"cursorfont.h" (usually under /usr/include/X11/) and
	"keysymdef.h" (usually under /usr/include/X11/)

at the locations configured via the Makefile. Once the
various files (./lib/Colors etc.) have been created from
these files, you can modify the created files as you need
them (sorting, removing of uninteresting items, etc.).

The default parameter settings (especially the file and
path names) should be configured by the user. It is necessary
that the user has writing permission to some
files and path names.

Installing the help pages:
--------------------------
To install the help system, it is necessary that the manual
pages for Tcl and Tk are installed. The four shell-scripts
./xfhelp/make{Add,Tcl,Tk,Widgets}?.? will extract the needed
parts from the manual pages. By default the manual pages are
searched in the locations defined in the Makefiles for
Tcl/Tk. You can change this in the Makefile, if you have
different locations for your manual pages. It may also be
necessary to adapt the shell-scripts that do the extraction
(the section of the manuals, the col command etc.).

makeAdd?.?	- extracts manual pages for additional
		  widgets, if they are installed, 
makeTcl?.? 	- extracts and splits the manual page of the
		  tcl language,
makeTk?.?	- extracts the manual pages of the tk commands
		  (except the widget commands), 
makeWidgets?.? 	- extracts and splits the manual pages of the
		  different standard widgets.

Now you can type:

make Help3.2

or:

make Help3.3

that depends on the version of the installed manual pages.

Using:
------
Before you start XF 2.2, please remove your local XF 1.4
configuration file (~/.xf-config). It may also be necessary
to remove the other local configuration files (menubar, and
iconbar definitions). This is important !!!

If you start XF, you get a normal wish window and the main
editing window of XF. (And the quest begins....:-)

If you have any problems, call the help facility of XF,
and/or read the FAQ's. Under General (Hints) you will find
some features and hints that will make life with XF much
easier.

If there occur errors during the work with XF that are
producing output to stderr, these errors are mirrored to the
file xferrors in the XF tmp directory. If you can say that
they are caused by XF or you are not sure, please send me
the file so that I can locate the problem.

To use the version control for procedures, you will need the
shape toolkit. The shape toolkit is a collection of programs
to support software configuration management in a UNIX
environment. It consists of a set of version and attribute
control commands and a building tool ("shape"). It should be
installed on every "good" system :-). Shape is available at
coma.cs.tu-berlin.de. 

Bugs:
-----
- still in development (introducing new errors :-)


