README 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. Sylpheed - a GTK+ based, lightweight, and fast e-mail client
  2. Copyright(C) 1999-2002 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+, running on
  18. X Window System, and aiming for
  19. * Quick response
  20. * Graceful, and sophisticated interface
  21. * Easy configuration, intuitive operation
  22. * Abundant features
  23. The appearance and interface are similar to some popular e-mail clients for
  24. Windows, such as Outlook Express, Becky!, and Datula. The interface is also
  25. designed to emulate the mailers on Emacsen, and almost all commands are
  26. accessible with the keyboard. You'll figure out the usage if you have ever
  27. used some e-mail clients for Windows, or Mew or Wanderlust.
  28. The messages are managed by MH format, and you'll be able to use it together
  29. with another mailer based on MH format (like Mew). You can also utilize
  30. fetchmail or/and procmail, and external programs on receiving (like inc or
  31. imget).
  32. Currently implemented features are:
  33. o POP3 support
  34. o IMAP4rev1 support
  35. o integrated NetNews client
  36. o unlimited multiple account handling
  37. o thread display
  38. o filtering
  39. o MIME (attachments)
  40. o built-in image view
  41. o X-Face support
  42. o multiple MH folder support
  43. o mbox importing / exporting
  44. o external editor support
  45. o message queueing
  46. o automatic mail checking
  47. o draft message function
  48. o template function
  49. o line-wrapping
  50. o clickable URI
  51. o XML-based address book
  52. o LDAP, vCard, and JPilot support
  53. o newly arrived and unread message management
  54. o Mew/Wanderlust-like key bind
  55. o printing
  56. o APOP authentication support
  57. o SMTP AUTH support
  58. o SSL support (POP3, SMTP, IMAP4rev1)
  59. o IPv6 support
  60. o drag & drop (partially implemented)
  61. o GnuPG support (currently implementing)
  62. o automake + autoconf support
  63. o internationalization of messages by gettext
  64. o support of many code sets, including UTF-8 (Unicode) (when using
  65. libjconv)
  66. and more.
  67. Installation
  68. ============
  69. See INSTALL for installation instructions.
  70. Usage
  71. =====
  72. Preparation before running
  73. --------------------------
  74. If you want to use characters other than English (aka US-ASCII),
  75. you must specify some environmental variables related to locale.
  76. For example:
  77. % export LANG=de_DE (sh, bash etc.)
  78. or
  79. % setenv LANG de_DE (csh, tcsh etc.)
  80. (replace de_DE to appropriate locale name)
  81. If you don't want translated messages, set LC_MESSAGES to "C"
  82. (and unset LC_ALL if specified).
  83. How to run
  84. ----------
  85. Input `sylpheed' on a command line, or double-click the icon on a file
  86. manager to execute.
  87. Initial startup
  88. ---------------
  89. When Sylpheed is executed for the first time, it automatically creates the
  90. configuration files under ~/.sylpheed/, and asks you the location of
  91. mailbox. The default is ~/Mail. If some files which are non-MH format
  92. already exist on the directory, you will have to specify another location.
  93. Required settings
  94. -----------------
  95. Initially, you have to create at least one account to send or receive
  96. messages (you can read messages that already exist without creating
  97. accounts). The configuration dialog will be shown by clicking
  98. "Configuration -> Create new account..." on the menu, or "Account" on
  99. the toolbar. Then, fill the required settings.
  100. Refer to the manual supplied with this program for the general usage.
  101. Information
  102. ===========
  103. You can check the newest version and information about Sylpheed at:
  104. http://sylpheed.good-day.net/
  105. There's also the manual of Sylpheed written by
  106. Yoichi Imai <yoichi@silver-forest.com> on:
  107. http://y-imai.good-day.net/sylpheed/
  108. Feedback
  109. ========
  110. Comments, ideas and (most of all) bug reports (and especially patches) are
  111. very welcome.
  112. Anonymous cvs
  113. =============
  114. You can get the newest source code with the anonymous cvs.
  115. First, set your CVSROOT environment variable to:
  116. :pserver:anonymous@sylpheed.good-day.net:/cvsroot/sylpheed
  117. Next, login with:
  118. cvs login
  119. and just press Enter key to `CVS password:'.
  120. Move to an appropriate directory, and with the command:
  121. cvs -z3 checkout sylpheed
  122. a source tree named `sylpheed' is created under the current directory.
  123. To update to the newest source tree, run the command:
  124. cvs -z3 update
  125. on the top directory of the source tree.
  126. --
  127. Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>