
                                wmappl 0.2

                     Copyright (C) 1999 Casey Harkins


Introduction
============

	WMAppl is a simple application launcher for the Window Maker dock.
It is loosely based off of WMButton by Edward Flora. It began as a large
patch to WMButton, then a complete re-write, now a separate application.
I don't know of any bugs in it yet (I'll leave it to who's ever reading
this to find those!). There is still a bit of work to be done yet
(see Future Plans for details). Enough rambling, on to the software . . . 


Getting the software
====================
	
	Chances are if you're reading this you've already found it. 
WMAppl is available at http://www.pobox.com/~charkins/wmappl.html and
will continue to reside there as long as I choose to maintain it! It's
currently only available in source tarball.


Compiling and Installation
==========================

	Extract the archive:
		tar -xvzf wmappl-0.2.tar.gz

	Enter the wmappl directory and edit the Makefile:
		cd wmappl-0.2/
		vi Makefile

	The Makefile should be fairly straight forward. You may need
	to change the INCDIR and LIBDIR variables to point to their
	correct locations. If you're running Solaris you'll need
	to add extra libraries to the LIBS variable. There are also
	two variables INSTALL_DIR and INSTALL_BIN that specify where
	things get installed if you run make install. 

	Make the binary:
		make

	Install the binary:
		make install

	This will copy the binary to /usr/local/bin and the sample rc file
	and icon directory to /usr/local/share/wmappl.

	That's it, each user will need to copy wmapplrc.sample to their
	home directory as .wmapplrc or launch the program with the -f 
	option and specify the file name and location.


Using WMAppl
============

	usage:	wmappl [-f configfile] [-i iconpath] [-V]

	-f : specifies the config file default:~/.wmapplrc
	-i : icons in the config file are prefixed with iconpath
	-d : debug mode (doesn't execute commands)
	-V : display version information


Configuring
===========
	
	The rc file format is simple but a bit picky. Entries must
be on a single line or expanded by ending the line with a backslash
character (\). The first string on the line is the icon filename.
No white space is allowed within the icon filename. The second string
is the command line to be executed when the button is pressed. This
string is read to the end of the line and may include white space.
The pound sign # may be used as a comment character, all characters
until the end of the line are ignored. Blank lines are now allowed.


Future Plans
============

	- configure scripts (GNU autoconf)
	- specifying of icon path in the config file
	- drag and drop
	- GUI config tool
	- AfterStep support
	- icon search path, rather than a single icon path

Contributors
============

	Casey Harkins (charkins@pobox.com)
	Richard Eisenman -- scrolling patch, icons package
	Jacob Beardsley -- icon package
	Edward Flora (ehflora@ksu.edu) -- Author of WMButton
