1/*
2 * Author:	William Chia-Wei Cheng (bill.cheng@acm.org)
3 *
4 * @(#)$Header: /mm2/home/cvs/bc-src/tgif/README,v 1.7 2009/10/04 03:02:48 william Exp $
5 */
6
7This is the ``tgif'' README file.  Tgif is pronounced, "T-G-I-F".
8
9Tgif is an Xlib base 2-D drawing facility under X11.
10
111) Please read the "Copyright" file in this distribution for the copyright
12   and licensing information.
13
14   Please note that starting from tgif-4.1.41, an Open Sourced version of
15   tgif is simulatneously released under the Q Public License.  For every
16   tgif-x.y.z release, a corresponding tgif-QPL-x.y.z is also release.
17   Therefore, if you want to use an Open Sourced version of tgif, please
18   look for the tgif-QPL releases.
19
202) Tgif resources:
21
22                    Home Page: http://bourbon.cs.umd.edu:8001/tgif/
23                          FAQ: http://bourbon.cs.umd.edu:8001/tgif/faq/
24   Current Release & Download: http://bourbon.cs.umd.edu:8001/tgif/current.html
25         Join to Mailing List: tgif4-announce-subscribe@yahoogroups.com
26                 Mailing List: tgif4-announce@yahoogroups.com
27          Bug Reports Send To: bill.cheng@acm.org
28
293) Please read tgif.man, the man pages that comes with the distribution.
30	nroff -t -man tgif.man | more	<== to view
31	psroff -man tgif.man		<== to print
32
334) If you want to use imake, you can copy Tgif.tmpl-PLATFORM to Tgif.tmpl
34   (where PLATFORM depends on the platform you are on).  The default Tgif.tmpl
35   is identical to Tgif.tmpl-linux.  There's only a few Tgif.tmpl-* files in
36   the current release of tgif.  More will be added when they become available.
37   I only have access to limited number of platforms, so if you don't find your
38   platform listed, please ask a local expert to modify Tgif.tmpl and send a
39   working version to me so I can create new Tgif.tmpl-* files.
40
415) Modify the DEFINES line at the beginning of Tgif.tmpl or Makefile.noimake
42   (see "Things to try..." in the Tgif.tmpl for examples).  Please do not
43   change -DTELEPORT_ATTR=\"warp_to=\", -DLAUNCH_ATTR=\"launch=\", or
44   -DEXEC_ATTR=\"exec=\".
45
46   If you plan to do a "make install" and you don't have root privileges,
47   please uncomment (by remove XCOMM) BINDIR, MANPATH, and the second occurance
48   of TGIFDIR, and replace "/u/halfmoon" with your target directory (such as
49   "/home/yourlogin").
50
516) If you have imake and xmkmf, do the following (this is the preferred way
52   of building tgif),
53	xmkmf
54	make tgif
55	make install
56
57   If you don't have imake, just do the following,
58	cp Makefile.noimake Makefile
59	make tgif
60
61   If you have imake but don't have xmkmf, do the following,
62		(note that the config directory should be set to
63		wherever you can find Imake.tmpl)
64	imake -DUseInstalled -I/usr/local/libdata/X11/config
65	make tgif
66	make install
67
687) If you do not have imake or xmkmf, please try the following (you can
69   change "/usr" to a top-level directory where you would like tgif to be
70   installed, e.g., "${HOME}"; this will cause tgif to be installed in
71   ${HOME}/bin and other data files to be installed in ${HOME}/lib/X11/tgif):
72	./configure --prefix=/usr
73	make
74	make install
75
76   If "make" does not work, it may be due to platform-specific
77   problems, please do the following for specified platforms:
78
79	Mac OS X: append "-D__DARWIN__ -D_NO_DL_SUPPORT" after
80			"-DUSE_XT_INITIALIZE" in Makefile
81
82   Afterwards, please try the following:
83	make clean
84	make
85	make install
86
878) If your <Meta> key does not work on a HP-UX machine, try doing the following
88   (<Meta> is also labeled <Alt> on some keyboards):
89
90	xmodmap -e "clear mod1"
91	xmodmap -e "add mod1 = Meta_L Meta_R"
92
939) Please also note that tgif has nothing to do with GIF files/formats.
94