2008-01-22 [wwp] 3.2.0cvs61
[claws.git] / doc / man / claws-mail.1
index 10bf390184782c878e31d29532d15dd8ea698f37..b92401de77e58ea2334f07a87117ef66c9c7aab3 100644 (file)
@@ -1,4 +1,13 @@
-.TH "Claws Mail" "1" "" "Hiroyuki Yamamoto & the Claws Mail team" ""
+.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
@@ -29,7 +38,7 @@ o MIME (attachments)
 .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 
@@ -69,7 +78,7 @@ o IPv6 support
 .br 
 o drag & drop (partially implemented)
 .br 
-o GnuPG support (currently implementing)
+o GnuPG support
 .br 
 o automake + autoconf support
 .br 
@@ -81,9 +90,7 @@ o 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]
@@ -118,7 +125,12 @@ Claws Mail \- a GTK+ based fast email and news client
 .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 
@@ -129,7 +141,7 @@ $PREFIX/share/claws\-mail
 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
@@ -143,14 +155,32 @@ Directory for header files
 $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/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
@@ -161,21 +191,35 @@ Configuration for custom headers for sending mail
 $HOME/.claws\-mail/dispheaderrc
 Configuration for custom display of headers in message view
 .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 
@@ -222,7 +266,7 @@ show the total number of messages per folder
 .br 
 [new][unread][unread answers to marked][total]
 .TP 
-\fB\-\-select [mailbox/]folder[/msg|/msgid]\fR
+\fB\-\-select [#mh/mailbox/]folder[/msg|/msgid]\fR
 On startup, jumps to the specified folder/message
 .TP 
 \fB\-\-online\fR
@@ -243,8 +287,15 @@ for debug mode
 \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.
@@ -266,6 +317,7 @@ Password: [Enter password]
 # make install
 .LP 
 Refer to ./configure \-\-help for further information.
+
 .SH "AUTHORS"
 .LP 
 .TP 
@@ -314,7 +366,6 @@ Sergey Vlasov
 .br 
 Hiroyuki Yamamoto
 
-
 .SH "SEE ALSO"
 .LP 
 .TP