-.TH "CLAWS MAIL" "1" "June 4, 2015" "The Claws Mail team" "User Manuals"
+.TH "CLAWS MAIL" "1" "January 2, 2019" "The Claws Mail team" "User Manuals"
.SH "NAME"
-.LP
+.LP
Claws Mail \- a GTK+ based fast email and news client
.SH "SYNOPSIS"
.B claws\-mail
-.RI [ options ]
+.RI [ options ]...
.SH "DESCRIPTION"
-.TP
+.TP
Claws Mail is an email client (and news reader) based on GTK+, running on the X Window System, and aiming for:
-.br
+.br
\[bu] Quick response
-.br
+.br
\[bu] Graceful, and sophisticated interface
-.br
+.br
\[bu] Easy configuration, intuitive operation
-.br
+.br
\[bu] Abundant features
\fR
-.TP
+.TP
Currently implemented features include:
\[bu] POP3 support
-.br
+.br
\[bu] IMAP4rev1 support
-.br
+.br
\[bu] integrated NetNews client
-.br
+.br
\[bu] unlimited multiple account handling
-.br
+.br
\[bu] thread display
-.br
+.br
\[bu] filtering
-.br
+.br
\[bu] MIME (attachments)
-.br
+.br
\[bu] built\-in image view
-.br
+.br
\[bu] X\-Face and (colour) Face support
-.br
+.br
\[bu] multiple MH folder support
-.br
+.br
\[bu] mbox importing / exporting
-.br
+.br
\[bu] external editor support
-.br
+.br
\[bu] message queueing
-.br
+.br
\[bu] automatic mail checking
-.br
+.br
\[bu] draft message function
-.br
+.br
\[bu] template function
-.br
+.br
\[bu] line\-wrapping
-.br
+.br
\[bu] clickable URI
-.br
+.br
\[bu] XML\-based address book
-.br
+.br
\[bu] LDAP, vCard, and JPilot support
-.br
+.br
\[bu] newly arrived and unread message management
-.br
+.br
\[bu] Mew/Wanderlust\-like key bind
-.br
+.br
\[bu] printing
-.br
+.br
\[bu] APOP authentication support
-.br
+.br
\[bu] SMTP AUTH support
-.br
+.br
\[bu] SSL support (POP3, SMTP, IMAP4rev1)
-.br
+.br
\[bu] IPv6 support
-.br
+.br
\[bu] drag & drop (partially implemented)
-.br
+.br
\[bu] GnuPG support
-.br
+.br
\[bu] automake + autoconf support
-.br
+.br
\[bu] internationalization of UI messages by gettext
-.br
-\[bu] support of many code sets, including UTF\-8 (Unicode) (when using libjconv)
-.br
+.br
+\[bu] support of many code sets, including UTF\-8 (Unicode)
+.br
\[bu] support for plugins
\fR
-.LP
+.LP
This list is not complete.
.SH "OPTIONS"
-.LP
+.LP
\fB \-\-compose\fR [address]
-.br
+.br
\fB \-\-compose\-from\-file\fR file
-.br
-\fB \-\-subscribe\fR [uri]
-.br
-\fB \-\-attach file1 [file2]...\fR
-.br
+.br
+\fB \-\-subscribe\fR uri
+.br
+\fB \-\-attach\fR file1 [file2]...\fR
+.br
+\fB \-\-insert\fR file1 [file2]...\fR
+.br
\fB \-\-receive\fR
-.br
+.br
\fB \-\-receive\-all\fR
-.br
+.br
\fB \-\-cancel\-receiving\fR
-.br
+.br
\fB \-\-cancel\-sending\fR
-.br
+.br
+\fB \-\-search\fR folder type request [recursive]
+.br
\fB \-\-send\fR
-.br
+.br
\fB \-\-status\fR
-.br
-\fB \-\-status folder[/subfolder]\fR
-.br
+.br
+\fB \-\-status\fR folder[/subfolder]
+.br
\fB \-\-status\-full\fR
-.br
+.br
+\fB \-\-status\-full\fR folder[/subfolder]
+.br
\fB \-\-statistics\fR
-.br
+.br
\fB \-\-reset-statistics\fR
-.br
-\fB \-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
-.br
+.br
+\fB \-\-select\fR [#mh/mailbox/]folder[/msg|/msgid], a file:// uri or an absolute path
+.br
\fB \-\-online\fR
-.br
+.br
\fB \-\-offline\fR
-.br
+.br
\fB \-\-exit\fR
-.br
+.br
\fB \-\-debug\fR
-.br
+.br
\fB \-\-toggle\-debug\fR
-.br
+.br
\fB \-\-help\fR
-.br
+.br
\fB \-\-version\fR
-.br
+.br
\fB \-\-version\-full\fR
-.br
+.br
\fB \-\-config\-dir\fR
.br
-\fB \-\-alternate\-config\-dir [dir]\fR
+\fB \-\-alternate\-config\-dir\fR directory
+.br
+\fB \-\-geometry\fR [WxH][+X+Y]
.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/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/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/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/extraheaderrc
-Editable extra headers to be added to compose window combobox
-.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
-.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.
+\fB$HOME/Mail\fR
+Default directory for mail storage.
+.TP
+\fB$PREFIX/share/claws\-mail\fR
+Global program directory.
+.TP
+\fB$PREFIX/share/claws\-mail/manual\fR
+Manual files in HTML, PDF, PostScript and plain text format.
+.TP
+\fB$PREFIX/share/claws\-mail/themes\fR
+Global themes directory.
+.TP
+\fB$PREFIX/lib/claws\-mail/plugins\fR
+Directory for plugins.
+.TP
+\fB$PREFIX/include/claws\-mail\fR
+Directory for header files.
+.TP
+\fB$HOME/.claws\-mail\fR
+Default directory for user's configuration files directory.
+.TP
+\fB$HOME/.claws\-mail/addrbook/*\fR
+Addressbook files.
+.TP
+\fB$HOME/.claws\-mail/autofaces/*\fR
+Automatic Faces and X\-Faces files for accounts.
+.TP
+\fB$HOME/.claws\-mail/certs/*\fR
+SSL certificates received from mail servers.
+.TP
+\fB$HOME/.claws\-mail/tagsdb\fR
+Tags directory.
+.TP
+\fB$HOME/.claws\-mail/templates\fR
+User\-defined templates directory.
+.TP
+\fB$HOME/.claws\-mail/themes\fR
+User's themes directory.
+.TP
+\fB$HOME/.claws\-mail/accountrc\fR
+Configuration for account(s).
+.TP
+\fB$HOME/.claws\-mail/actionsrc\fR
+User\-defined custom actions.
+.TP
+\fB$HOME/.claws\-mail/addrbook/attributesrc\fR
+User\-defined address book custom attributes.
.TP
-%APPDATA%\\Claws\-mail\\claws.log
-Claws Mail log file
+\fB$HOME/.claws\-mail/claws.log\fR
+Claws Mail logfile.
+.TP
+\fB$HOME/.claws\-mail/clawsrc\fR
+Main configuration file.
+.TP
+\fB$HOME/.claws\-mail/command_history\fR
+User\-specified commands.
+.TP
+\fB$HOME/.claws\-mail/customheaderrc\fR
+Configuration for custom headers for sending mail.
+.TP
+\fB$HOME/.claws\-mail/dispheaderrc\fR
+Configuration for custom display of headers in message view.
+.TP
+\fB$HOME/.claws\-mail/extraheaderrc\fR
+Editable extra headers to be added to compose window combobox.
+.TP
+\fB$HOME/.claws\-mail/folderitemrc\fR
+All folders' attributes.
+.TP
+\fB$HOME/.claws\-mail/folderlist.xml\fR
+Folder hierarchy listing.
+.TP
+\fB$HOME/.claws\-mail/gtkrc-2.0\fR
+Optional GTK+ settings to be load on startup.
+.TP
+\fB$HOME/.claws\-mail/matcherrc\fR
+Filtering and Processing function configuration.
+.TP
+\fB$HOME/.claws\-mail/menurc\fR
+Menu shortcut\-key configuration.
+.TP
+\fB$HOME/.claws\-mail/messagesearch_history\fR
+User\-specified searches in message bodies.
+.TP
+\fB$HOME/.claws\-mail/quicksearch_history\fR
+User\-specified quick\-search list.
+.TP
+\fB$HOME/.claws\-mail/messagesearch_history\fR
+User\-specified searches in message bodies.
+.TP
+\fB$HOME/.claws\-mail/summary*_history\fR
+User\-specified searches in message list.
+.TP
+\fB$HOME/.claws\-mail/passwordstorerc\fR
+User saved passwords.
+.TP
+\fB$HOME/.claws\-mail/tagsrc\fR
+User\-specified tag list.
+.TP
+\fB$HOME/.claws\-mail/toolbar*.xml\fR
+User\-defined custom toolbars.
+.TP
+\fB%TEMP%\\claws\-win32.log \fI(Windows only)\fR
+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
+\fB %APPDATA%\\Claws\-mail\\claws.log \fI(Windows only)\fR
+Claws Mail log file.
.SH "EXAMPLES"
-.LP
+.LP
To run this program the standard way type:
-.LP
+.LP
claws\-mail
-.LP
+.LP
Alternatively you can run it with the following options:
-.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\-\-attach file1 [file2]...\fR
-open composition window with specified files attached
-.TP
+.TP
+\fB\-\-compose\fR [address]
+To open a Compose window.
+.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.
-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
+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\-\-compose\-from\-file\fR file
+Open composition window with data from the 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\fR uri
+Subscribe to the given URI if possible.
+.TP
+\fB\-\-attach\fR file1 [file2]...
+Open composition window with specified files attached.
+.TP
+\fB\-\-insert\fR file1 [file2]...
+Open composition window with specified files inserted.
+.TP
\fB\-\-receive\fR
-receive new messages
-.TP
+Receive new messages.
+.TP
\fB\-\-receive\-all\fR
-receive new messages from all accounts
-.TP
+Receive new messages from all accounts.
+.TP
\fB\-\-cancel\-receiving\fR
-cancel receiving of messages
-.TP
+Cancel receiving of messages.
+.TP
\fB\-\-cancel\-sending\fR
-cancel sending of messages
-.TP
+Cancel sending of messages.
+.TP
+\fB\-\-search\fR folder type request [recursive]
+.br
+Searches mail:
+.br
+folder ex.: "#mh/Mailbox/inbox" or "Mail"
+.br
+type: s[ubject],f[rom],t[o],e[xtended],m[ixed] or g: tag
+.br
+request: search string
+.br
+recursive: false if arg. starts with 0, n, N, f or F
+.TP
\fB\-\-send\fR
-.br
-send all queued messages
-.TP
+.br
+Send all queued messages.
+.TP
\fB\-\-status\fR
-show the total number of messages
-.br
+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
+.TP
+\fB\-\-status\fR folder[/subfolder]
+Show the total number of messages in the specified folder:
+.br
[new][unread][unread answers to marked][total]
-.TP
+.TP
\fB\-\-status\-full\fR
-show the total number of messages per folder
-.br
+Show the total number of messages per folder:
+.br
[new][unread][unread answers to marked][total]
-.TP
+.TP
+\fB\-\-status\-full\fR folder[/subfolder]
+Show the total number of messages int the specified folder:
+.br
+[new][unread][unread answers to marked][total]
+.TP
\fB\-\-statistics\fR
-.br
-show session statistics
-.TP
+.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
-.TP
+.br
+Reset session statistics.
+.TP
+\fB\-\-select\fR #mh/Mailbox/inbox/123
+.RS 0
+.br
+\fB\-\-select\fR file://home/johndoe/Mail/inbox/123
+.br
+\fB\-\-select\fR /home/johndoe/Mail/inbox/123
+.RS
+On startup, jump to the specified folder/message.
+.RE
+.TP
\fB\-\-online\fR
-start Claws Mail in (or switch to, if already running) online mode
-.TP
+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
+Start Claws Mail in (or switch to, if already running) offline mode.
+.TP
\fB\-\-exit\fR
-exit Claws Mail
-.TP
+Exit Claws Mail.
+.TP
\fB\-\-debug\fR
-for debug mode (on Windows systems output is written to a file instead
+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
+section).
+.TP
\fB\-\-toggle-debug\fR
-toggle debug mode of a running Claws Mail instance
-.TP
+Toggle debug mode of the running Claws Mail instance.
+.TP
+\fB\-\-help\fR
+Display the help message.
+.TP
\fB\-\-version\fR
-display version number and exit
-.TP
+Display version number.
+.TP
\fB\-\-version\-full\fR
-display version number and compiled\-in features then exit
-.TP
+Display version number and compiled\-in features.
+.TP
\fB\-\-config\-dir\fR
-display the CONFIG\-DIR and exit
+Display the CONFIG\-DIR.
.TP
-\fB\-\-alternate\-config\-dir [dir]\fR
-start Claws Mail with the configuration stored in [dir] directory
+\fB\-\-alternate\-config\-dir\fR dir
+Start Claws Mail with the configuration stored in the [dir] directory.
+.TP
+\fB\-\-geometry\fR [WxH][+X+Y]
+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)
+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
+Default host and display number to use.
.TP
\fBETPANSERVER\fR, \fBETPANPORT\fR
-when using a tunnel command to open server connections these temporary
+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
+environment of the running command.
.TP
\fBGPG_AGENT_INFO\fR
-the information to access the GPG agent if using GPG agent is enabled in
+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)
+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
+Assumes that filenames are in the locale encoding rather than in UTF\-8.
.TP
\fBHOME\fR
-full path of the user's home directory
+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)
+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)
+If defined overrides default J\-Pilot charset (CP1252).
.TP
\fBPOSIXLY_CORRECT\fR
-if defined regular expressions matching follows POSIX standards
+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)
+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
+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
+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
+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
+Used to initialize default "user_id" preference in newly created accounts.
.SH "BUGS"
.LP
.SH "COPYRIGHT"
.LP
.TP
-1999\-2015 Hiroyuki Yamamoto and the Claws Mail team
+1999\-2020 The Claws Mail team and Hiroyuki Yamamoto
.LP
Portions are also Copyright:
.br
See COPYING file on toplevel distribution directory for more license details.
.SH "AUTHORS"
-.LP
-.TP
+.LP
+.TP
.I "The Claws Mail Team"
.LP
.RS 4
Holger Berndt <berndth@users.sf.net>
-.br
+.br
Tristan Chabredier <wwp@claws\-mail.org>
-.br
+.br
Andrej Kacian <andrej@kacian.sk>
-.br
+.br
Darko Koruga <darko@users.sf.net>
-.br
+.br
Ricardo Mones Lastra <ricardo@mones.org>
-.br
+.br
+Charles Lehner <charles@claws-mail.org>
+.br
Colin Leroy <colin@colino.net>
-.br
+.br
Paul Mangan <paul@claws\-mail.org>
-.br
+.br
Salvatore De Paolis <iwkse@claws\-mail.org>
.br
Pawel Pekala <cOrn@o2.pl>
Michael Rasmussen <mir@datanom.net>
.RE
-.TP
+.TP
.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
+Carsten Schurig, Fabien Vantard, Sergey Vlasov and Hiroyuki Yamamoto.
.RE
.SH "SEE ALSO"
-.LP
-.TP
+.LP
+.TP
Claws Mail Homepage
<http://www.claws\-mail.org>
.TP
.TP
Claws Mail plugins
<http://www.claws\-mail.org/plugins.php>
+.TP
+\fIX\fR(7), \fIxwininfo\fR(1).
projects / claws.git / blobdiff