This is slrnface, a small helper utility which displays X-Faces on behalf
of programs like slrn and mutt when they are run in the X11 terminal
emulator.

Requirements:

a) X11.
b) Terminal emulator which sets WINDOWID environment variable. Most of the
   ones in common use will set it. If you're using some terminal emulator
   which doesn't have this capability, you'll have to set it yourself.

How to build:

a) Install libcompface. I recommend getting the source from the nearest
   Debian GNU/Linux mirror because there's a patch which adds the
   ability to output XBM image, as well as the historic brain dead
   format. Slrnface doesn't use that feature, but it might be handy for
   something else.

b) Edit Makefile.

c) Invoke make.

d) Install with "make install".

Upgrading from version 1.x:

   If you have used one of the older versions of slrnface, you probably
   have .slrnface file in your home directory. You can delete it, because
   the new version doesn't use it any more. Instead, the pipes will be
   created in $HOME/.slrnfaces directory. There are no other user visible
   changes.

Using slrnface with slrn:

   This version requires S-Lang 1.4 or later and slrn 0.9.7.4. It might
   work with slrn 0.9.7.3, but I haven't tested that configuration. It
   will not work properly with older versions.

   In case you can't or won't upgrade, take a look at the slrnface home
   page. You'll find older versions which might work with what you have.

   Take a look at slrnface.sl, edit if you want and then include it in
   your .slrnrc, like this:

   interpret slrnface.sl

   Run slrn.

Using slrnface with mutt:

   Mutt doesn't have a way to use some kind of embeded interpreter, like
   S-Lang. Since Mutt's current capabilities are not good enough for our
   purposes, a patch for the source is provided. It has been tested with
   mutt 1.4, but it should work with the 1.3.x series, if x is high
   enough.

   Uncompress mutt 1.4 source and apply mutt.patch from the slrnface
   distribution.

   Compile mutt as usual.

   Edit your ~/.muttrc and add:

   set xface=yes

   Run mutt.

If you think X-Faces are not placed at the appropriate location on your
terminal emulator window or you don't like the colors, set some X resources.
Read the man page for more information. Additional documentation is in the
doc directory.

Licence: GPL. See file called COPYING.

Special thanks to Mark R. Bowyer for proofreading the man page.

Home page: http://dave.willfork.com/slrnface/

dave@willfork.com
