claws-mail/doc/man/sylpheed.1
2004-01-12 21:28:31 +00:00

307 lines
6 KiB
Groff

.TH "Sylpheed-Claws" "1" "" "Hiroyuki Yamamoto & the Sylpheed-Claws team" ""
.SH "NAME"
.LP
Sylpheed\-Claws \- a GTK+ based fast e\-mail and news client
.SH "DESCRIPTION"
.TP
Sylpheed\-Claws is an e\-mail client (and news reader) based on GTK+, running on X Window System, and aiming for
.br
* Quick response
.br
* Graceful, and sophisticated interface
.br
* Easy configuration, intuitive operation
.br
* Abundant features
\fR
.TP
Currently implemented features include:
o POP3 support
.br
o IMAP4rev1 support
.br
o integrated NetNews client
.br
o unlimited multiple account handling
.br
o thread display
.br
o filtering
.br
o MIME (attachments)
.br
o built\-in image view
.br
o X\-Face support
.br
o multiple MH folder support
.br
o mbox importing / exporting
.br
o external editor support
.br
o message queueing
.br
o automatic mail checking
.br
o draft message function
.br
o template function
.br
o line\-wrapping
.br
o clickable URI
.br
o XML\-based address book
.br
o LDAP, vCard, and JPilot support
.br
o newly arrived and unread message management
.br
o Mew/Wanderlust\-like key bind
.br
o printing
.br
o APOP authentication support
.br
o SMTP AUTH support
.br
o SSL support (POP3, SMTP, IMAP4rev1)
.br
o IPv6 support
.br
o drag & drop (partially implemented)
.br
o GnuPG support (currently implementing)
.br
o automake + autoconf support
.br
o internationalization of messages by gettext
.br
o support of many code sets, including UTF\-8 (Unicode) (when using libjconv)
.br
o support for plugins
\fR
.LP
This list is not complete.
.SH "OPTIONS"
.LP
\fB \-\-compose\fR [address]
.br
\fB \-\-attach file1 [file2]...\fR
.br
\fB \-\-receive\fR
.br
\fB \-\-receive\-all\fR
.br
\fB \-\-send\fR
.br
\fB \-\-status\fR
.br
\fB \-\-status folder[/subfolder]\fR
.br
\fB \-\-status\-full\fR
.br
\fB \-\-online\fR
.br
\fB \-\-offline\fR
.br
\fB \-\-debug\fR
.br
\fB \-\-help\fR
.br
\fB \-\-version\fR
.br
\fB \-\-config\-dir\fR
.SH "FILES"
.LP
.TP
$HOME/Mail
Default directory for mail storage
.TP
$PREFIX/share/sylpheed
Global program directory
.TP
$PREFIX/share/sylpheed/manual
Manual files in HTML format
.TP
$PREFIX/share/sylpheed/faq
FAQ files in HTML format
.TP
$PREFIX/share/sylpheed/themes
Global themes directory
.TP
$PREFIX/lib/sylpheed/plugins
Directory for plugins
.TP
$PREFIX/include/sylpheed
Directory for header files
.TP
$HOME/.sylpheed
Default directory for user's configuration files directory
.TP
$HOME/.sylpheed/themes
User's themes directory
.TP
$HOME/.sylpheed/accountrc
Configuration for account(s)
.TP
$HOME/.sylpheed/addrbook*
Addressbook files
.TP
$HOME/.sylpheed/command_history
User\-specified commands
.TP
$HOME/.sylpheed/customheaderrc
Configuration for custom headers for sending mail
.TP
$HOME/.sylpheed/dispheaderrc
Configuration for custom display of headers in message view
.TP
$HOME/.sylpheed/matcherrc
Filtering and Processing function configuration
.TP
$HOME/.sylpheed/folderlist.xml
Folder hierachy listing
.TP
$HOME/.sylpheed/menurc
Menu shortcut\-key configuration
.TP
$HOME/.sylpheed/sylpheed.log
Sylpheed logfile
.TP
$HOME/.sylpheed/sylpheedrc
Main configuration file
.SH "EXAMPLES"
.LP
To run this program the standard way type:
.LP
sylpheed
.LP
Alternatively you can run it with the following options:
.TP
\fB\-\-debug\fR
for debug mode
.TP
\fB\-\-compose [address]\fR
to open a Compose window
.TP
\fB\-\-attach file1 [file2]...\fR
open composition window with specified files attached
.TP
\fB\-\-compose\fR "mailto:\fI%t\fR?subject=\fI%s\fR&cc=\fI%c\fR&body=\fI%b\fR"
this syntax can be used in web\-browsers and CLI to open a pre\-populated Compose window
.TP
\fB\-\-receive\fR
receive new messages
.TP
\fB\-\-receive\-all\fR
receive new messages from all accounts
.TP
\fB\-\-send\fR
.br
send all queued messages
.TP
\fB\-\-status\fR
show the total number of messages
.br
[new][unread][unread answers to marked][total]
.TP
\fB\-\-status folder[/subfolder]\fR
show the total number of messages in specified folder
.br
[new][unread][unread answers to marked][total]
.TP
\fB\-\-status\-full\fR
show the total number of messages per folder
.br
[new][unread][unread answers to marked][total]
.TP
\fB\-\-online\fR
Start sylpheed in (or switch to, if already running) online mode
.TP
\fB\-\-offline\fR
Start sylpheed in (or switch to, if already running) offline mode
.TP
\fB\-\-help\fR
display the help message and exit
.TP
\fB\-\-version\fR
display version number and exit
.TP
\fB\-\-config\-dir\fR
display the CONFIG\-DIR and exit
.SH "INSTALLATION"
.LP
This program requires GTK+ 1.2.6 or higher to be compiled.
.LP
Please make sure that gtk\-devel and glib\-devel (or similar) packages are
installed before the compilation (you may also require flex (lex) and bison
(yacc)).
.LP
To compile and install, just type:
.LP
% ./configure
.br
% make
.br
% su
.br
Password: [Enter password]
.br
# make install
.LP
Refer to ./configure \-\-help for further information.
.SH "AUTHORS"
.LP
.TP
main\-branch (http://sylpheed.good\-day.net)
Hiroyuki Yamamoto <hiro\-y@kcn.ne.jp>
<yamamoto@good\-day.co.jp>
.TP
claws\-branch (http://sylpheed\-claws.sourceforge.net)
Hoa viet Dinh <dinh.viet.hoa@free.fr>
.br
Match Grun <match@dimensional.com>
.br
Melvin Hadasht <melvin.hadasht@free.fr>
.br
Christoph Hohmann <reboot@gmx.ch>
.br
Alfons Hoogervorst <alfons@proteus.demon.nl>
.br
Darko Koruga <darko.koruga@hermes.si>
.br
Colin Leroy <colin@colino.net>
.br
Thorsten Maerz <torte@netztorte.de>
.br
Paul Mangan <claws@thewildbeast.co.uk>
.br
Luke Plant <L.Plant.98@cantab.net>
.br
Martin Schaaf <mascha@ma\-scha.de>
.br
Carsten Schurig <Carsten.Schurig@web.de>
.br
Sergey Vlasov <vsu@users.sourceforge.net>
.br
Hiroyuki Yamamoto <hiro\-y@kcn.ne.jp>
.TP
sylpheed\-claws\-w32
Thorsten Maerz <torte@netztorte.de>\fR
.SH "SEE ALSO"
.LP
.TP
Sylpheed Homepage
<http://sylpheed.good\-day.net>
.TP
Sylpheed\-Claws Homepage
<http://sylpheed\-claws.sf.net>
.TP
Sylpheed\-Claws Win32 Homepage
<http://sylpheed\-claws.sf.net/win32>