-.TH "Claws Mail" "1" "December 18, 2007" "Hiroyuki Yamamoto & the Claws Mail team"
+.TH "CLAWS MAIL" "1" "November 1, 2011" "The Claws Mail team" "User Manuals"
.SH "NAME"
.LP
.SH "DESCRIPTION"
.TP
-Claws Mail is an email client (and news reader) based on GTK+, running on X Window System, and aiming for
+Claws Mail is an email client (and news reader) based on GTK+, running on the X Window System, and aiming for:
.br
* Quick response
.br
.br
o built\-in image view
.br
-o X\-Face support
+o X\-Face and (colour) Face support
.br
o multiple MH folder support
.br
.br
o drag & drop (partially implemented)
.br
-o GnuPG support (currently implementing)
+o GnuPG support
.br
o automake + autoconf support
.br
.LP
\fB \-\-compose\fR [address]
.br
+\fB \-\-compose\-from\-file\fR file
+.br
\fB \-\-subscribe\fR [uri]
.br
\fB \-\-attach file1 [file2]...\fR
.br
\fB \-\-receive\-all\fR
.br
+\fB \-\-cancel\-receiving\fR
+.br
+\fB \-\-cancel\-sending\fR
+.br
\fB \-\-send\fR
.br
\fB \-\-status\fR
.br
\fB \-\-status\-full\fR
.br
+\fB \-\-statistics\fR
+.br
+\fB \-\-reset-statistics\fR
+.br
\fB \-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
.br
\fB \-\-online\fR
.br
\fB \-\-version\fR
.br
+\fB \-\-version\-full\fR
+.br
\fB \-\-config\-dir\fR
.br
\fB \-\-alternate\-config\-dir [dir]\fR
$HOME/.claws\-mail
Default directory for user's configuration files directory
.TP
+$HOME/.claws\-mail/addrbook/*
+Addressbook files
+.TP
+$HOME/.claws\-mail/autofaces/*
+Automatic Faces and X\-Faces files for accounts
+.TP
+$HOME/.claws\-mail/certs/*
+SSL certificates received from mail servers
+.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/addrbook*
-Addressbook files
+$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/dispheaderrc
Configuration for custom display of headers in message view
+.TP
+$HOME/.claws\-mail/extraheaderrc
+Editable extra headers to be added to compose window combobox
.TP
-$HOME/.claws\-mail/matcherrc
-Filtering and Processing function configuration
+$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/claws.log
-Claws Mail logfile
+$HOME/.claws\-mail/messagesearch_history
+User\-specified searches in message bodies
.TP
-$HOME/.claws\-mail/clawsrc
-Main configuration file
+$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
.TP
\fB\-\-compose [address]\fR
to open a Compose window
+.TP
+\fB\-\-compose\-from\-file file
+open composition window with data from given file. Use \- as file name
+for reading from standard input. Content format: headers first (To:
+header required) until an empty line is found, then mail body until
+end of file.
.TP
\fB\-\-subscribe [uri]\fR
subscribe to the given URI if possible
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
+this syntax can be used in web\-browsers and CLI to open a pre\-populated Compose window.
+Possible fields after the destination recipient are: subject, from, cc, bcc, in\-reply\-to,
+body, insert (insert a file in body part, needs an absolute path), attach (attach a file,
+needs an absolute path, see also: \-\-attach)
.TP
\fB\-\-receive\fR
receive new messages
\fB\-\-receive\-all\fR
receive new messages from all accounts
.TP
+\fB\-\-cancel\-receiving\fR
+cancel receiving of messages
+.TP
+\fB\-\-cancel\-sending\fR
+cancel sending of messages
+.TP
\fB\-\-send\fR
.br
send all queued messages
.br
[new][unread][unread answers to marked][total]
.TP
+\fB\-\-statistics\fR
+.br
+show session statistics
+.TP
+\fB\-\-reset-statistics\fR
+.br
+reset session statistics
+.TP
\fB\-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
-On startup, jumps to the specified folder/message
+on startup, jumps to the specified folder/message
.TP
\fB\-\-online\fR
-Start claws\-mail in (or switch to, if already running) online mode
+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
+start Claws Mail in (or switch to, if already running) offline mode
.TP
\fB\-\-help\fR
display the help message and exit
\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 "ENVIRONMENT"
+.LP
+.TP
+\fBLC_ALL\fR
+.TP
+\fBLC_CTYPE\fR
+.TP
+\fBLANG\fR
+locale to use for non-win32 systems (the first one not empty is used)
+.TP
+\fBSSL_CERT_FILE\fR
+use this CA certificates file instead of searching known system files
+.TP
+\fBSSL_CERT_DIR\fR
+use this CA certificates directory instead known system directories
+.TP
+\fBPOSIXLY_CORRECT\fR
+if defined regular expressions matching follows POSIX standards
+.TP
+\fBHOME\fR
+full path of the user's home directory
+.TP
+\fBCLAWS_NO_CRASH\fR
+if defined disables crash dialog (only if Claws Mail has been built with
+crash dialog feature enabled)
+.TP
+\fBG_BROKEN_FILENAMES\fR
+assumes that filenames are in the locale encoding rather than in UTF-8
+.TP
+\fBPILOT_CHARSET\fR
+if defined overrides default J-Pilot charset (CP1252)
+.TP
+\fBSESSION_MANAGER\fR
+if defined tries to use the Session Manager (only if Claws Mail has been
+built with libSM feature enabled)
+.TP
+\fBDISPLAY\fR
+default host and display number to use
+.TP
+\fBGPG_AGENT_INFO\fR
+the information to access the GPG agent if using GPG agent is enabled in
+GPG plugin preferences (this is usually set by the agent when launched,
+otherwise it likely means the GPG agent is not running)
+.TP
+\fBSHELL\fR
+if defined overrides default shell "sh" used by Spamassassin plugin to
+launch spamc wrappers
+
+.SH "BUGS"
+.LP
+.TP
+You can search for existing bugs and report new ones on Claws Mail bugzilla:
+.br
+<http://www.thewildbeast.co.uk/claws-mail/bugzilla/>
+
+.SH "COPYRIGHT"
+.LP
+.TP
+1999-2012 Hiroyuki Yamamoto and the Claws Mail team
.SH "AUTHORS"
.LP
.br
Tristan Chabredier <wwp@claws\-mail.org>
.br
-Ho\(`a Vi\(^et Dinh <hoa@users.sf.net>
-.br
-Werner Koch <wk@gnupg.org>
+Andrej Kacian <andrej@kacian.sk>
.br
Darko Koruga <darko@users.sf.net>
.br
.br
Paul Mangan <paul@claws\-mail.org>
.br
-Martin Schaaf <mascha1@users.sf.net>
+Salvatore De Paolis <iwkse@claws\-mail.org>
.TP
Previous team members
+Ho\(`a Vi\(^et Dinh
+.br
Keith Edmunds
.br
Match Grun
.br
Alfons Hoogervorst
.br
+Werner Koch
+.br
Thorsten Maerz
.br
Leandro A. F. Pereira
.br
Luke Plant
.br
+Martin Schaaf
+.br
Carsten Schurig
.br
+Fabien Vantard
+.br
Sergey Vlasov
.br
Hiroyuki Yamamoto
.TP
Claws Mail Homepage
<http://www.claws\-mail.org>
+.TP
+Claws Mail online manual
+<http://www.claws\-mail.org/manual>
+.TP
+Claws Mail plugins
+<http://www.claws\-mail.org/plugins.php>
+
projects / claws.git / blobdiff