Fix a Gtk+ warning; tiny UI cleanup
[claws.git] / 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 remote operation by command line
58         o per-folder configuration
59         o external editor support
60         o message queueing
61         o automatic mail checking
62         o draft message function
63         o template function
64         o line-wrapping
65         o clickable URI
66         o XML-based address book
67         o LDAP, vCard, and JPilot support
68         o newly arrived and unread message management
69         o Mew/Wanderlust-like key bind
70         o printing
71         o APOP authentication support
72         o SMTP AUTH support
73         o SSL support (POP3, SMTP, IMAP4rev1)
74         o IPv6 support
75         o drag & drop (partially implemented)
76         o GnuPG support (currently in progress)
77         o automake + autoconf support
78         o internationalization of messages by gettext
79         o support of many code sets, including UTF-8 (Unicode) (when using
80           libjconv)
81
82 and more.
83
84 Installation
85 ============
86
87 See INSTALL for installation instructions.
88
89 Usage
90 =====
91
92 Preparation before running
93 --------------------------
94
95 If you want to use characters other than English (aka US-ASCII),
96 you must specify some environmental variables related to locale.
97 For example:
98
99 % export LANG=de_DE     (sh, bash etc.)
100
101 or
102
103 % setenv LANG de_DE     (csh, tcsh etc.)
104
105 (replace de_DE to appropriate locale name)
106
107 If you don't want translated messages, set LC_MESSAGES to "C"
108 (and unset LC_ALL if specified).
109
110 How to run
111 ----------
112
113 Input `sylpheed' on a command line, or double-click the icon on a file
114 manager to execute.
115
116 Initial startup
117 ---------------
118
119 When Sylpheed is executed for the first time, it automatically creates the
120 configuration files under ~/.sylpheed/, and asks you the location of
121 mailbox. The default is ~/Mail. If some files which are non-MH format
122 already exist on the directory, you will have to specify another location.
123
124 Required settings
125 -----------------
126
127 Initially, you have to create at least one account to send or receive
128 messages (you can read messages that already exist without creating
129 accounts). The configuration dialog will be shown by clicking
130 "Configuration -> Create new account..." on the menu, or "Account" on
131 the toolbar. Then, fill the required settings.
132
133 Refer to the manual supplied with this program for the general usage.
134
135 Hidden settings
136 ---------------
137
138 You can configure most of the features in Sylpheed through the preferences
139 dialog, but there are a few parameters which don't have user interface
140 (you don't have to modify them in normal use). You must edit
141 ~/.sylpheed/sylpheedrc by an editor when Sylpheed is not running.
142
143 bold_font                       bold font used in folder, summary and text view
144 small_font                      small font used in summary view etc.
145 enable_hscrollbar               enable horizontal scroll bar in summary view
146                                 0: off  1: on   [default: 1]
147 bold_unread                     show unread messages using bold font in
148                                 summary view
149                                 0: off  1: on   [default: 1]
150 folderview_vscrollbar_policy    specify the policy of vertical scroll bar
151                                 of folder view
152                                 0: always  1: automatic  2: never [default: 0]
153
154 Information
155 ===========
156
157 You can check the newest version and information about Sylpheed at:
158
159         http://sylpheed.good-day.net/
160
161 There's also the manual of Sylpheed written by
162 Yoichi Imai <yoichi@silver-forest.com> on:
163
164         http://y-imai.good-day.net/sylpheed/
165
166 Feedback
167 ========
168
169 Comments, ideas and (most of all) bug reports (and especially patches) are
170 very welcome.
171
172 Anonymous cvs
173 =============
174
175 You can get the newest source code with the anonymous cvs.
176
177 First, set your CVSROOT environment variable to:
178
179         :pserver:anonymous@sylpheed.good-day.net:/cvsroot/sylpheed
180
181 Next, login with:
182
183         cvs login
184
185 and just press Enter key to `CVS password:'.
186
187 Move to an appropriate directory, and with the command:
188
189         cvs -z3 checkout sylpheed
190
191 a source tree named `sylpheed' is created under the current directory.
192
193 To update to the newest source tree, run the command:
194
195         cvs -z3 update
196
197 on the top directory of the source tree.
198
199 -- 
200 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>