
What it does
~~~~~~~~~~~~

  sgrotum generates signatures for email messages, optionally including
  randomly selected quotations.



Requirements
~~~~~~~~~~~~

  glib-2.0



Installation
~~~~~~~~~~~~

  To install from source, most people will:

    $ cd sgrotum-2.0.0
    $ ./configure
    $ make
    # make install-strip
    $ make clean

  To run a test:

    $ sgrotum tests/test

  To uninstall:

    # make uninstall

  See the file named INSTALL for more information.



Getting started
~~~~~~~~~~~~~~~

  1) Make a copy of the "examples" directory:

     $ cp -r examples ~/.sgrotum

  2) Try the default setup by doing this a few times:

     $ sgrotum ~/.sgrotum/default && cat ~/.signature

     or, for the same result with less typing:

     $ sgrotum -s

  3) Edit the files in ~/.sgrotum to suit yourself:

     ~/.sgrotum/default is the preference file sgrotum reads by default.
     It tells the program which quote file and template files to use, and
     where to write the result (e.g. ~/.signature).

     The files named ~/.sgrotum/template* are signature files, optionally
     containing special instructions for the insertion of random quotations.
     Make as many as you like, and list them in sgrotum's preference file.

     ~/.sgrotum/quotefile contains a list of quotations, one per line.

     If you have the 'fortunes' package installed, the genquotes.sh bash
     script can be used to generate new quote files for sgrotum. Try
     'genquotes.sh --help' for information.

  For details and options, see 'man sgrotum'.



Running sgrotum automatically
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  - Using cron (see "man 1 crontab" and "man 5 crontab"):

    # Crontab entry to run sgrotum at 15 minutes past the hour,
    # from 7:15am until 11:15pm.
    15  7-23  *  *  *   sgrotum

  - Using mutt:

    # ~/.muttrc
    set editor="sgrotum ; vim"

  - Another mutt example, this generates signatures according to
    the mailbox you're in:

    # ~/.muttrc
    folder-hook news 'set signature = "sgrotum -s ~/.sgrotum/plain |"'
    folder-hook clug 'set signature = "sgrotum -s ~/.sgrotum/clug |"'
    folder-hook mbox 'set signature = "sgrotum -s |"'



Help, updates, etc.
~~~~~~~~~~~~~~~~~~~

  - There's a sgrotum FAQ, written by sgrotum user Shantanu:
    http://www.shantanu.cjb.net/

  - To see if there's a newer version of sgrotum available:
    http://homepages.ihug.co.nz/~trmusson/programs.html#sgrotum

  - If you have any trouble or suggestions:
    Timothy Musson <trmusson@ihug.co.nz>

