Xslideshow README.euc   (Updated Feb 17 1997 by Susumu Shiohara)

-----------------------------------------------------------------
[Introduction]

	xslideshow is an image display program. It can display and
	animate an image on any workstation screen running X server.
	xslideshow requires both Xt and X11(R4 or R5 or R6) libraries,
	and at least 8 bit pseudo-color device(256 color).

-----------------------------------------------------------------
[Summary]
	The main feature of xslideshow is an image animation.
	xslideshow switches the pictures with an image effect such as
	fade-in and fade-out.
	The animation options are the followings.

		slide,
		fade,
		flush,
		reverse,
		monotone,
		wipe,
		wipe24,
		block,
		block24,
		mosaic,
		shuffle,
		puzzle,
		slit,
		transparent,
		move,
		float24,
		coloranim1,
		coloranim2,

	Xslideshow supports to read GIF and JPEG image files.
	Xslideshow also supports to read Gif-Anim formatted gif file.

-----------------------------------------------------------------
[Compilation]
1. In case of having xmkmf
	Edit config.h to suit your environment.

	xmkmf -a
	make

	or

	xmkmf
	make depend
	make

2. In case of no imake
	cp Makefile.noimake Makefile
	Edit Makefile to suit your environment.
	make

-----------------------------------------------------------------
[Resource creation]
	cp Xslideshow.sample Xslideshow.ad
	Edit Xslideshow.ad to match your environment.

	ex.
	If you have a lot of image files in the /pub/images/misc and 
	/pub/images/anime directory, the edit Xslideshow.ad as shown
	bellow.

		Xslideshow*pathDir: /pub/images/misc \n\
							/pub/images/anime


-----------------------------------------------------------------
[Installation]
	Put xslideshow and xslideshow-control in your PATH directory.

	ex.
	/usr/local/bin/X11/xslideshow
	/usr/local/bin/X11/xslideshow-control

	Place Xslideshow.ad in the Application Resource PATH.
	The Application Resource PATH is defined by the environment
	variable called XAPPLRESDIR.

	ex.
	setenv XAPPLRESDIR /usr/local/app-defaults
	cp Xslideshow.ad /usr/local/app-defaults/Xslideshow

	or add the resource entry directly in your ~/.Xdefaults file.


-----------------------------------------------------------------
[Details]
	See xslideshow.man.


-----------------------------------------------------------------
[How to use the Xslideshow]
1) To display images
	xslideshow ~/tmp/picture/* -animate shuffle ....
		Specifies files ~/tmp/picture/*

	xslideshow -path ~/tmp/picture -animate wipe ....
		Specifies path directory ~/tmp/picture

	If no file or path is given, xslideshow searches file on the current
	dirctory.

	Xslideshow display the image on a Root Window with -root option.
	When xslideshow is invoked from Xscreensaver, specify -root.

2) To display a digital clock
	xslideshow -clock ....
		Display a digital clock
		Xslideshow works as a picture clock.

	You can specify the font name with -font option.

3) To display the file name
	xslideshow -fname ....
		Display the file name.
		With no clock, image size is displaied.

	You can specify the font name with -font option.

4) To enable Biff
	xslideshow -biff -mail_spool /usr/spool/mail ....
		Xslideshow inform you have new mail.

5) To do simple edit
	xslideshow -animate slide -dest /picture/misc -confirm -interval 0 ....

	This simple edit mode is avail with animation mode "slide".
	-confirm option enable to display the confirmation window.
	With -interval 0, Xslideshow does not change picture until
	any action is applied.

	The default key bind are show bellow.

	   Shift<Btn1Down>: tail_frame()\n\
	   Shift<Btn2Down>: stop()\n\
		    <Key>q: stop()\n\
		Ctrl<Key>c: stop()\n\
	   Shift<Btn3Down>: head_frame()\n\
		<Btn1Down>: next_frame()\n\
		    <Key>n: next_frame()\n\
		<Btn2Down>: pause_frame()\n\
		    <Key>s: pause_frame()\n\
		<Btn3Down>: prev_frame()\n\
		    <Key>p: prev_frame()\n\
		<Key>space: change_frame()\n\
		    <Key>r: resize()\n\
		    <Key>f: fit()\n\
		    <Key>h: right()\n\
		    <Key>l: left()\n\
		    <Key>j: up()\n\
		    <Key>k: down()\n\
		Ctrl<Key>x: remove()\n\
		    <Key>m: move()\n\

		n    : change next picture
		p    : change previous picture
		s    : pause display
		space: change picture

		Animation mode "slide" enable following actions.
		r    : display with original image size
		f    : diaplay with window size
		h,l,j,k: move the image in a window
		Ctrl + x: delete the image file
		m    : move the image file to the destination path directory

	This simple edit function is very useful to arrange the daily
	pictures.
 
6) To display with xslideshow-control
	It is useful to control xslideshow for the presentation.

	xslideshow -full -override ... 
	Xslideshow  display the window with nomatte, full size.

7) To study color reduction algorithms
	xslideshow -reduce dither ...
	xslideshow -reduce mediancut ...
	xslideshow -reduce quantize ...
	xslideshow -reduce nquant ...
	xslideshow -perfect ... (TrueColor only)

8) To study zooming algorithms
	xslideshow -zoom fast ...
	xslideshow -zoom slow ...

and so on.



-----------------------------------------------------------------
[Copyright]

See the provided Copyright file.


-----------------------------------------------------------------
[Environment]

xslideshow uses Athena widget. If you don't have Athena widget,
undefine DO_EDIT in config.h.

xslideshow-control uses Athena widget and I don't confirm if it is
able to compile on the X11R4 machine yet, because Athena widget on
the X11R4 is diffrent from the X11R5, and I don't have any X11R4
machine currently.

Fortunately xslideshow can work without xslideshow-control, so if you
have X11R4 machine and you can't compile it, don't worry about that.

Xslideshow-control also can work with Motif Library. If you have Motif
Library, define HAS_MOTIF in config.h.

Xslideshow was confirmed that it is able to compile and run on the
below machines. If you can compile and run on the other machine,
please inform me.


SONY NWS-3870 NEWS-OS 4.1R X11R4 PseuodoColor
SONY NWS-3870 NEWS-OS 4.2.1R X11R5 PseuodoColor
SONY NWS-5000 NEWS-OS 4.2.1R X11R5 PseuodoColor
SONY NWS-5000 NEWS-OS 6.x X11R5 PseuodoColor

NEC EWS4800/220(R3000) SVR4.0 Rel6.2 PseuodoColor
NEC EWS4800/330(R4000) SVR4.2 Rel7.2 PseuodoColor
NEC EWS4800/220 EWS-UX/V R6.3 PseuodoColor

HP9000/s400 HP-UX 8.00 X11R4 PseuodoColor
HP9000/s700 HP-UX 8.07 X11R4 PseuodoColor
HP9000/s700 HP-UX 9.01 X11R5 PseuodoColor
HP9000/s700 HP-UX 9.03 X11R5 PseuodoColor
HP9000/s300 HP-UX 8.00 X11R4 PseuodoColor

SUN  SparcStation2  SunOS4.1.3-JLE1.1.3 (MIT X11R5) PseuodoColor
SUN  SparcStation4  SunOS4.1.3 (MIT X11R5) PseuodoColor
SUN  SparcStation10 Solaris 2.3 (/usr/openwin/lib) PseuodoColor
SUN  SparcStationLX Solaris2.2J (/usr/openwin/lib) PseuodoColor
SUN  SparcStation20 Solaris 2.5 (/usr/openwin/lib) X11R6.1 TrueColor 24bit

PC intel CPU Unix/XFree86

Xslideshow also works with other X-Servers.
xwin32 on the Win3.1 WinNT3.51 WinNT4.0 Win95. PseudoColor/TrueColor
MIXServer5.5 on the WinNT3.51 WinNT4.0 PseudoColor/TrueColor


-----------------------------------------------------------------
[History]

Xslideshow version 3.1	Feb 17 1997
	Support to animate TrueColor-only-animation on the PseudoColorDisplay.
		Xslideshow uses a global color table and dithers the image
		automatically when it animates TrueColor-only-animation.
		Note: The image quality is not better than normal animation.

	Append new animate mode "float24".
	Delete an animation mode "move24".

	Modify the JPEG reading algorithm.
	Add and modify the color reduction algorithm.
		dither    : Oomoto's inteligent dithering algorithm
		mediancut : Heckbert's median cut algorithm
		quantize  : E. I. du Pont de Nemours & Company's quantize algorithm
		nquant    : Anthony Dekker's NeuQuant algorithm

	Add the new image zooming algorithm.
		fast : Jim Frost's zooming algorithm
		slow : zoom the image using Lagrange polynominals algorithm


Xslideshow version 3.0.6	Nov 21 1996
	No need to define LITTLE_ENDEAN.

	Support to read the progressive jpeg image.
	Support to read the gif sub image (Gif-Anim).
	Support to display under 24 bit depth TrueColor Display.
	Support xslideshow-control with Motif Widget .
		defines HAS_MOTIF in config.h

	Append new animate mode "slit".
	Append new animate mode "transparent" (TrueColor Only).

	Fix some animation bugs.

	Tune-up the whole sources and resources.

	Thank you so much for sending bug report and testing it
		Mr. Ichikawa <ichikawa@hv.epson.co.jp>
		Mr. Nakagawa <nakag@yk.rim.or.jp>
		Mr. Takayama <taka@magic.omiya.saitama.jp>


Xslideshow version 3.0.4	Oct 30 1996
	Change resource item's meaning.

		ex. private 
			old: use default colormap
			new: use private colormap and install it

			fadeTicks
			old: usleep((1000000/fadeTicks)) <- hard to understand
			new: usleep(fadeTicks)

			many other item's meaning has been changed.

	Rename resource file name XSlideshow -> Xslideshow

	Modify a get event function (myevent) to decrease network traffic.
	Append a sort function to sort file list alphabetical order when sequent is specified.
	Because opendir func does not read file names alphabetically.
	Thank you for giving above suggestions
		Mr. Andrea Marro <marro@teksid.com>

	Fix endean problem of jpeg2gimage.c when compiling on the Intel CPU machine.
	Thank you for sending bug report and test it.
		Mr. Ichikawa <ichikawa@hv.epson.co.jp>

	Fix an animation move24 bug.

Xslideshow version 3.0.3	Oct 25 1996
	Append animate mode "move24" (TrueColor Only).
		"move24" display and move plural pictures in a window.

	Fix endean problem (Intel CPU , TrueColor Display).
	Thank you for sending bug report
		Mr. Ichikawa <ichikawa@hv.epson.co.jp>
		Mr. Yamasita <yamasita@db.is.kyushu-u.ac.jp>

Xslideshow version 3.0.2	Oct 22 1996
	Append some functions in xslideshow-control.
		You can get file list from the running xslideshow.
		Also, you can select a file and set it to the current file in
		the xslideshow.

	Append animate mode "wipe24" (TrueColor Only).
		"wipe24" display a picture over a previous picture transparently.

	Implement faster jpg2gimage function than previous one.
	Thank you Mr. Ryuji Oomoto <oomoto@tpp.epson.co.jp>

	Fix a bug about actions.
	Fix a bug about the -root option. (Cause SIGBUS error)
	Thank you for sending bug report
		Mr. Nishimura <nishimu@sdd.siznes.nec.co.jp>
		Mr. Imai <kimai@av.crl.sony.co.jp> for debug xslideshow.
		Mr. Sakane <sakane@d4.bsd.nes.nec.co.jp> for debug xslideshow.
	Note: xslideshow-control does not work for RootWindow.


Xslideshow version 3.0.1	Oct 18 1996
	Fix a bug about the remote display connection.
		Note: Need a access permission to the remote display.
			  You should type on the remote display as shown bellow.
			  xhost +<your_host_name>

	Append animate mode "block24" (TrueColor Only).
		"block24" display a picture over a previous picture transparently.

Xslideshow version 3.0		Oct 16 1996
	Support TrueColor visual type (depth 24).
		TrueColor can animate except color animations as shown bellow.
			fade, flush, reverse, monotone, coloranim, coloranim2
			
	Append remote control program xslideshow-control.
		You can control xslideshow by xslideshow-control.

	Append pathDir.
		Specify file path directory to XSlideshow*pathDir.
	Delete newFileList.
	Delete fileList.

Xslideshow version 2.1.2 beta4	Apr 13 1994
	Append newFileList.
		Specify new file to XSlideshow*newFileList.
		At the first, xslideshow display picture from newFileList,
		and after display all newFileList switch picture from fileList.
	Append random animation mode.
		Specify XSlideshow*animate : random
		Select animation mode from XSlideshow*animateList randomly.
	Append "-maxfit" option.
		If apply -maxfit, any picture size fit to the window.
		If picture size is larger than window size, then reduce it.
		If picture size is smaller than window size, then zoom it.
	Append button actions.
		Ex.
		Shift<Btn1Down>: Go to first frame.
		Shift<Btn2Down>: Go to last frame.
		Shift<Btn3Down>: Pause frame.
			 <Btn1Down>: Go to next frame.
			 <Btn2Down>: Go to prev frame.
			 <Btn3Down>: quit.
		You can do above actions while interval time.
	Append "clockMove" option.
		Move clock left or right when display it with -root option.
		XSlideshow*clockMove: True or False

	Some bug fixed.

	Merci Monsieur Fadi Sandakly <Fadi.Sandakly@sophia.inria.fr>
	Thank you Dr. Eberhard W. Lisse <el@lisse.NA>
	Thank you Mr. Peter Grina <grina@fai.com>
	Thank you Mr. Daniel Welch <dwelch@mpd.tandem.com>
	Thank you Mr. Jonathan G. Monsarrat <jgm@cs.brown.edu>
	Thank you Mr. Fokke de Boer <Fokke.de.Boer@rivm.nl>
	Thank you Mr. Brian Meyer <meyer@a19thhole.stortek.com>

Xslideshow version 2.1.1	Mar 22 1994
	Append the fitting option (-fit).
	Some bug fixed.

Xslideshow version 2.1		Mar 11 1994
	Append "clock" option.
		Display the clock while screen saving.
		XSlideshow*clock: True or False
	Append "biff" option.
		Scroll the Biff message when you have new mail.
		XSlideshow*biff: True or False

Xslideshow version 2.0.1	Mar  4 1994
	Append "clock" option.

Xslideshow version 2.0		Feb 22 1994
	Support SYSV machine (For Solaris2.x or other System V OS)
	Append animation flush, monotone, coloanim2

Xslideshow version 1.1		Feb  2 1994
	First release.

-----------------------------------------------------------------


