README: $Id: README,v 1.4 2000/01/15 18:35:05 danielr Exp $

	Please read this entire file before starting. I haven't had
time to go back and reorganize it to flow better, so something
important maybe mentioned in an odd place at this point.

################################################################
# Why this tool exists
################################################################

	I use Pine to read my eMail and procmail to sort incoming
messages into multiple folders. I don't want to have to check every
folder to see if it has new eMail in it or not. Pine really doesn't
have any indication when you are in the folder view, if a folder has
new messages. I also don't like the "jump to the next unread" feature,
as I sometimes like to ignore folders.

	This little utility will go through the files and/or
directories you give it and report on which folders have new messages
and how many of them there are. It also gives you stats on total
messages in each folder. You can also sort the output in various ways
and filter the output to include or exclude certain information.

################################################################
# How to use this tool?
################################################################

	You first need to create a configuration file which let's the
tool know what files or directories to look for new messages in. You
can also setup a few options about how you want the tool to output the
information. This is a copy of the help text, which explains the
available options:

The default configuration should be located at "~/.mailinforc"

Syntax:
     One file or directory per line

Options:
     Begin a line with # to have it ignored
     Set a line to "busy" to turn on the busy indicator
     Set a line to "separate" to print a separator before the totals
     Set a line to "toptotal" to have the totals printed first
     Set a line to "onlynew" to show only folders that have new messages
     Set a line to "sort [order]" to change the sorting options
        <order> is a 3 letter combination, in any order. You must use
        one letter from each set:
        Capital letters reverse the sort order
        Either u or U - unread messages
        Either t or T - total messages
        Either f, F, i, or I - folder name (i = case insensitive )

        The order of the three options determines how items are sorted
        For example: "uti" sorts first by unread, then total, and lastly
                     folder name

   * Note x and X apply to the full path name of a folder

     Set a line to "x [filename]" to remove it from the files being searched
     Set a line to "X [regex]" to remove any files matching that regular
        expression from the files being searched
        This should be a proper Perl regular expression with special 
        characters escaped
        For example: "old" would exclude all files that contain the word old
                     "^\/home" would exclude all files that being with /home

	Once you have the configuration file in place, start adjusting
the options to something that you like. It's that simple (well I hope
it's that simple anyway).

################################################################
# Basic configuration
################################################################

	This is what my configuration file looks like:

/home/danielr/mail/new
/var/spool/mail/danielr
separate
busy
sort uti
onlynew
	
################################################################
# Other Stuff
################################################################

	At this point I'm not sure if this code will work for anyone
else, and if it does, how well it will. I mainly put it together as a
nice little utility for myself.

	I'd like to hear feedback if other people are using it and how
(if at all) it is working for them.

-- Daniel R. <danielr@ccs.neu.edu> [http://www.ccs.neu.edu/home/danielr/]
