README

   1
   2
   3 -----------------------------------------------------------------------
   4                 Alpine/Pico/Pilot/Web Alpine/Imapd Distribution
   5 -----------------------------------------------------------------------
   6
   7
   8 /* ====================================================================
   9  * Copyright 2006-2009 University of Washington
  10  *
  11  * Licensed under the Apache License, Version 2.0 (the "License");
  12  * you may not use this file except in compliance with the License.
  13  * You may obtain a copy of the License at
  14  *
  15  *     http://www.apache.org/licenses/LICENSE-2.0
  16  *
  17  * ====================================================================
  18 */
  19
  20 For the latest info about Alpine, see http://www.washington.edu/alpine
  21
  22 -----------------------------------------------------------------------
  23 DISTRIBUTION CONTENTS
  24 -----------------------------------------------------------------------
  25
  26 This Alpine distribution includes:
  27
  28 alpine     - The Alpine source directory
  29 configure  - Script to set system-specific configuration, defaults
  30 contrib    - Contributed ports and additions
  31 doc        - Documentation directory. The main documentation is
  32              tech-notes.txt
  33 imap       - Source tree containing C-Client IMAP implementation
  34 m4         - macros used in the configure process
  35 packages   - Scripts for building packages for various Linux
  36              distributions
  37 pico       - The Pico and Pilot source directory
  38 pith       - Core functions common to Alpine/Web Alpine
  39 po         - localization data
  40 web        - Source and scripts for web-based version of Alpine
  41
  42 Most of the documentation is in doc/tech-notes.txt. It is not user
  43 level documentation, but there are things in it some users might find
  44 useful.  The directory doc/tech-notes contains source for
  45 doc/tech-notes.txt in HTML format which can be viewed via a Web
  46 pbrowser by opening doc/tech-notes/index.html.
  47
  48 User level documentation for Alpine is contained in the programs
  49 themselves in the form of context-sensitive help.
  50
  51
  52 -----------------------------------------------------------------------
  53 PRELIMINARIES
  54 -----------------------------------------------------------------------
  55
  56 If you are reading this, you have presumably succeeded in extracting
  57 the distribution from the compressed tar archive file, via the
  58 following command, or equivalent:
  59
  60         tar zxf alpine.tar.z
  61
  62 Some of the instructions that follow assume that your current workding
  63 directory is the alpine-X.XX directory created by the un-tar process
  64 above.
  65
  66
  67 -----------------------------------------------------------------------
  68 BUILD PROCESS
  69 -----------------------------------------------------------------------
  70
  71 The Alpine build process is based on GNU autotools.  On most Unix
  72 systems, generating a suitable Alpine binary from the source
  73 distribution should be as simple as typing the commands:
  74
  75         ./configure
  76         make
  77
  78 For a list of configuration options and default Alpine settings type:
  79
  80        ./configure --help
  81
  82 Note, the included UW IMAP Toolkit used for mailbox access does not
  83 make use of GNU autotools.  However, in most cases Alpine's configure
  84 script should set the appropriate make target and options.  The
  85 targetted OS can be set from Alpine's configure command line, but in
  86 rare cases more significant manual intervention may be required.  If
  87 problems are encountered, see imap/README for more details.
  88
  89 The PC-Alpine build is based on the Microsoft C compiler and
  90 libraries.  The Alpine Team bases builds on Visual Studio 8 from the
  91 command line using the static build.bat batch and makefiles to
  92 generate suitable binaries.
  93
  94 The Web Alpine application requires a few extra, manual steps to get
  95 all the components built and installed.  See web/README for an
  96 explanation of the various components and web/INSTALL for a basic
  97 installation recipe.
  98
  99
 100 -----------------------------------------------------------------------
 101 RESULTING EXECUTABLES
 102 -----------------------------------------------------------------------
 103
 104 The executables produced are:
 105
 106  alpine The Alpine mailer. Once compiled this should work just fine on
 107         your system with no other files than this binary, and no
 108         modifications to your system. Optionally you may create two
 109         configuration files, /usr/local/lib/pine.conf and
 110         /usr/local/lib/pine.info. See the documentation for details.
 111
 112  pico   The standalone editor similar to the Alpine message composer.
 113         This is a very simple straight forward text editor.
 114
 115  pilot  The standalone file system navigator.
 116
 117  alpined
 118         The Web Alpine serveret that is the primary component of
 119         Web Alpine
 120
 121  imapd  The IMAP daemon. If you want to run alpine in client/server
 122         mode, this is the daemon to run on the server. Installing this
 123         requires system privileges and modifications to /etc/services.
 124         See doc/tech-notes for more details.
 125
 126  mtest  The test IMAP client, an absolutely minimal mail client, useful
 127         for debugging.
 128
 129  rpload Utility for uploading a local pinerc or address book to an IMAP
 130         server.
 131
 132  rpdump Utility for downloading a pinerc or address book to the
 133         local machine.
 134
 135  mailutil
 136         Utility for performing various operations on mailboxes,
 137         be they local or remote.
 138
 139 In general "make install" should place alpine, pico and pilot, and
 140 their corresponding man pages, in the proper directory for your
 141 system.  As the remaining binaries are intended for specific uses or
 142 are a component of a larger package, their installation is typically
 143 done by hand.
 144
 145 --
 146 alpine.tar.z README
 147 $Id: README 1204 2009-02-02 19:54:23Z hubert@u.washington.edu $