2012-11-27 [wwp] 3.9.0cvs21
[claws.git] / doc / man / claws-mail.1
index e2cb8ee023fbfba440c2df1b0188a10e96ce1fda..c05cfd88c9d8a797945e7ccc3bb50f68cb189279 100644 (file)
@@ -1,7 +1,16 @@
-.TH "Claws Mail" "1" "" "Hiroyuki Yamamoto & the Claws Mail team" ""
+.TH "CLAWS MAIL" "1" "November 1, 2011" "The Claws Mail team" "User Manuals"
+
+.SH "NAME"
+.LP 
+Claws Mail \- a GTK+ based fast email and news client
+
+.SH "SYNOPSIS"
+.B claws-mail
+.RI [ options ]
+
 .SH "DESCRIPTION"
 .TP 
 .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 
 * Quick response
 .br 
@@ -29,7 +38,7 @@ o MIME (attachments)
 .br 
 o built\-in image view
 .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 multiple MH folder support
 .br 
@@ -69,7 +78,7 @@ o IPv6 support
 .br 
 o drag & drop (partially implemented)
 .br 
 .br 
 o drag & drop (partially implemented)
 .br 
-o GnuPG support (currently implementing)
+o GnuPG support
 .br 
 o automake + autoconf support
 .br 
 .br 
 o automake + autoconf support
 .br 
@@ -81,13 +90,13 @@ o support for plugins
 \fR
 .LP 
 This list is not complete.
 \fR
 .LP 
 This list is not complete.
-.SH "NAME"
-.LP 
-Claws Mail \- a GTK+ based fast email and news client
+
 .SH "OPTIONS"
 .LP 
 \fB \-\-compose\fR [address]
 .br 
 .SH "OPTIONS"
 .LP 
 \fB \-\-compose\fR [address]
 .br 
+\fB \-\-compose\-from\-file\fR file
+.br 
 \fB \-\-subscribe\fR [uri]
 .br 
 \fB \-\-attach file1 [file2]...\fR
 \fB \-\-subscribe\fR [uri]
 .br 
 \fB \-\-attach file1 [file2]...\fR
@@ -96,6 +105,10 @@ Claws Mail \- a GTK+ based fast email and news client
 .br 
 \fB \-\-receive\-all\fR
 .br 
 .br 
 \fB \-\-receive\-all\fR
 .br 
+\fB \-\-cancel\-receiving\fR
+.br 
+\fB \-\-cancel\-sending\fR
+.br 
 \fB \-\-send\fR
 .br 
 \fB \-\-status\fR
 \fB \-\-send\fR
 .br 
 \fB \-\-status\fR
@@ -104,6 +117,10 @@ Claws Mail \- a GTK+ based fast email and news client
 .br 
 \fB \-\-status\-full\fR
 .br 
 .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
 \fB \-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
 .br 
 \fB \-\-online\fR
@@ -118,7 +135,12 @@ Claws Mail \- a GTK+ based fast email and news client
 .br 
 \fB \-\-version\fR
 .br 
 .br 
 \fB \-\-version\fR
 .br 
+\fB \-\-version\-full\fR
+.br 
 \fB \-\-config\-dir\fR
 \fB \-\-config\-dir\fR
+.br
+\fB \-\-alternate\-config\-dir [dir]\fR
+
 .SH "FILES"
 .LP 
 .TP 
 .SH "FILES"
 .LP 
 .TP 
@@ -129,7 +151,7 @@ $PREFIX/share/claws\-mail
 Global program directory
 .TP 
 $PREFIX/share/claws\-mail/manual
 Global program directory
 .TP 
 $PREFIX/share/claws\-mail/manual
-Manual files in HTML format
+Manual files in HTML, PDF, PostScript and plain text format
 .TP 
 $PREFIX/share/claws\-mail/themes
 Global themes directory
 .TP 
 $PREFIX/share/claws\-mail/themes
 Global themes directory
@@ -143,14 +165,38 @@ Directory for header files
 $HOME/.claws\-mail
 Default directory for user's configuration files directory
 .TP 
 $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/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/command_history
 User\-specified commands
@@ -160,22 +206,39 @@ 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/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 
 .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 
 .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/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 
 .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 
 
 .SH "EXAMPLES"
 .LP 
@@ -187,6 +250,12 @@ Alternatively you can run it with the following options:
 .TP 
 \fB\-\-compose [address]\fR 
 to open a Compose window
 .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
 .TP 
 \fB\-\-subscribe [uri]\fR
 subscribe to the given URI if possible
@@ -195,7 +264,10 @@ 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"
 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
 .TP 
 \fB\-\-receive\fR
 receive new messages
@@ -203,6 +275,12 @@ receive new messages
 \fB\-\-receive\-all\fR
 receive new messages from all accounts
 .TP 
 \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
 \fB\-\-send\fR
 .br 
 send all queued messages
@@ -222,14 +300,22 @@ show the total number of messages per folder
 .br 
 [new][unread][unread answers to marked][total]
 .TP 
 .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
 \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
 .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
 .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
 .TP 
 \fB\-\-help\fR
 display the help message and exit
@@ -243,29 +329,75 @@ for debug mode
 \fB\-\-version\fR
 display version number and exit
 .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
 \fB\-\-config\-dir\fR
 display the CONFIG\-DIR and exit
-.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.
+.TP
+\fB\-\-alternate\-config\-dir [dir]\fR
+start Claws Mail with the configuration stored in [dir] directory
+
+.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 
 .TP 
 .SH "AUTHORS"
 .LP 
 .TP 
@@ -274,9 +406,7 @@ Holger Berndt                       <berndth@users.sf.net>
 .br 
 Tristan Chabredier             <wwp@claws\-mail.org>
 .br 
 .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 
 Darko Koruga                   <darko@users.sf.net>
 .br 
@@ -286,10 +416,12 @@ Colin Leroy                       <colin@colino.net>
 .br 
 Paul Mangan                    <paul@claws\-mail.org>
 .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
 
 .TP 
 Previous team members
+Ho\(`a Vi\(^et Dinh
+.br
 Keith Edmunds
 .br 
 Match Grun
 Keith Edmunds
 .br 
 Match Grun
@@ -302,21 +434,33 @@ Christoph Hohmann
 .br 
 Alfons Hoogervorst
 .br 
 .br 
 Alfons Hoogervorst
 .br 
+Werner Koch
+.br 
 Thorsten Maerz
 .br 
 Leandro A. F. Pereira
 .br 
 Luke Plant
 .br 
 Thorsten Maerz
 .br 
 Leandro A. F. Pereira
 .br 
 Luke Plant
 .br 
+Martin Schaaf
+.br 
 Carsten Schurig
 .br 
 Carsten Schurig
 .br 
+Fabien Vantard
+.br 
 Sergey Vlasov
 .br 
 Hiroyuki Yamamoto
 
 Sergey Vlasov
 .br 
 Hiroyuki Yamamoto
 
-
 .SH "SEE ALSO"
 .LP 
 .TP 
 Claws Mail Homepage
 <http://www.claws\-mail.org>
 .SH "SEE ALSO"
 .LP 
 .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>
+