Frequently asked questions about the INSTALLATION of XF:

Index:
======

I-1) What do I need for running XF ?
I-2) How do I install XF ?
I-3) How do I install the XF help system ?
I-4) Why does the installation not work on my machine ?
I-5) What to do when I get something like:
      I could not find: ^[    ]+pathName[     ]+deactivate
I-6) What to do when I get empty help pages ?
I-7) What to do when I get wrong help pages ?

I-8) Do I need shape ?
I-9) What is shape needed for ?
I-10) Where can I get shape ?
I-11) Do I need edge ?
I-12) What is edge needed for ?
I-13) Where can I get edge ?
I-14) Where do I get the widget XXX ?

Questions/Answers:
==================

I-1) What do I need for running XF ?
        You need Tk 2.3 or later. Make sure that you have
	installed the manual pages of Tcl/Tk in a location
	that can be found by man(1). The installation
	procedure expects the manual pages in the standard
	Tk distribution pathnames. The installation procedure
	expects Tk 3.2 or Tk 3.3 manual pages. Sorry, but
	keeping the parsing routines compatible to all
	versions is too hard.


I-2) How do I install XF ?
        To install the program, create a path where the
        library files are to be placed (almost everything in
        this distribution belongs to the class "library
        files" :-). Go into this directory and unpack the
        distribution tar file. This tar file contains the
        complete XF distribution in a subdirectory named
        "xf/...". When the files are unpacked, you have to
        configure the Makefile. The Makefile contains some
        file and path names that must correspond to your
        system.

        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 pathnames) should be configured by the user. It
        is necessary that the user has writing permission to
        some files and path names.


I-3) How do I install the XF help system ?

        To install the help system, it is necessary that the
        manual pages for Tcl and Tk are installed (Tk 3.1
        manual pages). The four shell-scripts
        ./xfhelp/make{Add,Tcl,Tk,Widgets} will extract the
        needed parts from the manual pages. By default the
        manualpages 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 Help


I-4) Why does the installation not work on my machine ?
        You should first check if you have writing
        permission to the directories that you have
        specified as target directories in the Makefile
        (something like /usr/local/bin/X11,
        /usr/local/lib/X11/app-defaults,
        /usr/local/man/mann etc.).


I-5) What to do when I get something like:
     I could not find: ^[    ]+pathName[     ]+deactivate
        You should first check if you have installed the
        latest manual pages. The installation procedure
        tells you which Tk version is required.

        On some machines (troff), the formatting of the
        manual pages may differ from the formatting that I
        get with my groff. In this case, try to modify the
        grep command in ./xfhelp/make{Add,Tcl,Tk,Widgets}.

        Another reason for this error may be that the manual
        pages from Tcl/Tk are not installed in a manual
        section where they can be found. In this case,
        change the Makefile or the shell-scripts
        ./xfhelp/make{Add,Tcl,Tk,Widgets}.


I-6) What to do when I get empty help pages ?
        The installation of the help pages requires access
        to the Tcl and Tk manual pages via man(1). The
        program col(1) is used to remove backspacing codes
        from the manual page. The current call to col(1) is:

               col -b -x
  
        It may be necessary to change this call to col(1)
        for your local machine (in the makefile or in the
        files ./xfhelp/make{Add,Tcl,Tk,Widgets}).


I-7) What to do when I get wrong help pages ?
        There is probably a name collision with other manual
        pages.  This would require a change in the help page
        creation programs (See I-3).




I-8) Do I need shape ?
        No. The shapeToolkit is not needed for the
        installation. You can use it in XF to store
        procedures in a version database instead of storing
        them into standard UNIX files. But this is only a
        feature, not a requirement.


I-9) What is shape needed for ?
        The shape toolkit is used for the version control of
        procedures, and for version control of source
        modules. 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 :-).


I-10) Where can I get shape ?
	Shape is available at:
		coma.cs.tu-berlin.de (pub/shapeTools/), and on
		gatekeeper.dec.com (pub/plan/shape)


I-11) Do I need edge ?
	No. Edge is a tool to display graphs. It is only
	used as an additional feature.


I-12) What is edge needed for ?
	The edge system is used to display the widget tree
	as a graph. This graph is only used for
	visualisation. No interaction is possible.


I-13) Where can I get edge ?
	Edge is available at:
		coma.cs.tu-berlin.de (pub/edge/), and on
		iraun1.ira.uka.de (pub/graphic/)


I-14) Where do I get the widget XXX ?
	Generally barkley.berkeley.edu is a good place to
	look for it. The following list is not complete, but
	it directs you to the sites for the widgets that are
	supported by the distribution:

	- xygraph, barchart and hypertext
		ecn.purdue.edu:		pub/tcl/contrib/extensions
		ftp.ibp.fr:		pub/tcl/contrib/extensions
		barkley.berkeley.edu:	tcl/extensions/
		nic.funet.fi:		pub/languages/tcl/extensions/
		coma.cs.tu-berlin.de:	pub/tcl/

	- photo
		ecn.purdue.edu:		pub/tcl/contrib/extensions
		ftp.ibp.fr:		pub/tcl/contrib/extensions
		barkley.berkeley.edu:	tcl/extensions/
		nic.funet.fi:		pub/languages/tcl/extensions/
		coma.cs.tu-berlin.de:	pub/tcl/

	- bargraph, dial, pie and stripchart
		ftphost.comp.vuw.ac.nz: 
		coma.cs.tu-berlin.de:	pub/tcl/vuw_meters_widgets.tar.Z

	- TkEmacs
		ecn.purdue.edu:		pub/tcl/contrib/extensions
		ftp.ibp.fr:		pub/tcl/contrib/extensions
		barkley.berkeley.edu:	tcl/extensions/
		nic.funet.fi:		pub/languages/tcl/extensions/
		coma.cs.tu-berlin.de:	pub/tcl/

	- TkPixmap (no widget, but color pixmaps for Tk)
		ecn.purdue.edu:		pub/tcl/contrib/extensions
		ftp.ibp.fr:		pub/tcl/contrib/extensions
		barkley.berkeley.edu:	tcl/extensions/
		nic.funet.fi:		pub/languages/tcl/extensions/
		coma.cs.tu-berlin.de:	pub/tcl/


