README

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