README 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228
  1. Sylpheed - a GTK+ based, lightweight, and fast e-mail client
  2. Copyright(C) 1999-2004 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>
  3. This program is free software; you can redistribute it and/or modify
  4. it under the terms of the GNU General Public License as published by
  5. the Free Software Foundation; either version 2, or (at your option)
  6. any later version.
  7. This program is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. GNU General Public License for more details.
  11. You should have received a copy of the GNU General Public License
  12. along with this program; if not, write to the Free Software
  13. Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  14. For more details see the file COPYING.
  15. What's Sylpheed
  16. ===============
  17. Sylpheed is an e-mail client and news reader based on GTK+ GUI toolkit,
  18. and runs on X Window System.
  19. Sylpheed is a free software distributed under the GNU GPL.
  20. The development of Sylpheed sets the following things as its goal:
  21. * Quick response by keeping CPU and memory usage to a minimum
  22. * Fast processing even though a folder contains large number of messages
  23. (more than 10 thousand)
  24. * Enables intuitive operation by simple, graceful, and well-polished
  25. interface
  26. * Similar operation methods to other mailers.
  27. * Readily available with simple configuration
  28. * Fully equipped with features required as a mailer
  29. * Full support of Japanese, and support of i18n
  30. * Enables flexible interaction with external commands
  31. * Stable, and don't lose any data (to the utmost) in case of crash
  32. The appearance and interface are similar to some popular e-mail clients for
  33. Windows, such as Outlook Express, Becky!, and Datula. The interface is also
  34. designed to emulate the Emacs-based mailers, and almost all commands are
  35. accessible with the keyboard. So you will able to migrate to Sylpheed
  36. without much discomfort in the case where you are accustomed to other
  37. mailers.
  38. The messages are managed by MH format, and you'll be able to use it together
  39. with another mailer based on MH format (like Mew). It has less possibility
  40. of losing mails on failures since one file corresponds to one mail. You can
  41. import or export mbox format messages. You can also utilize fetchmail or/and
  42. procmail, and external programs on receiving (like inc or imget).
  43. Currently implemented major features
  44. ====================================
  45. Supported protocols
  46. o POP3
  47. o IMAP4rev1
  48. o SMTP
  49. o NNTP
  50. o SSL/TLSv1 (POP3, SMTP, IMAP4rev1, NNTP)
  51. o IPv6
  52. Features
  53. o multiple accounts
  54. o thread display
  55. o powerful filtering
  56. o MIME (attachments)
  57. o integrated News reader
  58. o SMTP AUTH support
  59. o CRAM-MD5 authentication (SMTP AUTH / IMAP4rev1)
  60. o APOP authentication (POP3)
  61. o PGP signature / encryption (requires GPGME)
  62. o built-in image view
  63. o X-Face display
  64. o user-defined headers
  65. o color label
  66. o Mew/Wanderlust compatible key bind
  67. o multiple MH folder support
  68. o mbox importing / exporting
  69. o external editor
  70. o message queueing
  71. o automatic mail checking
  72. o draft message
  73. o template
  74. o line-wrapping
  75. o clickable URI
  76. o XML-based address book
  77. o newly arrived and unread message management
  78. o printing
  79. o offline mode
  80. o remote operation by command line
  81. o per-folder configuration
  82. o LDAP, vCard, and JPilot support
  83. o Drag & Drop
  84. o autoconf, automake support
  85. o internationalization of messages by gettext
  86. o support of many code sets, including UTF-8 (Unicode)
  87. and more.
  88. Installation
  89. ============
  90. See INSTALL for installation instructions.
  91. Usage
  92. =====
  93. Preparation before running
  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. % export LANG=de_DE (sh, bash etc.)
  99. or
  100. % setenv LANG de_DE (csh, tcsh etc.)
  101. (replace de_DE to appropriate locale name)
  102. If you don't want translated messages, set LC_MESSAGES to "C"
  103. (and unset LC_ALL if specified).
  104. How to run
  105. ----------
  106. Input `sylpheed' on a command line, or double-click the icon on a file
  107. manager to execute.
  108. Initial startup
  109. ---------------
  110. When Sylpheed is executed for the first time, it automatically creates the
  111. configuration files under ~/.sylpheed/, and asks you the location of
  112. mailbox. The default is ~/Mail. If some files which are non-MH format
  113. already exist on the directory, you will have to specify another location.
  114. Required settings
  115. -----------------
  116. Initially, you have to create at least one account to send or receive
  117. messages (you can read messages that already exist without creating
  118. accounts). The configuration dialog will be shown by clicking
  119. "Configuration -> Create new account..." on the menu, or "Account" on
  120. the toolbar. Then, fill the required settings.
  121. Refer to the manual supplied with this program for the general usage.
  122. Hidden settings
  123. ---------------
  124. You can configure most of the features in Sylpheed through the preferences
  125. dialog, but there are a few parameters which don't have user interface
  126. (you don't have to modify them in normal use). You must edit
  127. ~/.sylpheed/sylpheedrc by an editor when Sylpheed is not running.
  128. allow_jisx0201_kana allow JIS X 0201 Kana (half-width kana) on
  129. sending.
  130. 0: off 1: on [default: 0]
  131. bold_font bold font used in folder, summary and text view
  132. small_font small font used in summary view etc.
  133. enable_hscrollbar enable horizontal scroll bar in summary view
  134. 0: off 1: on [default: 1]
  135. bold_unread show unread messages using bold font in
  136. summary view
  137. 0: off 1: on [default: 1]
  138. folderview_vscrollbar_policy specify the policy of vertical scroll bar
  139. of folder view
  140. 0: always 1: automatic 2: never [default: 0]
  141. Information
  142. ===========
  143. You can check the newest version and information about Sylpheed at:
  144. http://sylpheed.good-day.net/
  145. There's also the manual of Sylpheed written by
  146. Yoichi Imai <yoichi@silver-forest.com> on:
  147. http://y-imai.good-day.net/sylpheed/
  148. Feedback
  149. ========
  150. Comments, ideas and (most of all) bug reports (and especially patches) are
  151. very welcome.
  152. Anonymous cvs
  153. =============
  154. You can get the newest source code with the anonymous cvs.
  155. First, set your CVSROOT environment variable to:
  156. :pserver:anonymous@sylpheed.good-day.net:/cvsroot/sylpheed
  157. Next, login with:
  158. cvs login
  159. and just press Enter key to `CVS password:'.
  160. Move to an appropriate directory, and with the command:
  161. cvs -z3 checkout sylpheed
  162. a source tree named `sylpheed' is created under the current directory.
  163. To update to the newest source tree, run the command:
  164. cvs -z3 update
  165. on the top directory of the source tree.
  166. --
  167. Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>