README
bgrot - A program to keep backgrounds interesting
Author: Matthew Fuller <fullermd@over-yonder.net>

This is version 1.30 of bgrot.  See the file RELNOTES for information on
this and previous releases.

This has some bugfixes and enhancements over 1.20, the last
widely-distributed version.  It includes fixes for file recursion,
missing files, etc.



INSTALLATION:

0) Ensure that you are A) Running X, and B) have xv installed

1) Unpack the distribution.  Since you're reading this, it's assumed that
	you know how to do this.

2) Edit the makefile to set the installation parameters.

3) Type 'make install' to install the distribution.

4) Put the images you want to rotate through under $HOME/.bgrot/images.  This
	can be a symlink elsewhere if you prefer.  You can also change it by
	making a $HOME/.bgrot/conf/bgrot.conf file and overriding the system-wide
	defaults in /usr/local/etc/bgrot.conf.

5) Run createlist.sh (defaults to in /usr/local/bin) to create the master list
	of images.  There's also a makefile target 'buildlist' to do this for
	you.

6) Run background.sh to start the ball rolling.  You can put this in your
	.xinitrc to start it every time you login to X.  I always run it nice'd,
	but it shouldn't make much difference.
	i.e.: /usr/bin/nice -20 /usr/local/bin/background.sh &


INFO:

- You can adjust the delay between image changes by editing the DELAY
	setting in your personal bgrot.conf (or systemwide).  DELAY is in seconds.

- The bgrandom.pl script puts the images in a random order.  At the
	beginning of each 'cycle', it reads in the master image list
	(master.background.list), randomly orders it, and saves it into
	'background.list'.  This is so you can view the order it's
	presently running at any time.  Then it reads in the randomized
	list, and displays the images, waiting DELAY seconds between
	each image.  This file will be in DATADIR, which defaults to
	$BGROTDIR/conf ($HOME/.bgrot/conf).

- You can add images anytime.  Add them to the images directory, then
	rebuild the	image list (createlist.sh).  The new images will be
	automatically picked up the next cycle.

- Check for updates at the bgrot project home page.
	Homepage: http://www.over-yonder.net/~fullermd/projects/bgrot/


FILES:

LICENSE: License information

Makefile: The Makefile (mainly just installation)

README: This file

RELNOTES: Information on current, past, and present releases

background.sh: The main loop file, rotates the backgrounds

bgrandom.pl: The script that randomizes the picture order

bgrotman.pl: A useful debugging tool, lets you cycle through the
			pictures one at a time, by hitting Enter

createlist.sh: The frontend to creating the image list automatically

masterlistgen.sh: The backend, called by createlist.sh.  Can be invoked
			seperately for debugging purposes.  You would then have to
			source the config files to set the env variables manually

master.background.list: The master image list, compiled by createlist.sh

background.list: The runtime background list, regenerated every cycle
			by bgrandom.pl

createconfig.pl: Used during installation to create the system-wide
			config file.

setconfdir.pl: Used during installation to create the user interface
			programs
