INSTALL

   1 Building and Installation Instructions for Mailvisa
   2 ===================================================
   3
   4 This file contains the building and installation instructions for
   5 Mailvisa. A quick and dirty procedure is given first, followed by more
   6 detailed instructions.
   7
   8 Quick Start
   9 -----------
  10
  11 In short, the process boils down to
  12
  13 ./configure
  14 make
  15 make install
  16
  17 This will configure Mailvisa to use the autodetected Ruby interpreter,
  18 build it, and install it to /usr/local.
  19
  20 Configuration
  21 -------------
  22
  23 The configure script takes a number of parameters to control where
  24 things will eventually be installed, and the location of the Ruby
  25 interpreter. Each of these parameters can be specified using a command
  26 line option or an environment variable. If neither is specified, a
  27 default is used. The output of ./configure --help describes the possible
  28 options:
  29
  30 --prefix <path>
  31         Set the installation prefix to <path>.
  32 --bindir <path>
  33         Set the installation directory for binaries to <path>.
  34 --datadir <path>
  35         Set the installation directory for data to <path>.
  36 --mandir <path>
  37         Set the installation directory for manpages to <path>.
  38 --ruby <path>
  39         Use the ruby interpreter specified by <path>
  40
  41 The following table lists the corresponding environment variables and
  42 the defaults:
  43
  44 Option          Variable        Default
  45 --prefix        PREFIX          /usr/local
  46 --bindir        bindir          ${PREFIX}/bin
  47 --datadir       datadir         ${PREFIX}/share
  48 --mandir        mandir          ${PREFIX}/man
  49 --ruby          RUBY            ${bindir}/ruby
  50
  51 The location of the Ruby interpreter is also detected by which(1), which
  52 should find the interpreter if it's in your path.
  53
  54 The configure script writes the configured paths to Makefile.cfg, which
  55 is used by the rest of the build process.
  56
  57 As an example, if you wanted to build Mailvisa for installation to /usr
  58 (instead of the default of /usr/local), and your Ruby interpreter is
  59 in /usr/bin/ruby1.8, you could use the following command:
  60
  61 ./configure --prefix /usr --ruby /usr/bin/ruby1.8
  62
  63 Building
  64 --------
  65
  66 Building Mailvisa involves generating the script mailvisa with correct
  67 paths for the Ruby interpreter and the locations of the support files.
  68 This is accomplised by running make_mailvisa.rb with the environment
  69 variables RUBY and pagkagedir set to the location of the Ruby
  70 interpreter and the location where the support files will be installed,
  71 respectively. Running make with no arguments does this for you, taking
  72 the paths from Makefile.cfg.
  73
  74 You can override the paths using environment variables, should you wish
  75 to do so. However, you would normally have set the right values using
  76 the configure script, so building only requires that you type
  77
  78 make
  79
  80 Installation
  81 ------------
  82
  83 Installation is done by running
  84
  85 make install
  86
  87 You can performe a staged install by setting the environment variable
  88 PREFIX to your staging directory. E.g.
  89
  90 env PREFIX=stage/usr make install
  91
  92 will install files to stage/usr in the current directory, instead of the
  93 configured installation prefix, but paths will be set as if the package
  94 had been installed to the configured prefix. This is useful for
  95 packaging.
  96
  97 The above is assuming that you have not overridden the paths that are
  98 normally relative to PREFIX (i.e. bindir, datadir, and mandir). If you
  99 have, you will have to set new locations for these, as well. E.g., if
 100 you had set datadir to /opt, you would have to run
 101
 102 env PREFIX=stage/usr datadir=stage/opt make install
 103
 104 instead.