The Long-awaited Help.txt :)
============================

This document attempts to explain the various defaults that WMMail.app
understands.  In principle, this file should not be necessary since a
graphical configuration program is supposed to take care of the defaults
domain, but I am too lazy to write the program. :)


    DisableBeep = Yes | No

        Indicates whether WMMail.app should give audio feedback.
        If "No", WMMail.app will sound the standard X Window bell when
        new mails arrive.

    DoubleClickTime = <number>

        Tells WMMail.app how fast your double-clicks are, in microseconds.
        The larger <number> is, the longer WMMail.app will wait for the
        second click.

    DisplayEachMailbox = Yes | No;

        EXPERIMENTAL. Tells WMMail.app to display the mailbox name along
        with the message counts for every mailbox that contains new mails.

    DisplayMessageCount = None | NewOnly | TotalOnly | NewOverTotal

        Tells WMMail.app how message counts should be displayed.
        If "None", WMMail.app does not display any numbers on its
        application icon.  If "NewOnly", only the number of new
        messages in your mailbox is displayed.  If "TotalOnly",
        the total number of messages in your mailbox is displayed.
        If "NewOverTotal", both numbers are displayed, separated by
        a slash.  If DisplayEachMailbox is "No", then the numbers
        displayed are summed across all mailboxes.

    DisplayColor = <colour>

        Specifies the colour used for display message counts.  <colour>
        should be a colour specification in hexadecimal RGB notation,
        e.g. "#FFFF00".

    DisplayFont = <font>

        Specifies the font used for displaying message
        counts.  <font> should be a valid X font, e.g.
        "-*-helvetica-medium-r-*-*-10-*-*-*-*-*-*-*"

    DisplayLocation = (<x>, <y>)

        Specifies where on the application icon the message counts should
        be displayed. The lower left pixel of the text string will be
        placed at the specified coordinates. Since an application icon
        is customarily 64x64 pixels, <x> and <y> should not exceed 64,
        and certainly shouldn't be less than 0. (0, 10) is a good default.

    ExecuteOnClick = "command line"

        Tells WMMail.app what to execute when you double-click on its
        application icon.  Shell expansions and shell meta-characters like
        '&' and '>' don't work.  If you must use shell functionalities,
        wrap your commands in a shell script and execute that instead.

    ExecuteOnNew = "command line"

        Tells WMMail.app what to execute when new mails arrive.  See
        ExecuteOnClick.

    ExecuteOnNewOnce = Yes | No

        This seems to be broken now. Do not use.

    Animations = { Empty = {...}; Old = {...}; New = {...}; }

        The "Animations" keyword lets you define your own animation
        sequence for each of the three states that the application icon
        may be in.  If left out, the default (unanimated) icons are used.
        An animation sequence has the following format:

        <state> = {
            Delay = <number>;
            Frames = ( file1.xpm, file2.xpm, file3.xpm );
        }

        <state> is one of "Empty", "Old", and "New". <number> specifies
        the delay between each frame of the animation in 100 milliseconds.
        e.g. a Delay of 10 means the speed of the animation is 1 frame
        per second. Frames is a parenthesized, comma-delimited list of
        XPM files.

  Mailboxes = ( mailbox1 [, mailbox2 ...] )

        Specifies the mailboxes that WMMail.app should monitor for new
        mails. Each mailbox is defined as follows:

        {
            Name = "name";
            Type = <type>;
            UpdateInterval = <number>;
            ExecuteOnUpdate = "command line";
            Options = { ... };
        }

        Every mailbox has a name, which should be a short string that
        identifies it.  If the name is too long, and DisplayEachMailbox
        is "Yes", there may not be enough space on the application icon
        to display the entire name with the message counts.

        <type> should be one of "mbox", "pop3", "imap", "mh", and
        "maildir", and indicates the kind of mailbox that you wish
        to monitor.

        <number> specifies the length of time in seconds that WMMail.app
        should wait before updating the status of the mailbox.

        ExecuteOnUpdate is a command that WMMail.app should run prior
        to checking the mailbox.  For example, before checking a local
        mail spool, one might wish to run fetchmail first to download
        mails from a remote server into the local mail spool.  Also see
        ExecuteOnClick and ExecuteOnNew.

        Options is a list of keyword-value pairs (a "dictionary"
        in libPropList terminology) that provide the specifics of the
        mailbox.  The format of the list is different for different types
        of mailboxes.  For example, the Options for a POP3 mailbox will
        include the hostname of the POP3 server, and a username and a
        password on the POP3 server.  The Options for an mbox file will
        include the path to the file itself and so on.

        See the source for more information about the Options dictionary.