/*
 * Author:      William Chia-Wei Cheng (bill.cheng@acm.org)
 *
 * @(#)$Header: /mm/src/tgif/v4/tgifcal/RCS/README,v 1.1 1999/03/09 19:49:06 william Exp $
 */

This is the ``tgifcal'' README file.  This file assumes tgifcal-1.0.1.
If you have a different version, simply replace "tgifcal-1.0.1" with
the appropriate string.

Tgifcal calls the UNIX calender program, "cal", combine it with a GIF or
a JPEG image and generate a tgif .obj file.

1) Tgifcal is meant to be compiled against the source code of tgif-4.1.1
   or a newer version of tgif.

   For example, if you have tgif-4.1.1 and if the source code of tgif-4.1.1
   is in ~/src/tgif/tgif-4.1.1, do:

	cd ~/src/tgif/tgif-4.1.1
	gunzip -c tgifcal-1.0.1.tar.gz | tar xvf -
	make	(<-- must build tgif first)
	cd tgifcal-1.0.1

   If you don't have tgif, please download tgif source from tgif's download
   link mentioned below.

2) Tgif resources:

                    Home Page: http://bourbon.cs.umd.edu:8001/tgif/
                          FAQ: http://bourbon.cs.umd.edu:8001/tgif/faq/
   Current Release & Download: http://bourbon.cs.umd.edu:8001/tgif/current.html
         Join to Mailing List: kragen-tgif-subscribe@kragen.dnaco.net
                 Mailing List: kragen-tgif@kragen.dnaco.net
          Bug Reports Send To: bill.cheng@acm.org

3) Please copy Tgifcal.tmpl-PLATFORM to Tgifcal.tmpl (where PLATFORM
   depends on the platform you are on).  For example, if you are on a
   Solaris platform, do:

	rm Tgifcal.tmpl
	cp Tgifcal.tmpl-solaris Tgifcal.tmpl

   The default Tgifcal.tmpl is identical to Tgifcal.tmpl-linux.  There's
   only a few Tgifcal.tmpl-* files in the current release of tgifcal.
   More will be added when they become available.  I only have access to
   limited number of platforms, so if you don't find your platform listed,
   please ask a local expert to modify Tgifcal.tmpl and send a working
   version to me so I can create new Tgifcal.tmpl-* files.

4) Modify the MOREDEFINES line at the beginning of Tgifcal.tmpl.

5) Do the following (this is the preferred way of building tgifcal),

	xmkmf
	make depend
	make

   If you have imake but, for some reason, don't have xmkmf, do the following,
   (note that the config directory should be set to wherever you can find
   Imake.tmpl)

	imake -DUseInstalled -I/usr/local/libdata/X11/config
	make depend
	make

6) Make sure that you have the following entries in your X default file:

	Tgif.MaxImportFilters: 4
	Tgif.ImportFilter0:    GIF-dither gif giftopnm %s | ppmdither | ppmtoxpm
	Tgif.ImportFilter1:    GIF gif giftopnm %s | ppmquant 222 | ppmtoxpm
	Tgif.ImportFilter2:    JPEG-dither jpg;jpeg \n\
                               djpeg -gif %s | giftopnm | ppmdither | ppmtoxpm
	Tgif.ImportFilter3:    JPEG jpg;jpeg \n\
                               djpeg -gif -colors 222 %s | giftopnm | ppmtoxpm

   Tgifcal uses the "GIF" and the "JPEG" entries in the above X defaults.

   Giftopnm, ppmdither, ppmquant, and ppmtoxpm are from the netpbm package.
   Djpeg is part of the jpeg package.  If you don't have them, please see
   tgif's home page at <URL:http://bourbon.cs.umd.edu:8001/tgif/> regarding
   where to obtain them.

7) To generate a calendar page for February, 1999, do:

	./tgifcal 2 1999 \
        http://bourbon.cs.umd.edu:8001/images/bruin-football.gif > feb1999.obj

   This will create feb1999.obj.  Then you can view it with:

	../tgif feb1999

   If you want to generate PostScript file directly, you can do:

	./tgifcal -ps 2 1999 \
        http://bourbon.cs.umd.edu:8001/images/bruin-football.gif > feb1999.ps