aspbm 0.8

NAME
       	aspbm - Afterstep phone bill monitor.

SYNOPSIS
       	aspbm [ -h ] [ -s ] [ -t ] [ -u update ] [ -v ] [ -z ]

DESCRIPTION
       	aspbm is a utility to monitor ppp modem connections for
       	the AfterStep window manager. It runs under Linux systems
       	running the X Window System.

       	aspbm currently provides:

       	* Time on line;
       	* Time until next pulse drop;
       	* Cycle between In/Out bytes view and Graphic view.
       	* Support for multiple time intervals (Four) + default.
       	* Statistics display (Cost, Total cost, Total time on line);
       	* Graphic with In/Out rates is autoscaling;
       	* Can be started multiple times;
       	* Commandline options;
       	* Does some logs;

	aspbm uses the /proc/net/route to verify a ppp connection
	information under Linux. In its normal state it displays a window 
	with two time meters, the one on top of the window is time until 
	next pulse drop and the other one is time on line. It also 
	displays the graphic of in/out bytes, speed rates, three led for 
	the ON, TX and RX and the number of pulses in current connection.
	This information is updated every second, except for the graphic 
	part which can be controled in command line.

       	By clicking in the lower part window, a pop-up window
       	appears showing the cost and time in seconds to use in
       	this time interval, the cost of the current connection and
       	the total cost and time on line using the log file.

       	By clicking in the upper part window, the window changes
       	to the In/Out bytes view, which displays the amount of
       	bytes in and out.

	There are some 'known' unfinished parts, be sure to read 
	the TODO file;) 
  
OPTIONS
       	The following options are available.

       	-h    		Display the command line options.
	-s    		Displays in shaped form.
       	-t    		Set the on-line timer to MM:SS instead of HH:MM.
       	-u update	Graph and speed update rate, default 5 seconds.
       	-v    		Prints version number.
       	-z    		Test mode.

INVOCATION
       	asfsm can be called from one of many ways. The most common 
	invocation is the command line:

       		[user@host] ~% aspbm -t -u 2 &

       	Another way to call aspbm is from the window manager:

            	*Wharf aspbm - Swallow "aspbm" aspbm -s -t -u 2 &

       	This line, when placed in the wharf file causes aspbm 
	to start in a button on the Wharf button bar under the
       	afterstep window manager.

CONFIGURATION FILE
       	aspbm reads the configuration file stored in ~/aspbmrc.
                                                       
       	Configuration file as the folowing keys:

       	warn: num
             	Where num can be 
			0 - if no warning window should  be shown 
			1 - if warning window should be shown.

       	warning: seconds
             	Number  of  seconds to display warning window before
             	pulse drop.

       	warnmsg: message
             	The message to be displayed in warning window.

       	delay: seconds
             	Number of seconds between phone connect and ppp
             	interface appears in /proc/net/route.

       	currency_symbol: symbol
             	The symbol for country currency.

       	currency_position: position
             	The position for currency symbol. right or left       

       	log: num
             	Where  num can be 
			0 - if no logs should be done 
			1 - if logs should be done.  
			  (Log  file  is ~/.aspbmlogs/aspbm.log).

       	There are eight entries for phone provider rules, one
       	for which weekday plus the default.  
	
		default: | sunday:  | monday:  |  tuesday:  |  
		wednesday: | thurday: | friday: | saturday:

       	each of them is followed by:

       		from HH:MM to HH:MM use seconds at cost

       	If more than a time zone is needed:

       		and from HH:MM to HH:MM use seconds at cost

      	Special days are defined in the holydays: key.

       		holydays: DAY/MONTH , DAY/MONTH ...                     
       
	Configuration file example:

          warn: 1
          warning: 30
          warnmsg: Next pulse drop in 30 seconds
          delay: 8
          currency_symbol:  Esc
          currency_position: right
          log: 1
          default: from 0:00 to 24:00 use 400 at 10
          sunday:  from 0:00 to 24:00 use 400 at 10
          monday: from 8:59 to 18:00 use 180 at 10
          tuesday: from 8:59 to 18:00 use  180  at  10  and  from 18:59 to 21:29 use 18 at 12
          wednesday: from 0:00 to 18:00 use 180 at 10
          thursday: from 8:59 to 18:00 use 180 at 10
          friday: from 8:59 to 18:00 use 400 at 10
          saturday: from 0:00 to 24:00 use 400 at 10
          holydays:  1/1,  2/4,  4/4, 25/4, 1/5, 3/6, 10/6, 15/8, 5/10, 1/11, 1/12, 8/12, 25/12

       	When multiple time intervals are needed, time interval can     
       	be exclusive:

       		from  9:00  to 12:59 use 400 at 10 and from 13:00 to 17:59 use 300 at 8

       	or can be time interval inside time interval:

       		from 9:00 to 20:59 use 400 at 10 and from 13:00  to  17:59 use 300 at 8

       	in  the  second  case  the  largest  time interval must be
       	defined first.

DEVELOPMENT MACHINE
	aspbm is being developped on Intel MMX 200 Mhz machines 
	running Linux/RedHat-5.2 + Updates. (Kernel 2.2.5).
	It was't been tested on other architetures but it should 
	work.

FILES
	README 		This file.
	INSTALL         Installation instructions.
	HINTS           Hints about what you can do with aspbm.
	BUGS            Things you don't want to know ;-)
	CHANGES         Description of changes.
	COPYING         GNU General Public License Version 2.
	TODO            Stuff i've planned for future aspbm releases.

BUGS
       	Mostly unfinished business.

       	If you discover any bugs in this software, please  send  a
       	bugreport  to  moleiro@ip.pt  and  describe the problem as
       	detailed as you can.

COPYRIGHTS
       	aspbm is copyright (c) 1999 by Pedro Moleiro and  licensed          
       	through  the GNU General Public License.  Read the COPYING
       	file for the complete GNU license.

AUTHOR
       	Pedro Moleiro (moleiro@ip.pt)
       	http://www.ip.pt/~ip241956/aspbm.html     
