revise 'translatable string' policy
[claws.git] / README
diff --git a/README b/README
index 93d946f..2b830ae 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
        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
 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
-designed to emulate the mailers on Emacsen, and almost all commands are
-accessible with the keyboard.
+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
-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).
-
-Currently implemented features are:
-
-       o user-friendly and intuitive interface
-       o 3-paned view like many Windoze-based mail client
-       o ability of keyboard-only operation
-       o Mew/Wanderlust-like key bind (most of normally used keys have been
-         implemented)
-       o IMAP4rev1 support
-       o multipart MIME
-       o built-in image view
-       o X-Face support
-       o external editor support
+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
+
+Features
+
        o unlimited multiple account handling
-       o message queueing
+       o thread display
        o filtering
-       o draft message function
-       o line-wrapping
-       o XML-based address book
-       o APOP support
-       o unread message management
+       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 X-Face display
+       o user-defined headers
+       o color label
+       o Mew/Wanderlust compatible key bind
        o multiple MH folder support
-       o integrated NetNews client
-       o IPv6 support
-       o GnuPG support (currently implementing)
-       o multithread support (experimental)
        o mbox importing / exporting
+       o external editor
+       o message queueing
+       o automatic mail checking
+       o draft message
+       o template
+       o line-wrapping
+       o clickable URI
+       o XML-based address book
+       o newly arrived and unread message management
+       o printing
+       o offline mode
+       o remote operation by command line
+       o per-folder configuration
+       o LDAP, vCard, and JPilot support
        o drag & drop (partially implemented)
-       o fast thread display
-       o high-speed message processing
-       o lightweight resource usage
-       o easily customizable configuration
-       o supports automake + autoconf, and internationalization of message
-         by gettext
 
-You'll figure out the usage if you have used a mailer on Windows, or
-Mew or Wanderlust.
+Others
+
+       o autoconf, automake support
+       o internationalization of messages by gettext
+       o support of many code sets, including UTF-8 (Unicode)
+
+and more.
 
 Installation
 ============
@@ -85,6 +116,24 @@ See INSTALL for installation instructions.
 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
 ----------
 
@@ -110,6 +159,28 @@ the toolbar. Then, fill the required settings.
 
 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 (hankaku 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
 ===========
 
@@ -155,5 +226,5 @@ To update to the newest source tree, run the command:
 
 on the top directory of the source tree.
 
---
+-- 
 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>