WMMail.app-0.64 Installation Instructions
=========================================

$Id: INSTALL,v 1.9 2000/07/02 20:40:40 bryan.chan Exp $



REQUIREMENTS

  You must have the following to run the WMMail binary:

    - X11R6 with the X11 Nonrectangular Window Shape Extension
    - libXpm, the XPM graphics library, 4.8 or above

  You must also have the following if you want to build from source:

    - GNU make 3.74 or above
    - libPropList, the GNUstep property list library

  You should be using Window Maker as your window manager, but this is
  not strictly necessary.



INSTALLATION

  To build and install WMMail.app, follow these steps:

    1. Unpack the WMMail.app package. This is usually done with:

         gunzip -c WMMail.app-0.##.tar.gz | tar xf -

    2. Enter the source directory:

         cd WMMail.app-0.##

    3. Type "./configure" to run the configure script. Type "./configure
       --help" for a list of command line options you can pass to the 
       script. Also read the section "CONFIGURE OPTIONS," below.

    4. Type "make" to build the WMMail binary.

    5. Type "make install" to install the program. You may need root
       access to do this. If you are installing into a system-wide
       location, edit /usr/local/GNUstep/Apps/WMMail.app/Defaults/WMMail
       to define default value for the users on your system.



RUNNING WMMAIL.APP

    1. Copy the defaults domain from
       /usr/local/GNUstep/Apps/WMMail.app/Defaults/WMMail to 
       ~/GNUstep/Defaults/WMMail and edit it to suit your needs.
       Instructions on how to edit the file is currently unavailable.
       Hopefully we will have an easy-to-use GUI for this in the near
       future.

    2. Run WMMail, and drag its appicon to the Window Maker Dock to dock
       it. Right-click on the back-plate of the appicon, and select
       "Settings." In the Docked Application Settings panel, select the
       "Start when WindowMaker [sic] is started" checkbox, so that
       WMMail will be started automatically next time you log in.



CONFIGURE OPTIONS

  Options can be passed to the configure script to specify what features
  are enabled or disabled, where needed files are located, where
  WMMail.app should be installed, etc.

    --prefix=<topdir>

      Specifies under which directory tree WMMail.app should be installed.
      <topdir> is /usr/local by default.

    --with-appspath=<appspath>

      Specifies where GNUstep applications are installed. If
      $GNUSTEP_LOCAL_ROOT is not defined, then <appspath> is
      $prefix/GNUstep/Apps by default; otherwise it is
      $GNUSTEP_LOCAL_ROOT/Apps.

  WMMail.app will be installed in <appspath>/WMMail.app. This means that
  it will be installed in /usr/local/GNUstep/Apps/WMMail.app by default.

    --with-PL-libs=<flags>, --with-PL-incs=<flags>

      Passes compiler flags that let the C compiler find the libPropList
      libraries and header files, if they are not in a standard location.

    --with-WM-libs=<flags>, --with-WM-inc=<flags>

      Passes compiler flags that let the C compiler find the Window
      Maker libraries and header files, if they are not in a standard
      location. These are currently not needed.

    --disable-mbox, --disable-mh, --disable-maildir,
    --disable-pop3, --disable-imap

      Disables support for the corresponding mailbox format (everything is
      on by default). For obvious reasons, you should NOT disable support
      for all of them. :)

    --enable-debug

      Turn on debugging (off by default). This will make WMMail produce a
      lot of debugging messages when executed.

  Example: ./configure --prefix="/opt"                             \
                       --with-PL-libs="-L/opt/libPropList/lib"     \
                       --with-PL-incs="-I/opt/libPropList/include" \
                       --disable-mh --disable-maildir --disable-imap