WMFstatus-0.4
--------------------------------------------------------------
Authors...:	Dmitry Fink <finik@sporu.net>
Homepage..:	http://www.finik.net/software.html

Description
--------------------------------------------------------------
WMFstatus is a general purpose dockapp LCD screen, that can
show any textual data generated by script or any other program.
The options are unlimited. You can make it show number of
new messages in your inbox, the temperature of your cpu,
number of new articles on Slashdot etc... Just provide
the needed data, and it will show it on the screen.

The LCD screen contains 5 lines. Every line has 5 letters and
3 digits, and looks like:

  +----------+
  |XXXXX  XXX| 
  |XXXXX  XXX|
  |XXXXX  XXX|
  |XXXXX  XXX|
  |XXXXX  XXX|
  +----------+

The data to display is provided as a text-file,
every line should be of the next form:
name <tab> number <tab> command-to-run-when-pressed

If there are more than 5 lines, the data is nicely scrolled on the LCD
screen.

As an example, here is my data file. It is generated by a perl script
that counts new mails in folders every time mail arrives:

INBOX   0       xterm -bg black -fg white -e pine -i
STORY   28      xterm -bg black -fg white -e pine -i -f Stories
SPORU   34      xterm -bg black -fg white -e pine -i -f sporu.net
LINUX   15      xterm -bg black -fg white -e pine -i -f Linux-IL
SPAM    0       xterm -bg black -fg white -e pine -i -f SPAM

When WMFstatus is run with no "-c" parameter, it looks for the data
in ~/.wmfstatusrc file. Otherwise, you can provide the filename to look
in with "wmfstatus -c <filename>".

Non-polling mode
----------------
WMFstatus can now work in a non-polling mode - i.e to update
the LCD screen ONLY! by users demand. This is done using
the USR1 unix signal. Just use the (-p) command line option
and "kill -USR1 <PID>" in your script anytime you do an update.
The PID of the process can be found in <input_data_path>.pid file.
<input_data_path> is the default one ($HOME/.wmfstatusrc) or the
one provided by you via the (-c) command line option. 


Files
--------------------------------------------------------------
README		This file.
INSTALL		Installation instructions.
HINTS 		Hints about what you can do with WMFstatus.
CHANGES		Description of changes.
COPYING		GNU General Public License Version 2.
	

Bugs
--------------------------------------------------------------
If you discover any bugs in this software, please send a 
bugreport to finik@sporu.net and describe the
problem as detailed! as you can.


Thanks
--------------------------------------------------------------
* Dave Clark,
  Antoine Nulle,
  Martijn Pieterse:
  
  for writing WMiNET and other cool dockapp applications
  which inspired me and provided much of the initial code
  for writing this one.

* Leonid Igolnik,
  Kolb Norbert:

  For bugfixes and contribution to the code,
  see CHANGES for more details. 

Copyright
--------------------------------------------------------------
WMFstatus is copyright (c) 1999,2000 by Dmitry Fink (FINiK)

WMFstatus is licensed through the GNU General Public License.
Read the COPYING file for the complete GNU license.
