Applied patch from Tsuyoshi Kitamoto <tsuyoshi.kitamoto@city.sapporo.jp>.
[elisp/wanderlust.git] / doc / wl.texi
index eefa605..659f735 100644 (file)
@@ -5,7 +5,7 @@
 @c %**end of header
 @documentlanguage en
 @documentencoding us-ascii
-@set VERSION 2.5.5
+@include version.texi
 @synindex pg cp
 @finalout
 
@@ -19,7 +19,7 @@
 This file documents Wanderlust, Yet another message interface on
 Emacsen.
 
-Copyright @copyright{} 1998, 1999, 2000 @w{Yuuichi Teranishi},
+Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada}.
 
@@ -61,7 +61,7 @@ into another language, under the above conditions for modified versions.
 @page
 
 @vskip 0pt plus 1filll
-Copyright @copyright{} 1998, 1999, 2000 @w{Yuuichi Teranishi},
+Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
 @w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
 @w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada}.
 
@@ -243,18 +243,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 +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
 
@@ -610,6 +610,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 +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"
 @}
 #
@@ -737,9 +738,9 @@ Format:
 
 You can specify @code{login} (encoded password transmission),
 @code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
-authentication) or @code{plain} (or @code{nil}, plain password
+authentication) or @code{clear} (or @code{nil}, plain password
 transmission) as @var{authenticate-type}.  (To use CRAM-MD5 or
-DIGEST-MD5 authentication, you must install @file{utils/sasl} package.)
+DIGEST-MD5 authentication, you must install @file{utils/sasl} package if FLIM version is earlier than 1.14.0. If FLIM version is 1.14.0 or later, you need not install @file{utils/sasl})
 
 default:
 
@@ -761,21 +762,36 @@ 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
 your server is unable to receive an encoded password, authentication
-will fall back to @code{plain} (that is, sending password in raw format)
+will fall back to @code{clear} (that is, sending password in raw format)
 after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
-authentication will fall back to @code{plain} without confirmation
+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
@@ -784,10 +800,10 @@ Example:
 %#mh/inbox -> IMAP mailbox "#mh/inbox"
 
 %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
-%inbox:hoge/login@@server1
+%inbox:hoge/clear@@server1
             -> server1's IMAP mailbox "inbox"
                of user "hoge", with plain password authentication
-               ('plain).
+               ('clear).
 @end group
 @end example
 
@@ -2457,8 +2473,12 @@ the appearance like following.
 If you type @kbd{/} key once again, the thread is closed.
 With prefix argument, @kbd{/} opens all children threads.
 
+If you type @kbd{[}, opens all threads in summary.  @kbd{]} closes all
+threads.
+
 Commands with the key binding that begins with @kbd{t} executes commands
 on the messages in the thread.
+@xref{Key Bindings of Summary}.
 
 @subsection reconstruct thread by hand
 
@@ -2815,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
@@ -2822,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
@@ -3407,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
@@ -3602,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
 
 
@@ -3726,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)}
@@ -3867,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")
          )
@@ -4238,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
@@ -4263,6 +4319,11 @@ All headers that match this regexp will be deleted when resending a message.
 If non-nil, always removes your own address from @samp{To:} and
 @samp{Cc:} when you are replying to the mail addressed to you.
 
+@item wl-draft-delete-myself-from-bcc-fcc
+@vindex wl-draft-delete-myself-from-bcc-fcc
+If any of @code{wl-subscribed-mailing-list} are contained in @samp{To:}
+or @samp{Cc:} field, do not insert @samp{Bcc:} or @samp{FCC:} field.
+
 @item wl-smtp-posting-server
 @vindex wl-smtp-posting-server
 The initial setting is @code{nil}.
@@ -5780,6 +5841,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
 
 
@@ -5924,7 +5986,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
@@ -5951,6 +6013,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
@@ -6221,6 +6311,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
 
 
@@ -6236,6 +6335,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
@@ -6699,6 +6802,8 @@ valuable advice and many pieces of code they contributed.
       7/11    killed message feature.
       7/18    Use UIDL in POP3.
       9/12    biff feature with Satata-san & Yamaoka-san.
+     10/17    expire-hide by Okada-san.
+     11/08    Released 2.4.0 stable.
 @end example
 
 See @file{ChangeLog} for details.