
Gubby Version 0.5.5 (2004-12-16)

Copyright and License

        Copyright (C) 2003, 2004 Christian Stigen Larsen

        http://gubby.sourceforge.net

        Gubby is free software; see the file COPYING for copying conditions.
        There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
        PARTICULAR PURPOSE.


What is Gubby?

        Gubby is a small program that continually shows where  Procmail has
        placed new email.  It runs both in commandline and in an ncurses
        environment with colors, and will update the overview in real time,
        while using very low resources.  Users can launch a specified
        mailreader by selecting a folder in the overview.

        Gubby requires that you have enabled Procmail logging.  The ncurses
        environment have the same look and feel as Mutt.


License

        Gubby is distributed under the GNU General Public License (GPL).
        See the file COPYING in the source distribution for more
        information, or visit

                http://www.gnu.org/copyleft/gpl.html

Installing

        Gubby is just a tiny program made for my friends and myself, so I
        haven't bothered making gubby easily installable nor very portable.
        The following _should_ do the trick however on most systems that
        have a working C++ compiler (such as GNU g++ 3.2.1), STL, the
        (n)curses library, as well as GNU make:

                $ make all install

	On BSD derived systems you may need to specify to use GNU make
	explicitly:

		$ gmake all install

        See the makefile for details; the above commands should compile
        gubby, set proper permissions, strip the binary and copy it to
        /usr/bin/.

	If needed, you can always tailor the Makefile to suit your own
	needs.


Compilation Problems

	If you have an old GCC version (like 2.95.2) and get this error
	message:

	  src/keys.cpp:28: sstream: No such file or directory
	  make: *** [src/keys.o] Error 1

	Then run:

	  make COPTS=-DUSE_STRSTREAM

	That should include an older header file instead, and should work
	fine.

	I've gotten another errormessage on GCC 2.96:

	  In file included from src/keys.cpp:28:
	  /usr/include/g++-3/sstream: In method `string stringstreambase::str ()
	  const':
	  /usr/include/g++-3/sstream:104: taking dynamic typeid of object with
	  -fno-rtti
	  /usr/include/g++-3/sstream: In method `void stringstreambase::str
	  (const string &)':
	  /usr/include/g++-3/sstream:109: taking dynamic typeid of object with
	  -fno-rtti
	  make: *** [src/keys.o] Error 1

	Then you'll have to compile with:

	  make COPTS=-DUSE_STRSTREAM

	This is also true for other older versions of GCC.


Procmail

        If you do not specify a procmail logfile as a commandline option,
        Gubby will try to read $HOME/.procmailrc and find your LOGFILE=
        setting, and read that.  If it can't find any logfile, it will
        simply exit with a FILE* == NULL error message (you might want to
        run gubby with the verbose option -V to display such messages).

        So you need to enable logging in your procmailrc for Gubby to work.
        Also, Gubby relies on the procmail logging format, and will search
        for the string " Folder: ".  If this is incorrect for your version
        of procmail, you should change the source and recompile, and give me
        a note.


Platforms

        See the file PLATFORMS for a list of platforms that Gubby has been
        successively compiled for out-of-the-box.


Bug reports

        Please send bug reports to <csl@sublevel3.org> and I'll try to
        fix any bugs, inconsistencies, bad or non-portable code.


Downloading

        The latest information on Gubby as well as the sources should always
        be available on the World-Wide-Web at

                http://gubby.sourceforge.net/

        It's also been submitted to the Freshmeat site, so you can follow
        project progress on the following location:

                http://freshmeat.net/projects/gubby/

	If you're using FreeBSD, then you might want to use the Gubby ports
	install, maintained by Michael Hostbaek.  It should be available
	in updated port-trees in /usr/ports/mail/gubby (from the top of my
	head)


CVS Access

	Sourceforge.net hosts the CVS repository for Gubby.  You are allowed
	anonymous CVS access to get the latest updates.  See the webpages
	for more information.  If you want to contribute as a developer, let
	me know.


Contact Information

        If you want to contact me, please email me on

                <csl@sublevel3.org>.

        Hope you'll find Gubby useful!


$Id: README.TXT,v 1.14 2004/12/16 16:18:45 cslsublevel3org Exp $
