Applied patch from Tsuyoshi Kitamoto <tsuyoshi.kitamoto@city.sapporo.jp>.
[elisp/wanderlust.git] / doc / wl.texi
index 146f53e..659f735 100644 (file)
@@ -5,7 +5,7 @@
 @c %**end of header
 @documentlanguage en
 @documentencoding us-ascii
-@set VERSION 2.5.8
+@include version.texi
 @synindex pg cp
 @finalout
 
@@ -243,7 +243,7 @@ FLIM:   ftp://ftp.m17n.org/pub/mule/flim/
 @end group
 @end example
 
-You have to install APEL, FLIM and SEMI in this order.  Generally
+You have to install APEL, FLIM and SEMI in this order.  Generally,
 @samp{make install} will do the job.  (In XEmacs 21, @samp{make
 install-package}.)
 
@@ -254,7 +254,7 @@ Recommended combination of APEL, FLIM and SEMI are following:
 @end itemize
 
 You can also use many other FLIM/SEMI variants. Combination of the
-latest versions should work.  For example, following combination is
+latest versions should work.  For example, the following combination are
 confirmed to work.
 
 @itemize @minus
@@ -502,9 +502,9 @@ The minimal requirement for settings is as the following.
 (setq wl-icon-dir "~/work/wl/etc")
 
 ;; @r{SMTP server for mail posting. Default: @code{nil}}
-(setq wl-smtp-posting-server "your.smtp.server.com")
+(setq wl-smtp-posting-server "your.smtp.example.com")
 ;; @r{NNTP server for news posting. Default: @code{nil}}
-(setq wl-nntp-posting-server "your.nntp.server.com")
+(setq wl-nntp-posting-server "your.nntp.example.com")
 @end group
 @end lisp
 
@@ -630,14 +630,14 @@ Format for @file{~/.folders} is very simple. Here is an example:
 %inbox  "Inbox"
 +trash  "Trash"
 +draft  "Drafts"
-%#mh/Backup@@my.imap.server.com "Sent"
+%#mh/Backup@@my.imap.example.com "Sent"
 # Folder Group
 Emacsen@{
     %#mh/spool/wl            "Wanderlust ML"
     %#mh/spool/elips         "ELIPS ML"
     %#mh/spool/apel-ja       "APEL Japanese ML"
     %#mh/spool/xemacs-beta   "XEmacs beta"
-    -fj.news.reader.gnus@@other.nntp.server.com "Gnus Net news"
+    -fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
     *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
 @}
 #
@@ -762,12 +762,22 @@ You can omit the @var{hostname} from folder names if you set
 For example, you can specify a folder as @samp{foo%imap@@gateway} even
 if you have to go through a firewall.
 
+@lisp
+;; Example: imap4.exaple.org as main IMAP server
+(setq elmo-default-imap4-server "imap4.example.org")
+@end lisp
+
 SSL (Secure Socket Layer) connection will be used if a folder name ends
 with @samp{!}. Or, if the value of @code{elmo-default-imap4-stream-type}
-is non-nil, SSL will be the default connection.  If a folder name ends
-with @samp{!!}, STARTTLS connection will be established.  If the value
-of @code{elmo-default-imap4-stream-type} is @code{starttls}, STARTTLS
-will be the default connection.
+is @code{ssl}, SSL will be the default connection.  If a folder name
+ends with @samp{!!}, STARTTLS connection will be established.  If the
+value of @code{elmo-default-imap4-stream-type} is @code{starttls},
+STARTTLS will be the default connection.
+
+@lisp
+;; Example: Use SSL connection
+(setq elmo-default-imap4-stream-type 'ssl)
+@end lisp
 
 If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
 authentication method, the password is sent in encoded form. But, if
@@ -777,6 +787,11 @@ after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
 authentication will fall back to @code{clear} without confirmation
 (default value is @code{nil}).
 
+@lisp
+;; Example: password in raw format
+(setq elmo-default-imap4-authenticate-type 'clear)
+@end lisp
+
 Example:
 
 @example
@@ -2820,6 +2835,11 @@ yet.
 @findex wl-summary-down
 Move cursor to the downward message which is unread or marked
 as @samp{$}.
+In the offline mode, cursor is not moved to the messages which are not cached
+yet.
+If there are messages which have target mark @samp{*} in the summary,
+cursor is moved to the downward message which have a target mark.
+This behavior is changed according to the value of @code{wl-summary-move-order}.
 (@code{wl-summary-down})
 
 @item P
@@ -2827,6 +2847,11 @@ as @samp{$}.
 @findex wl-summary-up
 Move cursor to the upward message which is unread or marked
 as @samp{$}.
+In the offline mode, cursor is not moved to the messages which are not cached
+yet.
+If there are messages which have target mark @samp{*} in the summary,
+cursor is moved to the downward message which have a target mark.
+This behavior is changed according to the value of @code{wl-summary-move-order}.
 (@code{wl-summary-up})
 
 @item w
@@ -3412,9 +3437,11 @@ The initial setting is @samp{ja}.  Specify language of the weekday.
 displays Deutsch.
 
 @item wl-summary-fix-timezone
-@vindex  wl-summary-fix-timezone
-The initial setting is @samp{JST}.  Timezone to adjust summary's
-timezone.  If @code{nil}, adjust to GMT.
+@vindex wl-summary-fix-timezone
+The initial setting is @samp{nil}. 
+Time zone of the date string in summary mode is adjusted using this value.
+If @code{nil}, it is adjust to the default time zone information
+(system's default time zone or environment variable @samp{TZ}).
 
 @item wl-use-petname
 @vindex  wl-use-petname
@@ -3607,6 +3634,30 @@ cached.
 @vindex elmo-pop3-use-cache
 The initial setting is @code{t}.  If non-nil, messages read via POP3 are
 cached.
+
+@item wl-folder-process-duplicates-alist
+@vindex wl-folder-process-duplicates-alist
+The initial setting is @code{nil}.
+This list determines how to deal with duplicated messages in the same folder.
+Each item in the list is regexp of folder name and action; you can specify any
+one of the following in the place of action:
+
+@example
+@code{nil} : do nothing for duplicated messages.
+@code{hide} : hide duplicated messages from the summary.
+@code{read} : set duplicated messages as read.
+@end example
+
+@noindent
+Following is an example (hide duplicated messages in multi folders)
+
+@lisp
+@group
+(setq wl-folder-process-duplicates-alist
+                 '(("^\\+draft$" . nil) ("^\\+trash$" . nil)
+                   ("^\\*.*" . hide) (".*" . read)))
+@end group
+@end lisp
 @end table
 
 
@@ -3731,13 +3782,13 @@ before sending the message.
 @lisp
 @group
 (setq wl-draft-config-alist
-      '(((string-match "aaa.ne.jp$" (system-name))
+      '(((string-match "aaa.example.com$" (system-name))
          ;; @r{applied if the expression is non-nil}
          (wl-smtp-posting-server . "mailserver-B")
          (wl-nntp-posting-server . "newsserver-B")
          ;; @r{settings of temporary variables}
          )
-        ("^To: .*user@@aaa.bbb.com"
+        ("^To: .*user@@aaa.bbb.example.com"
          ;; @r{applied if it matches the header of the draft buffer}
          ("Organization" . (format "Go %s" my-webpage)))
                        ;; @r{you can write elisp expressions here (eval only)}
@@ -3872,7 +3923,7 @@ The format of @code{wl-template-alist} is almost the same as
          (body . "Hello.\n"))
         ("report"
          (template . "default")                 ;; @r{(a)}
-         ("To" . "jousi@@kaisha.jp")
+         ("To" . "boss@@example.com")
          ("Subject" . "Report")
          (body-file . "~/work/report.txt")
          )
@@ -4243,8 +4294,8 @@ sent off-line.
 
 @item wl-draft-use-cache
 @vindex wl-draft-use-cache
-The initial setting is @code{t}.
-If non-nil, cache the message which is sent.
+The initial setting is @code{nil}. If the value is non-nil and
+@code{wl-insert-message-id} is nil, cache the message which is sent.
 
 @item wl-auto-flush-queue
 @vindex wl-auto-flush-queue