Synch with dot.addresses.
[elisp/wanderlust.git] / doc / wl.texi
index a6d72da..84f6ce3 100644 (file)
@@ -5,7 +5,7 @@
 @c %**end of header
 @documentlanguage en
 @documentencoding us-ascii
-@set VERSION 2.5.7
+@include version.texi
 @synindex pg cp
 @finalout
 
@@ -173,15 +173,20 @@ Wanderlust:
 
 @itemize @bullet
 @item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
-@item Cyrus imapd 1.4, 1.5.19, 1.6.22, 2.0.5 or later
+@item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
+@item Courier-IMAP 1.3.2 or later
 @item AIR MAIL (AIRC imapd release 2.00)
 @item Express Mail
 @item Microsoft Exchange Server 5.5
-@item Sun Internet Mail Server 4.0
+@item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
 @end itemize
 
-@c LDAP connectivity with following LDAPd are confirmed to work with
-@c Wanderlust:
+LDAP connectivity with following LDAPd are confirmed to work with
+Wanderlust:
+
+@itemize @bullet
+@item OpenLDAP 2.0.6 or later
+@end itemize
 
 
 @node Start Me Up, Folders, Introduction, Top
@@ -243,18 +248,18 @@ 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}.)
 
 Recommended combination of APEL, FLIM and SEMI are following:
 
 @itemize @minus
-@item APEL 10.2, FLIM 1.13.2 and SEMI 1.13.7
+@item APEL 10.3, FLIM 1.14.2 and SEMI 1.14.3
 @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 +507,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
 
@@ -576,9 +581,9 @@ The format is very simple. Like this. @refill
 # @r{Format of each line:}
 # @var{email-address}  "@var{nickname} "@var{realname}"
 #
-teranisi@@gohome.org            "Yuuichi"      "Yuuichi Teranishi"
-foo@@bar.gohome.org             "Mr. Foo"    "John Foo"
-bar@@foo.gohome.org             "Mr. Bar"    "Michael Bar"
+teranisi@@gohome.org            "YT"            "Yuuichi Teranishi"
+foo@@example.com                "Mr. Foo"       "John Foo"
+bar@@example.org                "Mr. Bar"       "Michael Bar"
 @end group
 @end example
 
@@ -610,6 +615,7 @@ the program @command{ldapsearch}.
 
 You can skip this section because it is possible to add/edit the
 subscribe folders from the buffer for list of folders.
+@xref{Folder Manager}.
 
 Define the folders you want to subscribe in file @file{~/.folders}.  The
 contents written in @file{~/.folders} become the folders which you
@@ -629,14 +635,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"
 @}
 #
@@ -761,12 +767,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
@@ -776,6 +792,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
@@ -1262,7 +1283,7 @@ Example:
 @end group
 @end example
 
-To use apop as an @var{authenticate-type}, @file{md5.el} is needed
+To use APOP as an @var{authenticate-type}, @file{md5.el} is needed
 (XEmacs doesn't need @file{md5.el}).  @file{md5.el} is included in
 @file{utils/sasl/lisp/} or Emacs/W3 package
 (@uref{http://www.cs.indiana.edu/elisp/w3/docs.html}) or LCD archive
@@ -2819,6 +2840,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
@@ -2826,6 +2852,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
@@ -3730,13 +3761,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)}
@@ -3871,7 +3902,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")
          )
@@ -4242,8 +4273,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 non-nil, cache the message which is sent.
 
 @item wl-auto-flush-queue
 @vindex wl-auto-flush-queue
@@ -5789,6 +5820,7 @@ Examples with other packages.
 * mu-cite::                     mu-cite.el
 * x-face-mule::                 x-face-mule.el
 * dired-dd::                    dired-dd.el
+* MHC::                         MHC
 @end menu
 
 
@@ -5933,7 +5965,7 @@ value of the variable @code{wl-x-face-file}), it is inserted as a
 @code{wl-auto-insert-x-face} is non-nil).
 
 
-@node dired-dd,  , x-face-mule, Living with other packages
+@node dired-dd, MHC, x-face-mule, Living with other packages
 @subsection dired-dd(Dired-DragDrop)
 @pindex Dired-DragDrop
 @pindex Dired-DD
@@ -5960,6 +5992,34 @@ specific, but general-purpose for tm/SEMI).
 @end group
 @end lisp
 
+@node MHC, , dired-dd, Living with other packages
+@subsection mhc.el
+@pindex MHC
+
+Message Harmonized Calendaring system
+(@uref{http://www.quickhack.net/mhc/})
+
+By using MHC, you can make a calendar from the messages.
+
+For mhc-0.25:
+
+@lisp
+@group
+(setq mhc-mailer-package 'wl)
+(autoload 'mhc-mode "mhc" nil t)
+(add-hook 'wl-summary-mode-hook 'mhc-mode)
+(add-hook 'wl-folder-mode-hook 'mhc-mode)
+@end group
+@end lisp
+
+For mhc-current:
+
+@lisp
+@group
+(autoload 'mhc-wl-setup "mhc-wl")
+(add-hook 'wl-init-hook 'mhc-wl-setup)
+@end group
+@end lisp
 
 @node Highlights, Biff, Living with other packages, Customization
 @section Highlights
@@ -6230,6 +6290,15 @@ If @code{nil}, wl doesn't check mail arrival.
 @vindex wl-biff-check-interval
 The initial setting is 40 (in seconds).
 Check mail arrival in this period. 
+
+@item wl-biff-notify-hook
+@vindex wl-biff-notify-hook
+The initial setting is @code{nil}.
+This is a hook run at the arrival of the new mail.
+To beep, set as:
+@lisp
+(setq wl-biff-notify-hook '(beep))
+@end lisp
 @end table
 
 
@@ -6245,6 +6314,10 @@ Check mail arrival in this period.
 
 @node Draft for Reply, Thread Format, Advanced Settings, Advanced Settings
 @subsection Draft for Replay
+@vindex wl-draft-reply-with-argument-list
+@vindex wl-draft-reply-without-argument-list
+@vindex wl-draft-reply-myself-with-argument-list
+@vindex wl-draft-reply-myself-without-argument-list
 
 If you want, when you replying to articles in mailing lists, the address
 in Reply-To field of the original message to be prepared to To field of