-.TH "Claws Mail" "1" "" "Hiroyuki Yamamoto & the Claws Mail team" ""
+.TH "CLAWS MAIL" "1" "March 4, 2016" "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
-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
+\[bu] Quick response
.br
-* Graceful, and sophisticated interface
+\[bu] Graceful, and sophisticated interface
.br
-* Easy configuration, intuitive operation
+\[bu] Easy configuration, intuitive operation
.br
-* Abundant features
+\[bu] Abundant features
\fR
.TP
Currently implemented features include:
-o POP3 support
+\[bu] POP3 support
.br
-o IMAP4rev1 support
+\[bu] IMAP4rev1 support
.br
-o integrated NetNews client
+\[bu] integrated NetNews client
.br
-o unlimited multiple account handling
+\[bu] unlimited multiple account handling
.br
-o thread display
+\[bu] thread display
.br
-o filtering
+\[bu] filtering
.br
-o MIME (attachments)
+\[bu] MIME (attachments)
.br
-o built\-in image view
+\[bu] built\-in image view
.br
-o X\-Face support
+\[bu] X\-Face and (colour) Face support
.br
-o multiple MH folder support
+\[bu] multiple MH folder support
.br
-o mbox importing / exporting
+\[bu] mbox importing / exporting
.br
-o external editor support
+\[bu] external editor support
.br
-o message queueing
+\[bu] message queueing
.br
-o automatic mail checking
+\[bu] automatic mail checking
.br
-o draft message function
+\[bu] draft message function
.br
-o template function
+\[bu] template function
.br
-o line\-wrapping
+\[bu] line\-wrapping
.br
-o clickable URI
+\[bu] clickable URI
.br
-o XML\-based address book
+\[bu] XML\-based address book
.br
-o LDAP, vCard, and JPilot support
+\[bu] LDAP, vCard, and JPilot support
.br
-o newly arrived and unread message management
+\[bu] newly arrived and unread message management
.br
-o Mew/Wanderlust\-like key bind
+\[bu] Mew/Wanderlust\-like key bind
.br
-o printing
+\[bu] printing
.br
-o APOP authentication support
+\[bu] APOP authentication support
.br
-o SMTP AUTH support
+\[bu] SMTP AUTH support
.br
-o SSL support (POP3, SMTP, IMAP4rev1)
+\[bu] SSL support (POP3, SMTP, IMAP4rev1)
.br
-o IPv6 support
+\[bu] IPv6 support
.br
-o drag & drop (partially implemented)
+\[bu] drag & drop (partially implemented)
.br
-o GnuPG support (currently implementing)
+\[bu] GnuPG support
.br
-o automake + autoconf support
+\[bu] automake + autoconf support
.br
-o internationalization of messages by gettext
+\[bu] internationalization of UI messages by gettext
.br
-o support of many code sets, including UTF\-8 (Unicode) (when using libjconv)
+\[bu] support of many code sets, including UTF\-8 (Unicode) (when using libjconv)
.br
-o support for plugins
+\[bu] support for plugins
\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
+\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 \-\-debug\fR
.br
+\fB \-\-toggle\-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
+.br
+\fB \-\-geometry WxH+X+Y\fR
+
.SH "FILES"
.LP
.TP
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
$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/tagsdb
+Tags directory
+.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/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
-.TP
-$HOME/.claws\-mail/clawsrc
-Main configuration file
-
+$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
+.TP
+.B "Windows only"
+.LP
+.TP
+%TEMP%\\claws\-win32.log
+Claws Mail output file when \-\-debug is enabled. If %TEMP% is not set it
+defaults to windows directory (usually C:\\Windows) or C:\\ if windows
+directory is not available.
+.TP
+%APPDATA%\\Claws\-mail\\claws.log
+Claws Mail log file
.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
exit Claws Mail
.TP
\fB\-\-debug\fR
-for debug mode
+for debug mode (on Windows systems output is written to a file instead
+of standard error output, see \fBWindows only\fR on \fBFILES\fR
+section)
+.TP
+\fB\-\-toggle-debug\fR
+toggle debug mode of a running Claws Mail instance
.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
-.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
+\fB\-\-geometry WxH+X+Y\fR
+set initial X geometry of main window
+
+.SH "ENVIRONMENT"
+.LP
+.TP
+\fBCLAWS_NO_CRASH\fR
+if defined disables crash dialog (only if Claws Mail has been built with
+crash dialog feature enabled)
+.TP
+\fBDISPLAY\fR
+default host and display number to use
+.TP
+\fBETPANSERVER\fR, \fBETPANPORT\fR
+when using a tunnel command to open server connections these temporary
+variables are set to the server name and server port respectively in the
+environment of the running command
+.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
+\fBG_BROKEN_FILENAMES\fR
+assumes that filenames are in the locale encoding rather than in UTF\-8
+.TP
+\fBHOME\fR
+full path of the user's home directory
+.TP
+\fBLC_ALL\fR, \fBLC_CTYPE\fR, \fBLANG\fR
+locale to use for non\-windows systems (the first one not empty is used)
+.TP
+\fBPILOT_CHARSET\fR
+if defined overrides default J\-Pilot charset (CP1252)
+.TP
+\fBPOSIXLY_CORRECT\fR
+if defined regular expressions matching follows POSIX standards
+.TP
+\fBSESSION_MANAGER\fR
+if defined tries to use the Session Manager (only if Claws Mail has been
+built with libSM feature enabled)
+.TP
+\fBSHELL\fR
+if defined overrides default shell "sh" used by Spamassassin plugin to
+launch spamc wrappers
+.TP
+\fBSSL_CERT_DIR\fR
+use this CA certificates directory instead known system directories
+.TP
+\fBSSL_CERT_FILE\fR
+use this CA certificates file instead of searching known system files
+.TP
+\fBUSER\fR
+used to initialize default "user_id" preference in newly created accounts
+
+.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\-2016 The Claws Mail team and Hiroyuki Yamamoto
+.LP
+Portions are also Copyright:
+.br
+(C) 2007\-2009 g10 Code GmbH
+.br
+(C) 1999\-2005 Nullsoft, Inc.
+.br
+(C) 1991\-1993, 1996\-2000, 2001 Free Software Foundation, Inc.
+.br
+(C) 2001 Thomas Link, Hiroyuki Yamamoto
+.br
+(C) 1995\-1997 Peter Mattis and Spencer Kimball
+.br
+(C) 1995\-1997 Peter Mattis, Spencer Kimball, Josh MacDonald
+.br
+(C) 1997\-1998 Jay Painter <jpaint@serv.net><jpaint@gimp.org>
+.br
+(C) 1999\-2003 Michael Natterer <mitch@gimp.org>
+.br
+(C) 2000 Evan Martin
+.br
+(C) 1998 Lars Hamann and Stefan Jeske
+.br
+(C) 2005, 2006, 2007, 2009 GNOME Foundation
+.br
+(C) 2004\-2006 Christian Hammond
+.br
+(C) 2003\-2004 Pawel Salek
+.br
+(C) 2001, 2002 \- DINH Viet Hoa
+.br
+(C) 1999\-2000, Gael Roualland <gael.roualland@iname.com>
+.br
+(C) 1998\-2002 Sendmail, Inc.
+.br
+(C) 2007\-2008 Juha Kautto (juha at xfce.org)
+.br
+(C) 1994\-2002 World Wide Web Consortium
+.br
+(C) 1999 Graham Davison
+.br
+(C) 1999 Eric Busboom
+.br
+(C) 2000, Eric Busboom, http://www.softwarestudio.org
+.br
+(C) 2002\-2007 Randall Hand <yerase@yerot.com>
+.br
+(C) 2001 by Werner Koch <dd9jn@gnu.org>
+.br
+(C) 2004 Apache Software Foundation
+.br
+(C) 2008 Mikkel Kamstrup Erlandsen
+.br
+(C) 2002 Red Hat, Inc.; Copyright 1998, 2001 Tim Janik
+.br
+(C) 2008\-2009 Christian Hammond, David Trowbridge
+.br
+(C) 2003\-2005 Lars Lindner <lars.lindner@gmx.net>
+.br
+(C) 2004,2005 Nathan J. Conrad <t98502@users.sourceforge.net>
+.br
+(C) 2004 Karl Soderstrom <ks@xanadunet.net>
+.br
+(C) 2000 Helix Code, Inc. (www.helixcode.com)
+
+.SH "LICENSE"
+.LP
+.TP
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+.TP
+See COPYING file on toplevel distribution directory for more license details.
+
.SH "AUTHORS"
.LP
.TP
-The Claws Mail Team
+.I "The Claws Mail Team"
+.LP
+.RS 4
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>
+Andrej Kacian <andrej@kacian.sk>
.br
Darko Koruga <darko@users.sf.net>
.br
Ricardo Mones Lastra <ricardo@mones.org>
.br
+Charles Lehner <charles@claws-mail.org>
+.br
Colin Leroy <colin@colino.net>
.br
Paul Mangan <paul@claws\-mail.org>
.br
-Martin Schaaf <mascha1@users.sf.net>
+Salvatore De Paolis <iwkse@claws\-mail.org>
+.br
+Pawel Pekala <cOrn@o2.pl>
+.br
+Michael Rasmussen <mir@datanom.net>
+.RE
.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
-
+.I "Previous team members"
+.LP
+.RS 4
+Ho\(`a Vi\(^et Dinh, Keith Edmunds, Match Grun, Melvin Hadasht,
+Oliver Haertel, Christoph Hohmann, Alfons Hoogervorst, Werner Koch,
+Thorsten Maerz, Leandro A. F. Pereira, Luke Plant, Martin Schaaf,
+Carsten Schurig, Fabien Vantard, Sergey Vlasov, Hiroyuki Yamamoto
+.RE
.SH "SEE ALSO"
.LP
.TP
Claws Mail Homepage
<http://www.claws\-mail.org>
+.TP
+Claws Mail frequently asked questions
+<http://www.claws\-mail.org/faq>
+.TP
+Claws Mail online manual
+<http://www.claws\-mail.org/manual>
+.TP
+Claws Mail plugins
+<http://www.claws\-mail.org/plugins.php>
+.TP
+\fIX\fR(7), \fIxwininfo\fR(1).
+
projects / claws.git / blobdiff