INSTALL

   1 This document describes the steps which are necessary to
   2 install and use Mutt-ng
   3
   4
   5 Supported platforms:
   6 ====================
   7
   8 Mutt-ng should run under the following platforms:
   9
  10 AIX, BSDI, Convex, Data General Unix (DG/UX), Digital Unix (OSF/1),
  11 DYNIX/ptx, FreeBSD, HP-UX, IRIX, Linux, Atari MiNT, MkLinux, NetBSD,
  12 OpenBSD, QNX, SCO Unix 3.2v4/5, Solaris, SunOS, Ultrix, UnixWare,
  13 MacOSX
  14
  15
  16 Requirements:
  17 =============
  18
  19 1. ANSI C compilter. The GNU c compiler would be a good choice
  20
  21 2. A SysV compatible semigraphic library.
  22    Mutt-ng supports:
  23    - GNU ncurses , ftp://ftp.gnu.org/gnu/ncurses/
  24    - S-Lang, ftp://space.mit.edu/pub/davis/slang/
  25
  26 3. An implementation of the iconv API for character set
  27   conversions. This one is recommend:
  28   http://www.gnu.org/software/libiconv/
  29
  30
  31 Installation:
  32 =============
  33
  34 1. Installing Mutt-ng is very easy. Just use tar and gzip/bzip2.
  35    For example type: `tar xvfz mutt-ng-20050515.tar.gz'.
  36    If you have obtained the distribution from
  37    the SVN (subversion)  repository, run the `autogen.sh' script with the
  38    same command line parameters like it is described in doc/devel-notes.txt
  39
  40 2. The next step is to call `configure' to configure your installation
  41    depending on your system.
  42    In most cases, configure will automatically determine everything it
  43    needs to know in order to compile.  However, there are a few options
  44    to `configure` to help it out, or change the default behavior:
  45
  46     Configure options:
  47     ==================
  48
  49     --prefix=DIR
  50         install Mutt-ng in DIR instead of /usr/local
  51
  52     --with-curses=DIR
  53         use the curses lib in DIR/lib.  If you have ncurses, `configure'
  54         will automatically look in /usr/include/ncurses for the include
  55         files.
  56
  57     --with-slang[=DIR]
  58         use the S-Lang library instead of ncurses.  This library seems to
  59         work better for some people because it is less picky about proper
  60         termcap entries than ncurses.
  61
  62     This are just a few configure options to get a complete list type:
  63     `configure --help'
  64
  65 3. Once `configure' has completed, simply type `make install.'
  66
  67 Mutt-ng should compile cleanly (without errors) and you should end up with a
  68 binary called `muttng.'  If you get errors about undefined symbols like
  69 A_NORMAL or KEY_MIN, then you probably don't have a SysV compliant curses
  70 library.  You should install either ncurses or S-Lang (see above), and then
  71 run the `configure' script again.
  72 Depending on the features you included via configure you can get similliar
  73 errors from other libraries that are missing.
  74
  75
  76 Iconv character set support
  77 =====================
  78
  79 If you decide to use your system's iconv implementation, you may
  80 need to tell Mutt-ng about implementation-defined names for some
  81 character sets.  Sample configuration files for various systems can
  82 be found in the directory contrib/iconv/ in this source
  83 distribution, and will be installed in the samples/iconv directory
  84 as part of Mutt-ng's documentation.
  85
  86 In order to use these sample configuration files, just put a line
  87 like
  88
  89      source /usr/local/doc/muttng/samples/iconv/iconv.osf1-4.0d.rc
  90
  91 into your system's global Muttngrc, which normally resides in /etc or
  92 /usr/local/etc.
  93
  94 If you really want to, you can configure Mutt-ng --disable-iconv, but
  95 there will then be no character set conversion.
  96
  97
  98 Platform Notes
  99 ==============
 100
 101 All platforms
 102
 103 There is a bug in most (if not all) S-Lang versions which
 104 prevents the Meta key from working with Mutt-ng.  A patch can
 105 be found in the file contrib/patch.slang-1.2.2.keypad.1 in
 106 this Mutt-ng distribution.
 107
 108 - Solaris 2.4
 109
 110 The system regcomp() and regexec() routines are very badly
 111 broken.  This should be automatically detected by the
 112 configure script.  If not, use the --with-regex switch when
 113 configuring Mutt-ng.
 114
 115 We are also hearing reports that Solaris 2.4's NLS libraries
 116 dump core with Mutt-ng when using a locale different from "C".
 117 Use the --with-included-gettext configuration switch if you
 118 experience this problem.
 119
 120 Color does not work right with Solaris curses.  You will
 121 have to compile with either ncurses or slang to get working
 122 color support.
 123
 124 - Solaris 2.6
 125
 126 There are reports that Mutt-ng behaves strangely when linked with
 127 the system regexp library.  Please use the --with-regex switch
 128 when configuring on this platform.
 129
 130 For the real fix, applying Sun patches # 105490-05 (linker
 131 patch) and # 105210-17 (libc and malloc patch) from
 132 sunsolve.sun.com has been reported to stop these problems
 133 from occuring.
 134
 135 - Linux
 136
 137 On recent Linux systems, flock() and fcntl() locks don't mix.  If
 138 you use the --enable-flock switch on such systems, be sure to
 139 give the --disable-fcntl argument as well.
 140
 141
 142 Mo Mai 23 19:52:22 CEST 2005 Nico 'nion' Golde <nion@muttng.org>
 143
 144  * updated/rewrote document