claws-mail/doc/man/claws-mail.1

.TH "Claws Mail" "1" "December 18, 2007" "Hiroyuki Yamamoto & the Claws Mail team"

.SH "NAME"
.LP 
Claws Mail \- a GTK+ based fast email and news client

.SH "SYNOPSIS"
.B claws-mail
.RI [ options ]

.SH "DESCRIPTION"
.TP 
Claws Mail is an email 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 and (colour) 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
.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 \-\-subscribe\fR [uri]
.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 \-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
.br 
\fB \-\-online\fR
.br 
\fB \-\-offline\fR
.br 
\fB \-\-exit\fR
.br 
\fB \-\-debug\fR
.br 
\fB \-\-help\fR
.br 
\fB \-\-version\fR
.br 
\fB \-\-version\-full\fR
.br 
\fB \-\-config\-dir\fR
.br
\fB \-\-alternate\-config\-dir [dir]\fR

.SH "FILES"
.LP 
.TP 
$HOME/Mail
Default directory for mail storage
.TP 
$PREFIX/share/claws\-mail
Global program directory
.TP 
$PREFIX/share/claws\-mail/manual
Manual files in HTML, PDF, PostScript and plain text format
.TP 
$PREFIX/share/claws\-mail/themes
Global themes directory
.TP 
$PREFIX/lib/claws\-mail/plugins
Directory for plugins
.TP 
$PREFIX/include/claws\-mail
Directory for header files
.TP 
$HOME/.claws\-mail
Default directory for user's configuration files directory
.TP 
$HOME/.claws\-mail/addrbook/*
Addressbook files
.TP 
$HOME/.claws\-mail/templates
User\-defined templates directory
.TP 
$HOME/.claws\-mail/themes
User's themes directory
.TP 
$HOME/.claws\-mail/accountrc
Configuration for account(s)
.TP 
$HOME/.claws\-mail/actionsrc
User\-defined custom actions
.TP 
$HOME/.claws\-mail/addressbookcustomattributerc
User\-defined address book custom attributes
.TP 
$HOME/.claws\-mail/claws.log
Claws Mail logfile
.TP 
$HOME/.claws\-mail/claws-win32.log
Claws Mail output file (Windows only)
.TP 
$HOME/.claws\-mail/clawsrc
Main configuration file
.TP 
$HOME/.claws\-mail/command_history
User\-specified commands
.TP 
$HOME/.claws\-mail/customheaderrc
Configuration for custom headers for sending mail
.TP 
$HOME/.claws\-mail/dispheaderrc
Configuration for custom display of headers in message view
.TP 
$HOME/.claws\-mail/folderitemrc
All folders' attributes
.TP 
$HOME/.claws\-mail/folderlist.xml
Folder hierarchy listing
.TP 
$HOME/.claws\-mail/matcherrc
Filtering and Processing function configuration
.TP 
$HOME/.claws\-mail/menurc
Menu shortcut\-key configuration
.TP 
$HOME/.claws\-mail/messagesearch_history
User\-specified searches in message bodies
.TP 
$HOME/.claws\-mail/quicksearch_history
User\-specified quick-search list
.TP 
$HOME/.claws\-mail/messagesearch_history
User\-specified searches in message bodies
.TP 
$HOME/.claws\-mail/summary*_history
User\-specified searches in message list
.TP 
$HOME/.claws\-mail/tagsrc
User\-specified tag list
.TP 
$HOME/.claws\-mail/toolbar*.xml
User\-defined custom toolbars

.SH "EXAMPLES"
.LP 
To run this program the standard way type:
.LP 
claws\-mail
.LP 
Alternatively you can run it with the following options:
.TP 
\fB\-\-compose [address]\fR 
to open a Compose window
.TP 
\fB\-\-subscribe [uri]\fR
subscribe to the given URI if possible
.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\-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
On startup, jumps to the specified folder/message
.TP 
\fB\-\-online\fR
Start claws\-mail in (or switch to, if already running) online mode
.TP 
\fB\-\-offline\fR
Start claws\-mail in (or switch to, if already running) offline mode
.TP 
\fB\-\-help\fR
display the help message and exit
.TP 
\fB\-\-exit\fR
exit Claws Mail
.TP 
\fB\-\-debug\fR
for debug mode
.TP 
\fB\-\-version\fR
display version number and exit
.TP 
\fB\-\-version-full\fR
display version number and compiled-in features then exit
.TP 
\fB\-\-config\-dir\fR
display the CONFIG\-DIR and exit
.TP
\fB\-\-alternate\-config\-dir [dir]\fR
start Claws Mail with the configuration stored in [dir] directory

.SH "INSTALLATION"
.LP 
This program requires GTK+ 2.6.x 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 
The Claws Mail Team
Holger Berndt 			<berndth@users.sf.net>
.br 
Tristan Chabredier		<wwp@claws\-mail.org>
.br 
Ho\(`a Vi\(^et Dinh 			<hoa@users.sf.net>
.br 
Werner Koch			<wk@gnupg.org>
.br 
Darko Koruga 			<darko@users.sf.net>
.br 
Ricardo Mones Lastra 	<ricardo@mones.org>
.br 
Colin Leroy 			<colin@colino.net>
.br 
Paul Mangan 			<paul@claws\-mail.org>
.br 
Martin Schaaf 			<mascha1@users.sf.net>

.TP 
Previous team members
Keith Edmunds
.br 
Match Grun
.br 
Melvin Hadasht
.br 
Oliver Haertel
.br 
Christoph Hohmann
.br 
Alfons Hoogervorst
.br 
Thorsten Maerz
.br 
Leandro A. F. Pereira
.br 
Luke Plant
.br 
Carsten Schurig
.br 
Sergey Vlasov
.br 
Hiroyuki Yamamoto

.SH "SEE ALSO"
.LP 
.TP 
Claws Mail Homepage
<http://www.claws\-mail.org>