2005-10-13 [colin] 1.9.15cvs44

[claws.git] / README

diff --git a/README b/README
index 50bbb31ab8d3dfd46015a392481b536546ecb79c..29c8b8fdbcdb12add51489700434e841d00dfa0f 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
        Sylpheed - a GTK+ based, lightweight, and fast e-mail client
 
        Sylpheed - a GTK+ based, lightweight, and fast e-mail client
 

-   Copyright(C) 1999-2001 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>
+   Copyright(C) 1999-2004 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>

 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by


@@ -14,7 +14,7 @@
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software

-   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 
    For more details see the file COPYING.
 
 
    For more details see the file COPYING.
 


@@ -22,59 +22,86 @@
 What's Sylpheed
 ===============
 
 What's Sylpheed
 ===============
 

-Sylpheed is an e-mail client (and news reader) based on GTK+, running on
-X Window System, and aiming for
+Sylpheed is an e-mail client and news reader based on GTK+ GUI toolkit,
+and runs on X Window System.

 
 

-  * Quick response
-  * Graceful, and sophisticated interface
-  * Easy configuration, intuitive operation
-  * Abundant features
+Sylpheed is a free software distributed under the GNU GPL.
+
+The development of Sylpheed sets the following things as its goal:
+
+  * Quick response by keeping CPU and memory usage to a minimum
+  * Fast processing even though a folder contains large number of messages
+    (more than 10 thousand)
+  * Enables intuitive operation by simple, graceful, and well-polished
+    interface
+  * Similar operation methods to other mailers.
+  * Readily available with simple configuration
+  * Fully equipped with features required as a mailer
+  * Full support of Japanese, and support of i18n
+  * Enables flexible interaction with external commands
+  * Stable, and don't lose any data (to the utmost) in case of crash

 
 The appearance and interface are similar to some popular e-mail clients for
 Windows, such as Outlook Express, Becky!, and Datula. The interface is also
 
 The appearance and interface are similar to some popular e-mail clients for
 Windows, such as Outlook Express, Becky!, and Datula. The interface is also

-designed to emulate the mailers on Emacsen, and almost all commands are
-accessible with the keyboard. You'll figure out the usage if you have ever
-used some e-mail clients for Windows, or Mew or Wanderlust.
+designed to emulate the Emacs-based mailers, and almost all commands are
+accessible with the keyboard. So you will able to migrate to Sylpheed
+without much discomfort in the case where you are accustomed to other
+mailers.

 
 The messages are managed by MH format, and you'll be able to use it together
 
 The messages are managed by MH format, and you'll be able to use it together

-with another mailer based on MH format (like Mew). You can also utilize
-fetchmail or/and procmail, and external programs on receiving (like inc or
-imget).
+with another mailer based on MH format (like Mew). It has less possibility
+of losing mails on failures since one file corresponds to one mail. You can
+import or export mbox format messages. You can also utilize fetchmail or/and
+procmail, and external programs on receiving (like inc or imget).
+
+Currently implemented major features
+====================================
+
+Supported protocols
+
+       o POP3
+       o IMAP4rev1
+       o SMTP
+       o NNTP
+       o SSL/TLSv1 (POP3, SMTP, IMAP4rev1, NNTP)
+       o IPv6

 
 

-Currently implemented features are:
+Features

 
 

-       o POP3 support
-       o IMAP4rev1 support
-       o integrated NetNews client
-       o unlimited multiple account handling
+       o multiple accounts

        o thread display
        o thread display

-       o filtering
+       o powerful filtering

        o MIME (attachments)
        o MIME (attachments)

+       o integrated News reader
+       o SMTP AUTH support
+       o CRAM-MD5 authentication (SMTP AUTH / IMAP4rev1)
+       o APOP authentication (POP3)
+       o PGP signature / encryption (requires GPGME)

        o built-in image view
        o built-in image view

-       o X-Face support
+       o X-Face display
+       o user-defined headers
+       o color label
+       o Mew/Wanderlust compatible key bind

        o multiple MH folder support
        o mbox importing / exporting
        o multiple MH folder support
        o mbox importing / exporting

-       o external editor support
+       o external editor

        o message queueing
        o automatic mail checking
        o message queueing
        o automatic mail checking

-       o draft message function
+       o draft message
+       o template

        o line-wrapping
        o clickable URI
        o XML-based address book
        o line-wrapping
        o clickable URI
        o XML-based address book

-       o LDAP, vCard, and JPilot support

        o newly arrived and unread message management
        o newly arrived and unread message management

-       o Mew/Wanderlust-like key bind

        o printing
        o printing

-       o APOP authentication support
-       o SMTP AUTH support
-       o SSL support (POP3, SMTP, IMAP4rev1)
-       o IPv6 support
-       o drag & drop (partially implemented)
-       o GnuPG support (currently implementing)
-       o automake + autoconf support
+       o offline mode
+       o remote operation by command line
+       o per-folder configuration
+       o LDAP, vCard, and JPilot support
+       o Drag & Drop
+       o autoconf, automake support

        o internationalization of messages by gettext
        o internationalization of messages by gettext

-       o support of many code sets, including UTF-8 (Unicode) (when using
-         libjconv)
+       o support of many code sets, including UTF-8 (Unicode)

 
 and more.
 
 
 and more.
 


@@ -86,6 +113,24 @@ See INSTALL for installation instructions.
 Usage
 =====
 
 Usage
 =====
 

+Preparation before running
+--------------------------
+
+If you want to use characters other than English (aka US-ASCII),
+you must specify some environmental variables related to locale.
+For example:
+
+% export LANG=de_DE    (sh, bash etc.)
+
+or
+
+% setenv LANG de_DE    (csh, tcsh etc.)
+
+(replace de_DE to appropriate locale name)
+
+If you don't want translated messages, set LC_MESSAGES to "C"
+(and unset LC_ALL if specified).
+

 How to run
 ----------
 
 How to run
 ----------
 


@@ -111,6 +156,28 @@ the toolbar. Then, fill the required settings.
 
 Refer to the manual supplied with this program for the general usage.
 
 
 Refer to the manual supplied with this program for the general usage.
 

+Hidden settings
+---------------
+
+You can configure most of the features in Sylpheed through the preferences
+dialog, but there are a few parameters which don't have user interface
+(you don't have to modify them in normal use). You must edit
+~/.sylpheed/sylpheedrc by an editor when Sylpheed is not running.
+
+allow_jisx0201_kana            allow JIS X 0201 Kana (half-width kana) on
+                               sending.
+                               0: off  1: on   [default: 0]
+bold_font                      bold font used in folder, summary and text view
+small_font                     small font used in summary view etc.
+enable_hscrollbar              enable horizontal scroll bar in summary view
+                               0: off  1: on   [default: 1]
+bold_unread                    show unread messages using bold font in
+                               summary view
+                               0: off  1: on   [default: 1]
+folderview_vscrollbar_policy   specify the policy of vertical scroll bar
+                               of folder view
+                               0: always  1: automatic  2: never [default: 0]
+

 Information
 ===========
 
 Information
 ===========
 


@@ -156,5 +223,5 @@ To update to the newest source tree, run the command:
 
 on the top directory of the source tree.
 
 
 on the top directory of the source tree.
 

---
+-- 

 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>
 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>