update the man page
[claws.git] / doc / man / sylpheed.1
index 89057a64b1f624d30000f7aa474e4c6ae8768c01..157e1de403542e3feb733c94d75ad02ee07f7a9a 100644 (file)
@@ -1,10 +1,10 @@
-.TH "Sylpheed" "1" "" "Hiroyuki Yamamoto" ""
+.TH "Sylpheed-Claws" "1" "" "Hiroyuki Yamamoto & the Sylpheed-Claws team" ""
 .SH "NAME"
 .LP 
-Sylpheed \- a GTK+ based fast e\-mail and news client
+Sylpheed\-Claws \- a GTK+ based fast e\-mail and news client
 .SH "DESCRIPTION"
 .TP 
-Sylpheed is an e\-mail client (and news reader) based on GTK+, running on X Window System, and aiming for
+Sylpheed\-Claws is an e\-mail client (and news reader) based on GTK+, running on X Window System, and aiming for
 .br 
 * Quick response
 .br 
@@ -79,26 +79,40 @@ o automake + autoconf support
 o internationalization of messages by gettext
 .br 
 o support of many code sets, including UTF\-8 (Unicode) (when using libjconv)
+.br 
+o support for plugins
 \fR
 .LP 
 This list is not complete.
 .SH "OPTIONS"
 .LP 
-\fBsylpheed \-\-compose\fR ["mailto:\fI%t\fR?subject=\fI%s\fR&cc=\fI%c\fR&body=\fI%b\fR"]
+\fB \-\-compose\fR [address]
+.br 
+\fB \-\-attach file1 [file2]...\fR
+.br 
+\fB \-\-receive\fR
+.br 
+\fB \-\-receive\-all\fR
+.br 
+\fB \-\-send\fR
+.br 
+\fB \-\-status\fR
 .br 
-\fBsylpheed \-\-receive\fR
+\fB \-\-status folder[/subfolder]\fR
 .br 
-\fBsylpheed \-\-receive\-all\fR
+\fB \-\-status\-full\fR
 .br 
-\fBsylpheed \-\-send\fR
+\fB \-\-online\fR
 .br 
-\fBsylpheed \-\-status\fR
+\fB \-\-offline\fR
 .br 
-\fBsylpheed \-\-debug\fR
+\fB \-\-debug\fR
 .br 
-\fBsylpheed \-\-help\fR
+\fB \-\-help\fR
 .br 
-\fBsylpheed \-\-version\fR
+\fB \-\-version\fR
+.br 
+\fB \-\-config\-dir\fR
 .SH "FILES"
 .LP 
 .TP 
@@ -114,8 +128,20 @@ Manual files in HTML format
 $PREFIX/share/sylpheed/faq
 FAQ files in HTML format
 .TP 
+$PREFIX/share/sylpheed/themes
+Global themes directory
+.TP 
+$PREFIX/lib/sylpheed/plugins
+Directory for plugins
+.TP 
+$PREFIX/include/sylpheed
+Directory for header files
+.TP 
 $HOME/.sylpheed 
-User's configuration files directory
+Default directory for user's configuration files directory
+.TP 
+$HOME/.sylpheed/themes
+User's themes directory
 .TP 
 $HOME/.sylpheed/accountrc
 Configuration for account(s)
@@ -132,8 +158,8 @@ Configuration for custom headers for sending mail
 $HOME/.sylpheed/dispheaderrc
 Configuration for custom display of headers in message view
 .TP 
-$HOME/.sylpheed/filterrc
-Filter function configuration
+$HOME/.sylpheed/matcherrc
+Filtering and Processing function configuration
 .TP 
 $HOME/.sylpheed/folderlist.xml
 Folder hierachy listing
@@ -154,36 +180,59 @@ To run this program the standard way type:
 .LP 
 sylpheed
 .LP 
-Alternatively you can run it as:
+Alternatively you can run it with the following options:
 .TP 
-\fBsylpheed \-\-debug\fR
+\fB\-\-debug\fR
 for debug mode
 .TP 
-\fBsylpheed \-\-compose\fR 
+\fB\-\-compose [address]\fR 
 to open a Compose window
 .TP 
-\fBsylpheed \-\-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 pre\-populated Compose window
+\fB\-\-attach file1 [file2]...\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
 .TP 
-\fBsylpheed \-\-receive\fR
+\fB\-\-receive\fR
 receive new messages
 .TP 
-\fBsylpheed \-\-receive\-all\fR
+\fB\-\-receive\-all\fR
 receive new messages from all accounts
 .TP 
-\fBsylpheed \-\-send\fR
+\fB\-\-send\fR
+.br 
 send all queued messages
 .TP 
-\fBsylpheed \-\-status\fR
+\fB\-\-status\fR
 show the total number of messages
 .br 
-[new][unread][total]
+[new][unread][unread answers to marked][total]
+.TP 
+\fB\-\-status folder[/subfolder]\fR
+show the total number of messages in specified folder
+.br 
+[new][unread][unread answers to marked][total]
+.TP 
+\fB\-\-status\-full\fR
+show the total number of messages per folder
+.br 
+[new][unread][unread answers to marked][total]
+.TP 
+\fB\-\-online\fR
+Start sylpheed in (or switch to, if already running) online mode
 .TP 
-\fBsylpheed \-\-help\fR
+\fB\-\-offline\fR
+Start sylpheed in (or switch to, if already running) offline mode
+.TP 
+\fB\-\-help\fR
 display the help message and exit
 .TP 
-\fBsylpheed \-\-version\fR
+\fB\-\-version\fR
 display version number and exit
+.TP 
+\fB\-\-config\-dir\fR
+display the CONFIG\-DIR and exit
 .SH "INSTALLATION"
 .LP 
 This program requires GTK+ 1.2.6 or higher to be compiled.
@@ -204,7 +253,7 @@ Password: [Enter password]
 .br 
 # make install
 .LP 
-See INSTALL from the source distribution package for full installation instructions.
+Refer to ./configure \-\-help for further information.
 .SH "AUTHORS"
 .LP 
 .TP 
@@ -227,8 +276,12 @@ Darko Koruga               <darko.koruga@hermes.si>
 .br 
 Colin Leroy            <colin@colino.net>
 .br 
+Thorsten Maerz         <torte@netztorte.de>
+.br 
 Paul Mangan            <claws@thewildbeast.co.uk>
 .br 
+Luke Plant             <L.Plant.98@cantab.net>
+.br 
 Martin Schaaf          <mascha@ma\-scha.de>
 .br 
 Carsten Schurig     <Carsten.Schurig@web.de>
@@ -237,10 +290,7 @@ Sergey Vlasov              <vsu@users.sourceforge.net>
 .br 
 Hiroyuki Yamamoto      <hiro\-y@kcn.ne.jp>
 .TP 
-sylpheed\-w32 (http://www.gnupg.org/cvs\-access.html)
-Werner Koch            <wk@gnupg.org>
-.TP 
-sylpheed\-claws\-w32 (http://claws\-w32.sourceforge.net)
+sylpheed\-claws\-w32
 Thorsten Maerz         <torte@netztorte.de>\fR
 
 
@@ -251,10 +301,7 @@ Sylpheed Homepage
 <http://sylpheed.good\-day.net>
 .TP 
 Sylpheed\-Claws Homepage
-<http://www.sf.net/sylpheed\-claws>
-.TP 
-Sylpheed Win32
-<http://www.gnupg.org/cvs\-access.html>
+<http://sylpheed\-claws.sf.net>
 .TP 
 Sylpheed\-Claws Win32 Homepage
-<http://www.sf.net/claws\-w32>
+<http://sylpheed\-claws.sf.net/win32>