README

   1         Sylpheed - a GTK+ based, lightweight, and fast e-mail client
   2
   3    Copyright(C) 1999-2002 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2, or (at your option)
   8    any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18
  19    For more details see the file COPYING.
  20
  21
  22 What's Sylpheed
  23 ===============
  24
  25 Sylpheed is an e-mail client (and news reader) based on GTK+, running on
  26 X Window System, and aiming for
  27
  28   * Quick response
  29   * Graceful, and sophisticated interface
  30   * Easy configuration, intuitive operation
  31   * Abundant features
  32
  33 The appearance and interface are similar to some popular e-mail clients for
  34 Windows, such as Outlook Express, Becky!, and Datula. The interface is also
  35 designed to emulate the mailers on Emacsen, and almost all commands are
  36 accessible with the keyboard. You'll figure out the usage if you have ever
  37 used some e-mail clients for Windows, or Mew or Wanderlust.
  38
  39 The messages are managed by MH format, and you'll be able to use it together
  40 with another mailer based on MH format (like Mew). You can also utilize
  41 fetchmail or/and procmail, and external programs on receiving (like inc or
  42 imget).
  43
  44 Currently implemented features are:
  45
  46         o POP3 support
  47         o IMAP4rev1 support
  48         o integrated NetNews client
  49         o unlimited multiple account handling
  50         o thread display
  51         o filtering
  52         o MIME (attachments)
  53         o built-in image view
  54         o X-Face support
  55         o multiple MH folder support
  56         o mbox importing / exporting
  57         o external editor support
  58         o message queueing
  59         o automatic mail checking
  60         o draft message function
  61         o template function
  62         o line-wrapping
  63         o clickable URI
  64         o XML-based address book
  65         o LDAP, vCard, and JPilot support
  66         o newly arrived and unread message management
  67         o Mew/Wanderlust-like key bind
  68         o printing
  69         o APOP authentication support
  70         o SMTP AUTH support
  71         o SSL support (POP3, SMTP, IMAP4rev1)
  72         o IPv6 support
  73         o drag & drop (partially implemented)
  74         o GnuPG support (currently implementing)
  75         o automake + autoconf support
  76         o internationalization of messages by gettext
  77         o support of many code sets, including UTF-8 (Unicode) (when using
  78           libjconv)
  79
  80 and more.
  81
  82 Installation
  83 ============
  84
  85 See INSTALL for installation instructions.
  86
  87 Usage
  88 =====
  89
  90 Preparation before running
  91 --------------------------
  92
  93 If you want to use characters other than English (aka US-ASCII),
  94 you must specify some environmental variables related to locale.
  95 For example:
  96
  97 % export LANG=de_DE     (sh, bash etc.)
  98
  99 or
 100
 101 % setenv LANG de_DE     (csh, tcsh etc.)
 102
 103 (replace de_DE to appropriate locale name)
 104
 105 If you don't want translated messages, set LC_MESSAGES to "C"
 106 (and unset LC_ALL if specified).
 107
 108 How to run
 109 ----------
 110
 111 Input `sylpheed' on a command line, or double-click the icon on a file
 112 manager to execute.
 113
 114 Initial startup
 115 ---------------
 116
 117 When Sylpheed is executed for the first time, it automatically creates the
 118 configuration files under ~/.sylpheed/, and asks you the location of
 119 mailbox. The default is ~/Mail. If some files which are non-MH format
 120 already exist on the directory, you will have to specify another location.
 121
 122 Required settings
 123 -----------------
 124
 125 Initially, you have to create at least one account to send or receive
 126 messages (you can read messages that already exist without creating
 127 accounts). The configuration dialog will be shown by clicking
 128 "Configuration -> Create new account..." on the menu, or "Account" on
 129 the toolbar. Then, fill the required settings.
 130
 131 Refer to the manual supplied with this program for the general usage.
 132
 133 Hidden settings
 134 ---------------
 135
 136 You can configure most of the features in Sylpheed through the preferences
 137 dialog, but there are a few parameters which don't have user interface
 138 (you don't have to modify them in normal use). You must edit
 139 ~/.sylpheed/sylpheedrc by an editor when Sylpheed is not running.
 140
 141 bold_font                       bold font used in folder, summary and text view
 142 small_font                      small font used in summary view etc.
 143 enable_hscrollbar               enable horizontal scroll bar in summary view
 144                                 0: off  1: on   [default: 1]
 145 bold_unread                     show unread messages using bold font in
 146                                 summary view
 147                                 0: off  1: on   [default: 1]
 148 folderview_vscrollbar_policy    specify the policy of vertical scroll bar
 149                                 of folder view
 150                                 0: always  1: automatic  2: never [default: 0]
 151
 152 Information
 153 ===========
 154
 155 You can check the newest version and information about Sylpheed at:
 156
 157         http://sylpheed.good-day.net/
 158
 159 There's also the manual of Sylpheed written by
 160 Yoichi Imai <yoichi@silver-forest.com> on:
 161
 162         http://y-imai.good-day.net/sylpheed/
 163
 164 Feedback
 165 ========
 166
 167 Comments, ideas and (most of all) bug reports (and especially patches) are
 168 very welcome.
 169
 170 Anonymous cvs
 171 =============
 172
 173 You can get the newest source code with the anonymous cvs.
 174
 175 First, set your CVSROOT environment variable to:
 176
 177         :pserver:anonymous@sylpheed.good-day.net:/cvsroot/sylpheed
 178
 179 Next, login with:
 180
 181         cvs login
 182
 183 and just press Enter key to `CVS password:'.
 184
 185 Move to an appropriate directory, and with the command:
 186
 187         cvs -z3 checkout sylpheed
 188
 189 a source tree named `sylpheed' is created under the current directory.
 190
 191 To update to the newest source tree, run the command:
 192
 193         cvs -z3 update
 194
 195 on the top directory of the source tree.
 196
 197 --
 198 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>