-\input texinfo @c -*-texinfo -*- coding: iso-2022-jp -*-
+\input texinfo @c -*-texinfo -*-
@c %**start of header
@setfilename wl.info
@settitle Wanderlust -- Yet Another Message Interface On Emacsen --
-@c @documentlanguage en
@c %**end of header
-@c texinfo of Wanderlust
-@set Time-stamp: <00/04/26 17:31:25 teranisi>
-@set version 1.1.1
+@documentlanguage en
+@documentencoding us-ascii
+@include version.texi
@synindex pg cp
@finalout
+@dircategory GNU Emacs Lisp
@direntry
* Wanderlust: (wl). Yet Another Message Interface On Emacsen
@end direntry
@c permissions text appears in an Info file before the first node.
@ifinfo
-This file documents Wanderlust,
-Yet another message interface on Emacsen.
+This file documents Wanderlust, Yet another message interface on
+Emacsen.
-Copyright @copyright{} 1998, 1999, 2000 @w{Yuuichi Teranishi}.
-@c Copyright @copyright{} 1998, 1999, 2000 @w{Yuuichi Teranishi}, @*
-@c @w{Fujikazu Okunishi}, @w{Masahiro Murata},
-@c @w{Kenichi Okada}, @w{Kaoru Takahashi}, @w{Bun Mizuhara}
-and @w{Masayuki Osada}.
+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},
+@w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
-This edition is for Wanderlust version @value{version}.
+This edition is for Wanderlust version @value{VERSION}.
-Permission is granted to make and distribute verbatim copies of
-this manual provided the copyright notice and this permission notice
-are preserved on all copies.
+Permission is granted to make and distribute verbatim copies of this
+manual provided the copyright notice and this permission notice are
+preserved on all copies.
@ignore
Permission is granted to process this file through TeX and print the
-results, provided the printed document carries copying permission
-notice identical to this one except for the removal of this paragraph
-(this paragraph not being relevant to the printed manual).
+results, provided the printed document carries copying permission notice
+identical to this one except for the removal of this paragraph (this
+paragraph not being relevant to the printed manual).
@end ignore
Permission is granted to copy and distribute modified versions of this
-manual under the conditions for verbatim copying, provided that the entire
-resulting derived work is distributed under the terms of a permission
-notice identical to this one.
+manual under the conditions for verbatim copying, provided that the
+entire resulting derived work is distributed under the terms of a
+permission notice identical to this one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions.
@titlepage
@sp 10
-@title Wanderlust User's Manual (ver. @value{version})
+@title Wanderlust User's Manual
+@subtitle Yet another message interface on Emacsen
+@subtitle for Wanderlust version @value{VERSION}
@author Yuuichi Teranishi
@author Fujikazu Okunishi
@author Masahiro Murata
@author Kaoru Takahashi
@author Bun Mizuhara
@author Masayuki Osada
+@author Katsumi Yamaoka
+@author Hiroya Murata
+@author Yoichi Nakayama
@page
@vskip 0pt plus 1filll
-Copyright @copyright{} 1998, 1999, 2000 @w{Yuuichi Teranishi}.
-@c Copyright @copyright{} 1998, 1999, 2000 @w{Yuuichi Teranishi}, @*
-@c @w{Fujikazu Okunishi}, @w{Masahiro Murata},
-@c @w{Kenichi Okada}, @w{Kaoru Takahashi},
-@c @w{Bun Mizuhara} and @w {Masayuki Osada}
+Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
+@w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
+@w{Kaoru Takahashi}, @w{Bun Mizuhara}, @w{Masayuki Osada},
+@w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
-This manual is for Wanderlust version @value{version}.
+This manual is for Wanderlust version @value{VERSION}.
-Permission is granted to make and distribute verbatim copies of
-this manual provided the copyright notice and this permission notice
-are preserved on all copies.
+Permission is granted to make and distribute verbatim copies of this
+manual provided the copyright notice and this permission notice are
+preserved on all copies.
Permission is granted to copy and distribute modified versions of this
-manual under the conditions for verbatim copying, provided that the entire
-resulting derived work is distributed under the terms of a permission
-notice identical to this one.
+manual under the conditions for verbatim copying, provided that the
+entire resulting derived work is distributed under the terms of a
+permission notice identical to this one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions.
@end titlepage
-@c
-@c Top
-@c
@ifinfo
@node Top, Introduction, (dir), (dir)
@top Wanderlust User's Manual
Kaoru Takahashi
Bun Mizuhara
Masayuki Osada
-Last Modified@value{Time-stamp:}
+Katsumi Yamaoka
+Hiroya Murata
+Yoichi Nakayama
@end flushright
-This manual is for Wanderlust@value{version}.
+This manual is for Wanderlust @value{VERSION}.
@end ifinfo
@menu
-* Introduction:: Read this first.
-* Start Me Up:: Invoking Wanderlust.
-* Folders:: How to specify folders.
-* Folder:: Selecting and editing folders.
-* Summary:: Reading and refiling messages.
-* Message:: Saving and playing MIME multipart entities.
-* Draft:: Draft buffer, sending mail and news.
+* Introduction:: Read this first
+* Start Me Up:: Invoking Wanderlust
+* Folders:: How to specify folders
+* Folder:: Selecting and editing folders
+* Summary:: Reading and refiling messages
+* Message:: Saving and playing MIME multipart entities
+* Draft:: Draft buffer, sending mail and news
* Disconnected Operations:: Off-Line management
-* Expire and Archive:: Automatic expiration and archiving of messages.
-* Scoring:: Score of the messages.
-* Customization:: Customizing Wanderlust.
+* Expire and Archive:: Automatic expiration and archiving of messages
+* Scoring:: Score of the messages
+* Address Book:: Management of Address Book
+* Customization:: Customizing Wanderlust
* Mailing List:: Wanderlust mailing list
* Addition:: Additional Information
-* Index:: Key index.
+* Index:: Key index
@end menu
-@c
-@c Introduction
-@c
@node Introduction, Start Me Up, Top, Top
@chapter Introduction of Wanderlust
@cindex Introduction
@item Folder Mode shows the list of subscribed folders.
@item Message Cache, Disconnected Operation (Read Only).
@item MH-like FCC. (FCC: %Backup and FCC: $Backup is allowed).
-@item MIME compliant (by SEMI or tm).
+@item MIME compliant (by SEMI).
@item Transmission of news and mail are unified by Message transmitting draft.
-@item Graphical list of folders (XEmacs).
+@item Graphical list of folders (XEmacs and Emacs 21).
@item View a part of message without retrieving the whole message (IMAP4).
@item Server-side message look up (IMAP4). Multi-byte characters are allowed.
@item Virtual Folders.
@item Template function makes it convenient to send fixed form messages.
@end itemize
-Wanderlust is supposed to run on Mules based on Emacs 19.28, 19.34,
-Emacs 20.2 or later, XEmacs 20.4 or later, Meadow 1.00 or later(on MS Windows),
-Mule for Windows v1.22 (on MS Windows), NTEmacs(Windows NT).
-PMMule on OS/2 is also supported. Wanderlust runs even on Nemacs 3.3.2
-based on Emacs 18.55, 18.59 (with limited functionality).
-IMAP4 connectivity with UW imapd 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.7a,
-Cyrus imapd 1.4, Cyrus imapd 1.5.19, AIR MAIL(AIRCimapd release 2.00)
-and ExpressMail are confirmed to work with Wanderlust.
+@section Environment
+
+Wanderlust is supposed to run on following Emacsen:
+
+@itemize @bullet
+@item Mule 2.3 based on Emacs 19.34
+@item Emacs 20.2 or later
+@item XEmacs 20.4 or later
+@item Meadow 1.00 or later
+@item NTEmacs 20.4 or later
+@item PMMule
+@end itemize
+
+IMAP4 connectivity with following imapd are confirmed to work with
+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--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 3.5, 3.5.alpha, 4.0
+@end itemize
+
+LDAP connectivity with following LDAPd are confirmed to work with
+Wanderlust:
+
+@itemize @bullet
+@item OpenLDAP 2.0.6 or later
+@end itemize
+
-@c
-@c Start Me Up
-@c
@node Start Me Up, Folders, Introduction, Top
@chapter Start up Wanderlust
@cindex Start up
-
-The necessary procedure for starting Wanderlust is explained in steps here.
+The necessary procedure for starting Wanderlust is explained in steps
+here.
(Of course, you need a mail/news readable environment in advance)
@menu
-* MIME Modules:: Installing the MIME modules.
-* Download:: Download and extract the packages.
-* Install:: Byte-compile and install.
-* Minimal Settings:: @file{.emacs} setup.
-* Mail Addresses:: Address book definition.
-* Folder Definition:: Folder definition.
+* MIME Modules:: Installing the MIME modules
+* Download:: Download and extract the packages
+* Install:: Byte-compile and install
+* Minimal Settings:: @file{.emacs} setup
+* Folder Definition:: Folder definition
* Start Wanderlust:: Starting Wanderlust
@end menu
@pindex APEL
@pindex FLIM
@pindex SEMI
-@pindex tm
-
-SEMI or tm must be installed to make Wanderlust work correctly.
-
-SEMI does not run on Emacs19.28 or earlier
-@footnote{SEMI runs on Emacs 19.34. @*
-@samp{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} describes how to.},
-so you must install tm, the predecessor of SEMI. (tm version 8.7 or later
-is needed.)
-However, SEMI is recommended because of its wider functionality.
-Partial download function in IMAP4 is enabled only when SEMI is installed.
+SEMI must be installed to make Wanderlust work correctly.
-Refer to the documents of each package for detailed installation procedure.
-
-SEMI and tm can be downloaded from these sites:
+SEMI can be downloaded from these sites:
@example
-SEMI: ftp://ftp.m17n.org/mule/semi/
-tm: http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
+@group
+SEMI: ftp://ftp.m17n.org/pub/mule/semi/
+@end group
@end example
You need packages named APEL and FLIM to use SEMI.
-You can download FLIM and APEL from following URLs.
+You can download APEL and FLIM from following URLs:
@example
-FLIM: ftp://ftp.m17n.org/mule/flim/
-APEL: ftp://ftp.m17n.org/mule/apel/
+@group
+APEL: ftp://ftp.m17n.org/pub/mule/apel/
+FLIM: ftp://ftp.m17n.org/pub/mule/flim/
+@end group
@end example
-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:
-
-@itemize @minus
-@item APEL 10.2, FLIM 1.12.7 and SEMI 1.13.4
-@item APEL 10.2, FLIM 1.13.2 and SEMI 1.13.7
-@end itemize
+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}.)
-Combination of APEL 10.2 and FLIM 1.12.7 makes following error
-while compiling FLIM 1.12.7.
+Refer to the documents of each package for detailed installation
+procedure @footnote{If you want to use SEMI on Emacs 19.34. @*
+@uref{http://www.jpl.org/elips/INSTALL-SEMI-ja.html} (In Japanese)
+may help you.}.
-@example
-Please install latest APEL 7.3 or later.
-@end example
-In this case, please comment out following lines in FLIM-CFG.
+Recommended combination of APEL, FLIM and SEMI are following:
-@example
-(or (fboundp 'write-region-as-binary)
- (error "Please install latest APEL 7.3 or later."))
-(or (fboundp 'insert-file-contents-as-binary)
- (error "Please install latest APEL 7.3 or later."))
-@end example
+@itemize @minus
+@item APEL 10.3, FLIM 1.14.3 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
-@item APEL 10.2, Chao 1.14.1 and REMI 1.14.1
+@item APEL 10.2, Chao 1.14.1, REMI 1.14.2
+@item APEL 10.2, SLIM 1.14.3, EMY 1.13.9
@end itemize
-@c You have to re-install Wanderlust
-@c if you upgraded APEL, FLIM, SEMI or tm.
+You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
+
@node Download, Install, MIME Modules, Start Me Up
@section Download and Extract the Package
Mirrored ftp/http sites:
@example
+@group
ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/
-ftp://daidai.kuis.kyoto-u.ac.jp/pub/mirror/ftp.gohome.org/pub/elisp/wl/
-http://www.jpl.org/elips/
+http://www.jpl.org/elips/wl/
http://www.ring.gr.jp/archives/text/elisp/wl/
ftp://ftp.ring.gr.jp/pub/text/elisp/wl/
ftp://opaopa.org/pub/mirror/elisp/wl/
+@c ftp://roguelife.org/pub/tsumura/wl/
+@end group
@end example
Extract the obtained package to your working directory:
@example
+@group
% cd ~/work
-% tar zxvf wl-(@var{version}).tar.gz
-% cd wl-(@var{version})
+% tar zxvf wl-@var{version}.tar.gz
+% cd wl-@var{version}
+@end group
@end example
@subsection To use SSL (Secure Socket Layer)
+@cindex SSL
+@pindex OpenSSL
+@pindex starttls
-SSL (Secure Socket Layer) can be used for
+SSL (Secure Socket Layer) can be used for
SMTP, IMAP, NNTP and POP connections in Wanderlust.
-There are two ways to use SSL. One is to start SSL negotiation just after
-the connection establishment (generic way).
-The other one is to start SSL negotiation by invoking STARTTLS command in
-the each session.
+There are two ways to use SSL. One is to start SSL negotiation just
+after the connection establishment (generic way). The other one is to
+start SSL negotiation by invoking STARTTLS command in the each session.
-To use the formar SSL (generic SSL), you must install @file{ssl.el} in the
-@file{utils} directory. OpenSSL command @file{openssl} is also required
-to use @file{ssl.el}. You must set PATH to the directory that OpenSSL
-commands are installed.
+To use the formal SSL (generic SSL), you must set @env{PATH} to the
+directory that OpenSSL commands are installed.
To use the latter SSL(STARTTLS), you must install starttls package in
-addition to above.
+addition to above.
You can download starttls package from the following site.
@example
Then, please execute following commands.
@example
+@group
% make
% make install
+@end group
@end example
Destination directory is auto-probed if you leave @code{LISPDIR}
-in @file{Makefile} as is. (That is, leave it as NONE)
+in @file{Makefile} as is. (That is, leave it as @samp{NONE})
If you are using an Emacs variant which does not merge specified directory
-to load-path (e.g. Mule 2.3 based on Emacs 19.28),
+to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
then you will see the error message:
@example
@end example
@noindent
-In this case, either add destination directories of custom, apel, flim and semi
-to environmental variable EMACSLOADPATH, or define load-path in @file{WL-CFG}
-in extracted directory.
+In this case, either add destination directories of custom, APEL, FLIM
+and SEMI to environmental variable @env{EMACSLOADPATH}, or define
+@code{load-path} in @file{WL-CFG} in extracted directory.
-If you want to use BBDB, then the necessary modules are byte-compiled and
-installed when BBDB directory is added to load-path.
+If you want to use BBDB, then the necessary modules are byte-compiled
+and installed when BBDB directory is added to @code{load-path}.
@xref{BBDB}.
-@subsection WL-CFG
+@subsection @file{WL-CFG}
Contents of the file @file{WL-CFG} is loaded under installation if a file
with that name exists in extracted directory. You can use @file{WL-CFG} to
-configure load-path to extra packages such as SEMI if needed.
+configure @code{load-path} to extra packages such as SEMI if needed.
If you want to specify the install directory of Wanderlust related
files, then set following variables in @file{WL-CFG}
A directory to install WL modules.
This directory is relative directory from @code{LISPDIR}.
WL modules include @file{wl*.el}, @file{wl*.elc} files.
-@c Modules under the directory @file{util/} are also installed if
+@c Modules under the directory @file{util/} are also installed if
@c it detected as necessary.
@item ELMO_PREFIX
ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
@c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
@end table
-
+
@noindent
Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
(setq ELMO_PREFIX "elmo")
@end lisp
-@noindent
@subsection Install as a XEmacs package
@cindex XEmacs package
@cindex XEmacs package install
@c @cindex install-package
It is possible to install Wanderlust as one of packages of XEmacs (21.0
-or greater). Configuration for autoload and icon-path in local
-@file{.emacs} files are no longer necessary, if you install Wanderlust
+or later). Configuration for autoload and icon-path in local
+@file{~/.emacs} files are no longer necessary, if you install Wanderlust
as a package.
Follow the next example to install Wanderlust as an XEmacs package.
@example
+@group
% vi Makefile
% make package
% make install-package
+@end group
@end example
package directory is auto-probed, if SEMI is installed.
@subsection Run in place
-If wl and elmo directories are defined in load-path, then byte-compilation
-and installation are not necessary to start Wanderlust. For example,
-if package is extracted in @file{~/work}, Wanderlust can be invoked with
-following setting in @file{.emacs}.
+If wl and elmo directories are defined in @code{load-path}, then
+byte-compilation and installation are not necessary to start Wanderlust.
+For example, if package is extracted in @file{~/work}, Wanderlust can be
+invoked with following setting in @file{~/.emacs}.
@lisp
-(add-to-list 'load-path "~/work/wl-(@var{version})")
-(add-to-list 'load-path "~/work/wl-(@var{version})/elmo")
+@group
+(add-to-list 'load-path "~/work/wl-@var{version}/wl")
+(add-to-list 'load-path "~/work/wl-@var{version}/elmo")
+@end group
@end lisp
-@node Minimal Settings, Mail Addresses, Install, Start Me Up
+@subsection Manual
+
+Manual is described in Info format. Please do following.
+
+@example
+@group
+% make info
+% make install-info
+@end group
+@end example
+
+If you install Wanderlust as a XEmacs package, Info file is already
+installed too, so there are no need of these commands.
+
+Manual directory is automatically detected. Of course, it can be
+configured by @code{INFODIR} in @file{Makefile}.
+
+You can read manual at the following URL:
+
+@example
+http://www.gohome.org/wl/doc/wl-euc_toc.html
+@end example
+
+@node Minimal Settings, Folder Definition, Install, Start Me Up
@section Set up .emacs
@cindex Minimal Settings
@cindex Settings
@table @samp
@item ELMO (elmo-*.el)
-These modules show everything as folders. This is the back-end for Wanderlust.
+These modules show everything as folders. This is the back-end for WL.
@item WL (wl-*.el)
These modules controls the behavior of main body of Wanderlust.
They are also the front-end for ELMO.
@end table
You can customize the behavior of Wanderlust by changing the value
-of environmental variables which begins with @code{elmo-*} and @code{wl-*}.
+of environmental variables which begins with @code{elmo-} and @code{wl-}.
The minimal requirement for settings is as the following.
@lisp
-;; The setting to use SEMI/tm
-(load "mime-setup")
+@group
+;; @r{The setting to use SEMI}
+(require 'mime-setup)
-;; autoload configuration
-;; (These are not required if Wanderlust is installed as XEmacs package)
+;; @r{autoload configuration}
+;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
(autoload 'wl "wl" "Wanderlust" t)
(autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
-;; Directory where icons are placed (XEmacs Only). Default value is nil.
-;; (This is not required if Wanderlust is installed as XEmacs package)
-(setq wl-icon-dir "~/work/wl/etc")
+;; @r{Directory where icons are placed.}
+;; @r{Default: the peculiar value to the running version of Emacs.}
+;; @r{(This is not required if the default value has been set properly)}
+(setq wl-icon-directory "~/work/wl/etc")
-;; SMTP server for mail posting. Default: "localhost"
-(setq wl-smtp-posting-server "your.smtp.server.com")
-;; NNTP server for news posting. Default: "localhost"
-(setq wl-nntp-posting-server "your.nntp.server.com")
+;; @r{SMTP server for mail posting. Default: @code{nil}}
+(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.example.com")
+@end group
@end lisp
@file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
(if you write it to @file{.emacs}, you'll get an error).
@xref{Highlights}.
-All above described settings except (load "mime-setup") can be written in
+All above described settings except @samp{(require 'mime-setup)} and autoload
+configuration can be written in
@file{~/.wl}).
-@subsection mail-user-agent
+@subsection @code{mail-user-agent}
@cindex Default Mailer
@cindex Mailer, Default
@vindex mail-user-agent
@findex compose-mail
If you write following setting in you @file{.emacs}, you can
-start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
+start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
This means it enables you to run Wanderlust as a default mail composer
- of Emacs.
+ of Emacsen.
It is effective only when your Emacs can define @code{mail-user-agent}.
-@c @xref{Mail Methods, , ,emacs}.
+@xref{Mail Methods, , ,emacs-ja, The Emacs Editor}.
@lisp
+@group
(autoload 'wl-user-agent-compose "wl-draft" nil t)
(if (boundp 'mail-user-agent)
(setq mail-user-agent 'wl-user-agent))
'wl-draft-send
'wl-draft-kill
'mail-send-hook))
+@end group
@end lisp
-@node Mail Addresses, Folder Definition, Minimal Settings, Start Me Up
-@section Address book
-@cindex Address book Definition
-@cindex .addresses
-@cindex Alias, Address
-
-The file @file{~/.addresses} is a simple address book for Wanderlust.
-Make address file @file{~/.addresses}, and edit to suit your requirement.
-
-The data written in @file{~/.addresses} are used for address completion
-under draft editing mode. Furthermore, they are used when showing names
-in summary display mode. You can safely skip this section, if you don't
-want to customize address completion and summary display.
-It is possible to add/change/remove addresses from @file{~/.addresses} in
-summary buffer after Wanderlust is invoked. @refill
-
-The format is very simple. Like this. @refill
-
-@example
-#
-# @r{Lines begin with @samp{#} are comment.}
-# @r{Empty lines are ignored}
-#
-# @r{Format of each line:}
-# @r{email-address ``nickname'' ``realname''}
-#
-teranisi@@gohome.org "Yuuichi" "Yuuichi Teranishi"
-foo@@bar.gohome.org "Mr. Foo" "John Foo"
-bar@@foo.gohome.org "Mr. Bar" "Michael Bar"
-@end example
-
-@noindent
-One line defines one persons description.
-
-Actually, in default setup, "nickname" is used in summary-mode and "real name"
-is used in draft preparation mode. This behavior is better understood if you
-try it and confirmed the function first. You can write and try a small
-definition, so you will know the idea of the address book before writing a big
-one.
-
-And, if MH alias file is specified in variable @code{wl-alias-file},
-it is used as an address information in the draft preparation mode.
-@node Folder Definition, Start Wanderlust, Mail Addresses, Start Me Up
+@node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
@section Folder Definition
@cindex Folder Definition
@cindex .folders
-Define the folders you want to subscribe in file @file{~/.folders}.
-The contents written in @file{~/.folders} become the folders which
-you subscribe to as it is.
-
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
+subscribe to as it is.
Format for @file{~/.folders} is very simple. Here is an example:
@example
+@group
#
# @r{Lines begin with @samp{#} are comment.}
# @r{Empty lines are ignored}
#
-# @r{folder name} "@r{folder nickname}"
+# @var{folder name} "@var{folder nickname}"
# @r{(nicknames are not necessary)}
#
%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/tm-ja "tm Japanese 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"
@}
#
%#mh/expire@@localhost /
# @r{All MH folders are included in one folder group.}
+ /
+@end group
@end example
-Each line contains one folder you want to read. The definition of folders
-will be explained in detail in the next section.
+Each line contains one folder you want to read. The definition of
+folders will be explained in detail in the next section.
-The part surrounded by @samp{@var{group name}@{} and @samp{@}} will become one folder group.
-One folder group is treated as a directory which can bed opened and closed in
-folder mode. It is convenient for collecting some folders and putting them
-in order.
+The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
+become one folder group. One folder group is treated as a directory
+which can be opened and closed in folder mode. It is convenient for
+collecting some folders and putting them in order.
Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
line and you have to write it that way (It is because the parser sucks).
There are two types of groups. One is like @samp{Emacsen} from above
example which the user chooses his favorite folders as a group.
-The other one is @dfn{access group} like @samp{+} from above example.
-It makes all the sub-folders in a folder to a group.
-(It differs from the type of the folder. For example, @samp{+} makes entire
- MH sub-directories to one group)
+The other one is @dfn{access group} like @samp{+ /} from above example.
+It makes all the sub-folders in a folder to a group. (It differs from
+the type of the folder. For example, @samp{+} followed by @samp{/}
+makes entire MH sub-directories to one group)
-This behavior is better understood if you try it and confirmed the function
-first. You can write and try a small folder definition, so you will know the
-idea of the folder function before writing the real one.
+This behavior is better understood if you try it and confirmed the
+function first. You can write and try a small folder definition, so you
+will know the idea of the folder function before writing the real one.
@node Start Wanderlust, , Folder Definition, Start Me Up
@section Start Wanderlust
If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
can skip folder checking.
-@c
-@c Folders
-@c
+Basically, you will handle messages in wanderlust while you come and go
+from/to each of the following buffers.
+
+@table @samp
+@item Folder Buffer
+You can see the list of folders. You can select some folder and go into the summary
+of it. You can subscribe new folder or edit subscription list.
+@item Summary Buffer
+You can see the list of messages in the folder. You can select message and view its
+contents, and reply to some message. You can delete ones or move ones to another
+folder.
+@item Message Buffer
+You can see the contents of the message. You can save part to disk or open in external
+programs.
+@item Draft Buffer
+You can edit message.
+@end table
+
+Details of each ones are explained later.
+
+
@node Folders, Folder, Start Me Up, Top
-@chapter Wanderlust's folders
+@chapter Wanderlust's folders
@cindex Folder Type
This chapter describes the folder types which Wanderlust is able to handle.
Wanderlust uses ELMO as it's interface, so every folder types supported
by ELMO is usable in Wanderlust.
-As of version @value{version}, 10 types of folders are predefined. These are
-IMAP, NNTP, LocalDir(MH), News Spool, POP, Archive, Multi, Filter, Pipe
-and Internal folder types.
+As of version @value{VERSION}, 11 types of folders are predefined. These are
+IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
+Pipe and Internal folder types.
@menu
-* IMAP Folder:: @samp{%} -- IMAP folder
-* NNTP Folder:: @samp{-} -- NNTP folder
-* MH Folder:: @samp{+} -- MH folder
-* Maildir Folder:: @samp{.} -- Maildir folder
-* News Spool Folder:: @samp{=} -- News spool folder
-* Archive Folder:: @samp{$} -- Archive folder
-* POP Folder:: @samp{&} -- POP folder
-* Multi Folder:: @samp{*} -- Multi folder
-* Filter Folder:: @samp{/} -- Filter folder
-* Pipe Folder:: @samp{|} -- Pipe folder
-* Internal Folder:: @samp{'} -- Internal folder
+* IMAP Folder:: @samp{%} -- IMAP folder
+* NNTP Folder:: @samp{-} -- NNTP folder
+* MH Folder:: @samp{+} -- MH folder
+* Maildir Folder:: @samp{.} -- Maildir folder
+* News Spool Folder:: @samp{=} -- News spool folder
+* Archive Folder:: @samp{$} -- Archive folder
+* POP Folder:: @samp{&} -- POP folder
+* Shimbun Folder:: @samp{@@} -- Shimbun Folder
+* Namazu Folder:: @samp{[} -- Namazu Folder
+* Multi Folder:: @samp{*} -- Multi folder
+* Filter Folder:: @samp{/} -- Filter folder
+* Pipe Folder:: @samp{|} -- Pipe folder
+* Internal Folder:: @samp{'} -- Internal folder
@end menu
@node IMAP Folder, NNTP Folder, Folders, Folders
@section IMAP Folder
-@cindex IMAP Folder
@cindex @samp{%}
+@cindex IMAP Folder
+@cindex Folder, IMAP
@cindex RFC 2060
@cindex IMAP4rev1
A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
+Format:
+
@example
-Format: '%' 'IMAP mailbox'[':' 'username' ['/' 'authenticate-type']]['@@' 'hostname'][':' 'port']['!']
+@group
+@samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
+@end group
+@end example
-You can specify
-"auth" (encoded password transmission), "cram-md5" (cram-md5 authentication)
-and "login" (plain password transmission) as authenticate-type.
-(To use cram-md5 authentication, you must install utils/sasl package.)
+You can specify @code{login} (encoded password transmission),
+@code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
+authentication) or @code{clear} (or @code{nil}, plain password
+transmission) as @var{authenticate-type}.
default:
-username -> The value of @code{elmo-default-imap4-user}.
- Initial setting is `USER' environment variable or
- `LOGNAME' environment variable or return value of
- (user-login-name).
-authenticate-type -> The value of @code{elmo-default-imap4-authenticate-type}.
+@example
+@var{username} -> The value of @code{elmo-imap4-default-user}.
+ Initial setting is @env{USER} environment variable or
+ @env{LOGNAME} environment variable or return value of
+ @code{(user-login-name)}.
+@var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
Initial setting is "auth".
-hostname -> The value of @code{elmo-default-imap4-server}.
+@var{hostname} -> The value of @code{elmo-imap4-default-server}.
Initial setting is "localhost".
-port -> The value of @code{elmo-default-imap4-port}.
+@var{port} -> The value of @code{elmo-imap4-default-port}.
Initial setting is 143.
+@end example
-You can omit the hostname from folder names if you set
-@code{elmo-default-imap4-server} as your main IMAP server.
-For example, you can specify a folder as @samp{foo%imap@@geteway} even
+You can omit the @var{hostname} from folder names if you set
+@code{elmo-imap4-default-server} as your main IMAP server.
+For example, you can specify a folder as @samp{foo%imap@@gateway} even
if you have to go through a firewall.
-SSL (Secure Socket Layer) connection will be used if a folder name
-ends with '!'. Or, if the value of @code{elmo-default-imap4-ssl} is non-nil,
-SSL will be the default connection.
-If a folder name ends with '!!', STARTTLS connection will be established.
-if the value of @code{elmo-default-imap4-ssl} is 'starttls,
+@lisp
+@group
+;; @r{Example: imap4.exaple.org as main IMAP server}
+(setq elmo-imap4-default-server "imap4.example.org")
+@end group
+@end lisp
+
+SSL (Secure Socket Layer) connection will be used if a folder name ends
+with @samp{!}. Or, if the value of @code{elmo-imap4-default-stream-type}
+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-imap4-default-stream-type} is @code{starttls},
STARTTLS will be the default connection.
-If you specify "auth" or "cram-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 "login" (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 "login" without confirmation
-(default value is nil).
-
-Example: %inbox -> IMAP mailbox "inbox"
- %#mh/inbox -> IMAP mailbox "#mh/inbox"
-
- %inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
- %inbox:hoge/login@@server1
- -> server1's IMAP mailbox "inbox"
- of user "hoge", with plain password authentication
- ("login").
+@lisp
+@group
+;; @r{Example: Use SSL connection}
+(setq elmo-imap4-default-stream-type 'ssl)
+@end group
+@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{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{clear} without confirmation
+(default value is @code{nil}).
+
+@lisp
+@group
+;; @r{Example: password in raw format}
+(setq elmo-imap4-default-authenticate-type 'clear)
+@end group
+@end lisp
+
+Example:
+
+@example
+@group
+%inbox -> IMAP mailbox "inbox"
+%#mh/inbox -> IMAP mailbox "#mh/inbox"
+
+%inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
+%inbox:hoge/clear@@server1
+ -> server1's IMAP mailbox "inbox"
+ of user "hoge", with plain password authentication
+ ('clear).
+@end group
@end example
@subsection International mailbox names (Modified UTF7)
-
-You can use international mailbox names in 'IMAP mailbox' part, if you
+@cindex Modified UTF7
+@cindex UTF7
+@cindex UTF8
+@cindex Unicode
+@pindex Mule-UCS
+@pindex ucs-conv
+
+You can use international mailbox names in @var{mailbox} part, if you
are using Emacs which can treat unicode and
@code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
-value is nil).
+value is @code{nil}).
Currently, following Emacsen can treat unicode.
You can obtain ucs-conv package from following anonymous CVS.
@example
-:pserver:anonymous@@cvs.m17n.org:/cvs/root
-Password: NULL (Just enter return key)
+@group
+cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root login
+Password: @var{NULL} (Just enter return key)
+cvs -d :pserver:anonymous@@cvs.m17n.org:/cvs/root checkout ucs-conv
+@end group
@end example
-You also need utf7 conversion programs, u7tou8 and u8tou7 to use international
-mailbox name in the current XEmacs.
-These programs are included in the UTF7 package which can be obtained
-from following URL.
+You also need utf7 conversion programs, @command{u7tou8} and
+@command{u8tou7} to use international mailbox name in the current
+XEmacs. These programs are included in the UTF7 package which can be
+obtained from following URL.
@example
ftp://ftp.ifcss.org/pub/software/unix/convert/utf7.tar.gz
@end example
@end itemize
+
@node NNTP Folder, MH Folder, IMAP Folder, Folders
@section NNTP Folder
-@cindex NNTP Folder
@cindex @samp{-}
+@cindex NNTP Folder
+@cindex Folder, NNTP
+@cindex Folder, News
+@cindex NetNews
+@cindex News
+@cindex Newsgroup
+@cindex RFC 977
A folder to access USENET news via NNTP protocol (RFC 977).
One newsgroup is treated as a folder.
+Format:
+
@example
-Format: '-' 'newsgroup'[[':' 'username']['@@' 'hostname'][':' 'port']]['!']
+@group
+@samp{-} @var{newsgroup} [[@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
+@end group
+@end example
default:
-hostname -> The value of @code{elmo-default-nntp-server}.
- Initial setting is "localhost".
-username -> The value of @code{elmo-default-nntp-user}.
- Initial setting is nil.
-port -> The value of @code{elmo-default-nntp-port}.
+@example
+@var{hostname} -> The value of @code{elmo-nntp-default-server}.
+ Initial setting is @samp{localhost}.
+@var{username} -> The value of @code{elmo-nntp-default-user}.
+ Initial setting is @code{nil}.
+@var{port} -> The value of @code{elmo-nntp-default-port}.
Initial setting is 119.
+@end example
-AUTHINFO is used as authentication method if the username is non-nil.
-SSL will be default method if @code{elmo-default-nntp-ssl} is non-nil even
-if the folder name doesn't end with '!'
-If a folder name ends with '!!', STARTTLS connection will be established.
-if the value of @code{elmo-default-nntp-ssl} is 'starttls,
-STARTTLS will be the default connection.
+AUTHINFO is used as authentication method if the @var{username} is
+non-nil. SSL will be default method if
+@code{elmo-nntp-default-stream-type} is non-nil even if the folder name
+doesn't end with @samp{!}. If a folder name ends with @samp{!!},
+STARTTLS connection will be established. if the value of
+@code{elmo-nntp-default-stream-type} is @code{starttls}, STARTTLS will
+be the default connection.
-Example: -fj.rec.tv -> Newsgroup `fj.rec.tv'.
- -fj.rec.tv@@newsserver -> Newsgroup `fj.rec.tv' on newsserver.
+Example:
+
+@example
+@group
+-fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
+-fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
+@end group
@end example
+
@node MH Folder, Maildir Folder, NNTP Folder, Folders
@section MH Folder
-@cindex MH Folder
@cindex @samp{+}
+@cindex MH Folder
+@cindex Folder, MH
@pindex MH
A folder to access MH format mail (1 file is 1 mail).
+Format:
+
@example
-Format: '+' 'directory-name'
+@samp{+} @var{directory-name}
+@end example
-Normally, directory paths are relative to variable
+Normally, @var{directory-name} is an relative path to the variable
@code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
starts with @samp{/} or @samp{~}, then it is treated as an absolute path
(this is also true for drive-letters).
Message number is used for the name of the message file.
-Example: +inbox -> "~/Mail/inbox"
- +from/teranisi -> "~/Mail/from/teranisi"
- +~/test -> "~/test"
+Example:
+
+@example
+@group
++inbox -> @file{~/Mail/inbox}
++from/teranisi -> @file{~/Mail/from/teranisi}
++~/test -> @file{~/test}
+@end group
@end example
+
@node Maildir Folder, News Spool Folder, MH Folder, Folders
@section Maildir Folder
-@cindex Maildir Folder
@cindex @samp{.}
+@cindex Maildir Folder
@pindex Maildir
+@pindex qmail
-A folder to access to Maildir format (1 file is 1 mail).
+A folder to access Maildir format (1 file is 1 mail).
+
+Format:
@example
-Format: '.' 'directory-name'
+@samp{.} [@var{directory-name}]
+@end example
-Normally, directory paths are relative to variable
+Normally, @var{directory-name} is a relative path to the variable
@code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
starts with @samp{/} or @samp{~}, then it is treated as an absolute path
(this is also true for drive-letters).
Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
-Messages are contained in the @file{cur} directory. All
-message files in the @file{new} directory are moved to @file{cur}
-directory when you access to the folder. All message files contained in
-the @file{tmp} directory and not accessed for 36 hours are deleted.
+Messages are contained in the @file{cur} directory. All message files
+in the @file{new} directory are moved to @file{cur} directory when you
+access the folder. All message files contained in the @file{tmp}
+directory and not accessed for 36 hours are deleted.
-These behaviors are defined the @samp{http://cr.yp.to/proto/maildir.html}.
+This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
-Example: . -> "~/Maildir"
- .inbox -> "~/Maildir/inbox"
- .from/teranisi -> "~/Maildir/from/teranisi"
- .~/test -> "~/test"
+Example:
+
+@example
+@group
+. -> @file{~/Maildir}
+.inbox -> @file{~/Maildir/inbox}
+.from/teranisi -> @file{~/Maildir/from/teranisi}
+.~/test -> @file{~/test}
+@end group
@end example
+
@node News Spool Folder, Archive Folder, Maildir Folder, Folders
@section News Spool Folder
-@cindex News spool Folder
@cindex @samp{=}
+@cindex News spool Folder
@pindex gnspool
-This folder handles locally saved news articles which are proposed by Mew/IM.
-You can also read articles directly from a spool-file which is retrieved
-by an utility like gnspool.
+This folder handles locally saved news articles which are proposed by
+Mew/IM. You can also read articles directly from a spool-file which is
+retrieved by an utility like @command{gnspool}.
+
+Format:
@example
-Format: '=' 'directory-name'
+@samp{=} @var{directory-name}
+@end example
-directory-name is sub-directory to the directory defined by variable
-@code{elmo-localnews-folder-path} (default is "~/News")
+@var{directory-name} is a sub-directory to the directory defined by
+variable @code{elmo-localnews-folder-path} (default is @file{~/News})
You can use @samp{.} as directory delimiter as well as @samp{/}.
-Example: =fj/os/os2 -> "~/News/fj/os/os2"
- =fj.os.bsd.freebsd -> "~/News/fj/os/bsd/freebsd"
+Example:
+
+@example
+@group
+=fj/os/os2 -> @file{~/News/fj/os/os2}
+=fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
+@end group
@end example
+
@node Archive Folder, POP Folder, News Spool Folder, Folders
@section Archive Folder
-@cindex Archive Folder
@cindex @samp{$}
+@cindex Archive Folder
@c @pindex ange-ftp
This method can handle archive files, which are compressed by utilities
such as Info-ZIP or LHA, as one folder.
+Format:
+
@example
-Format: '$' 'path-name' [';' archiver-type ';' prefix]
-
-`path-name' is the relative path from @code{elmo-archive-folder-path}
-(initial setting is @file{~/Mail}).
-If path-name begins with @samp{/} or @samp{~} or `drive-letter of DOS',
-path-name is treated as absolute path.
-ange-ftp format is also permitted under the environment of ange-ftp, efs.
-
-The actual file name of the archive folder is
-@code{elmo-archive-basename}(Initial setting is "elmo-archive")
-under the path-name. If a file named path-name exists, it is treated as
-folder. The suffix is automatically decided for archiver-type.
-
-If `archiver-type' is omitted, @code{elmo-archive-default-type}
-(Initial setting is 'zip) is referred.
-
-`prefix' specifies the internal directory structure of the archive.
-For example, if the ML server is fml, @file{msend.tar.gz} has a structure like
-@file{spool/1}, so you have to specify "spool" as `prefix'.
-
-Example: $teranisi -> "~/Mail/teranisi/elmo-archive.zip"
- $bsd/freebsd;lha -> "~/Mail/bsd/freebsd/elmo-archive.lzh"
- $/foo@@server:~/bar;zoo -> "~/bar/elmo-archive.zoo" on ftp server
- $d:/msend.tar.gz;tgz;spool -> "d:/msend.tar.gz"
+@group
+@samp{$} @var{path-name} [@samp{;} @var{archiver-type} @samp{;} @var{prefix}]
+@end group
+@end example
+
+@var{path-name} is the relative path from
+@code{elmo-archive-folder-path} (initial setting is @file{~/Mail}). If
+@var{path-name} begins with @samp{/} or @samp{~} or `drive-letter of
+DOS', @var{path-name} is treated as absolute path. ange-ftp format is
+also permitted under the environment of ange-ftp, efs.
+
+The actual file name of the archive folder is
+@code{elmo-archive-basename} (Initial setting is @file{elmo-archive})
+under the @var{path-name}. If a file named @var{path-name} exists, it is
+treated as folder. The suffix is automatically decided for
+@var{archiver-type}.
+
+If @var{archiver-type} is omitted, @code{elmo-archive-default-type}
+(Initial setting is @code{zip}) is referred.
+
+@var{prefix} specifies the internal directory structure of the archive.
+For example, if the ML server is fml, @file{msend.tar.gz} has a
+structure like @file{spool/1}, so you have to specify @samp{spool} as
+@var{prefix}.
+
+Example:
+
+@example
+@group
+$teranisi -> @file{~/Mail/teranisi/elmo-archive.zip}
+$bsd/freebsd;lha -> @file{~/Mail/bsd/freebsd/elmo-archive.lzh}
+$/foo@@server:~/bar;zoo -> @file{~/bar/elmo-archive.zoo} on ftp server
+$d:/msend.tar.gz;tgz;spool -> @file{d:/msend.tar.gz}
+@end group
@end example
@menu
-* Archiver:: Archivers supported
+* Archiver:: Supported Archivers
* Archive Tips:: TIPS
* Archive Vars:: Customization
@end menu
By default, following archives are supported.
@example
+@group
LHA, Info-ZIP/UNZIP, ZOO, RAR ;; full-access
GNU TAR('tgz, 'tar) ;; read-only
+@end group
@end example
If your archiver can include multiple files in one archive, you have a
possibility use it as an archiver of Wanderlust (ARJ/UNARJ, ARC is one
of the candidate. TAR is supported read-only because it cannot delete
-file in the archive ('mv)).
+file in the archive (@code{mv})).
-gzip, bzip, bzip2 cannot be used as an archiver of Wanderlust because
-they cannot include multiple files. Archivers that cannot extract files
-to standard output are also not supported.
+@command{gzip}, @command{bzip}, @command{bzip2} cannot be used as an
+archiver of Wanderlust because they cannot include multiple
+files. Archivers that cannot extract files to standard output are also
+not supported.
@subsection OS specific information about archiver.
GNU tar 1.11.8 + 1.5(WIN32)
GZIP 1.2.4
RAR 2.06
+@end example
* Caution about LHA
* Caution about GNU tar
-You have to take care about GNU tar's version because
-many version has problem on deleting file from archive.
+You have to take care about GNU tar's version because many version has
+problem on deleting file from archive.
-Please test --delete -f options work. Otherwise, your archive will be
-destroyed. No problem is reported on above versions of GNU tar.
-@end example
+Please test @option{--delete} @option{-f} options work. Otherwise, your
+archive will be destroyed. No problem is reported on above versions of
+GNU tar.
@node Archive Tips, Archive Vars, Archiver, Archive Folder
@subsection TIPS
@cindex Archive Tips
-For comfortable migration, usage of wl-summary-archive() (@pxref{Archive}) or
-Expire (@pxref{Expire}) is recommended.
-To treat archive folders created by expiration,
-you must set non-nil value to @code{elmo-archive-treat-file}.
+For comfortable migration, usage of @code{wl-summary-archive}
+(@pxref{Archive}) or Expire (@pxref{Expire}) is recommended. To treat
+archive folders created by expiration, you must set non-nil value to
+@code{elmo-archive-treat-file}.
On the OS/2, there is a great difference between Mule2.3(19.28) and Emacs20.2
in processing speed. For comfortable use, Emacs20 is recommended.
(If re-search's performance is the problem, 19.3x or later may be okay.)
If many files are included in one archive,
-it takes long time to access to the archive folder because
+it takes long time to access the archive folder because
archiver starting overhead is increased (especially LHA).
150-200 messages in one archive is recommended.
-Of course, following is possible @t{:-)}
+Of course, following is possible @t{:-)}
(meanings of these variables are described later.)
+
@lisp
+@group
(setq wl-fcc "$backup")
(setq wl-trash-folder "$trash;lha")
+@end group
@end lisp
-@noindent
@node Archive Vars, , Archive Tips, Archive Folder
@subsection Variables About Archive Folder
@cindex Archive variables
@table @code
@item elmo-archive-default-type
@vindex elmo-archive-default-type
-The initial setting is 'zip.
-Set archiver type by symbol.
+The initial setting is @code{zip}.
+Set archiver type by symbol.
@item elmo-archive-@var{type}-method-alist
@vindex elmo-archive-TYPE-method-alist
Each element of the alist is following.
@example
- (action . (exec-name options)) ;; external program and its option.
- (action . function) ;; function
+@group
+(@var{action} . (@var{exec-name} @var{options})) ;; external program and its option.
+(@var{action} . @var{function}) ;; function
+@end group
@end example
Currently available actions are following.
@example
- 'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
- 'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
- 'cp ('cp-pipe) ;;
+@group
+'ls, 'cat ('cat-headers) ;; Minimal setting(read-only)
+'mv ('mv-pipe), 'rm ('rm-pipe) ;; full-access (with above)
+'cp ('cp-pipe) ;;
+@end group
@end example
@noindent
-In above actions,
+In above actions,
actions enclosed with braces are optional (They are used for better
performance).
@item elmo-archive-lha-dos-compatible
@vindex elmo-archive-lha-dos-compatible
-The initial setting is t on OS/2 and Win32.
-If non-nil, LHA is DOS (Mr. Yoshizaki original) compatible.
+The initial setting is @code{t} on OS/2 and Win32. If non-nil, LHA is
+DOS (Mr. Yoshizaki original) compatible.
@item elmo-archive-cmdstr-max-length
@vindex elmo-archive-cmdstr-max-length
However, you don't have an influence of command line argument limit
if the archiver has `actions' to receive target file information from
-standard input (rm-pipe, mv-pipe, cat-headers action).
+standard input (@code{rm-pipe}, @code{mv-pipe}, @code{cat-headers} action).
@end table
-@node POP Folder, Multi Folder, Archive Folder, Folders
+
+@node POP Folder, Shimbun Folder, Archive Folder, Folders
@section POP Folder
-@cindex POP Folder
@cindex @samp{&}
+@cindex POP Folder
@cindex RFC 1939
@cindex POP3
@cindex APOP
A folder to access e-mails via POP3 protocol (RFC 1939).
+Format:
+
@example
-Format: '&' ['username'][['/' 'authenticate-type']['@@' 'hostname'][':' 'port']]['!']
+@group
+@samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
+@end group
+@end example
You can specify
-"user" (plain password transmission) or "apop" (APOP authentication)
-as authenticate-type.
+@samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
+as @var{authenticate-type}.
default:
-username -> The value of @code{elmo-default-pop3-user}.
- Initial setting is `USER' environment variable or
- `LOGNAME' environment variable or return value of
- (user-login-name).
-authenticate-type -> The value of @code{elmo-default-pop3-authenticate-type}.
- Initial setting is "user".
-hostname -> The value of @code{elmo-default-pop3-server}.
- Initial setting is "localhost".
-port -> The value of @code{elmo-pop3-default-port}.
+@example
+@var{username} -> The value of @code{elmo-pop3-default-user}.
+ Initial setting is @env{USER} environment variable or
+ @env{LOGNAME} environment variable or return value of
+ @code{(user-login-name)}.
+@var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
+ Initial setting is @samp{user}.
+@var{hostname} -> The value of @code{elmo-pop3-default-server}.
+ Initial setting is @samp{localhost}.
+@var{port} -> The value of @code{elmo-pop3-default-port}.
Initial setting is 110.
+@end example
+
+Example:
-Example: &hoge@@localhost -> access to localhost as user "hoge".
- &hoge@@popserver:109 -> access to the server "popserver" on port 109
- as user "hoge".
+@example
+@group
+&hoge@@localhost -> access localhost as user @samp{hoge}.
+&hoge@@popserver:109 -> access the server "popserver" on port 109
+ as user @samp{hoge}.
+@end group
@end example
-To use apop as an 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
+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
+(GPL2).
+
+If the last character of the folder name is @samp{!}, Wanderlust
+connects to the POP server via SSL (Secure Socket Layer). If you set
+non-nil value to @code{elmo-pop3-default-stream-type}, you don't have to put
+@samp{!} in the end of the folder name to use SSL. If a folder name ends
+with @samp{!!}, STARTTLS connection will be established. if the value
+of @code{elmo-pop3-default-stream-type} is @code{starttls}, STARTTLS will be the
+default connection.
+
+
+@node Shimbun Folder, Namazu Folder, POP Folder, Folders
+@section Shimbun Folder
+@cindex @samp{@@}
+@cindex Shimbun Folder
+@cindex Folder, Shimbun
+@cindex Folder, Web
+@pindex w3m
+@pindex emacs-w3m
+
+A folder for watching "shimbun" (means "newspaper" in Japanese),
+news site and mailing list archives on WWW by using emacs-w3m
+(@uref{http://emacs-w3m.namazu.org/}).
+
+You should possess w3m and emacs-w3m to use this.
+
+Format:
@example
-http://www.cs.indiana.edu/elisp/w3/docs.html
+@group
+@samp{@@} @var{module-name} @samp{.} @var{folder-name}
+@end group
@end example
-or LCD archive (GPL2).
+Admissible values of @var{module-name} and @var{folder-name} are
+described in @file{README.shimbun.ja} distributed with emacs-w3m.
-If the last character of the folder name is '!', Wanderlust connects to
-the POP server via SSL (Secure Socket Layer). If you set non-nil
-value to @code{elmo-default-pop-ssl}, you don't have to put '!' in the
-end of the folder name to use SSL.
-If a folder name ends with '!!', STARTTLS connection will be established.
-if the value of @code{elmo-default-pop-ssl} is 'starttls,
-STARTTLS will be the default connection.
+Example:
+
+@example
+@group
+@@airs.wl -> archive of wanderlust ML (using module @file{sb-airs.el})
+@@asahi/ -> access group of all folders in module @file{sb-asahi.el}
+@end group
+@end example
+
+
+@node Namazu Folder, Multi Folder, Shimbun Folder, Folders
+@section Namazu Folder
+@cindex @samp{[}
+@cindex Namazu Folder
+@cindex Folder, Namazu
+@cindex Folder, Text Search
+@pindex Namazu
+@pindex nmz
+A folder to access messages found in namazu-index with some condition.
+It uses namazu (@uref{http://www.namazu.org/}) for search.
+
+Format:
-@node Multi Folder, Filter Folder, POP Folder, Folders
+@example
+@group
+@samp{[} @var{search condition} @samp{]} [ @var{absolute path of namazu index} ]
+@end group
+@end example
+
+Default value of the path of namazu index can be assigned by @code{elmo-nmz-default-index-path}.
+
+Example:
+
+@example
+@group
+[wanderlust] -> search messages matched with
+ "wanderlust" from the default index
+[semi flim]~/Mail/semi -> search "semi flim" from the index
+ in the directory "~/Mail/semi"
+@end group
+@end example
+
+Tips
+
+If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
+
+
+@node Multi Folder, Filter Folder, Namazu Folder, Folders
@section Multi Folder
-@cindex Multi Folder
@cindex @samp{*}
+@cindex Multi Folder
@cindex Folder, Multiple
@cindex Folder, Marge
-A folder to access to a folder which collects messages from
-multiple folders virtually.
+A folder to access virtual folder which collects messages from
+multiple folders.
+
+Format:
@example
-Format: '*' 'folder' [',' 'folder'] ... [',' 'folder']
+@group
+@samp{*} @var{folder-1} [@samp{,} @var{folder-2}] @dots{} [@samp{,} @var{folder-N}]
+@end group
+@end example
-After '*' character, specify multiple folders you want to collect
-separated by ',' like folder1,folder2,@dots{},folderN.
+After @samp{*} character, specify multiple folders you want to collect
+separated by @samp{,} like
+@samp{@var{folder-1},@var{folder-2},@dots{},@var{folder-N}}.
Example:
- *-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
- -> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
- treated as one folder.
-
- *+inbox,-fj.rec.tv,%inbox
- -> +inbox, -fj.rec.tv and %inbox are treated as one folder.
+@example
+@group
+*-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs
+-> -fj.editor.xemacs, -fj.editor.mule and -fj.editor.emacs are
+ treated as one folder.
+
+*+inbox,-fj.rec.tv,%inbox
+-> +inbox, -fj.rec.tv and %inbox are treated as one folder.
+@end group
@end example
@node Filter Folder, Pipe Folder, Multi Folder, Folders
@section Filter Folder
-@cindex Filter Folder
@cindex @samp{/}
+@cindex Filter Folder
@cindex Folder, Filtering
@cindex Folder, Virtual
+@cindex Folder, Conditional
-A folder to access to a folder which collects all messages that
-satisfy a condition virtually.
+A folder to access virtual folder which collects all messages that
+satisfy a condition.
+
+Format:
@example
-Format: '/' 'condition' '/' 'target-folder'
+@samp{/} @var{condition} @samp{/} @var{target-folder}
+@end example
-In the 'condition' part, you can specify following.
+In the @var{condition} part, you can specify following.
-1. Partial filter: "first:NUMBER", "last:NUMBER"
+@enumerate
+@item
+Partial filter: @samp{first:@var{number}}, @samp{last:@var{number}}
-first: 'NUMBER' messages are picked from top of folder.
-last: 'NUMBER' messages are picked from bottom of folder.
+first: @var{number} messages are picked from top of folder.
+last: @var{number} messages are picked from bottom of folder.
Example:
- /last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
- /first:20/%inbox -> First 20 messages from %inbox are picked.
-2. Date filter: "since:DATE" "before:DATE"
+@example
+@group
+/last:10/-fj.os.linux -> Latest 10 messages from -fj.os.linux are picked.
+/first:20/%inbox -> First 20 messages from %inbox are picked.
+@end group
+@end example
+
+@item
+Date filter: @samp{since:@var{date}}, @samp{before:@var{date}}
-since: only messages arrived since 'DATE' are picked.
-before: only messages arrived before 'DATE' are picked.
+since: only messages arrived since @var{date} are picked.
+before: only messages arrived before @var{date} are picked.
-You can specify following as 'DATE'.
+You can specify following as @var{date}.
+@example
+@group
yesterday -> a day before today.
lastweek -> same day of last week.
lastmonth -> same day of last month.
lastyear -> same day of last year.
-'NUMBER'daysago -> 'NUMBER' days ago. (e.x. '3daysago')
-'DAY'-'MONTH'-'YEAR' -> specify date directly (ex. 1-Nov-1998)
+@var{number}daysago -> @var{number} days ago. (e.x. '3daysago')
+@var{day}-@var{month}-@var{year} -> specify date directly (ex. 1-Nov-1998)
+@end group
+@end example
Example:
- /since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
- are picked.
- /before:yesterday/+inbox -> messages arrived before yesterday in +inbox
- are picked.
-3. Field filter: "FIELD=VALUE"
+@example
+@group
+/since:3daysago/+inbox -> messages arrived since 3 days ago in +inbox
+ are picked.
+/before:yesterday/+inbox -> messages arrived before yesterday in +inbox
+ are picked.
+@end group
+@end example
+
+@item
+Field filter: @samp{@var{field}:@var{value}}
-All messages that have FIELD and its value is VALUE are picked.
-'FIELD' and 'VALUE' are case insensitive.
+All messages that have @var{field} and its value is @var{value} are picked.
+@var{field} and @var{value} are case insensitive.
Example:
- /from=teranisi/+inbox -> In +inbox, messages which have From: field
- and its value includes "teranisi" string are picked.
- /body=foo/%inbox -> In %inbox, messages which have "foo" text
- are picked.
-If you can split conditions by character "|", it is considered as OR condition.
-/tocc=xxxx/ is an abbreviation of /to=xxxx|cc=xxxx/.
+@example
+@group
+/from:teranisi/+inbox -> In +inbox, messages which have From: field
+ and its value includes "teranisi" string are picked.
+/body:foo/%inbox -> In %inbox, messages which have "foo" text
+ are picked.
+@end group
+@end example
+
+@item
+Compound condition
+
+If you combine conditions by character @samp{|}, it is considered as OR condition. @samp{&} is considered as AND condition, likewise.
+Condition can be grouped by parentheses (@samp{(}, and @samp{)}).
+
+@samp{/tocc:xxxx/} is an abbreviation of @samp{/to:xxxx|cc:xxxx/}.
+@samp{/!tocc:xxxx/} is an abbreviation of @samp{/!to:xxxx&!cc:xxxx/}.
Example:
- /from=teranisi|to=teranisi/+inbox
- -> In +inbox, messages are picked if
- the message's To: field includes
- "teranisi" or From: field includes "teranisi".
- /tocc=teranisi/+inbox -> In +inbox, messages are picked if
- the message's To: field or Cc: field includes
- "teranisi".
+@example
+@group
+/from:teranisi&!to:teranisi/+inbox
+ -> In +inbox, messages are picked if the message's
+ From: field includes "teranisi" and
+ To: field doesn't include "teranisi".
+
+/tocc:"Yuuichi Teranishi"/+inbox
+ -> In +inbox, messages are picked if the
+ message's To: field or Cc: field includes
+ "Yuuichi Teranishi".
+
+/(from:yt|from:teranisi)&subject:report/+inbox
+ -> In +inbox, messages are picked if the message's
+ From: field includes "yt" or "teranisi", and
+ Subject includes "report".
+@end group
+@end example
+@end enumerate
+
+@noindent
+Tip for string description:
+
+Space character, @samp{"}, @samp{/},@samp{)},@samp{|} and @samp{&}
+should be enclosed with @samp{"} in @var{value} string. (@samp{"}
+should be escaped with @samp{\} in it). You can enclose the string with
+@samp{"} even it does not contain these characters.
+@noindent
Advanced example:
- %inbox,/from=teranisi/%inbox@@server
- -> Messages in %inbox or
- message is in the %inbox@@server folder and it's From field
- includes "teranisi" are collected.
-
- /last:100//to=teranisi/*+inbox,%inbox
- -> Latest 100 messages which is in the +inbox or %inbox folder
- and To: field matches "teranisi".
-
- /from=hogehoge//last:20//tocc=teranisi/%#mh/inbox@@localhost
- -> Pick messages which have From: field and it includes "hogehoge"
- from latest 20 messages in the %#mh/inbox@@localhost
- and To: or Cc: field includes "teranisi".
-
-;;; --- Limit of implementation ---
-;;; In the current implementation, NNTP folder does not treat date filter and
-;;; field filter.
-;;; In IMAP4 folder, field filter only supports fields which can be
-;;; passed directly to rfc2060's search command.
-;;; (i.e. to,cc,from,subject and body)
-;;; Localdir folder treats arbitrary field name.
+@example
+*%inbox,/from:teranisi/%inbox@@server
+ -> Messages in %inbox or
+ message is in the %inbox@@server folder and it's From field
+ includes "teranisi" are collected.
+
+/last:100//to:teranisi/*+inbox,%inbox
+ -> Latest 100 messages which is in the +inbox or %inbox folder
+ and To: field matches "teranisi".
+
+/from:hogehoge//last:20//tocc:teranisi/%#mh/inbox@@localhost
+ -> Pick messages which have From: field and it includes "hogehoge"
+ from latest 20 messages in the %#mh/inbox@@localhost
+ and To: or Cc: field includes "teranisi".
@end example
@node Pipe Folder, Internal Folder, Filter Folder, Folders
@section Pipe Folder
-@cindex Pipe Folder
@cindex @samp{|}
+@cindex Pipe Folder
@cindex Get Message
@cindex Download Message
@cindex Incorporate Message
In the pipe folder, messages are automatically transferred from the source
folder to destination folder.
+Format:
+
@example
-Format: '|' source-folder '|' destination-folder
+@samp{|} @var{source-folder} @samp{|} @var{destination-folder}
+@end example
-When you access to the pipe folder, messages are automatically transferred
-from source-folder to destination-folder.
+When you access the pipe folder, messages are automatically transferred
+from @var{source-folder} to @var{destination-folder}.
It is convenient if you want to download messages to local disk via POP.
For example, if you specify following
+@example
|&username@@popserver|+inbox
+@end example
-and access to it, messages are downloaded automatically from
-&username@@popserver to +inbox.
+@noindent
+and access it, messages are downloaded automatically from
+@samp{&username@@popserver} to @samp{+inbox}.
+
+Example:
-Example: %inbox|%myinbox -> Download %inbox to %myinbox.
- *&user@@popserver1,&user@@popserver2|+inbox
+@example
+@group
+%inbox|%myinbox -> Download %inbox to %myinbox.
+*&user@@popserver1,&user@@popserver2|+inbox
-> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
+@end group
@end example
After messages are moved, a hook @code{elmo-pipe-drained-hook} is called.
@node Internal Folder, , Pipe Folder, Folders
@section Internal folder
-@cindex Internal Folder
@cindex @samp{'}
+@cindex Internal Folder
@cindex Folder, @samp{$} mark
+@cindex Cache
+@c @cindex Folder, Null
+
+A folder to access internal messages of Wanderlust.
-A folder to access to internal messages of Wanderlust.
+Format:
@example
-Format: 'mark
- or
- 'cache/00 - 1F
+@group
+'mark
+'sendlog
+'cache/00 - 1F
+@end group
+@end example
-A folder named 'mark is a special virtual folder which collects messages
-which have important mark @samp{$}.
+A folder named @samp{'mark} is a special virtual folder which collects
+messages which have important mark @samp{$}.
You can review important messages at once after you put important marks
on the messages in the different folders.
the message is removed. If you append messages to this folder, the
message will have @samp{$} mark.
-You can access to the cached messages fetched via network by accessing
-to the folders named 'cache/00 - 1F. 00 - 1F are the name of the
-subdirectories of the cache directory (@file{~/.elmo/cache}).
-@end example
+(Can't remove important mark @samp{$} on IMAP server from @samp{'mark}
+folder. If you want IMAP folder's message remove from @samp{'mark}
+folder, remove important mark at IMAP Folder.)
+
+
+A folder named @samp{'sendlog} is a virtual folder which collects
+cached messages which are recoded on @file{~/.elmo/sendlog}.
+It might be useful when you forgot to add cc for yourself.
+To use this, you should set @code{wl-draft-use-cache} to non-nil
+so that sent messages are cached.
+
+
+You can access cached messages fetched via network by accessing
+folders named @samp{'cache/00} - @samp{'cache/1F}. 00 - 1F are
+the name of the subdirectories of the cache directory
+(@file{~/.elmo/cache}).
+
-@c
-@c Folder
-@c
@node Folder, Summary, Folders, Top
@chapter Folder mode
@cindex Folder
You can select and edit folders in this mode.
@menu
-* Selecting Folder:: Select folder you want to read.
-* Folder Manager:: Editing folders.
+* Selecting Folder:: Select folder you want to read
+* Folder Manager:: Editing folders
@end menu
(In XEmacs, it looks much nicer @t{;-)})
@example
+@group
[-]Desktop:14186/35580/67263
Inbox:3/10/10
Trash:2/7/10
Mew:0/0/998
Mule-Win32:0/0/1491
fj's Emacsen:0/5/88
+@end group
@end example
Each line means:
@example
-FOLDER-NAME:NEW-NUMBER/UNREAD-NUMBER/ALL-NUMBER
+@var{folder-name}:@var{new-number}/@var{unread-number}/@var{all-number}
@end example
@noindent
@subsubsection Select Folder
-To enter summary mode of the folder, type return (or spece) key on
+To enter summary mode of the folder, type return (or space) key on
the folder line.
-If the variable @code{wl-stay-folder-window} has non-nil value,
+If the variable @code{wl-stay-folder-window} has non-nil value,
summary window appears on the right of the folder mode window.
@subsection Key bindings
@kindex @key{RET} (Folder)
@findex wl-folder-jump-to-current-entity
Enter to the summary mode of the folder at the current cursor point.
-If the cursor is on the top of folder group line,
+If the cursor is on the top of folder group line,
the folder group is opened or closed.
-When the cursor is on the access group and this command is called
+When the cursor is on the access group and this command is called
with prefix argument, folder children list is updated to the newest one.
(Children list is updated recursively if the access folder has hierarchical
structure.)
@item w
@kindex w (Folder)
-@findex wl-summary-write
+@findex wl-draft
Create a new draft message.
-(@code{wl-summary-write})
+(@code{wl-draft})
@item W
@kindex W (Folder)
-@findex wl-summary-write-current-newsgroup
-If the current cursor point is on the NNTP folder,
-create a new draft message which already has newsgroups field.
-(@code{wl-summary-write-current-newsgroup})
+@findex wl-folder-write-current-folder
+If the current cursor point is on the NNTP folder, create a new draft
+message which already has @samp{Newsgroups:} field. If the current
+cursor point is on the folder for mailing list (refile destination),
+create a new draft message which already has @samp{To:} field with
+guessed mailing list address (If @code{wl-subscribed-mailing-list} is
+valid list).
+(@code{wl-folder-write-current-folder})
+
+@item C-c C-o
+@kindex C-c C-o (Folder)
+@findex wl-jump-to-draft-buffer
+Move to the draft buffer if available. If multiple draft buffer exists,
+moved to one after another. If prefix argument is specified, load draft
+folder's message to the draft buffer and jump to it.
+(@code{wl-jump-to-draft-buffer})
@item s
@kindex s (Folder)
@findex wl-folder-check-current-entity
-Update new and unread number information of the folder at the current
+Update new and unread number information of the folder at the current
cursor point.
(@code{wl-folder-check-current-entity})
Update summary information of the folders in the currently selected region.
(@code{wl-folder-sync-region})
+@item Z
+@kindex Z (Folder)
+@findex wl-status-update
+Sync up address book status with @file{~/.addresses}'s content.
+(@code{wl-status-update})
+
@item P
@kindex P (Folder)
@findex wl-folder-prev-unread
@table @code
@item wl-folders-file
@vindex wl-folders-file
-The initial setting is "~/.folders".
+The initial setting is @file{~/.folders}.
Subscribed folders are described (saved) in this file.
@item wl-folder-info-save
@vindex wl-folder-info-save
-The initial setting is t.
-If non-nil, unread information is saved and used in the next Wanderlust session.
+The initial setting is @code{t}. If non-nil, unread information is
+saved and used in the next Wanderlust session.
@item wl-stay-folder-window
@vindex wl-stay-folder-window
-The initial setting is nil.
+The initial setting is @code{nil}.
If non-nil, summary window is appeared on the right side of the folder buffer.
@item wl-folder-window-width
The initial setting is 20.
Folder mode's window width when @code{wl-stay-folder-window} is non-nil.
+@item wl-folder-use-frame
+@vindex wl-folder-use-frame
+The initial setting is @code{nil}.
+If non-nil, use new frame for the folder window.
+
@item wl-folder-many-unsync-threshold
@vindex wl-folder-many-unsync-threshold
The initial setting is 70.
If the number of unread messages is more than this value,
folder color is changed.
+@item wl-highlight-folder-by-numbers
+@vindex wl-highlight-folder-by-numbers
+This option controls how to highlight each line in the folder buffer.
+The default value is @code{t}, highlighting with various colors based on
+the message numbers. If it is @code{nil}, highlighting with various
+colors based on the folder status. In addition, if it is a number
+(e.g. 1), highlighting will be done based on both the message numbers
+and the folder status.
+
@item wl-folder-desktop-name
@vindex wl-folder-desktop-name
-The initial setting is "Desktop".
+The initial setting is @samp{Desktop}.
The name of top folder group.
@item wl-folder-petname-alist
@vindex wl-folder-petname-alist
-The initial setting is nil.
+The initial setting is @code{nil}.
An alist of folder's realname and its nickname.
@item wl-folder-access-subscribe-alist
@vindex wl-folder-access-subscribe-alist
-The initial setting is nil.
+The initial setting is @code{nil}.
Control automatic subscribing and unsubscribing of the children list
of access groups.
Each element is:
-('regexp of access-folder' . ('subscribe-flag' 'regexp-of-folders' @dots{}))
+@example
+(@var{regexp-of-access-folder} . (@var{subscribe-flag} @var{regexp-of-folders} @dots{}))
+@end example
-If subscribe-flag is non-nil, folders which have name matched to
-regexp-of-folders are displayed. Otherwise, hidden.
-However, already unsubscribed folder is not displayed even
-when the subscribe-flag is non-nil. Multiple regexp-of-folders can be specified.
+@noindent
+If @var{subscribe-flag} is non-nil, folders which have name matched to
+@var{regexp-of-folders} are displayed. Otherwise, hidden. However,
+already unsubscribed folder is not displayed even when the
+@var{subscribe-flag} is non-nil. Multiple @var{regexp-of-folders} can be
+specified.
Example:
-@example
+@lisp
+@group
'(("^-fj$" . (t "^-fj\\.\\(comp\\|editor\\|mail\\)"
"^-fj\\.\\(net\\|news\\|os\\|rec\\)"))
("^-$" . (t "^-\\(fj\\|tnn\\|japan\\|gnu\\|comp\\)"))
("^\\+ml$" . (nil "^\\+ml$" "^\\+ml/tmp")))
-@end example
+@end group
+@end lisp
@item wl-folder-hierarchy-access-folders
@vindex wl-folder-hierarchy-access-folders
-The initial setting is '("-" "-alt").
+The initial setting is the list shown below:
+
+@lisp
+@group
+("-" "-alt")
+@end group
+@end lisp
+
+@noindent
A list of access groups which creates children folder list hierarchically.
For example, if you specify
@code{wl-folder-hierarchy-access-folders} like following,
@lisp
+@group
(setq wl-folder-hierarchy-access-folders
'("-" "-alt" "-japan" "-comp" "-comp.unix"))
+@end group
@end lisp
+@noindent
such access group hierarchy is obtained.
@example
+@group
[-]-:912/912/3011
[-]-fj:674/674/1314
-fj.comp.announce:0/0/2
[-]-comp.unix.bsd:0/0/23
-comp.unix.bsd.freebsd.announce:0/0/0
@dots{}
+@end group
@end example
If you opened @samp{-} in this example, only the direct children is created
@subsubsection Delete Nickname, Filter
-You can delete nickname or filter by putting ""(NULL) from the minibuffer
-while appending.
+You can delete nickname or filter by putting ``''(@var{NULL}) from the
+minibuffer while appending.
@subsubsection Append Folder to Empty Group
firstly open it, then execute append command in the next line.
If it is closed, folder is appended on the same level with
the above folder group. It is difficult to explain by words so try it.
-In other words, appended position depends on the
+In other words, appended position depends on the
above folder group's open/close status.
@subsubsection Charset of the Folders File.
@subsubsection Create Filter
-@kbd{m f} adds filter to the folder at the current cursor point.
-To create new filter folder and leave the current folder unchanged,
-copy it @kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}.
-Multiple filter can be specified while appending filter.
-If you put ""(NULL), filter is deleted.
+@kbd{m f} adds filter to the folder at the current cursor point. To
+create new filter folder and leave the current folder unchanged, copy it
+@kbd{M-c}, make filter @kbd{m f} and paste it @kbd{C-y}. Multiple
+filter can be specified while appending filter. If you put
+``''(@var{NULL}), filter is deleted.
@subsubsection Sort Folders
-Sorting of the folders is executed by the function specified by
-@code{wl-fldmgr-sort-func}.
-The initial setting is @code{wl-fldmgr-sort-standard},
+Sorting of the folders is executed by the function specified by
+@code{wl-fldmgr-sort-function}.
+The initial setting is @code{wl-fldmgr-sort-standard},
which sorts alphabetically.
-Sorting affects only on the current folder group. It does not
+Sorting affects only on the current folder group. It does not
affect on the child groups.
@subsubsection Hiding Folders in the Access Group
some folders hidden. Following operations are only available on access
group.
-Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles
-the visibility (subscribe/unsubscribe) of the folder at current cursor point.
+Command @code{wl-fldmgr-unsubscribe} (@kbd{u}) toggles the visibility
+(subscribe/unsubscribe) of the folder at current cursor point. Against
+this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders in the
+specified region.
-Against this, @code{wl-fldmgr-unsubscribe-region} (@kbd{U}) hides folders
-in the specified region. Note that @code{wl-fldmgr-unsubscribe-region}
-does not toggle while @code{wl-fldmgr-unsubscribe} toggles. These two
-commands accept prefix argument and if the argument has positive number,
-the unsubscribe it. If the prefix argument has negative value, folder
-becomes visible and if zero, folder visibility is toggled.
+Note that @code{wl-fldmgr-unsubscribe-region} does not toggle while
+@code{wl-fldmgr-unsubscribe} toggles. These two commands accept prefix
+argument and if the argument has positive number, the unsubscribe it.
+If the prefix argument has negative value, folder becomes visible and if
+zero, folder visibility is toggled.
The other commands, @code{wl-fldmgr-subscribe} and
@code{wl-fldmgr-subscribe-region} are also prepared (not binded to the
Moreover, if @code{wl-fldmgr-cut} or @code{wl-fldmgr-cut-region} is
executed in the access group, they have a same effect with
@code{wl-fldmgr-unsubscribe} and @code{wl-fldmgr-unsubscribe-region}.
-The difference is that cut(-region) commands deletes folders from the
-current buffer.
+The difference is that cut commands deletes folders from the current
+buffer.
@subsubsection Operations in the Access Group
children folders of the access group and they only sets the subscribe
status. In other words, insertion of the folder means subscribing,
deletion means unsubscribing.
-@footnote{In the current implementation,
+@footnote{In the current implementation,
it is faster to delete region than to unsubscribe region.}
To update the access group when children folders are inserted or deleted
-by other way (other than Wanderlust),
+by other way (other than Wanderlust),
open the access group by typing @kbd{C-u @key{RET}}.
@xref{Selecting Folder}.
@cindex Keybind, Folder Buffer
Key bindings on the folder mode related to folder editing are shown below.
-All bindings starts with @kbd{m}, and primary commands are binded to
+All bindings starts with @kbd{m}, and primary commands are binded to
one stroke key binding.
@table @kbd
@itemx m A
@kindex m A (Folder)
@findex wl-fldmgr-make-access-group
-Create an access group.
+Create an access group.
(@code{wl-fldmgr-make-access-group})
@item m d
@kindex r u (Folder)
@findex wl-fldmgr-unsubscribe-region
Set the visibility of the folders (subscribe/unsubscribe) in the
-specified region.
+specified region.
(@code{wl-fldmgr-unsubscribe-region})
@item l
@findex wl-fldmgr-access-display-all
List all folders regardless of the subscription status.
(@code{wl-fldmgr-access-display-all})
-
-@item C-c C-o
-@kindex C-c C-o (Folder)
-@findex wl-jump-to-draft-buffer
-Move to the draft buffer if available. If multiple draft buffer exists,
-moved to one after another. If prefix argument is specified, load draft
-folder's message to the draft buffer and jump to it.
-(@code{wl-jump-to-draft-buffer})
@end table
@table @code
@item wl-interactive-save-folders
@vindex wl-interactive-save-folders
-The initial setting is t.
-If non-nil and folder view is modified, confirm saving it before
-Wanderlust or Emacs exits.
-If nil, save without confirmation.
+The initial setting is @code{t}. If non-nil and folder view is
+modified, confirm saving it before Wanderlust or Emacs exits. If
+@code{nil}, save without confirmation.
@item wl-fldmgr-make-backup
@vindex wl-fldmgr-make-backup
-The initial setting is t.
-If non-nil, @file{~/.folders.bak} is created before saving the folder status.
+The initial setting is @code{t}. If non-nil, @file{~/.folders.bak} is
+created before saving the folder status.
-@item wl-fldmgr-sort-func
-@vindex wl-fldmgr-sort-func
-The initial setting is 'wl-fldmgr-sort-standard.
-A function to sort folders.
-By default function, folders are sorted alphabetically and
-folder group is put on top
-(when @code{wl-fldmgr-sort-group-first} is non-nil).
+@item wl-fldmgr-sort-function
+@vindex wl-fldmgr-sort-function
+The initial setting is @code{wl-fldmgr-sort-standard}. A function to
+sort folders. By default function, folders are sorted alphabetically
+and folder group is put on top (when @code{wl-fldmgr-sort-group-first}
+is non-nil).
@item wl-fldmgr-sort-group-first
@vindex wl-fldmgr-sort-group-first
-The initial setting is t.
-If non-nil, @code{wl-fldmgr-sort-standard} precedes folder group.
-If nil, it does not care whether it is folder group or not.
+The initial setting is @code{t}. If non-nil,
+@code{wl-fldmgr-sort-standard} precedes folder group. If @code{nil}, it
+does not care whether it is folder group or not.
@item wl-folder-check-async
@vindex wl-folder-check-async
-The initial setting is t.
-If non-nil, check folder's unread status asynchronously.
-It boosts newsgroup checking.
+The initial setting is @code{t}. If non-nil, check folder's unread
+status asynchronously. It boosts newsgroup checking.
@item wl-folder-check-fast
@vindex wl-folder-check-fast
-The initial setting is nil.
+The initial setting is @code{nil}.
If non-nil, it does not update folder status while checking.
@c it is obsolete?
@item wl-folder-notify-deleted
@vindex wl-folder-notify-deleted
-The initial setting is nil.
+The initial setting is @code{nil}.
@c nil means?
-If non-nil, negative value is displayed when the message is deleted.
-If 'sync, folder is synchronized when the message is deleted.
-If nil, message deletion is ignored.
+If non-nil, negative value is displayed when the message is deleted. If
+@code{sync}, folder is synchronized when the message is deleted. If
+@code{nil}, message deletion is ignored.
@end table
@subsection Miscellanea
by one paste command)
@item
-You cannot cut 'Desktop' group.
-Also, you cannot paste folders at the outside of the 'Desktop'.
+You cannot cut @samp{Desktop} group.
+Also, you cannot paste folders at the outside of the @samp{Desktop}.
@item
You cannot copy folder group.
@end enumerate
-@c
-@c Summary
-@c
@node Summary, Message, Folder, Top
@chapter Summary Mode
+After you select the folder via folder mode, you enter to the summary
+mode.
+
+@menu
+* Usage of Summary Mode:: TIPS
+* Thread Operations:: Thread operations
+* Cache:: File cache, Buffer cache, and Prefetch
+* Auto Refile:: Auto refile settings
+* Sticky Summary:: Summary make sticky
+* Key Bindings of Summary:: Key bindings
+* Variables of Summary:: Customize Summary Mode
+@end menu
+
+
+@node Usage of Summary Mode, Thread Operations, Summary, Summary
@section Usage (Tips)
@subsection Summary Content
-After you select the folder via folder mode, you enter to the summary mode.
In the summary mode, messages are displayed like following.
@example
+@group
377 09/16(Wed)11:57 [+1: Takuro Kitame ] Bug?
381 09/17(Thu)00:16 [+3: Fujikazu Okuni ] elmo-lha.el -- LHA interface
384 09/17(Thu)01:32 [+1: Yuuichi Terani ] wl-0.6.2
389 N09/18(Fri)01:07 [+2: Yuuichi Terani ] wl-0.6.3
+@end group
@end example
Each line displays:
@example
-Message number, Temporal mark, Persistent mark, Date, Sender, Subject
+@var{Message number}, @var{Temporal mark}, @var{Persistent mark}, @var{Date}, @var{Sender}, @var{Subject}
@end example
@noindent
You cannot change this in the current version.
-'Message number' is the message's unique number in the folder. In the NNTP
-folder, it is article number, in the IMAP folder, it is UID and in the
-MH folder, it is the filename of the message.
+@var{Message number} is the message's unique number in the folder. In
+the NNTP folder, it is article number, in the IMAP folder, it is UID and
+in the MH folder, it is the filename of the message.
-Temporal and Persistent marks are described later.
+@var{Temporal mark} and @var{Persistent mark} are described later.
-'Date' is displayed like 'Month/Day(Week Day)Hour:Minute'.
-Default setting displays week day in Japanese, but if you want to
-display it in English, set the value of @code{wl-summary-weekday-name-lang}
-as "en".
+@var{Date} is displayed like @samp{@var{Month}/@var{Day}(@var{Week
+Day})@var{Hour}:@var{Minute}}. Default setting displays week day in
+Japanese, but if you want to display it in English, set the value of
+@code{wl-summary-weekday-name-lang} as @samp{en}.
-'Sender's indentation corresponds to the depth of the thread.
-Sender name is displayed as nickname if it is defined in the address book.
-Set @code{wl-use-petname} as nil, if you want to quit displaying with nickname.
+@var{Sender}'s indentation corresponds to the depth of the thread.
+Sender name is displayed as nickname if it is defined in the address
+book. Set @code{wl-use-petname} as @code{nil}, if you want to quit
+displaying with nickname.
-If number is printed at the head of 'sender' part like @samp{+2},
+If number is printed at the head of @var{Sender} part like @samp{+2},
that means the message have 2 follow messages.
-'Subject' is the Subject header field of the message. If the message
-have same subject with the parent message, it is not displayed. Some
-mailing list puts its sequence number in the subject field, but it is
+@var{Subject} is the @samp{Subject:} header field of the message. If
+the message have same @samp{Subject:} with the parent message, it is not
+displayed. Some mailing list puts its sequence number in the
+@samp{Subject:} field, but it is
ignored. @code{wl-summary-no-subject-message} is displayed when the
message has empty subject field.
@subsection Temporary Marks
@cindex Mark, Temporary
-There are four temporary marks,
+There are four temporary marks,
@samp{*}, @samp{D}, @samp{o} and @samp{O}.
Temporary marks indicates message operations.
@item O
The mark to refile.
You can put this mark by typing @kbd{O} key.
-The difference between this mark and refile mark is,
+The difference between this mark and refile mark is,
this mark does not delete the message while latter does.
@end table
moves cursor to the next message.
Enter message buffer by typing @kbd{j} key.
To operate multipart, you have to enter to the message buffer.
+@xref{Message}.
-@subsection Thread Operations
+@subsection Pack the Message Numbers
+You can pack the message numbers in Summary by
+@kbd{M-x wl-summary-pack-number}. Note that only MH Folder,
+News Spool Folder and Maildir Folder are supported folder types.
+
+
+@node Thread Operations, Cache, Usage of Summary Mode, Summary
+@section Thread Operations
For example, the following line indicates one thread (a context of a topic).
the appearance like following.
@example
+@group
384 09/17(Thu)01:32 [ Teranishi ] wl-0.6.2
388 09/17(Thu)22:34 +-[ Murata san ]
+@end group
@end example
(Message 388 is the replied message to the message 384.)
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 Cache File
+@subsection reconstruct thread by hand
-The messages which have to access via network (e.x. IMAP, NNTP folder)
-are cached as a local file.
-The cache file is saved under the directory @file{~/.elmo/cache}.
+You can reconstruct the thread manually. In Summary, @kbd{M-w}
+(@code{wl-summary-save-current-message}) at the corresponding message,
+and @kbd{C-y} (@code{wl-summary-yank-saved-message}) at the new parent
+message then you have the reconstructed thread.
-To expire cache, type following.
-@example
-M-x elmo-cache-expire-by-size
-@end example
+@node Cache, Auto Refile, Thread Operations, Summary
+@section Cache
-@noindent
-The command deletes cache files to the specified size by the order of
-last accessed time.
+@subsection Cache File
+
+The messages which have to access via network (e.x. IMAP, NNTP folder)
+are cached as a local file. The cache file is saved under the directory
+@file{~/.elmo/cache}. To expire cache, type @kbd{M-x
+elmo-cache-expire-by-size}. The command deletes cache files to the
+specified size by the order of last accessed time.
@subsection Buffer Cache and Prefetching
-If the value of @code{elmo-use-buffer-cache} is non-nil,
-the messages that are read are kept in the cache buffer.
-It is called `buffer cache'.
-The number of cache buffer is specified by @code{elmo-buffer-cache-size}.
+The messages that are read are kept in the cache buffer. It is called
+`buffer cache'. The number of cache buffer is specified by
+@code{wl-message-buffer-cache-size}.
-There are message prefetching mechanism in the Wanderlust that prefetches next
-message while you are reading. This function requires that the value of
-@code{elmo-use-buffer-cache} is non-nil.
+There are message prefetching mechanism in the Wanderlust that
+prefetches next message while you are reading.
-You can control the message prefetching mechanism by these two variables.
+You can control the message prefetching mechanism by these two
+variables.
@table @code
-@item wl-cache-prefetch-folder-type-list
-@vindex wl-cache-prefetch-folder-type-list
-The initial setting is '(nntp imap4).
-It specifies the folder types in which message prefetching is enabled.
-In the initial setting, multi folder that contains localdir and imap4
-prefetches only imap4 messages.
-This variable precedes the value of @code{wl-cache-prefetch-folder-list}.
-
-If you want to prefetch localdir and localnews also, following setting is needed.
+@item wl-message-buffer-prefetch-folder-type-list
+@vindex wl-message-buffer-prefetch-folder-type-list
+The initial setting is @code{t}. In this case, prefetch messages in all
+folders.
+If it is a list of folder types, it specifies the folder types in which
+message prefetching is enabled.
+Following is an example (prefetch messages in nntp and imap4 folders)
+
@lisp
-(setq wl-cache-prefetch-folder-type-list
- '(nntp imap4 localdir localnews))
+@group
+(setq wl-message-buffer-prefetch-folder-type-list
+ '(nntp imap4))
+@end group
@end lisp
-@item wl-cache-prefetch-folder-list
-@vindex wl-cache-prefetch-folder-list
-The initial setting is nil.
+In this case, multi folder that contains localdir and imap4 prefetches
+only imap4 messages. This variable precedes the value of
+@code{wl-message-buffer-prefetch-folder-list}.
+
+@item wl-message-buffer-prefetch-folder-list
+@vindex wl-message-buffer-prefetch-folder-list
+The initial setting is @code{nil}.
A list of regexp of folders to enable message prefetching.
@end table
-@subsection Auto Refile
+
+@node Auto Refile, Sticky Summary, Cache, Summary
+@section Auto Refile
@vindex elmo-msgdb-extra-fields
@vindex wl-refile-rule-alist
@findex wl-summary-auto-refile
(@code{wl-summary-auto-refile}). It decides destination of refile by
the content of the message header information (information in the msgdb).
-By default, @samp{From}, @samp{Subject}, @samp{To} and @samp{Cc} is available.
-If you want to decide destination by other header fields,
+By default, @samp{From:}, @samp{Subject:}, @samp{To:} and @samp{Cc:} is
+available. If you want to decide destination by other header fields,
set the variable @code{elmo-msgdb-extra-fields} like following.
@lisp
+@group
(setq elmo-msgdb-extra-fields
'("x-ml-name"
"reply-to"
"sender"
"mailing-list"
"newsgroups"))
+@end group
@end lisp
@noindent
@code{wl-refile-rule-alist} is a list of a rule:
@example
- (FIELD (REGEXP . TARGET)
- (REGEXP . TARGET)
- @dots{})
+@group
+(@var{field} (@var{regexp} . @var{target})
+ (@var{regexp} . @var{target})
+ @dots{})
+@end group
@end example
-Each rule means `if FIELD value matches REGEXP, then refile to TARGET folder'.
+Each rule means `if @var{field} value matches @var{regexp},
+then refile to @var{target} folder'.
The rule matched first is applied.
-FIELD is a string of field name. You can specify a list of field name
+@var{field} is a string of field name. You can specify a list of field name
string, too. In this case, if one of these fields is matched, then the
rule is fired (i.e. OR condition).
-REGEXP is a regular expression for field value. TARGET is a target
-folder string. You can specify a rule at TARGET part, too. In this
+@var{regexp} is a regular expression for field value. @var{target} is a target
+folder string. You can specify a rule at @var{target} part, too. In this
case, If the field value of the rule and the current rule is matched,
then the current rule is fired (i.e. AND condition).
-In TARGET part, you can refer matched substring of REGEXP.
-To refer substring, specify following in TARGET:
+In @var{target} part, you can refer matched substring of @var{regexp}.
+To refer substring, specify following in @var{target}:
-@example
-\& means substitute original matched text.
-\N (number) means substitute what matched the Nth `\(...\)'.
-@end example
+@table @samp
+@item \&
+means substitute original matched text.
+
+@item \@var{N}
+means substitute what matched the @var{N}th `\(@dots{}\)'.
+(@var{N} is a number.)
+@end table
Following is an example of @code{wl-refile-rule-alist}.
@lisp
+@group
(setq wl-refile-rule-alist
'(("x-ml-name"
("^Wanderlust" . "+wl")
(("To" "Cc")
("\\([a-z]+\\)@@gohome.org" . "+\\1"))
("From"
- ("me@@gohome.org" . ("To" ("you@@gohome.org" .
+ ("me@@gohome.org" . ("To" ("you@@gohome.org" .
"+from-me-to-you"))))))
+@end group
@end lisp
After these settings, refile marks are automatically put on the condition
matched messages by typing @kbd{C-o} (@code{wl-summary-auto-refile}).
Messages which have @code{wl-summary-auto-refile-skip-marks} is skipped
-auto refiling.
+auto refiling.
By default, @samp{N}, @samp{U} and @samp{!} is specified, so the messages
with these persistent marks are not automatically refiled.
It means Wanderlust does not execute auto refile on unread messages by
(setq wl-summary-auto-refile-skip-marks nil)
@end lisp
-@subsection Sticky Summary
+
+@node Sticky Summary, Key Bindings of Summary, Auto Refile, Summary
+@section Sticky Summary
@cindex Summary, Sticky
@cindex Sticky Summary
-The buffer of the `sticky summary' does not killed by typing @kbd{q}.
+The buffer of the `sticky summary' does not killed by typing @kbd{q}.
-Sticky buffer is created by entering the summary by typing @kbd{C-u g} or
-type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
+Sticky buffer is created by entering the summary by typing @kbd{C-u g}
+or type @kbd{M-s} (@code{wl-summary-stick}) on the normal summary.
-The buffer name of the sticky summary becomes like
+The buffer name of the sticky summary becomes like
@samp{Summary:@var{folder-name}}.
You can visit the sticky summary at any time by @kbd{C-x b}
(@code{switch-to-buffer}). To exit sticky summary, type @kbd{C-u
q}. Other operations in the sticky summary are same as normal summary.
-@code{wl-summary-always-sticky-folder-list} specifies the folders that are
-automatically sticked.
+@code{wl-summary-always-sticky-folder-list} specifies the folders that
+are automatically stuck.
+
+@node Key Bindings of Summary, Variables of Summary, Sticky Summary, Summary
@section Key bindings
@cindex Keybind, Summary Mode
@cindex Keybind, Summary Buffer
@kindex . (Summary)
@findex wl-summary-redisplay
Redisplay a message at the current cursor point.
-If this command is called with prefix argument,
+If this command is called with prefix argument,
Redisplay message regardless of the message cache (message is re-loaded
-from source).
+from source).
(@code{wl-summary-redisplay})
@item <
Display the message at the current cursor point if it is not displayed yet.
(@code{wl-summary-next-line-content})
+@item -
+@itemx M-@key{RET}
+@kindex - (Summary)
+@kindex M-@key{RET} (Summary)
+@findex wl-summary-prev-line-content
+Display the previous line of the message at the current cursor point.
+Display the message at the current cursor point if it is not displayed yet.
+(@code{wl-summary-prev-line-content})
+
@item /
@kindex / (Summary)
@findex wl-thread-open-close
@findex wl-thread-close-all
(@code{wl-thread-close-all})
-@item -
-@itemx M-@key{RET}
-@kindex - (Summary)
-@kindex M-@key{RET} (Summary)
-@findex wl-summary-prev-line-content
-Display the previous line of the message at the current cursor point.
-Display the message at the current cursor point if it is not displayed yet.
-(@code{wl-summary-prev-line-content})
-
@item g
@kindex g (Summary)
@findex wl-summary-goto-folder
@kindex n (Summary)
@findex wl-summary-next
Move cursor to the next message.
-If message is marked with a temporal mark in
+If message is marked with a temporal mark in
@code{wl-summary-skip-mark-list}, cursor is not moved to it.
In the offline mode, cursor is not moved to the messages which are not cached
yet.
@kindex p (Summary)
@findex wl-summary-prev
Move cursor to the previous message.
-If message is marked with a temporal mark in
+If message is marked with a temporal mark in
@code{wl-summary-skip-mark-list}, cursor is not moved to it.
In the offline mode, cursor is not moved to the messages which are not cached
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
@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
@kindex w (Summary)
-@findex wl-draft
+@findex wl-summary-write
Prepare a new draft.
-(@code{wl-draft})
+(@code{wl-summary-write})
@item W
@kindex W (Summary)
-@findex wl-draft-write-current-newsgroup
-Prepare a new draft.
-If the current folder is netnews folder, Newsgroups: field is completed.
-(@code{wl-draft-write-current-newsgroup})
+@findex wl-summary-write-current-folder
+Prepare a new draft. If the current folder is NNTP folder,
+@samp{Newsgroups:} field is completed. If the current folder is mailing
+list folder (refile destination), guess @samp{To:} field and completed
+(If @code{wl-subscribed-mailing-list} is valid list)
+(@code{wl-summary-write-current-folder})
@item H
@kindex H (Summary)
@item B
@kindex B (Summary)
@findex wl-summary-burst
-If the message at current cursor point has
+If the message at current cursor point has
encapsulates multiple messages using MIME,
de-capsulate and extract them on the current folder.
(@code{wl-summary-burst})
@item @@
@kindex @@ (Summary)
@findex wl-summary-edit-addresses
-Append/change/delete the message's sender information to the address book
-@file{~/.addresses} interactively.
-If this command is called with prefix argument, arbitrary address can be edited.
+Append/change/delete the message's sender information to the address
+book @file{~/.addresses} interactively. If this command is called with
+prefix argument, arbitrary address can be edited.
(@code{wl-summary-edit-petname})
@item Z
@kindex # (Summary)
@findex wl-summary-print-message
Print out current message's content.
-It uses ps-print module in Emacs 20.x.
+It uses @code{ps-print} module in Emacs 20.x.
If you don't use color printer, you might want to set
-@code{wl-ps-print-buffer-func} to 'ps-print-buffer.
+@code{wl-ps-print-buffer-function} to @code{ps-print-buffer}.
+
+@lisp
+(setq wl-ps-print-buffer-function 'ps-print-buffer)
+@end lisp
+
(@code{wl-summary-print-message})
@item q
@item I
@kindex I (Summary)
Update summary status and
-prefetch all messages which have marks included in the
+prefetch all messages which have marks included in the
@code{wl-summary-incorporate-marks}.
@findex wl-summary-incorporate
(@code{wl-summary-incorporate})
@item M-j
@kindex M-j (Summary)
@findex wl-summary-jump-to-msg-by-message-id
-Jump cursor to the message which have specified Message-Id.
-If @code{elmo-use-database} is non-nil, other folder is also searched.
+Jump cursor to the message which have specified @samp{Message-Id:}. If
+@code{elmo-use-database} is non-nil, other folder is also searched.
(@code{wl-summary-jump-to-msg-by-message-id})
@item ^
@kindex s (Summary)
@findex wl-summary-sync
Synchronize summary view after prompting the update range
-(all, update, rescan, first, last).
+(@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}).
@example
+@group
all ...Discard current summary and update all message.
update ...Update the difference between summary and the folder itself.
rescan ...Rescan the msgdb and display again.
rescan-noscore ...Rescan the msgdb and display again (without scoring).
first, last ...Move to the filter folder(partial filter).
+@end group
@end example
@noindent
@kindex S (Summary)
@findex wl-summary-sort
Sort summary order.
-You can sort by date, from, number and subject.
+You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}.
(@code{wl-summary-sort})
@item T
@findex wl-summary-toggle-thread
Toggle the threading.
Threading status is displayed on the modeline.
-@{S@} means threading is off (Sequence) and
-@{T@} means threading is on (Thread).
+@samp{@{S@}} means threading is off (Sequence) and
+@samp{@{T@}} means threading is on (Thread).
(@code{wl-summary-toggle-thread})
@item l
@item i
@kindex i (Summary)
Prefetch the message at the current cursor point.
+With prefix argument, prefetch the message even if it is cached.
@findex wl-summary-prefetch
(@code{wl-summary-prefetch})
@item t $
@kindex t $ (Summary)
@findex wl-thread-mark-as-important
-Put important mark @samp{$} on the messages which are the
+Put important mark @samp{$} on the messages which are the
descendant of the current thread.
If @samp{$} mark exists, it is deleted.
With prefix argument, it affects on the all messages in the thread tree.
@item t u
@kindex t u (Summary)
@findex wl-thread-unmark
-
Unmark temporal mark on the messages which are the descendant of the
current thread. With prefix argument, it affects on the all messages in
-the thread tree.
+the thread tree.
(@code{wl-thread-unmark})
@item t y
@kindex m i (Summary)
@findex wl-summary-target-mark-prefetch
Prefetch all messages which have target mark @samp{*}.
+With prefix argument, prefetch all targets even if some of them are cached.
(@code{wl-summary-target-mark-prefetch})
@item m R
@item m ?
@kindex m ? (Summary)
@findex wl-summary-target-mark-pick
-Pick messages from the @samp{*} marked messages.
+Pick messages from the @samp{*} marked messages.
That is, @samp{*} marks on the messages are remained
if the specified condition is satisfied.
(@code{wl-summary-target-mark-pick})
moved to one after another. If prefix argument is specified, load draft
folder's message to the draft buffer and jump to it.
(@code{wl-jump-to-draft-buffer})
+
+@item M-w
+@kindex M-w (Summary)
+@findex wl-summary-save-current-message
+Save the message at the current cursor point.
+(@code{wl-summary-save-current-message})
+
+@item C-y
+@kindex C-y (Summary)
+@findex wl-summary-yank-saved-message
+Regard the message at the current cursor point as
+parent, connect the message saved by
+@code{wl-summary-save-current-message}
+to the thread.
+(@code{wl-summary-yank-saved-message})
@end table
-@section Customize variables
+
+@node Variables of Summary, , Key Bindings of Summary, Summary
+@section Customiziable variables
@table @code
@item wl-summary-move-order
@vindex wl-summary-move-order
-The initial setting is 'unread.
-Specify cursor moving policy.
-If you want to precede new messages, set 'new.
-If you want to precede unread messages, set 'unread.
-If nil, proceed to next message.
+The initial setting is @code{unread}. Specify cursor moving policy. If
+you want to precede new messages, set @code{new}. If you want to
+precede unread messages, set @code{unread}. If @code{nil}, proceed to
+next message.
@item wl-auto-select-first
@vindex wl-auto-select-first
-The initial setting is nil.
+The initial setting is @code{nil}.
If non-nil, first message is automatically displayed.
@item wl-auto-select-next
@vindex wl-auto-select-next
-The initial setting is nil.
-If non-nil, jump to next summary automatically.
-If 'unread, jump to next unread folder's summary after confirmation.
-If 'skip-no-unread, unread folders are automatically skipped.
+The initial setting is @code{nil}. This controls behavior when there is
+no unread message in current summary.
+
+@example
+nil: asks whether you want to go back to folder mode
+'unread: asks whether you want to go to next unread folder
+ If the next one comes to be possessing no unread message
+ by treatment of cross-posted messages or Scoring, then
+ asks whether you want to go to next to next folder.
+'skip-no-unread: similar as unread
+ But does not ask before going to next to next folder.
+otherwise: asks whether you want to go to next unread folder
+@end example
+
+It might be useful to set @code{'skip-no-unread} for people who
+want to continue reading by just pressing and pressing space key.
@item wl-thread-insert-opened
@vindex wl-thread-insert-opened
-The initial setting is nil.
+The initial setting is @code{nil}.
If non-nil, thread is inserted as opened.
@item wl-thread-open-reading-thread
@vindex wl-thread-open-reading-thread
-The initial setting is t.
-If non-nil, reading thread is automatically opened though it is closed thread.
+The initial setting is @code{t}. If non-nil, reading thread is
+automatically opened though it is closed thread.
@item wl-summary-exit-next-move
@vindex wl-summary-exit-next-move
-The initial setting is t.
-If non-nil, move to next folder at summary exit.
+The initial setting is @code{t}. If non-nil, move to next folder at
+summary exit.
@item wl-folder-move-cur-folder
@vindex wl-folder-move-cur-folder
-The initial setting is nil.
-If non-nil, cursor position on the folder is moved.
+The initial setting is @code{nil}. If non-nil, cursor position on the
+folder is moved.
@item wl-summary-weekday-name-lang
@vindex wl-summary-weekday-name-lang
-The initial setting is "ja".
-Specify language of the weekday.
-"en" displays English, "fr" displays French, "de" displays Deutsch.
+The initial setting is @samp{ja}. Specify language of the weekday.
+@samp{en} displays English, @samp{fr} displays French, @samp{de}
+displays Deutsch. You should rescan summary view after changing this value.
@item wl-summary-fix-timezone
-@vindex wl-summary-fix-timezone
-The initial setting is "JST".
-Timezone to adjust summary's timezone.
-If nil, adjust to UTC.
+@vindex wl-summary-fix-timezone
+The initial setting is @code{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
-The initial setting is t.
+The initial setting is @code{t}.
If non-nil, sender part displays nickname.
@item wl-break-pages
@vindex wl-break-pages
-The initial setting is t.
-If non-nil, message is splitted as pages by @samp{^L}.
+The initial setting is @code{t}.
+If non-nil, message is split as pages by @samp{^L}.
@item wl-message-window-size
@vindex wl-message-window-size
A cons cell to specify the rate of summary and message window.
car:cdr corresponds summary:message.
-@item wl-summary-recenter
-@vindex wl-summary-recenter
-The initial setting is t.
-If non-nil, cursor point is moved to the center of the summary window.
-
-@item wl-summary-indent-length-limit
-@vindex wl-summary-indent-length-limit
-The initial setting is 46.
-Specify the limit of thread indent level.
-If nil, max indent level is unlimited.
-
@item wl-summary-no-from-message
@vindex wl-summary-no-from-message
-The initial setting is "nobody@@nowhere?".
-A string which is displayed when there's no From: field in the message.
+The initial setting is @samp{nobody@@nowhere?}. A string which is
+displayed when there's no @samp{From:} field in the message.
@item wl-summary-no-subject-message
@vindex wl-summary-no-subject-message
-The initial setting is "(WL:No Subject in original.)".
-A string which is displayed when there's no Subject: field in the message.
+The initial setting is @samp{(WL:No Subject in original.)}. A string
+which is displayed when there's no @samp{Subject:} field in the message.
-@item wl-summary-width
-@vindex wl-summary-width
-The initial setting is 80.
-Width of summary line. If nil, summary line's width is as is.
+@item wl-summary-use-frame
+@vindex wl-summary-use-frame
+The initial setting is @code{nil}.
+If non-nil, use new frame for the summary.
@item wl-use-folder-petname
@vindex wl-use-folder-petname
-The initial setting is '(modeline).
-A list of display policy (symbol) of folder nickname.
-Available symbols are:
+The initial setting is the list shown below:
+
+@lisp
+@group
+(modeline)
+@end group
+@end lisp
+
+@noindent
+A list of display policy (symbol) of folder nickname. Available symbols
+are:
@table @code
@item modeline
@item wl-summary-move-direction-toggle
@vindex wl-summary-move-direction-toggle
-The initial setting is t.
-If non-nil, last executed @kbd{p}, @kbd{P}, @kbd{n}, @kbd{N} toggles
-the direction of cursor move.
-If you want to aware of reading direction, set this to t.
+The initial setting is @code{t}. If non-nil, last executed @kbd{p},
+@kbd{P}, @kbd{n}, @kbd{N} toggles the direction of cursor move. If you
+want to aware of reading direction, set this to @code{t}.
-@item wl-from-width
-@vindex wl-from-width
+@item wl-summary-width
+@vindex wl-summary-width
+The initial setting is 80.
+Width of summary line. If @code{nil}, summary line's width is as is.
+
+@item wl-summary-from-width
+@vindex wl-summary-from-width
The initial setting is 17.
Width of sender part of summary line.
+@item wl-summary-subject-length-limit
+@vindex wl-summary-subject-length-limit
+The initial setting is @code{nil}. Specify the limit for the length of
+subject parts in summary. @code{nil} means unlimited.
+
+@item wl-summary-indent-length-limit
+@vindex wl-summary-indent-length-limit
+The initial setting is 46.
+Specify the limit of thread indent level. @code{nil} means unlimited
+indent level.
+If you set this to @code{nil} you should set @code{wl-summary-width}
+to @code{nil}, too.
+
+@item wl-summary-recenter
+@vindex wl-summary-recenter
+The initial setting is t.
+If non-nil, cursor point is moved to the center of the summary window.
+
@item wl-summary-divide-thread-when-subject-changed
@vindex wl-summary-divide-thread-when-subject-changed
-The initial setting is nil.
-If non-nil, thread is splitted if the subject is changed.
+The initial setting is @code{nil}. If non-nil, thread is split if
+the subject is changed.
@item wl-summary-search-via-nntp
@vindex wl-summary-search-via-nntp
-The initial setting is 'confirm.
-If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed,
-call @code{wl-summary-jump-to-msg-by-message-id-via-nntp} and
-search message from the NNTP server @code{elmo-default-nntp-server}.
-The value of @code{elmo-default-nntp-user}, @code{elmo-default-nntp-port},
-@code{elmo-default-nntp-ssl} are used. If 'confirm, server name can
-be specified. You can specify NNTP folder format like
-@samp{-:username@@servername:119!}.
+The initial setting is @code{confirm}.
+
+If non-nil and @code{wl-summary-jump-to-msg-by-message-id} failed, call
+@code{wl-summary-jump-to-msg-by-message-id-via-nntp} and search message
+from the NNTP server @code{elmo-nntp-default-server}. The value of
+@code{elmo-nntp-default-user}, @code{elmo-nntp-default-port},
+@code{elmo-nntp-default-stream-type} are used.
+
+If @code{confirm}, server name can be specified. You can specify NNTP
+folder format like @samp{-:username@@servername:119!}.
@item wl-summary-keep-cursor-command
@vindex wl-summary-keep-cursor-command
-The initial setting is
-'(wl-summary-goto-folder wl-summary-goto-last-visited-folder).
+The initial setting is the list shown below:
+
+@lisp
+@group
+(wl-summary-goto-folder wl-summary-goto-last-visited-folder)
+@end group
+@end lisp
+
+@noindent
When you entered to summary by these commands and the target summary
-buffer already exists, summary status is not automatically updated and
+buffer already exists, summary status is not automatically updated and
cursor position is saved.
-@item wl-summary-update-confirm-threshold
-@vindex wl-summary-update-confirm-threshold
-The initial setting is 500.
-If updated message number is larger than this value,
-confirm whether drop them or not.
+@item elmo-folder-update-threshold
+@vindex elmo-folder-update-threshold
+The initial setting is 500. If updated message number is larger than
+this value, confirm whether drop them or not (in the case where the value
+of @code{elmo-folder-update-confirm} is non-nil).
+
+@item elmo-folder-update-confirm
+@vindex elmo-folder-update-confirm
+The initial setting is @code{t}. If the value is non-nil, do check with
+@code{elmo-folder-update-threshold}.
@item wl-summary-always-sticky-folder-list
@vindex wl-summary-always-sticky-folder-list
-The initial setting is nil.
-@code{wl-summary-always-sticky-folder-list} specifies the folders that are
-automatically sticked. Each element is regexp of folder name.
+The initial setting is @code{nil}.
+@code{wl-summary-always-sticky-folder-list} specifies the folders that
+are automatically stuck. Each element is regexp of folder name.
@item wl-summary-reserve-mark-list
@vindex wl-summary-reserve-mark-list
-The initial setting is '("o" "O" "D").
-If a message is already marked as temporal marks in this list,
-the message is not marked by any mark command.
+The initial setting is the list shown below:
+
+@lisp
+@group
+("o" "O" "D")
+@end group
+@end lisp
+
+@noindent
+If a message is already marked as temporal marks in this list, the
+message is not marked by any mark command.
@item wl-summary-skip-mark-list
@vindex wl-summary-skip-mark-list
-The initial setting is '("D").
-If a message is already marked as temporal marks in this list,
-the message is skipped at cursor move.
+The initial setting is the list shown below:
-@item wl-fetch-confirm-threshold
-@vindex wl-fetch-confirm-threshold
-The initial setting is 30000 (bytes).
-If displaying message has larger size than this value,
-Wanderlust confirms whether fetch the message or not.
-If nil, the message is fetched without confirmation.
+@lisp
+@group
+("D")
+@end group
+@end lisp
+
+@noindent
+If a message is already marked as temporal marks in this list, the
+message is skipped at cursor move.
+
+@item elmo-message-fetch-threshold
+@vindex elmo-message-fetch-threshold
+The initial setting is 30000 (bytes). If displaying message has larger
+size than this value, Wanderlust confirms whether fetch the message or
+not (in the case where the value of @code{elmo-message-fetch-confirm}
+is non-nil).
+
+@item elmo-message-fetch-confirm
+@vindex elmo-message-fetch-confirm
+The initial setting is @code{t}. If the value is non-nil, do check with
+@code{elmo-message-fetch-threshold}.
@item wl-prefetch-threshold
@vindex wl-prefetch-threshold
-The initial setting is 30000 (bytes).
-If prefetching message has larger size than this value and
-@code{wl-prefetch-confirm} is non-nil,
-Wanderlust confirms whether prefetch the message or not.
-If @code{wl-prefetch-threshold} is nil, the message is prefetched
+The initial setting is 30000 (bytes). If prefetching message has larger
+size than this value and @code{wl-prefetch-confirm} is non-nil,
+Wanderlust confirms whether prefetch the message or not. If
+@code{wl-prefetch-threshold} is @code{nil}, the message is prefetched
without confirmation.
@item wl-prefetch-confirm
@vindex wl-prefetch-confirm
-The initial setting is t. If non-nil,
-Wanderlust confirms whether prefetch the message or not if the
-message has larger size than @code{wl-prefetch-threshold}.
-
-@item wl-cache-fetch-threshold
-@vindex wl-cache-fetch-threshold
-The initial setting is 30000 (bytes).
-The messages which have larger size than @code{wl-fetch-confirm-threshold}
-are skipped buffer caching mechanism. If nil, any messages are prefetched by
-buffer caching mechanism.
+The initial setting is @code{t}. If non-nil, Wanderlust confirms whether
+prefetch the message or not if the message has larger size than
+@code{wl-prefetch-threshold}.
@item elmo-imap4-use-cache
@vindex elmo-imap4-use-cache
-The initial setting is t.
-If non-nil, messages read via IMAP4 are cached.
+The initial setting is @code{t}. If non-nil, messages read via IMAP4
+are cached.
@item elmo-nntp-use-cache
@vindex elmo-nntp-use-cache
-The initial setting is t.
-If non-nil, messages read via NNTP are cached.
+The initial setting is @code{t}. If non-nil, messages read via NNTP are
+cached.
@item elmo-pop3-use-cache
@vindex elmo-pop3-use-cache
-The initial setting is t.
-If non-nil, messages read via POP3 are cached.
+The initial setting is @code{t}. If non-nil, messages read via POP3 are
+cached.
+
+@item elmo-shimbun-use-cache
+@vindex elmo-shimbun-use-cache
+The initial setting is @code{t}. If non-nil, messages read in Shimbun
+folders 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
-@c
-@c Message
-@c
+
@node Message, Draft, Summary, Top
@chapter Message Buffer
-Message Buffers utilize MIME-View mode of SEMI/tm.
-For operational procedures and key bindings, refer to respective
-documents.
-@xref{MIME-View, , ,mime-ui-ja, a MIME user interface for GNU Emacs}.
+Message Buffers utilize MIME-View mode of SEMI. For operational
+procedures and key bindings, refer to respective documents.
+@xref{MIME-View, , ,mime-ui-en, a MIME user interface for GNU Emacs}.
+You can also see help by @kbd{?} in message buffer.
@kbd{p} at the top of a message or @kbd{n} at the bottom of a message
-brings you back to Summary mode.
-@kbd{l} toggles display of Summary mode buffer.
+brings you back to Summary mode. @kbd{l} toggles display of Summary
+mode buffer.
@section Key Bindings
@item Button-2
@findex wl-message-refer-article-or-url
@kindex Button-2 (Message)
-Assumes Message-ID at the mouse pointer, and shows the corresponding
-message if found.
+Assumes @samp{Message-ID:} at the mouse pointer, and shows the
+corresponding message if found.
(@code{wl-message-refer-article-or-url})
@item Button-4 (upward movement of a wheel)
Initial setting is @code{'(1 . 4)}. It is a cons cell and the ratio of
its car and cdr value corresponds to the ratio of Summary and Message
windows.
+
+@item wl-message-ignored-field-list
+@vindex wl-message-ignored-field-list
+(SEMI only) Initial setting is @code{nil}.
+All fields that match this list will be hidden in message buffer.
+Each elements are regexp of field-name.
+If @code{nil}, the value of @code{mime-view-ignored-field-list} is used.
+
+@item wl-message-visible-field-list
+@vindex wl-message-visible-field-list
+(SEMI only) Initial setting is @code{nil}.
+All fields that match this list will be display in message buffer.
+Each elements are regexp of field-name. This value precedes
+@code{wl-message-ignored-field-list}.
+If @code{nil}, the value of @code{mime-view-visible-field-list} is used.
+
+@item wl-message-sort-field-list
+@vindex wl-message-sort-field-list
+(SEMI only) Initial setting is
+'("Return-Path" "Received" "^To" "^Cc" "Newsgroups" "Subject" "^From").
+Header fields in message buffer are ordered by this value.
+Each elements are regexp of field-name.
+
+@item wl-message-truncate-lines
+@vindex wl-message-truncate-lines
+The initial value is the value of @code{default-truncate-lines}.
+If it is non-nil, truncate long lines in message buffer.
@end table
-@c
-@c Draft
-@c
@node Draft, Disconnected Operations, Message, Top
@chapter Draft Buffer
@subsection Address Completion
-Initially, the cursor is at the To: field. Fill in recipients
+Initially, the cursor is at the @samp{To:} field. Fill in recipients
addresses. @kbd{@key{TAB}} completes them.
-If you want to submit a news article, add Newsgroups: field by
+If you want to submit a news article, add @samp{Newsgroups:} field by
yourself. Field names can be completed by @kbd{@key{TAB}}.
If you save the draft buffer you are editing, it is appended to the
folder specified by @code{wl-draft-folder}.
-Using FCC: field, you can specify the folder to which a copy of the
-message is saved when it is sent.
+Using @samp{FCC:} field, you can specify the folder to which a copy of
+the message is saved when it is sent.
@subsection Editing Messages
-Multi-part editing utilize MIME edit mode of SEMI/tm. For procedures of
-editing, refer to respective documents.
-@xref{Mail Methods, , ,mime-ui-ja, a MIME user interface for GNU Emacs}.
+Multi-part editing utilize MIME edit mode of SEMI. For procedures of
+editing, refer to respective documents. @xref{MIME-Edit, , ,mime-ui-en,
+a MIME user interface for GNU Emacs}.
+You can also see help by @kbd{C-c C-x ?} in draft buffer.
@subsection Dynamic Modification of Messages
@vindex wl-draft-config-alist
-
@c @cindex Change Message
@c @cindex Message, Change Dynamic
message will automatically modified depending on information of header
and others.
-The initial setting of @code{wl-draft-config-alist} is nil.
+The initial setting of @code{wl-draft-config-alist} is @code{nil}.
In the example below, the header is modified when
-@code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
-You can set @code{wl-interactive-send} to non-nil so as to confirm
-changes before sending the message.
+@code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked. You
+can set @code{wl-interactive-send} to non-nil so as to confirm changes
+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)}
(top . "Hello.\n") ;; @r{inserted at the top of the body}
(bottom . "\nBye.\n") ;; @r{inserted at the bottom of the body}
))
+@end group
@end lisp
The format of @code{wl-draft-config-alist} is:
@example
-'(("regexp of the header" or elisp expression
- ("Field" . value(elisp expression))
- (variable . value(elisp expression))
- (sub-function . value(elisp expression))
- function
+@group
+'(("@var{regexp of the header}" or @var{elisp expression}
+ ("@var{Field}" . value(@var{elisp expression}))
+ (@var{variable} . value(@var{elisp expression}))
+ (@var{sub-function} . value(@var{elisp expression}))
+ @var{function}
@dots{})
- ("regexp of the header" or elisp expression
- ("Field" . value(elisp expression))
+ ("@var{regexp of the header}" or @var{elisp expression}
+ ("@var{Field}" . value(@var{elisp expression}))
@dots{}))
+@end group
@end example
Per default, there are 10 following sub-functions.
@example
'header: Inserts the specified string at the bottom of the header.
+'header-top: Inserts the specified string at the top of the header.
'header-file: Inserts the specified file at the bottom of the header.
-'x-face: Inserts "X-Face" field with the content of the specified file.
+'x-face: Inserts @samp{X-Face:} field with the content of the specified file.
'top: Inserts the specified string at the top of the body.
'top-file: Inserts the specified file at the top of the body.
'body: Replaces the body with the specified string.
- Specifying nil deletes the entire body string.
+ Specifying @code{nil} deletes the entire body string.
'body-file: Replaces the body with the content of the specified file.
'bottom: Inserts the specified string at the bottom of the body.
'bottom-file: Inserts the specified file at the top of the body.
+'part-top: Inserts the specified string at the top of the current part.
+'part-bottom: Inserts the specified string at the bottom of the current part.
'template: Applies the specified template.
(refer to the next subsection)
@end example
change them or add your own functions. If you read the code, you can
easily find how to write the functions.
-At the first of each item, "a regular expression of the header" or an
-elisp expression should be specified. In the case of an elisp
+At the first of each item, @var{a regular expression of the header} or
+an @var{elisp expression} should be specified. In the case of an elisp
expression, the item is applied when the expression is evaluated
non-nil.
Per default, when multiple items match or are evaluated non-nil, all
such items are applied, but if you set a variable
-@code{wl-draft-config-matchone} to t, only the first matching one is
-applied.
+@code{wl-draft-config-matchone} to @code{t}, only the first matching one
+is applied.
At the second of the item, a cons or a list of functions should be
specified. The car part of the cons should be a header field, a
-variable, or a sub-function. When a header field is specified, the field
-will be modified. If a variable is specified, the value of the variable
-will be modified temporarily.
+variable, or a sub-function. When a header field is specified, the
+field will be modified. If a variable is specified, the value of the
+variable will be modified temporarily.
In the cdr part of a cons, not only a variable but also an elisp
expression can be specified as is. If the car part is a header field
-and the cdr part is nil, the field will be deleted.
+and the cdr part is @code{nil}, the field will be deleted.
See the next example as well:
@lisp
+@group
(setq wl-draft-config-alist
'((reply ;; @r{(1)}
"X-ML-Name: \\(Wanderlust\\|emacs-mime-ja\\|apel-ja\\)"
(body . " Hello.\n")
(template . "default")
)))
+@end group
@end lisp
As in the (1) above, if a header regexp is prepended with @code{reply},
Note that @code{wl-draft-config-alist} is applied only once when
@code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked.
-Therefore, if you want to apply @code{wl-draft-config-alist} again after
+Therefore, if you want to apply @code{wl-draft-config-alist} again after
aborting transmission, execute @kbd{C-c C-e}
-(@code{wl-draft-config-exec}).
+(@code{wl-draft-config-exec}) explicitly.
+
+If you don't want to apply @code{wl-draft-config-alist} when
+@code{wl-draft-send-and-exit} or @code{wl-draft-send} is invoked,
+do the following:
-If you want to apply @code{wl-draft-config-alist} when a draft buffer is
+@lisp
+(remove-hook 'wl-draft-send-hook 'wl-draft-config-exec)
+@end lisp
+
+If you want to apply @code{wl-draft-config-alist} when a draft buffer is
prepared, do the following:
@lisp
(add-hook 'wl-mail-setup-hook 'wl-draft-config-exec)
@end lisp
+If you want to apply @code{wl-draft-config-alist} when you re-edit a mail
+from summary mode by typing @kbd{E}(@code{wl-summary-reedit}), do the
+following:
+
+@lisp
+(add-hook 'wl-draft-reedit-hook 'wl-draft-config-exec)
+@end lisp
+
@subsection Inserting Templates
@cindex Template
@cindex Apply Template
-Set a variable @code{wl-template-alist}, and type
-@kbd{C-c C-j} or @kbd{M-x wl-template-select}
-in the draft buffer.
+Set a variable @code{wl-template-alist}, and type @kbd{C-c C-j} or
+@kbd{M-x wl-template-select} in the draft buffer.
The format of @code{wl-template-alist} is almost the same as
@code{wl-draft-config-alist}.
@lisp
+@group
(setq wl-template-alist
'(("default"
("From" . wl-from)
(body . "Hello.\n"))
("report"
(template . "default") ;; @r{(a)}
- ("To" . "jousi@@kaisha.jp")
+ ("To" . "boss@@example.com")
("Subject" . "Report")
(body-file . "~/work/report.txt")
)
))
+@end group
@end lisp
As you can see, the only difference is item (template) names such as
-"default" and "report", instead of a regexp of header.
+@samp{default} and @samp{report}, instead of a regexp of header.
Because definition of each item is the same as
@code{wl-draft-config-alist}, you can call another template, like (a).
selection, but the result differs depending on variable
@code{wl-template-visible-select}.
-If @code{wl-template-visible-select} is t (default), a buffer window is
-shown below the draft buffer. You can select a template by @kbd{n} and
-@kbd{p} seeing the buffer window.
+If @code{wl-template-visible-select} is @code{t} (default), a buffer
+window is shown below the draft buffer. You can select a template by
+@kbd{n} and @kbd{p} seeing the buffer window.
-Press the RETURN key and the template is actually applied to the draft
-buffer. If you press @kbd{q}, nothing is applied. In addition, you can
+Press the @key{RET} key and the template is actually applied to the draft
+buffer. If you press @kbd{q}, nothing is applied. In addition, you can
adjust the window size by @code{wl-template-buffer-lines}.
-If @code{wl-template-visible-select} is nil, you should type the name of
-the template in the mini buffer.
+If @code{wl-template-visible-select} is @code{nil}, you should type the
+name of the template in the mini buffer.
As shown in the example in @code{wl-draft-config-alist}, you can select
-"default" template by writing:
+@samp{default} template by writing:
-@example
+@lisp
(template . "default")
-@end example
+@end lisp
-@noindent
@subsection Sending mail by POP-before-SMTP
@cindex POP-before-SMTP
You can send mail by POP-before-SMTP with this single line:
@lisp
-(setq wl-draft-send-mail-func 'wl-draft-send-mail-with-pop-before-smtp)
+(setq wl-draft-send-mail-function 'wl-draft-send-mail-with-pop-before-smtp)
@end lisp
@noindent
@table @code
@item wl-pop-before-smtp-user
The POP user name for POP-before-SMTP authentication.
-If unset, @code{elmo-default-pop3-user} is used.
+If unset, @code{elmo-pop3-default-user} is used.
@item wl-pop-before-smtp-server
The POP server name for POP-before-SMTP authentication.
-If unset, @code{elmo-default-pop3-server} is used.
+If unset, @code{elmo-pop3-default-server} is used.
@item wl-pop-before-smtp-authenticate-type
The POP authentication method for POP-before-SMTP authentication.
-If unset, @code{elmo-default-pop3-authenticate-type} is used.
+If unset, @code{elmo-pop3-default-authenticate-type} is used.
@item wl-pop-before-smtp-port
The POP port number for POP-before-SMTP authentication.
-If unset, @code{elmo-default-pop3-port} is used.
+If unset, @code{elmo-pop3-default-port} is used.
-@item wl-pop-before-smtp-ssl
-If non-nil, POP connection is established using SSL.
-If 'starttls, STARTTLS (RFC2595) connection will be established.
-If unset, @code{elmo-default-pop3-ssl} is used.
+@item wl-pop-before-smtp-stream-type
+If non-nil, POP connection is established using SSL. If
+@code{starttls}, STARTTLS (RFC2595) connection will be established. If
+unset, @code{elmo-pop3-default-stream-type} is used.
@end table
-If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
-unset, settings for POP folders (@code{elmo-default-pop3-*}) are
+If variables for POP-before-SMTP (@code{wl-pop-before-smtp-*}) are
+unset, settings for POP folders (@code{elmo-pop3-default-*}) are
used.
Therefore, if SMTP server and POP server are actually the same, and if
POP folder per default (such as @samp{&}) is available, no settings are
Refer to the following URL about POP-before-SMTP.
@example
+@group
http://spam.ayamura.org/tools/smPbS.html
http://www.iecc.com/pop-before-smtp.html
+@end group
@end example
@section Key Bindings
Kills the current draft.
(@code{wl-draft-kill})
-@c @item C-x k
-@c @kindex C-x k (Draft)
-@c @findex wl-draft-mimic-kill-buffer
-@c Kills the current draft.
-@c (@code{wl-draft-mimic-kill-buffer})
+@item C-x k
+@kindex C-x k (Draft)
+@findex wl-draft-mimic-kill-buffer
+Kills the current draft.
+(@code{wl-draft-mimic-kill-buffer})
@item C-c C-z
@kindex C-c C-z (Draft)
Encodes or decodes the specified region in Caesar cipher.
(@code{wl-caesar-region})
+@item C-l
+@kindex C-l (Draft)
+@findex wl-draft-highlight-and-recenter
+Recenter and rehighlight current draft.
+(@code{wl-draft-highlight-and-recenter})
+
@item M-t
@kindex M-t (Draft)
@findex wl-toggle-plugged
@item C-c C-a
@kindex C-c C-a (Draft)
-@findex wl-draft-insert-x-face-field
-Inserts the content of a file @file{~/.xface} (the value of the variable
-@code{wl-x-face-file}) as an X-Face field in the draft buffer.
-
-There should be encoded X-Face strings as a content of a file @file{~/.xface}.
-(@code{wl-draft-insert-x-face-field})
+@findex wl-addrmgr
+Enter Address Manager.
+@xref{Address Manager}.
+(@code{wl-addrmgr})
@end table
@section Customizable Variables
@table @code
@item wl-subscribed-mailing-list
@vindex wl-subscribed-mailing-list
-The initial setting is nil.
-Mailing lists to which you subscribe.
-If any of these are contained in To or Cc field of a reply draft,
-removes your own address from Mail-Followup-To and Cc.
-And if any of these are contained in To or Cc field of a message to be
+The initial setting is @code{nil}. Mailing lists to which you
+subscribe. If any of these are contained in @samp{To:} or @samp{Cc:}
+field of a reply draft, removes your own address from
+@samp{Mail-Followup-To:} and @samp{Cc:}. And if any of these are
+contained in @samp{To:} or @samp{Cc:} field of a message to be
automatically re-filed, the destination folder will be leaned in
connection with the address.
+
+Example:
+
+@lisp
+@group
+(setq wl-subscribed-mailing-list
+ '("wl@@lists.airs.net"
+ "apel-ja@@m17n.org"
+ "emacs-mime-ja@@m17n.org"))
+@end group
+@end lisp
+
@item wl-insert-mail-followup-to
@vindex wl-insert-mail-followup-to
-The initial setting is nil.
-If non-nil, Mail-Followup-To field is automatically inserted in the
-draft buffer.
+The initial setting is @code{nil}. If non-nil, @samp{Mail-Followup-To:}
+field is automatically inserted in the draft buffer.
@item wl-insert-mail-reply-to
@vindex wl-insert-mail-reply-to
-The initial setting is nil.
-If non-nil, Mail-Reply-To field is automatically inserted in the
-draft buffer.
+The initial setting is @code{nil}. If non-nil, @samp{Mail-Reply-To:}
+field is automatically inserted in the draft buffer.
@item wl-auto-insert-x-face
@vindex wl-auto-insert-x-face
-The initial setting is t.
-If non-nil and there is an encoded X-Face string in a file
-@file{~/.xface} (the value of the variable @code{wl-x-face-file}),
-inserts it as an X-Face field in the draft buffer.
-If nil, it is not automatically inserted. Press @kbd{C-c C-a} to insert.
+The initial setting is @code{t}. If non-nil and there is an encoded
+X-Face string in a file @file{~/.xface} (the value of the variable
+@code{wl-x-face-file}), inserts it as an @samp{X-Face:} field in the
+draft buffer. If @code{nil}, it is not automatically inserted.
@item wl-insert-message-id
@vindex wl-insert-message-id
-The initial setting is t.
-If non-nil, Message-ID field is automatically inserted on the
-transmission.
+The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
+is automatically inserted on the transmission.
@item wl-local-domain
@vindex wl-local-domain
-The initial setting is nil.
-If nil, the return value of the function @code{system-name} will be
-used as the domain part of Message-ID.
+The initial setting is @code{nil}. If @code{nil}, the return value of
+the function @code{system-name} will be used as the domain part of
+@samp{Message-ID:}.
If @code{system-name} does not return FQDN (i.e. the full name of the
-host, like @samp{smtp.gohome.org}), you @strong{must} set this variable to the
-string of the local domain name without hostname (like @samp{gohome.org}).
-That is, a concatenation of @code{system-name} "." @code{wl-local-domain}
-is used as domain part of the Message-ID.
+host, like @samp{smtp.gohome.org}), you @strong{must} set this variable
+to the string of the local domain name without hostname (like
+@samp{gohome.org}). That is, a concatenation of @code{system-name}
+@samp{.} @code{wl-local-domain} is used as domain part of the
+@samp{Message-ID:}.
If your terminal does not have global IP, set the value of
-@code{wl-message-id-domain}.
-(You might be beaten up on the Net News if you use invalid Message-ID.)
+@code{wl-message-id-domain}. (You might be beaten up on the Net News if
+you use invalid @samp{Message-ID:}.)
-Moreover,
-concatenation of @code{system-name} "." @code{wl-local-domain}
-will be used as an argument to the HELO command in SMTP.
+Moreover, concatenation of @code{system-name} @samp{.}
+@code{wl-local-domain} will be used as an argument to the HELO command
+in SMTP.
@item wl-message-id-domain
@vindex wl-message-id-domain
-The initial setting is nil.
-If non-nil, this value is used as a domain part of the Message-ID.
-If your terminal does not have global IP, set unique string to this value
-(e.x. your e-mail address).
+The initial setting is @code{nil}. If non-nil, this value is used as a
+domain part of the @samp{Message-ID:}. If your terminal does not have
+global IP address, set unique string to this value (e.x. your e-mail
+address).
@item wl-message-id-domain
@vindex wl-message-id-domain
-The initial setting is nil.
-If nil, the return value of the function @code{system-name} will be
-used as the domain part of Message-ID.
-If @code{system-name} does not return FQDN (i.e. the full name of the
-host, like smtp.gohome.org), you @strong{must} set this variable to the
-string of the full name of the host. Otherwise, you might be beaten up
-on the Net News.
+The initial setting is @code{nil}. If @code{nil}, the return value of
+the function @code{system-name} will be used as the domain part of
+@samp{Message-ID:}. If @code{system-name} does not return FQDN
+(i.e. the full name of the host, like @samp{smtp.gohome.org}), you
+@strong{must} set this variable to the string of the full name of the
+host. Otherwise, you might be beaten up on the Net News.
@item wl-draft-config-alist
@vindex wl-draft-config-alist
-The initial setting is nil.
-Modifies the draft message just before the transmission.
-The content of @code{wl-draft-config-alist} will be automatically
-applied only once on the transmission. If you want to apply it
-manually, use @kbd{C-c C-e}. This command can be used many times.
+The initial setting is @code{nil}. Modifies the draft message just
+before the transmission. The content of @code{wl-draft-config-alist}
+will be automatically applied only once on the transmission. If you
+want to apply it manually, use @kbd{C-c C-e}. This command can be used
+many times.
@item wl-template-alist
@vindex wl-template-alist
-The initial setting is nil.
+The initial setting is @code{nil}.
This variable specifies the template to be applied in the draft buffer.
@item wl-draft-config-matchone
@vindex wl-draft-config-matchone
-The initial setting is nil.
-If non-nil, only the first matching item is used when
-@code{wl-draft-config-alist} is applied. If nil, all matching items are
-used.
+The initial setting is @code{nil}. If non-nil, only the first matching
+item is used when @code{wl-draft-config-alist} is applied. If
+@code{nil}, all matching items are used.
@item wl-template-visible-select
@vindex wl-template-visible-select
-The initial setting is t.
+The initial setting is @code{t}.
If non-nil, you can preview the result of the template selection in
another window.
@item wl-template-confirm
@vindex wl-template-confirm
-The initial setting is nil.
+The initial setting is @code{nil}.
If non-nil, asks for confirmation when you press the enter key to select
template while previewing.
@item wl-template-buffer-lines
@vindex wl-template-buffer-lines
The initial setting is 7.
-If @code{wl-template-visible-select} is non-nil, this variable specifies
+If @code{wl-template-visible-select} is non-nil, this variable specifies
the size of the preview window.
@item wl-draft-reply-buffer-style
@vindex wl-draft-reply-buffer-style
-The initial setting is 'split.
-'split or 'full can be specified.
-In the case of 'full, the whole frame will be used for a reply draft
-buffer when it is prepared.
+The initial setting is @code{split}. @code{split} or @code{full} can be
+specified. In the case of @code{full}, the whole frame will be used for
+a reply draft buffer when it is prepared.
+
+@item wl-draft-use-frame
+@vindex wl-draft-use-frame
+The initial setting is @code{nil}.
+If non-nil, use new frame for the draft.
+
+@item wl-draft-truncate-lines
+@vindex wl-draft-truncate-lines
+The initial value is the value of @code{default-truncate-lines}.
+If it is non-nil, truncate long lines in draft buffer.
@item wl-from
@vindex wl-from
-The initial setting is the value of the variable @code{user-mail-address}.
-The value of this variable is inserted as a From field of the draft when
-it is prepared.
+The initial setting is the value of the variable
+@code{user-mail-address}. The value of this variable is inserted as a
+@samp{From:} field of the draft when it is prepared.
@item wl-envelope-from
@vindex wl-envelope-from
-The initial setting is nil.
+The initial setting is @code{nil}.
The value of this variable is used for envelope from (MAIL FROM).
-If nil, the address part of @code{wl-from} is used.
+If @code{nil}, the address part of @code{wl-from} is used.
@item wl-user-mail-address-list
@vindex wl-user-mail-address-list
-The initial setting is nil.
+The initial setting is @code{nil}.
This is the User's address list. If you have multiple addresses,
set this variable.
@item wl-fcc
@vindex wl-fcc
-The initial setting is nil.
-If non-nil, the value of this variable is inserted as a FCC of the draft
-when it is prepared.
+The initial setting is @code{nil}.
+If non-nil, the value of this variable is inserted as a @samp{Fcc:} of
+the draft when it is prepared. If function is specified, its return
+value is used.
@item wl-bcc
@vindex wl-bcc
-The initial setting is nil.
-If non-nil, the value of this variable is inserted as a Bcc of the draft
-when it is prepared.
+The initial setting is @code{nil}.
+If non-nil, the value of this variable is inserted as a @samp{Bcc:} of
+the draft when it is prepared.
@item wl-reply-subject-prefix
@vindex wl-reply-subject-prefix
-The initial setting is "Re: ".
-In the Subject of the reply draft, this string is prepended to the
-Subject of being replied.
+The initial setting is @samp{Re: }.
+In the @samp{Subject:} of the reply draft, this string is prepended to
+the @samp{Subject:} of being replied.
+
+@item wl-draft-reply-use-address-with-full-name
+@vindex wl-draft-reply-use-address-with-full-name
+The initial setting is @code{t}.
+If non-nil, insert her full name with address when prepare a draft for
+reply a message. If it is @code{nil}, insert her address only.
@item wl-draft-enable-queuing
@vindex wl-draft-enable-queuing
-The initial setting is t.
+The initial setting is @code{t}.
This flag controls off-line transmission. If non-nil, the draft is
sent off-line.
+@item wl-draft-use-cache
+@vindex wl-draft-use-cache
+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-fcc-force-as-read
+@vindex wl-fcc-force-as-read
+The initial setting is @code{nil}. If the value is non-nil,
+Mark as read the message saved by @samp{Fcc:} (only for IMAP folders).
+
@item wl-auto-flush-queue
@vindex wl-auto-flush-queue
The initial setting is t.
(with confirmation by @code{y-or-n-p}). If you want to transmit it
manually, press @kbd{F} in the folder mode.
+@item wl-ignored-forwarded-headers
+@vindex wl-ignored-forwarded-headers
+Initial setting is @samp{\\(received\\|return-path\\|x-uidl\\)}.
+All headers that match this regexp will be deleted when forwarding a message.
+
+@item wl-ignored-resent-headers
+Initial setting is @samp{\\(return-receipt\\|[bdf]cc\\)}.
+All headers that match this regexp will be deleted when resending a message.
+
@item wl-draft-always-delete-myself
@vindex wl-draft-always-delete-myself
-If non-nil, always removes your own address from To and CC when you are
-replying to the mail addressed to you.
+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 nil.
+The initial setting is @code{nil}.
This is the SMTP server name for mail transmission.
@item wl-smtp-posting-user
@vindex wl-smtp-posting-user
-The initial setting is nil.
-This is the user name for SMTP AUTH authentication.
-If nil, @code{smtp-authenticate-user} is used.
+The initial setting is @code{nil}.
+This is the user name for SMTP AUTH authentication. If @code{nil},
+@code{smtp-authenticate-user} is used.
@item wl-smtp-authenticate-type
@vindex wl-smtp-authenticate-type
-The initial setting is nil.
-This is the authentication method for SMTP AUTH authentication.
-If nil, @code{smtp-authenticate-type} is used.
-If it is still nil, authentication will not be carried out.
+The initial setting is @code{nil}.
+This is the authentication method for SMTP AUTH authentication. If
+@code{nil}, @code{smtp-authenticate-type} is used. If
+@code{smtp-authenticate-type} is still @code{nil}, authentication will
+not be carried out.
@item wl-smtp-connection-type
@vindex wl-smtp-connection-type
-The initial setting is nil.
+The initial setting is @code{nil}.
This variable specifies how to establish SMTP connections.
-If nil, @code{smtp-connection-type} is used.
-If it is 'starttls, STARTTLS (RFC2595) is used.
+If @code{nil}, @code{smtp-connection-type} is used.
+If it is @code{starttls}, STARTTLS (RFC2595) is used.
@item wl-nntp-posting-server
@vindex wl-nntp-posting-server
-The initial setting is nil.
+The initial setting is @code{nil}.
This is the NNTP server name used for news submission.
-If nil, @code{elmo-default-nntp-server} is used.
+If @code{nil}, @code{elmo-nntp-default-server} is used.
@item wl-nntp-posting-user
@vindex wl-nntp-posting-user
-The initial setting is nil.
+The initial setting is @code{nil}.
This is the user name for AUTHINFO authentication on news submission.
-If nil, @code{elmo-default-nntp-user} is used.
-If it is still nil, AUTHINFO authentication will not be carried out.
+If @code{nil}, @code{elmo-nntp-default-user} is used.
+If it is still @code{nil}, AUTHINFO authentication will not be carried out.
@item wl-nntp-posting-port
@vindex wl-nntp-posting-port
-The initial setting is nil.
+The initial setting is @code{nil}.
This is the port number of the NNTP server used for news submission.
-If nil, @code{elmo-default-nntp-server} is used.
+If @code{nil}, @code{elmo-nntp-default-server} is used.
-@item wl-nntp-posting-ssl
-@vindex wl-nntp-posting-ssl
-The initial setting is nil.
-If nil, @code{elmo-default-nntp-ssl} is evaluated.
-If non-nil, SSL is used for news submission.
-If 'starttls, STARTTLS (RFC2595) connection will be established.
+@item wl-nntp-posting-stream-type
+@vindex wl-nntp-posting-stream-type
+The initial setting is @code{nil}.
+If @code{nil}, @code{elmo-nntp-default-stream-type} is evaluated. If non-nil,
+SSL is used for news submission. If @code{starttls}, STARTTLS (RFC2595)
+connection will be established.
@item wl-pop-before-smtp-user
@vindex wl-pop-before-smtp-user
-The initial setting is nil.
+The initial setting is @code{nil}.
This is the POP user name for POP-before-SMTP.
-If it is nil, @code{elmo-default-pop3-user} is used.
+If it is @code{nil}, @code{elmo-pop3-default-user} is used.
@item wl-pop-before-smtp-server
@vindex wl-pop-before-smtp-server
-The initial setting is nil.
+The initial setting is @code{nil}.
This is the POP server name for POP-before-SMTP.
-If it is nil, @code{elmo-default-pop3-server} is used.
+If it is @code{nil}, @code{elmo-pop3-default-server} is used.
@item wl-pop-before-smtp-authenticate-type
@vindex wl-pop-before-smtp-authenticate-type
-The initial setting is nil.
+The initial setting is @code{nil}.
This is the authentication method for POP-before-SMTP authentication.
-If it is nil, @code{elmo-default-pop3-authenticate} is used.
+If it is @code{nil}, @code{elmo-pop3-default-authenticate} is used.
@item wl-pop-before-smtp-port
@vindex wl-pop-before-smtp-port
-The initial setting is nil.
-This is the POP port number for POP-before-SMTP.
-If it is nil, @code{elmo-default-pop3-port} is used.
+The initial setting is @code{nil}.
+This is the POP port number for POP-before-SMTP. If it is @code{nil},
+@code{elmo-pop3-default-port} is used.
-@item wl-pop-before-smtp-ssl
-@vindex wl-pop-before-smtp-ssl
-The initial setting is nil.
-This flag controls the use of SSL for POP-before-SMTP.
-If it is nil, @code{elmo-default-pop3-ssl} is used.
+@item wl-pop-before-smtp-stream-type
+@vindex wl-pop-before-smtp-stream-type
+The initial setting is @code{nil}.
+This flag controls the use of SSL for POP-before-SMTP. If it is
+@code{nil}, @code{elmo-pop3-default-stream-type} is used. If @code{starttls},
+STARTTLS (RFC2595) connection will be established.
@item wl-draft-queue-save-variables
@vindex wl-draft-queue-save-variables
@item wl-draft-sendlog
@vindex wl-draft-sendlog
-The initial setting is t.
-If t, transmission log is written in @file{~/.elmo/sendlog}.
-It is written when drafts are sent by smtp or qmail, and when they are
-saved into folders by fcc or queuing (it is written even if the
-transmission fails).
-But transmission by im-wl.el is not written in the sendlog and left to
-the logging function of imput.
+The initial setting is @code{t}.
+If @code{t}, transmission log is written in @file{~/.elmo/sendlog}. It
+is written when:
+
+@itemize @minus
+@item drafts are sent by smtp or qmail
+@item saved into folders by fcc
+@item saved into folders by queuing
+@end itemize
+
+(it is written even if the transmission fails).
+But transmission by @file{im-wl.el} is not written in the @file{sendlog}
+and left to the logging function of @command{imput}.
+
@item wl-draft-sendlog-max-size
@vindex wl-draft-sendlog-max-size
The initial setting is 20000 (in bytes).
-If @code{wl-draft-sendlog} is t, the log is rotated when it grows beyond
-the size specified by this variable.
+If @code{wl-draft-sendlog} is @code{t}, the log is rotated when it grows
+beyond the size specified by this variable.
+
+@item wl-use-ldap
+@vindex wl-use-ldap
+The initial setting is @code{nil}.
+If non-nil, address completion uses LDAP.
+
+@item wl-ldap-server
+@vindex wl-ldap-server
+The initial setting is @samp{localhost}.
+LDAP server name for address completion.
+
+@item wl-ldap-port
+@vindex wl-ldap-port
+The initial setting is @code{nil}.
+If non-nil, the value is used as port number.
+
+@item wl-ldap-base
+@vindex wl-ldap-base
+The initial setting is @samp{c=US}.
+LDAP search starting point (base) for address completion.
+
+@item wl-draft-remove-group-list-contents
+@vindex wl-draft-remove-group-list-contents
+The initial setting is @code{t}.
+If non-nil, remove the group-lists' members in the recipients when
+sending the message (group-list means the description such as
+@samp{Group: foo@@gohome.org, bar@@gohome.org;} in the recipients).
@end table
-
-@c
-@c Disconnected Operations
-@c
@node Disconnected Operations, Expire and Archive, Draft, Top
@chapter Off-line Management
@cindex Disconnected Operations
+Wanderlust has on-line and off-line states.
+
+@menu
+* Off-line State:: Wanderlust has on-line and off-line states
+* Enable Operations:: Enable Disconnected Operations
+* Plugged Mode:: Switching On-line/Off-line per Server/Port
+* Off-line State settings:: Invoking Wanderlust in the Off-line State
+* Variables of Plugged Mode:: Customize Plugged Mode
+@end menu
+
+
+@node Off-line State, Enable Operations, Disconnected Operations, Disconnected Operations
@section Off-line State
-Wanderlust has on-line and off-line states.
-In the off-line state, you cannot access messages via network, unless
-they are cached.
+Wanderlust has on-line and off-line states. In the off-line state, you
+cannot access messages via network, unless they are cached.
-@samp{[ON]} in the mode line indicates the on-line state.
-@samp{[--]} in the mode line indicates the off-line state.
-In folder or summary modes, press @kbd{M-t} to switch between off-
-and on-line.
+@samp{[ON]} in the mode line indicates the on-line state. @samp{[--]}
+in the mode line indicates the off-line state. In folder or summary
+modes, press @kbd{M-t} to switch between off- and on-line.
You can invoke Wanderlust in the off-line state by setting
-@code{wl-plugged} to nil in @file{~/.wl} or anything appropriate.
+@code{wl-plugged} to @code{nil} in @file{~/.wl} or anything appropriate.
In the off-line mode, @kbd{n} and @kbd{p} command in the summary mode
ignores uncached messages.
+
+@node Enable Operations, Plugged Mode, Off-line State, Disconnected Operations
+@section Enable Disconeected Operations
+
Even in the off-line state, provided that relevant messages are cached,
and the variable @code{elmo-enable-disconnected-operation} (described
-later) is non-nil, you can:
+later) is non-nil, you can following operations:
+@xref{Plugged Mode}, @xref{Off-line State settings}.
-@itemize @minus
-@item transmit messages
-@item re-file and copy (IMAP4)
-@item create folders (IMAP4)
-@item mark (IMAP4)
-@item pre-fetch (IMAP4, NNTP)
-@end itemize
+@menu
+* Send Messages off-line:: Transmit Messages
+* Re-file and Copy queue:: Re-file and Copy (IMAP4)
+* Creation of Folders:: Create Folders off-line (IMAP4)
+* Marking:: Mark (IMAP4)
+* Pre-fetching Reservations:: Pre-fetch (IMAP4, NNTP)
+@end menu
-As soon as Wanderlust becomes on-line, such operations invoked
-off-line are reflected in the servers via network.
+As soon as Wanderlust becomes on-line, such operations invoked off-line
+are reflected in the servers via network.
-@section Transmission of Messages
-You can send mail/news messages off-line (if you are using im-wl.el, it
-is irrelevant). Messages sent off-line are accumulated in the queue
-folder, @samp{+queue}. These messages are transmitted at once when
-Wanderlust becomes on-line.
+@node Send Messages off-line, Re-file and Copy queue, Enable Operations, Enable Operations
+@subsection Transmission of Messages
-You can visit @samp{+queue} in the off-line state and confirm content
-of messages in the queue. You can also remove messages. Removed messages
+You can send mail/news messages off-line (if you are using
+@file{im-wl.el}, it is irrelevant). Messages sent off-line are
+accumulated in the queue folder, @samp{+queue}. These messages are
+transmitted at once when Wanderlust becomes on-line.
+
+You can visit @samp{+queue} in the off-line state and confirm content of
+messages in the queue. You can also remove messages. Removed messages
are not transmitted even in the on-line state.
-@section Re-file and Copy (IMAP4)
+
+@node Re-file and Copy queue, Creation of Folders, Send Messages off-line, Enable Operations
+@subsection Re-file and Copy (IMAP4)
Re-file and copy operations to IMAP folders invoked during the off-line
state are accumulated in the queue, and reflected in the server side
off-line state.
For the safety reasons, messages re-filed off-line are removed from
-source folders only if their Message-ID match messages on the servers.
-While the queue is processed, messages that failed to be re-filed or
-copied to the specified folders are appended to the folder
+source folders only if their @samp{Message-ID:} match messages on the
+servers. While the queue is processed, messages that failed to be
+re-filed or copied to the specified folders are appended to the folder
@samp{+lost+found}.
-@section Creation of Folders (IMAP4)
+
+@node Creation of Folders, Marking, Re-file and Copy queue, Enable Operations
+@subsection Creation of Folders (IMAP4)
You can create IMAP folders off-line. The creation of folders are
-reflected in the servers when Wanderlust becomes on-line. At that time,
+reflected in the servers when Wanderlust becomes on-line. At that time,
if folders failed to be created on the servers for any reasons, messages
-re-filed to such folders are appended to the folder "+lost+found".
+re-filed to such folders are appended to the folder @samp{+lost+found}.
+
-@section Marking (IMAP4)
+@node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
+@subsection Marking (IMAP4)
Off-line changes in unread/read and importance mark @samp{$} information
are also reflected in the servers when Wanderlust becomes on-line.
-@section Pre-fetching (IMAP4, NNTP)
+
+@node Pre-fetching Reservations, , Marking, Enable Operations
+@subsection Pre-fetching (IMAP4, NNTP)
You can make reservations for pre-fetching messages in IMAP or NNTP
folders. Reserved messages are marked with @samp{!} but not cached
yet. When Wanderlust becomes on-line, they are pre-fetched from
servers.
-If the variable @code{elmo-enable-disconnected-operation} is nil, these
-off-line operations for IMAP4 and NNTP do not take place, and off-line
-re-file, copy or suchlike simply results in error.
+If the variable @code{elmo-enable-disconnected-operation} is @code{nil},
+these off-line operations for IMAP4 and NNTP do not take place, and
+off-line re-file, copy or suchlike simply results in error.
Because off-line operations use cache files, it is a bad idea to erase
them by hand; it may cause Wanderlust to malfunction.
-If you want to remove caches, be sure to execute
-@kbd{M-x elmo-cache-expire-by-size}.
-@code{elmo-cache-expire-by-size} does not remove caches for messages
-relevant to off-line operations.
+If you want to remove caches, be sure to execute @kbd{M-x
+elmo-cache-expire-by-size}. @code{elmo-cache-expire-by-size} does not
+remove caches for messages relevant to off-line operations.
+
+@node Plugged Mode, Off-line State settings, Enable Operations, Disconnected Operations
@section Switching On-line/Off-line per Server/Port
-@kbd{M-t} described above switches networking states as a whole, but you
+@kbd{M-t} described above switches networking states as a whole, but you
can switch on-line/off-line per server/port.
Pressing @kbd{C-t} in the folder or summary modes brings you in
for each port.
@example
+@group
Queuing:[ON] AutoFlushQueue:[--] DisconnectedOperation:[ON]
[ON](wl-plugged)
[--]hosta
%inbox(delete-msgids:1) @dots{}@r{dop queue}
[ON]nntp(119)
[ON]smtp
+@end group
@end example
The first line indicates status of the following three variables, and
-simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labelled
+simply pressing @kbd{@key{SPC}} or @kbd{@key{RET}} in each labeled
column modifies the values of these variables.
@example
-"Queuing" wl-draft-enable-queuing
-"AutoFlushQueue" wl-auto-flush-queue
-"DisconnectedOperation" elmo-enable-disconnected-operation
+@group
+"Queuing" @code{wl-draft-enable-queuing}
+"AutoFlushQueue" @code{wl-auto-flush-queue}
+"DisconnectedOperation" @code{elmo-enable-disconnected-operation}
+@end group
@end example
-where @samp{[ON]} means its value is t, and @samp{[--]} means nil.
+where @samp{[ON]} means its value is @code{t}, and @samp{[--]} means
+@code{nil}.
The second and after lines indicate on-line/off-line states of servers
and ports, where @samp{[ON]} stands for on-line and @samp{[--]} for
-off-line (in XEmacs, they are shown with icons). Pressing
+off-line (in XEmacs or Emacs 21, they are shown with icons). Pressing
@kbd{@key{SPC}} or @kbd{@key{RET}} in each line switches its state.
-"sending queue" means messages accumulated in the folder @samp{+queue}
-for off-line transmission, and "dop queue" means off-line operations
-when @code{elmo-enable-disconnected-operation} is t.
-@c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
+@dfn{sending queue} means messages accumulated in the folder
+@samp{+queue} for off-line transmission, and @dfn{dop queue} means
+off-line operations when @code{elmo-enable-disconnected-operation} is
+@code{t}.
+@c If the variable @code{elmo-enable-disconnected-operation} is non-nil,
@c off-line operations are enabled.
-They are displayed if there are any of them. In the example above,
-in the sending queue there are two messages (the first and the second
-in the queue folder) for smtp to hosta and one (the third) for nntp to
+They are displayed if there are any of them. In the example above, in
+the sending queue there are two messages (the first and the second in
+the queue folder) for smtp to hosta and one (the third) for nntp to
hosta, and in the dop queue there are one for @samp{%inbox} and two for
@samp{%#mh/wl}.
-If you change (wl-plugged) in the second line, the variable
+If you change @samp{(wl-plugged)} in the second line, the variable
@code{wl-plugged} is changed, so that the mode line indicator and
-plugged states of all ports are affected.
-If you change plugged states of any servers or ports, wl-plugged in the
-second line is affected depending on @code{elmo-plugged-condition}
-settings and the plugged state of each port.
+plugged states of all ports are affected. If you change plugged states
+of any servers or ports, @samp{(wl-plugged)} in the second line is
+affected depending on @code{elmo-plugged-condition} settings and the
+plugged state of each port.
+
+@node Off-line State settings, Variables of Plugged Mode, Plugged Mode, Disconnected Operations
@section Invoking Wanderlust in the Off-line State
-As described before, if you set @code{wl-plugged} to nil in @file{~/.wl}
-or anything appropriate, you can invoke Wanderlust in the off-line
-state. You can specify off-line state on a per server or port basis.
-Refer to @code{wl-reset-plugged-alist} also.
+As described before, if you set @code{wl-plugged} to @code{nil} in
+@file{~/.wl} or anything appropriate, you can invoke Wanderlust in the
+off-line state. You can specify off-line state on a per server or port
+basis. Refer to @code{wl-reset-plugged-alist} also.
Usually, when Wanderlust starts up, the plugged state of each port is
-read from @file{~/.folder} and @code{wl-smtp-posting-server},
+read from @file{~/.folders} and @code{wl-smtp-posting-server},
@code{wl-nntp-posting-server} and so on. If you want to change the
plugged state of these ports or to add other ports, configure
@code{wl-make-plugged-hook} with a function.
@lisp
+@group
(add-hook 'wl-make-plugged-hook
'(lambda ()
(elmo-set-plugged plugged-value(t/nil) server port)
;; @r{if the port is omitted, all ports are affected}
;; @r{(you cannot omit the port if you newly add the server)}
))
+@end group
@end lisp
+
+@node Variables of Plugged Mode, , Off-line State settings, Disconnected Operations
@section Customizable Variables
@table @code
@item wl-plugged
@vindex wl-plugged
-If this variable is set to nil, Wanderlust starts up in off-line mode from
-the beginning.
+If this variable is set to @code{nil}, Wanderlust starts up in off-line
+mode from the beginning.
@item wl-queue-folder
@vindex wl-queue-folder
-The initial setting is "+queue".
+The initial setting is @samp{+queue}.
This is the folder in which messages in the transmission queue are
accumulated.
@item wl-auto-flush-queue
@vindex wl-auto-flush-queue
-The initial setting is t.
+The initial setting is @code{t}.
This flag controls automatic transmission of the queue when Wanderlust
becomes on-line. If non-nil, the queue is automatically transmitted
(with confirmation by @code{y-or-n-p}). If you want to transmit it
@item elmo-enable-disconnected-operation
@vindex elmo-enable-disconnected-operation
-The initial setting is nil. Controls off-line operations regarding IMAP4.
-If non-nil, off-line operations are carried out.
+The initial setting is @code{nil}. Controls off-line operations
+regarding IMAP4. If non-nil, off-line operations are carried out.
@item elmo-lost+found-folder
@vindex elmo-lost+found-folder
-The initial setting is "+lost+found".
+The initial setting is @samp{+lost+found}.
This is the folder to which messages are saved when they fails to be
appended while the off-line re-file/copy queue is processed.
@item elmo-plugged-condition
@vindex elmo-plugged-condition
-The initial setting is 'one.
-The value of @code{wl-plugged} reflects the return value of the function
+The initial setting is @code{one}.
+The value of @code{wl-plugged} reflects the return value of the function
@code{elmo-plugged-p} (without arguments).
This variable @code{elmo-plugged-condition} specifies the condition on
-which the return value of (elmo-plugged-p) should be t depending on the
+which the return value of @code{(elmo-plugged-p)} should be t depending on the
plugged state of each port.
@example
'all : plugged if all ports are plugged.
'independent : reflects wl-plugged (elmo-plugged) regardless of plugged
states of the ports.
-function : reflects the return value of the function
+@var{function} : reflects the return value of the @var{function}
functions available per default
'elmo-plug-on-by-servers
: reflects the plugged state of the servers specified by the
@end example
@example
+@group
Example 1:
(setq elmo-plugged-condition 'all)
Example 2:
Example 3:
(setq elmo-plug-on-exclude-servers '("localhost" "myname"))
(setq elmo-plugged-condition 'elmo-plug-on-by-exclude-servers)
+@end group
@end example
@item wl-reset-plugged-alist
@vindex wl-reset-plugged-alist
-The initial setting is t. If non-nil, plugged states are initialized on
-a per server or port basis when Wanderlust starts up.
+The initial setting is @code{t}. If non-nil, plugged states are
+initialized on a per server or port basis when Wanderlust starts up.
-If nil, plugged states are retained while Emacs is running.
-In other words, they are initialized when Emacs is restarted even if the
-value is nil.
+If @code{nil}, plugged states are retained while Emacs is running. In
+other words, they are initialized when Emacs is restarted even if the
+value is @code{nil}.
@end table
-@c
-@c Expire and Archive
-@c
+
@node Expire and Archive, Scoring, Disconnected Operations, Top
@chapter Automatic Expiration and Archiving of Messages
@cindex Expire and Archive
An example configuration of @code{wl-expire-alist} is shown below.
Everything in this @code{wl-expire-alist} makes a great difference in
-expiration, so be careful.
-I advise you to set @code{wl-expire-use-log} to t, especially in the
-initial stage.
+expiration, so be careful. I advise you to set @code{wl-expire-use-log}
+to @code{t}, especially in the initial stage.
@lisp
+@group
(setq wl-expire-alist
'(("^\\+trash$" (date 14) remove)
;; @r{delete}
;; @r{archive by message number (retaining numbers)}
("^\\+ml/.*" (number 300 310) wl-expire-archive-number2 t)
;; @r{archive by a fixed number (retaining numbers)}
- ("^\\+nikki$" (date 30) wl-expire-archive-date)
+ ("^\\+diary$" (date 30) wl-expire-archive-date)
;; @r{archive by year and month (numbers discarded)}
))
+@end group
@end lisp
Items in the list has the format of:
@example
-("regexp_for_folders" (specification_of_messages_to_be_deleted) destination)
+(@var{regexp-for-folders} @var{specification-of-messages-to-be-deleted} @var{destination})
@end example
@noindent
-The folder is examined if it matches "regexp_for_folders" from the
+The folder is examined if it matches @var{regexp-for-folders} from the
beginning of the list. If you invoke expiration on the folder that does
-not match any of them, nothing will happen.
-And if either the second or the third element of the item is nil,
-expiration will not take place.
+not match any of them, nothing will happen. And if either the second or
+the third element of the item is @code{nil}, expiration will not take
+place.
You can use any one of the following for
-specification_of_message_to_be_deleted:
+@var{specification-of-message-to-be-deleted}:
@table @code
-@item (number n1 [n2])
+@item (number @var{n1} [@var{n2}])
deletes messages depending on the number of messages in the folder.
-n1 is the number of messages which should survive deletion, for example
+@var{n1} is the number of messages which should survive deletion, for example
if its value is 500, the newest 500 messages survive and the rests are
deleted.
-n2 is the number of messages in the folder on which expiration should
-take place, which defaults to n1 + 1. For example if its value is 510,
+@var{n2} is the number of messages in the folder on which expiration should
+take place, which defaults to @var{n1} + 1. For example if its value is 510,
folders with 510 or more messages are expired.
If you configured automatic expiration, frequently used folders may
expire every time it receive messages, and you may be annoyed with the
long delay in reading mail.
-In that case, you can set a wide margin between n2 and n1, so that
+In that case, you can set a wide margin between @var{n2} and @var{n1}, so that
expiration would not take place until a certain number of messages
accumulate.
will expire so as to have 500 messages including such ones.
Otherwise, it will have 500 messages except such ones.
-@item (date d1)
+@item (date @var{d1})
deletes messages depending on the dates.
-Messages dated d1 or more days ago are deleted, for example if its value
-is seven, messages seven days old or more are deleted.
-Note that the date is the one in the Date field of the message, not when
+Messages dated @var{d1} or more days ago are deleted, for example if its
+value is seven, messages seven days old or more are deleted. Note that
+the date is the one in the @samp{Date:} field of the message, not when
the message entered the folder.
-Messages with no or invalid Date field does not expire; you might have
-to delete them by hand.
+Messages with no or invalid @samp{Date:} field does not expire; you
+might have to delete them by hand.
@end table
-You can use any one of the following in the place of destination:
+You can use any one of the following in the place of @var{destination}:
-@table @code
-@item 'remove
+@table @asis
+@item @code{remove}
deletes the messages instantly.
-@item 'trash
+@item @code{hide}
+hide the messages from summary (messages are not deleted).
+
+@item @code{trash}
moves the messages to @code{wl-trash-folder}.
-@item string(folder)
-moves the messages to the specified folder.
+@item @var{string}(folder)
+moves the messages to the folder specified with @var{string}.
It would be useful for specifying an archiving folder, but because this
does not move important messages, it might be better to use the
standard functions described below.
-@item function
-invokes the specified function.
+@item @var{function}
+invokes the specified @var{function}.
-To the function, three arguments are passed: a folder name, a list of
-messages to be deleted, and msgdb information of the summary.
-You can specify function-specific arguments after the name of the
-function.
-Note that the list contains messages with marks in
+To the @var{function}, three arguments are passed: a folder name, a list
+of messages to be deleted, and msgdb information of the summary. You
+can specify function-specific arguments after the name of the
+@var{function}. Note that the list contains messages with marks in
@code{wl-summary-expire-reserve-marks}, be careful in writing your own
function.
@table @code
@item wl-expire-archive-number1
re-files to archiving folders corresponding to the message numbers of
-the messages being deleted.
-For example, a message numbered 102 will be re-filed to
-@file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
+the messages being deleted. For example, a message numbered 102 will be
+re-filed to @file{wl-00100.zip}, 390 to @file{wl-00300.zip}, and so on.
If @code{wl-expire-archive-files} is 200, messages will be re-filed to
@file{wl-00000.zip}, @file{wl-00200.zip}, @file{wl-00400.zip}, @dots{}.
The archiving folders to which messages are re-filed are determined by
-the name of the folder as follows
-(in this case, archiving folders are handled as if
-@code{elmo-archive-treat-file} were non-nil).
+the name of the folder as follows (in this case, archiving folders are
+handled as if @code{elmo-archive-treat-file} were non-nil).
-@table @code
+@table @asis
@item If the folder type is localdir:
+@file{@var{ArchiveDir}/@var{foldername}-xxxxx.zip}
-@code{$ArchiveDir/foldername-xxxxx.zip}
For example, @samp{+ml/wl} corresponds to @samp{$ml/wl;zip}
(@file{~/Mail/ml/wl-00100.zip}).
@item The folder type is other than localdir:
-@code{$ArchiveDir/foldertype/foldername-xxxxx.zip}
+@file{@var{ArchiveDir}/@var{foldertype}/@var{foldername}-xxxxx.zip}
For example, @samp{%#mh/ml/wl} corresponds to
@samp{$imap4/#mh/ml/wl;zip} (@file{~/Mail/imap4/#mh/ml/wl-00100.zip}).
This differs from @samp{wl-expire-archive-number1} in that this re-files
to the folder up to the specified number regardless of message numbers.
-The archiving folders to which messages are re-filed are determined in the
+The archiving folders to which messages are re-filed are determined in the
same way as @code{wl-expire-archive-number1}.
@item wl-expire-archive-date
folders.
For example, a message dated December 1998 is re-filed to
-@code{$folder-199812;zip}.
-The name of the archiving folders except the date part are determined in
-the same way as @code{wl-expire-archive-number1}.
+@code{$folder-199812;zip}. The name of the archiving folders except the
+date part are determined in the same way as
+@code{wl-expire-archive-number1}.
@end table
You can set the first argument to these three standard functions to non-nil
in @code{wl-expire-alist} so as to retain message numbers in the folder.
For example, it can be specified just after the name of the function:
-@example
+@lisp
("^\\+ml/wl$" (number 300 310) wl-expire-archive-number1 t)
-@end example
+@end lisp
If you omit the argument, consecutive numbers from 1 are assigned for
each archiving folder.
@subsection Treatment for Important or Unread Messages
-If you specify any of 'remove, 'trash, a folder name, or a standard
-function, messages with marks in @code{wl-summary-expire-reserve-marks}
-(which are called @dfn{reserved messages} thereafter) are retained.
+If you specify any of @code{remove}, @code{trash}, a folder name, or a
+standard function, messages with marks in
+@code{wl-summary-expire-reserve-marks} (which are called @dfn{reserved
+messages} thereafter) are retained.
Per default, this variable include the important, new, and unread marks,
so that messages with these marks are not removed.
in regexp and other settings before you set up this.
@lisp
-(add-hook 'wl-summary-prepared-pre-hook
- 'wl-summary-expire)
+@group
+(add-hook 'wl-summary-prepared-pre-hook 'wl-summary-expire)
+@end group
@end lisp
In the folder mode, you can invoke expiration per group as well as per
@subsection Confirming
-If you are to use 'remove, try 'trash at first and see messages move to
-@code{wl-trash-folder} as expected, then replace it with 'remove.
-It would be dangerous to use 'remove from the beginning.
+If you are to use @code{remove}, try @code{trash} at first and see
+messages move to @code{wl-trash-folder} as expected, then replace it
+with @code{remove}. It would be dangerous to use @code{remove} from the
+beginning.
If you are to use @code{wl-expire-archive-number1} and the like, try to
-make a folder of the archiver type ('zip or 'lha) and see if you can
-append messages to it.
-Even if settings in @code{wl-expire-alist} and @code{elmo-archive} are
-correct, messages would not be saved anywhere and disappeared in case
-the archiver program fails.
+make a folder of the archiver type (@code{zip} or @code{lha}) and see if
+you can append messages to it. Even if settings in
+@code{wl-expire-alist} and @code{elmo-archive} are correct, messages
+would not be saved anywhere and disappeared in case the archiver program
+fails.
After you make sure you can archive to the folder correctly, you can
invoke expiration and utilize the log.
-If you set @code{wl-expire-use-log} to t, @file{~/.elmo/expired-log}
-should contain the log, for example:
+If you set @code{wl-expire-use-log} to @code{t},
+@file{~/.elmo/expired-log} should contain the log, for example:
@example
+@group
delete +ml/wl (593 594 595 596 597 598 599)
move +ml/wl -> $ml/wl-00600;tgz;wl (600 601 602)
+@end group
@end example
-The first column indicates the operation, i.e. delete, copy, or move.
-The next is the name of the folder that expired. In the case of copy
-and move, the destination folder is recorded after @samp{->}.
-The last is the list of message numbers that are actually deleted or
-moved (in the case of copy and move, the number is the one in the source
-folder, rather than the destination folder).
+The first column indicates the operation, i.e. @samp{delete},
+@samp{copy}, or @samp{move}. The next is the name of the folder that
+expired. In the case of @samp{copy} and @samp{move}, the destination
+folder is recorded after @samp{->}. The last is the list of message
+numbers that are actually deleted or moved (in the case of @samp{copy}
+and @samp{move}, the number is the one in the source folder, rather than
+the destination folder).
@subsection Re-filing Reserved Messages
@file{~/.elmo/expired-alist} so that they are not copied over and over
again. They are not recorded if copied by @code{wl-summary-archive}.
-If you enabled logging, usually "move" is recorded for re-filing, but
-instead "copy" and "delete" are recorded separately if reserved messages
-are involved.
-This is because it actually copies messages including reserved, then
-deletes ones except reserved in that case.
+If you enabled logging, usually @samp{move} is recorded for re-filing,
+but instead @samp{copy} and @samp{delete} are recorded separately if
+reserved messages are involved. This is because it actually copies
+messages including reserved, then deletes ones except reserved in that
+case.
@section Customizable Variables
@table @code
@item wl-expire-alist
@vindex wl-expire-alist
-The initial setting is nil.
+The initial setting is @code{nil}.
This variable specifies folders and methods to expire. For details,
refer to @code{wl-expire-alist} settings above.
The initial setting is the list below.
@lisp
+@group
(list wl-summary-important-mark
wl-summary-new-mark
wl-summary-unread-mark
wl-summary-unread-uncached-mark
wl-summary-unread-cached-mark)
+@end group
@end lisp
Messages with these marks are retained in the folder, even after
following settings as well:
@table @code
-@item 'all
+@item all
All messages with permanent marks are retained,
-i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
+i.e. @code{wl-summary-read-uncached-mark} is included in addition to the
defaults.
-@item 'none
+@item none
All messages are handled as usual ones that are already read, no matter
what marks they have; even important messages are deleted.
@end table
@item wl-expire-number-with-reserve-marks
@vindex wl-expire-number-with-reserve-marks
-The initial setting is nil.
-If non-nil, if expiring messages are specified by "number", messages
-with @code{wl-summary-expire-reserve-marks} are also retained.
+The initial setting is @code{nil}.
+If non-nil, if expiring messages are specified by @code{number},
+messages with @code{wl-summary-expire-reserve-marks} are also retained.
-@item wl-expire-archive-get-folder-func
-@vindex wl-expire-archive-get-folder-func
-The initial setting is 'wl-expire-archive-get-folder.
+@item wl-expire-archive-get-folder-function
+@vindex wl-expire-archive-get-folder-function
+The initial setting is @code{wl-expire-archive-get-folder}.
-This variable specifies a function that returns the name of an archiving
-folder for standard functions in the place of destination.
+This variable specifies a function that returns the name of an archiving
+folder for standard functions in the place of @var{destination}.
You can use the following three variables for simple modification of
folder names; if you want more complex settings, define your own
function in this variable.
@code{wl-expire-archive-get-folder} can be customized by these
variables:
@itemize @bullet
-@item wl-expire-archive-folder-name-fmt
-@item wl-expire-archive-folder-type
-@item wl-expire-archive-folder-prefix
+@item @code{wl-expire-archive-folder-name-fmt}
+@item @code{wl-expire-archive-folder-type}
+@item @code{wl-expire-archive-folder-prefix}
@end itemize
@item wl-expire-archive-folder-name-fmt
@vindex wl-expire-archive-folder-name-fmt
-The initial setting is "%s-%%05d;%s".
-This is a format string for archiving folders used in
+The initial setting is @samp{%s-%%05d;%s}.
+This is a @code{format} string for archiving folders used in
@code{wl-expire-archive-number1} and @code{wl-expire-archive-number2}.
Note that you must specify the message number by @samp{%%d}, because it
is parsed twice by @code{format}.
-If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
+If you modify this, adjust @code{wl-expire-archive-folder-num-regexp} as
well.
@item wl-expire-archive-date-folder-name-fmt
@vindex wl-expire-archive-date-folder-name-fmt
-The initial setting is "%s-%%04d%%02d;%s".
-This is a format string for archiving folders used in
-@code{wl-expire-archive-date}.
-Note that you must specify the message number by @samp{%%d}, because it
-is parsed twice by @code{format}.
-There should be @code{%%d} twice, one for the year and the other for the
+The initial setting is @samp{%s-%%04d%%02d;%s}.
+This is a @code{format} string for archiving folders used in
+@code{wl-expire-archive-date}. Note that you must specify the message
+number by @samp{%%d}, because it is parsed twice by @code{format}.
+There should be @samp{%%d} twice, one for the year and the other for the
month.
If you modify this, adjust
@item wl-expire-archive-folder-type
@vindex wl-expire-archive-folder-type
-The initial setting is 'zip.
+The initial setting is @code{zip}.
This variable specifies an archiver type of the archiving folders.
@item wl-expire-archive-folder-prefix
@vindex wl-expire-archive-folder-prefix
-The initial setting is nil.
+The initial setting is @code{nil}.
This variable specifies the prefix (directory structure) to archiving
folders.
Exercise extreme caution in using this feature, as it has not been
@item nil
There will be no prefix.
-@item 'short
+@item short
For example, @samp{+ml/wl} will be prefixed by @samp{wl}, resulting in
@samp{$ml/wl-00000;zip;wl}.
@item wl-expire-archive-folder-num-regexp
@vindex wl-expire-archive-folder-num-regexp
-The initial setting is "-\\([-0-9]+\\);".
+The initial setting is @samp{-\\([-0-9]+\\);}.
This variable specifies the regular expression to be used for getting
message numbers from multiple archiving folders specified by
@code{elmo-list-folders}.
@item wl-expire-archive-date-folder-num-regexp
@vindex wl-expire-archive-date-folder-num-regexp
-The initial setting is "-\\([-0-9]+\\);".
+The initial setting is @samp{-\\([-0-9]+\\);}.
This is the regular expression to be used for getting message numbers
from multiple archiving folders specified by @code{elmo-list-folders}.
Set it in accordance with @code{wl-expire-archive-date-folder-name-fmt}.
@item wl-expire-delete-oldmsg-confirm
@vindex wl-expire-delete-oldmsg-confirm
-The initial setting is t.
+The initial setting is @code{t}.
If non-nil, messages older than the one with the largest number will be
deleted with confirmation.
-If nil, they are deleted without confirmation.
+If @code{nil}, they are deleted without confirmation.
This feature is valid only if non-nil is specified as a argument to the
standard functions so as to retain numbers.
@item wl-expire-use-log
@vindex wl-expire-use-log
-The initial setting is nil.
+The initial setting is @code{nil}.
If non-nil, expiration logs are recorded in @file{~/.elmo/expired-log}.
They are appended but not truncated or rotated automatically; you might
need to remove it manually.
@item wl-expire-add-seen-list
@vindex wl-expire-add-seen-list
-The initial setting is t.
+The initial setting is @code{t}.
If non-nil, when messages are re-filed by expiration, read/unread
information is passed to the destination folder.
However if you do not read the destination folder from Wanderlust,
@file{seen} under @file{~/.elmo/} grows larger and larger, so you might
-want to set this to nil if you are simply saving to some archiving
-folders. Even if its value is nil, messages in the archiving folders
-are simply treated as unread; it does not affect expiration itself.
+want to set this to @code{nil} if you are simply saving to some
+archiving folders. Even if its value is @code{nil}, messages in the
+archiving folders are simply treated as unread; it does not affect
+expiration itself.
@item wl-expire-folder-update-msgdb
@vindex wl-expire-folder-update-msgdb
-The initial setting is t.
-If t, in the folder mode, expiration is carried out after updating
-summary information.
-If you specified a list of regular expressions of folder names, summary
-information is updated for matching folders only.
+The initial setting is @code{t}.
+If @code{t}, in the folder mode, expiration is carried out after
+updating summary information. If you specified a list of regular
+expressions of folder names, summary information is updated for matching
+folders only.
@end table
folders. If there are the archiving folders already, only new messages
are appended.
-You can use @code{wl-archive-alist} in order to specify how messages are
+You can use @code{wl-archive-alist} in order to specify how messages are
archived according to their folder names, as in @code{wl-expire-alist}.
For example:
@lisp
+@group
(setq wl-archive-alist
'(("^\\+tmp$" wl-archive-date)
("^\\+outbox$" wl-archive-number2)
- (".*" wl-archive-number1)
- ))
+ (".*" wl-archive-number1)))
+@end group
@end lisp
Each item in the list has the following format:
@example
-("folders_regexp" deleting_function)
+(@var{folders-regexp} @var{deleting-function})
@end example
-As you can see, you can only use a function after @samp{folders_regexp}.
+As you can see, you can only use a function after @var{folders-regexp}.
Per default, there are three functions:
@itemize @bullet
-@item wl-archive-number1
-@item wl-archive-number2
-@item wl-archive-date
+@item @code{wl-archive-number1}
+@item @code{wl-archive-number2}
+@item @code{wl-archive-date}
@end itemize
As inferred from their names, they work similarly to "expire" versions,
numbers or by their dates.
These are also useful for backup or confirmation purposes before
expiration.
-If you try to re-file them after they are archived, they are deleted but
+If you try to re-file them after they are archived, they are deleted but
not re-filed.
Per default, the archiving folders to which messages are copied are
-determined automatically by @code{wl-expire-archive-get-folder-func}.
+determined automatically by @code{wl-expire-archive-get-folder-function}.
You can copy to a specific folder by invoking with a prefix argument,
i.e. @kbd{C-u M-x wl-summary-archive}.
relevant:
@itemize @bullet
-@item wl-expire-archive-files
-@item wl-expire-archive-get-folder-func
-@item wl-expire-archive-folder-name-fmt
-@item wl-expire-archive-folder-type
-@item wl-expire-archive-folder-prefix
-@item wl-expire-archive-folder-num-regexp
+@item @code{wl-expire-archive-files}
+@item @code{wl-expire-archive-get-folder-function}
+@item @code{wl-expire-archive-folder-name-fmt}
+@item @code{wl-expire-archive-folder-type}
+@item @code{wl-expire-archive-folder-prefix}
+@item @code{wl-expire-archive-folder-num-regexp}
@end itemize
@subsection Customizable Variables
@table @code
@item wl-archive-alist
@vindex wl-archive-alist
-The initial setting is '((".*" wl-archive-number1)).
+The initial setting is the list shown below:
+
+@lisp
+@group
+((".*" wl-archive-number1))
+@end group
+@end lisp
+@noindent
This variable specifies a function that copies to archiving folders.
To the function, three arguments are passed: a folder name, a list of
messages in the folder, and msgdb information of the summary.
@end table
-@c
-@c Scoring
-@c
-@node Scoring, Customization, Expire and Archive, Top
+@node Scoring, Address Book, Expire and Archive, Top
@chapter Score of the Messages
@cindex Scoring
@c @cindex Kill File
Scoring is the function that associates a score (value) with each
message, and marks as read or deletes from the summary according to it.
-You can put temp or important marks on essential messages, or read marks
+You can put target or important marks on essential messages, or read marks
on the ones you do not want to read, for example spam articles.
This scoring function has a capability and a format similar to the one
that Gnus has, although there are some unsupported features and
Wanderlust specifics.
+@xref{Scoring, , ,gnus, The gnus Newsreader}.
@menu
* Score Commands:: Score Commands
@subsection Score File Specification
-@code{wl-score-folder-alist} specifies score files or variables in which
+@code{wl-score-folder-alist} specifies score files or variables in which
scores are defined, corresponding to folder names.
@lisp
+@group
(setq wl-score-folder-alist
'(("^-.*"
"news.SCORE"
"my.SCORE")
(".*"
"all.SCORE")))
+@end group
@end lisp
If paths to the score files are omitted, the directory specified in the
Then type @kbd{s}, @kbd{s}, and @kbd{p} at a prompt in a mini-buffer.
The string in Subject is presented. Edit it and press @kbd{@key{RET}}.
-This makes -1000 are scored for messages with the same Subject as the
-string you entered. That is, such a score file is created
-automatically.
+This makes @minus{}1000 are scored for messages with the same
+@samp{Subject:} as the string you entered. That is, such a score file
+is created automatically.
Then, try typing @kbd{h} and @kbd{e} in the same summary buffer.
The score file you just made appears.
-This buffer is called "score editing buffer" thereafter.
+This buffer is called @dfn{score editing buffer} thereafter.
When you type @kbd{C-c C-e} in it, you are prompted in the mini-buffer
as you are previously; type @kbd{a}. Then a score entry for "From"
should be inserted.
but for "from" field, they are fixed upon automatically as substring and
permanent respectively.
However, score values can be modified by the prefix argument.
-Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
+Typing @kbd{?} at the mini-buffer shows a help on keys and corresponding
headers and types.
-At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
+At last, type @kbd{C-c C-c} in the score editing buffer. This saves the
score file and terminates the edit mode. Typing @kbd{C-c C-c} after
erasing contents of the buffer deletes the score file being edited.
@code{wl-summary-lower-score}, and @code{wl-score-edit-insert-entry},
scores for the entry is summed up.
-For example, if you create @samp{from} entry with the score of -1000 by
-@kbd{L a} and again @samp{from} with -200, one entry with the score of
--1200 will be created as a result.
+For example, if you create @samp{from} entry with the score of @minus{}1000 by
+@kbd{L a} and again @samp{from} with @minus{}200, one entry with the score of
+@minus{}1200 will be created as a result.
@subsubsection Creating Thread Key
@table @code
@item wl-summary-default-score
@vindex wl-summary-default-score
-The initial setting is zero.
+The initial setting is 0 (zero).
This variable specifies the default value of the score.
The score is increased or decreased based upon this value.
@item wl-summary-important-above
@vindex wl-summary-important-above
-The initial setting is nil.
+The initial setting is @code{nil}.
Messages with scores larger than this value are attached with the
important mark (@samp{$}).
-If nil, no important marks are attached.
+If @code{nil}, no important marks are attached.
-@item wl-summary-temp-above
-@vindex wl-summary-temp-above
-The initial setting is nil.
-Messages with scores larger than this value are attached with the temp
+@item wl-summary-target-above
+@vindex wl-summary-target-above
+The initial setting is @code{nil}.
+Messages with scores larger than this value are attached with the target
mark (@samp{*}).
-If nil, no temp marks are attached.
+If @code{nil}, no target marks are attached.
@item wl-summary-mark-below
@vindex wl-summary-mark-below
-The initial setting is zero.
+The initial setting is 0 (zero).
Messages with scores smaller than this value are marked as read.
@item wl-summary-expunge-below
@vindex wl-summary-expunge-below
-The initial setting is nil.
+The initial setting is @code{nil}.
Messages with scores smaller than this value are deleted from the
summary.
-If nil, they are not deleted.
+If @code{nil}, they are not deleted.
@item wl-summary-score-marks
@vindex wl-summary-score-marks
-The initial setting is '("N").
+The initial setting is the list shown below:
+
+@lisp
+@group
+(list wl-summary-new-mark)
+@end group
+@end lisp
+
+@noindent
Messages with these marks are scored.
@item wl-use-scoring
@item wl-score-files-dir
@vindex wl-score-files-dir
-The initial setting is "~/.elmo/".
+The initial setting is @file{~/.elmo/}.
The default directory for score files.
@item wl-score-interactive-default-score
@vindex wl-score-interactive-default-score
The initial setting is 1000.
-This value is used as a score when a score factor is nil in the score
-file.
-It is also used in @code{wl-summary-increase-score} and
+This value is used as a score when a score factor is @code{nil} in the
+score file. It is also used in @code{wl-summary-increase-score} and
@code{wl-summary-lower-score}, on condition that the value of
-@code{wl-score-header-default-entry} is nil.
+@code{wl-score-header-default-entry} is @code{nil}.
@item wl-score-expiry-days
@vindex wl-score-expiry-days
@item wl-score-update-entry-dates
@vindex wl-score-update-entry-dates
-The initial setting is t.
+The initial setting is @code{t}.
If non-nil, it enables deletion of time-limited scores.
@item wl-score-header-default-entry
@item wl-score-simplify-fuzzy-regexp
@vindex wl-score-simplify-fuzzy-regexp
-In the case of a type of a score entry is "fuzzy", this specifies a
+In the case of a type of a score entry is @code{fuzzy}, this specifies a
regular expression to be deleted from the string.
Because this is usually used for Subject, the default is prefixes that
are attached by mailing list programs.
does.
Unread marks reflect information on the IMAP4 server.
Important marks reflect information on the IMAP4 server (flagged or
-not), and contents of 'mark folder.
-The initial setting is t.
+not), and contents of @samp{'mark} folder.
+The initial setting is @code{t}.
@end table
The format of score files are the same as Gnus, and basically you can
use Gnus score files as they are. But they are not fully compatible
because some keys are not supported and there are Wanderlust specifics.
+@xref{Score File Format, , ,gnus, The gnus Newsreader}.
-@example
+@lisp
+@group
(("subject"
("for sale" -1000 nil s)
("profit" -1000 nil s))
("chars"
(1000000 -10 nil >))
(important 5000)
- (temp 3000)
+ (target 3000)
(mark 0)
(expunge -3000))
-@end example
+@end group
+@end lisp
@table @code
@item string
@enumerate
@item
A factor that matches header. This should be a number in the cases of
-"lines" and "chars", otherwise a string.
+@code{lines} and @code{chars}, otherwise a string.
@item
A score factor. When the first item matches, the score of the message
is increased or decreased by this value.
@item
-A time limiting factor. If nil, the score is permanent, and in the case
+A time limiting factor. If @code{nil}, the score is permanent, and in the case
of a number, the score is deleted if it does not match for days
(@code{wl-score-expiry-days}) from the date specified by this.
The date is since Dec. 31, 1 B.C.
@end enumerate
-The sum of these scores @emph{after all factors are applied} becomes the
+The sum of these scores @emph{after all factors are applied} becomes the
score of the message.
@cindex Score File Atoms
i.e. messages with a score less than this value is marked as read and
deleted from the summary.
-@item temp
+@item target
Messages with a score greater than this value is attached with temp
marks.
-The default is @code{wl-summary-temp-above}.
+The default is @code{wl-summary-target-above}.
@item important
Messages with a score greater than this value is attached with important
@subsection Caveats
-Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
+Not to mention the @code{extra} key, if @code{lines} or @code{xref} keys
are used, you need to set @code{elmo-msgdb-extra-fields}.
@lisp
Keys that can be seen by folder of types:
@example
+@group
chars lines xref extra
localdir,localnews Y E E E
nntp (supporting xover) Y E E N
Y: can be seen
N: cannot be seen (ignored)
E: can be seen with @code{elmo-msgdb-extra-fields} settings
+@end group
+@end example
+
+
+@node Address Book, Customization, Scoring, Top
+@chapter Address Book
+@cindex Address Book
+
+With address book, you can utilize address completion, and you have
+summary displayed with nicknames.
+
+@menu
+* Mail Addresses:: Definition of Address Book
+* Address Manager:: Address Manager
+@end menu
+
+@node Mail Addresses, Address Manager, Address Book, Address Book
+@section Address book
+@cindex Address book Definition
+@cindex .addresses
+@cindex Alias, Address
+
+The file @file{~/.addresses} is a simple address book for Wanderlust.
+Make address file @file{~/.addresses}, and edit to suit your requirement.
+
+The data written in @file{~/.addresses} are used for address completion
+under draft editing mode. Furthermore, they are used when showing names
+in summary display mode. You can safely skip this section, if you don't
+want to customize address completion and summary display.
+It is possible to add/change/remove addresses from @file{~/.addresses} in
+summary buffer after Wanderlust is invoked. @refill
+
+The format is very simple. Like this. @refill
+
+@example
+@group
+#
+# @r{Lines begin with @samp{#} are comment.}
+# @r{Empty lines are ignored}
+#
+# @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"
+@end group
@end example
+@noindent
+One line defines one persons description.
+
+Actually, in default setup, @var{nickname} is used in summary-mode and
+@var{realname} is used in draft preparation mode. This behavior is
+better understood if you try it and confirmed the function first. You
+can write and try a small definition, so you will know the idea of the
+address book before writing a big one.
+
+And, if MH alias file is specified in variable @code{wl-alias-file},
+it is used as an address information in the draft preparation mode.
+
+If variable @code{wl-use-ldap} is non-nil (initial setting is
+@code{nil}), address completion in draft mode uses LDAP information.
+
+If you use LDAP, you have to set @code{wl-ldap-server},
+@code{wl-ldap-port} and @code{wl-ldap-base} properly. If your emacs does
+not have LDAP feature as built-in feature (Currently only XEmacs can
+have built-in LDAP feature), you have to set command exec @env{PATH} to
+the program @command{ldapsearch}.
+
+
+@node Address Manager, , Mail Addresses, Address Book
+@section Address Manager
+@cindex Address Manager
+
+You can type @kbd{C-c C-a} to enter address manger mode. you can edit
+the address book and insert address to draft buffer.
+
+@subsection Key Bindings
+
+@table @kbd
+@item t
+@kindex t (Address Manager)
+@findex wl-addrmgr-set-to
+Add @samp{To:} mark.
+
+@item c
+@kindex c (Address Manager)
+@findex wl-addrmgr-set-cc
+Add @samp{Cc:} mark.
+
+@item b
+@kindex b (Address Manager)
+@findex wl-addrmgr-set-bcc
+Add @samp{Bcc:} mark.
+
+@item u
+@kindex u (Address Manager)
+@findex wl-addrmgr-unmark
+Cancel the mark.
+
+@item x
+@kindex x (Address Manager)
+@findex wl-addrmgr-apply
+
+Insert @samp{To:}, @samp{Cc:}, or @samp{Bcc:} marked addresses to draft
+buffer and quit address manager. When no draft buffer, make new draft
+with insert marked addresses.
+
+If no mark, quit address manager.
+
+
+@item q
+@kindex q (Address Manager)
+@findex wl-addrmgr-quit
+Quit address manager.
+
+@item a
+@kindex a (Address Manager)
+@findex wl-addrmgr-add
+Add new entry.
+
+@item d
+@kindex d (Address Manager)
+@findex wl-addrmgr-delete
+Delete entry.
+
+@item e
+@kindex e (Address Manager)
+@findex wl-addrmgr-edit
+Edit entry.
+@end table
+
-@c
-@c Customization
-@c
-@node Customization, Mailing List, Scoring, Top
+@node Customization, Mailing List, Address Book, Top
@chapter Customizing Wanderlust
@cindex Customization
@menu
-* Living with other packages:: Living with other packages
+* Living with other packages:: Cooperating with other packages
* Highlights:: Highlights
+* Biff:: Notify Mail arrival
* Advanced Settings:: Advanced Settings
* Customizable Variables:: Customizable Variables
+* Hooks:: Hooks
@end menu
Examples with other packages.
@menu
+* imput:: imput (im-wl.el)
* BBDB:: BBDB
* supercite:: supercite.el
* mu-cite:: mu-cite.el
-* x-face-mule:: x-face-mule.el
+* X-Face:: x-face,bitmap-mule
* dired-dd:: dired-dd.el
+* MHC:: MHC
+* Addrbook:: Addrbook
+* mime-w3m:: mime-w3m.el
@end menu
-@node BBDB, supercite, Living with other packages, Living with other packages
+@node imput, BBDB, Living with other packages, Living with other packages
+@subsection imput
+@pindex imput
+@cindex im-wl
+
+Place @file{util/im-wl.el} on the @code{load-path} and do the following
+settings.
+
+If @command{imput} is on the @code{exec-path} at the installation,
+@file{im-wl.el} is byte-compiled and installed. @xref{Install}.
+
+@lisp
+@group
+(autoload 'wl-draft-send-with-imput-async "im-wl")
+(setq wl-draft-send-function 'wl-draft-send-with-imput-async)
+@end group
+@end lisp
+
+
+@node BBDB, supercite, imput, Living with other packages
@subsection bbdb.el
@pindex BBDB
-Place @file{util/bbdb-wl.el} on the load-path and do the following
+Place @file{util/bbdb-wl.el} on the @code{load-path} and do the following
settings.
-If BBDB is on the load-path at the installation, @file{bbdb-wl.el} is
+If BBDB is on the @code{load-path} at the installation, @file{bbdb-wl.el} is
byte-compiled and installed.
@xref{Install}.
@lisp
+@group
(require 'bbdb-wl)
(bbdb-wl-setup)
(setq signature-use-bbdb t)
(setq bbdb-north-american-phone-numbers-p nil)
;; @r{shows the name of bbdb in the summary} :-)
-(setq wl-summary-from-func 'bbdb-wl-from-func)
+(setq wl-summary-from-function 'bbdb-wl-from-func)
;; @r{automatically add mailing list fields}
(add-hook 'bbdb-notice-hook 'bbdb-auto-notes-hook)
(setq bbdb-auto-notes-alist '(("X-ML-Name" (".*$" ML 0))))
+@end group
@end lisp
+You can complete address with BBDB by @kbd{M-@key{TAB}}
+in draft buffer.
+
+
@node supercite, mu-cite, BBDB, Living with other packages
@subsection sc.el(supercite), sc-register.el
@pindex sc
@pindex supercite
The same setting as usual mailers should be OK. The following is an
-example of settings.
+example of settings:
@lisp
-(autoload 'sc-cite-original "sc" nil t)
-(setq mail-yank-hooks 'sc-cite-original)
-(setq sc-preferred-header-style 1)
-(setq sc-electric-references-p nil)
-(setq sc-citation-leader "")
-(setq sc-load-hook '(lambda () (require 'sc-register)))
-(setq sc-preferred-attribution 'registeredname)
+@group
+(autoload 'sc-cite-original "supercite" nil t)
+(add-hook 'mail-citation-hook 'sc-cite-original)
+@end group
@end lisp
-@node mu-cite, x-face-mule, supercite, Living with other packages
+@node mu-cite, X-Face, supercite, Living with other packages
@subsection mu-cite.el
@pindex mu-cite
If you use mu-cite version 8.0 or earlier:
@lisp
+@group
(autoload 'mu-cite/cite-original "mu-cite" nil t)
(setq mail-citation-hook 'mu-cite/cite-original)
+@end group
@end lisp
If you use mu-cite version 8.1 or later:
@lisp
+@group
(autoload 'mu-cite-original "mu-cite" nil t)
(add-hook 'mail-citation-hook (function mu-cite-original))
+@end group
@end lisp
-@node x-face-mule, dired-dd, mu-cite, Living with other packages
-@subsection x-face-mule.el
-@pindex x-face-mule
-@pindex bitmap-mule
+@node X-Face, dired-dd, mu-cite, Living with other packages
+@subsection x-face
+@pindex x-face
-It depends on the version of x-face-mule.
-If you use x-face-mule 0.19 or older, do the following:
+If you have installed one of the following, you can decode
+@samp{X-Face:} field in message buffer and you will see face image.
-@lisp
-(setq wl-highlight-x-face-func
- (function
- (lambda (beg end)
- (x-face-mule:x-face-decode-message-header))))
+@menu
+* x-face-xmas:: XEmacs case
+* x-face-mule:: Emacs 19.34, 20.x case
+* x-face-e21:: Emacs 21.x case
+@end menu
-If you use x-face-mule 0.20 or later, try the following.
+If there is an encoded X-Face string in a file @file{~/.xface} (the
+value of the variable @code{wl-x-face-file}), it is inserted as a
+@samp{X-Face:} field in the draft buffer (if
+@code{wl-auto-insert-x-face} is non-nil).
-(setq wl-highlight-x-face-func
- (function
- (lambda (beg end)
- (x-face-mule-x-face-decode-message-header))))
-(require 'x-face-mule)
+@node x-face-xmas, x-face-mule, X-Face, X-Face
+@subsubsection x-face-xmas (for XEmacs)
+@pindex x-face-xmas
+
+If you use @file{x-face-xmas.el} in x-face (@uref{ftp://jpl.org/pub/elisp/})
+1.3.6.13 or later, do the following:
+
+@lisp
+@group
+(autoload 'x-face-xmas-wl-display-x-face "x-face")
+(setq wl-highlight-x-face-function 'x-face-xmas-wl-display-x-face)
+@end group
@end lisp
-Use these settings when you use @file{x-face-mule.el} attached to
-bitmap-mule 8.0 or later.
+@node x-face-mule, x-face-e21, x-face-xmas, X-Face
+@subsubsection x-face-mule (for Emacs 19.34, 20.x)
+@pindex x-face-mule
+@pindex bitmap-mule
+
+If you use @file{x-face-mule.el} in bitmap-mule
+(@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}) 8.0 or later, do the following:
@lisp
+@group
(autoload 'x-face-decode-message-header "x-face-mule")
-(setq wl-highlight-x-face-func
- (function x-face-decode-message-header))
+(setq wl-highlight-x-face-function 'x-face-decode-message-header)
+@end group
@end lisp
-If there is an encoded X-Face string in a file @file{~/.xface} (the value
-of the variable @code{wl-x-face-file}), it is inserted as a X-Face field
-in the draft buffer (if @code{wl-auto-insert-x-face} is non-nil).
+@node x-face-e21, , x-face-mule, X-Face
+@subsubsection x-face-e21 (for Emacs 21.x)
+@pindex x-face-e21
+
+If you use @file{x-face-e21.el} (@uref{ftp://jpl.org/pub/elisp/}),
+do the following:
+
+@lisp
+@group
+(autoload 'x-face-decode-message-header "x-face-e21")
+(setq wl-highlight-x-face-function 'x-face-decode-message-header)
+@end group
+@end lisp
-@node dired-dd, , x-face-mule, Living with other packages
+@node dired-dd, MHC, X-Face, Living with other packages
@subsection dired-dd(Dired-DragDrop)
@pindex Dired-DragDrop
@pindex Dired-DD
@cindex Drag and Drop
If you embed @file{dired-dd-mime.el} in the dired-dd package, you can
-compose multi-part by simple Drag&Drop from dired to the draft buffer
-being edited in GNU Emacs (this feature is not Wanderlust specific, but
-general-purpose for tm/SEMI).
+compose multi-part by simple Drag-and-Drop from dired to the draft
+buffer being edited in GNU Emacs (this feature is not Wanderlust
+specific, but general-purpose for SEMI).
@lisp
+@group
;; @r{dired-dd:} http://www.asahi-net.or.jp/~pi9s-nnb/dired-dd-home.html
(add-hook
'dired-load-hook
(if window-system
(progn (require 'dired-dd)
(require 'dired-dd-mime))))))
+@end group
+@end lisp
+
+@node MHC, Addrbook, 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 Addrbook, mime-w3m, MHC, Living with other packages
+@subsection wl-addrbook.el
+@pindex Addrbook
+
+Addrbook of Mew
+(@uref{http://www.mew.org/})
+
+Place @file{util/wl-addrbook.el} and @file{util/wl-complete.el} on the
+@code{load-path} and do the following settings.
+
+@lisp
+@group
+(require 'wl-addrbook)
+(wl-addrbook-setup)
+@end group
@end lisp
+@node mime-w3m, , Addrbook, Living with other packages
+@subsection mime-w3m.el
+@pindex mime-w3m
+
+You can display html part by using @file{mime-w3m.el}
+distributed with emacs-w3m (@uref{http://emacs-w3m.namazu.org/}).
+You can find the usage in comment region at the head of @file{mime-w3m.el}.
-@node Highlights, Advanced Settings, Living with other packages, Customization
+
+@node Highlights, Biff, Living with other packages, Customization
@section Highlights
@subsection Customizable Variables
@table @code
@item wl-summary-highlight
@vindex wl-summary-highlight
-The initial setting is t.
+The initial setting is @code{t}.
If non-nil, the summary is highlighted.
@item wl-highlight-max-summary-lines
@item wl-summary-partial-highlight-above-lines
@vindex wl-summary-partial-highlight-above-lines
-The initial setting is 30.
-If there are more lines of messages than
+The initial setting is 30. If there are more lines of messages than
@code{wl-summary-highlight-partial-threshold} in the summary, messages
after the point that is the same number of lines as this value above the
-cursor line are highlighted partially.
-(If this value is nil, the last same number of lines as the value of
+cursor line are highlighted partially. (If this value is @code{nil},
+the last same number of lines as the value of
@code{wl-summary-highlight-partial-threshold} are highlighted.)
@item wl-highlight-body-too
@vindex wl-highlight-body-too
-The initial setting is t.
+The initial setting is @code{t}.
If non-nil, bodies of drafts and messages are also highlighted.
@item wl-highlight-message-header-alist
@item wl-highlight-citation-prefix-regexp
@vindex wl-highlight-citation-prefix-regexp
-Specifies a regular expression to which quoted lines in bodies of
+Specifies a regular expression to which quoted lines in bodies of
drafts and messages match.
Bodies matching to this regular expression are highlighted by the faces
specified by (@code{wl-highlight-message-cited-text-*}).
@item wl-highlight-highlight-citation-too
@vindex wl-highlight-highlight-citation-too
-The initial setting is nil.
+The initial setting is @code{nil}.
If non-nil, the quoting regular expression itself given by
@code{wl-highlight-citation-prefix-regexp} is also highlighted.
Bodies matching to this regular expression are highlighted by the face
specified by @code{wl-highlight-message-headers}.
+@item wl-highlight-max-header-size
+@vindex wl-highlight-max-header-size
+The initial setting is @code{nil}. If a header size is larger than this
+value, it will not be highlighted. If @code{nil}, always highlighted
+(ignore header size).
+
@item wl-highlight-max-message-size
@vindex wl-highlight-max-message-size
The initial setting is 10000.
@item wl-use-highlight-mouse-line
@vindex wl-use-highlight-mouse-line
-The initial setting is t.
+The initial setting is @code{t}.
If non-nil, the line pointed by the mouse is highlighted in the folder
mode, summary mode, and the like.
@end table
@subsection Setting Colors and Fonts of the Characters
If you want to change colors or fonts of the characters, you need to
-modify faces defined in Wanderlust. Use set-face-font if you want to
-change fonts, and set-face-foreground for colors, and so on.
-You cannot write face settings in @file{.emacs}; write in @file{~/.wl}.
+modify faces defined in Wanderlust. Use @code{set-face-font} if you
+want to change fonts, and @code{set-face-foreground} for colors, and so
+on. You cannot write face settings in @file{.emacs}; write in
+@file{~/.wl}.
For example, if you want to change the color for signatures to yellow,
write
@item wl-highlight-message-important-header-contents
The face for important parts of message headers.
-Per default, this face is used for a body of Subject field.
+Per default, this face is used for a body of @samp{Subject:} field.
You can change its value by editing
@code{wl-highlight-message-header-alist}.
@item wl-highlight-message-important-header-contents2
The face for secondly important parts of message headers.
-Per default, this face is used for bodies of From and To fields.
-You can change its value by editing
+Per default, this face is used for bodies of @samp{From:} and @samp{To:}
+fields. You can change its value by editing
@code{wl-highlight-message-header-alist}.
@item wl-highlight-message-unimportant-header-contents
The face for unimportant parts of message headers.
-Per default, this face is used for bodies of X- fields User-Agent fields.
-You can change its value by editing
+Per default, this face is used for bodies of @samp{X-} fields
+@samp{User-Agent:} fields. You can change its value by editing
@code{wl-highlight-message-header-alist}.
@item wl-highlight-message-citation-header
The face for headers of quoted messages.
@item wl-highlight-message-cited-text-*
-The face for texts of quoted messages.
-The last "*" is a single figure so that 10 different colors can be used
-according to citation levels.
+The face for texts of quoted messages. The last @samp{*} is a
+@var{single figure} so that 10 different colors can be used according to
+citation levels.
@item wl-highlight-message-signature
-The face for signatures of messages.
-The initial settings are khaki for light background colors, and
-DarkSlateBlue for dark background colors.
+The face for signatures of messages. The initial settings are
+@samp{khaki} for light background colors, and @samp{DarkSlateBlue} for
+dark background colors.
@item wl-highlight-header-separator-face
The face for header separators of draft messages.
The face for message lines with copy marks in the summary.
@item wl-highlight-summary-target-face
-The face for message lines with temp marks @samp{*} in the summary.
+The face for message lines with target marks @samp{*} in the summary.
@item wl-highlight-summary-thread-top-face
The face for message lines that are on the top of the thread in the
@item wl-highlight-folder-opened-face
The face for open groups in the folder mode.
-It is meaningful when @code{wl-highlight-group-folder-by-numbers} is nil.
+It is meaningful when @code{wl-highlight-folder-by-numbers} is
+@code{nil} or a @var{number}.
@item wl-highlight-folder-closed-face
The face for close groups in the folder mode.
-It is meaningful when @code{wl-highlight-group-folder-by-numbers} is nil.
+It is meaningful when @code{wl-highlight-folder-by-numbers} is
+@code{nil} or a @var{number}.
@item wl-highlight-folder-path-face
The face for the path to the currently selected folder in the folder
The face for strings (for example, a version number) in the demo.
@end table
-@node Advanced Settings, Customizable Variables, Highlights, Customization
+
+@node Biff, Advanced Settings, Highlights, Customization
+@section Notify Mail arrival
+@cindex Biff
+
+Following setting is to notify mail arrival of @samp{%inbox}
+by the indicator on the modeline
+
+@lisp
+(setq wl-biff-check-folder-list '("%inbox"))
+@end lisp
+
+@subsection Customizable Variables
+@table @code
+@item wl-biff-check-folder-list
+@vindex wl-biff-check-folder-list
+The initial setting is @code{nil}.
+This is the list of folders to check mail arrival.
+If @code{nil}, wl doesn't check mail arrival.
+
+@item wl-biff-check-interval
+@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
+This hook is run at the arrival of new mail.
+To beep with mail arrival(initial setting), set as follows.
+@lisp
+(setq wl-biff-notify-hook '(ding))
+@end lisp
+For silence, set to @code{nil}.
+@end table
+
+
+@node Advanced Settings, Customizable Variables, Biff, Customization
@section Advanced Settings
@menu
* Draft for Reply:: Draft for Reply
* Thread Format:: Appearance of Thread
-* User-Agent Header:: User-Agent Header
+* User-Agent Field:: @samp{User-Agent:} Header Field
@end menu
@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
following settings:
@lisp
+@group
(setq wl-draft-reply-without-argument-list
'(("Mail-Followup-To" . (("Mail-Followup-To") nil ("Newsgroups")))
("Followup-To" . (nil nil ("Followup-To")))
(("X-ML-Name" "Reply-To") . (("Reply-To") nil nil))
("From" . (("From") ("To" "Cc") ("Newsgroups")))))
+@end group
@end lisp
@noindent
-(Only if there are both of "X-ML-Name" and "Reply-To" fields in the
-original message, Reply-To: field in the original is copied to To:
-field.)
+(Only if there are both of @samp{X-ML-Name:} and @samp{Reply-To:} fields
+in the original message, @samp{Reply-To:} field in the original is
+copied to @samp{To:} field.)
-@node Thread Format, User-Agent Header, Draft for Reply, Advanced Settings
+Moreover, the behavior of @kbd{a} with prefix argument can
+be directed by @code{wl-draft-reply-with-argument-list} as well.
+
+Note: To set the behavior when you reply to the message written by yourself, use
+@code{wl-draft-reply-myself-without-argument-list} and
+@code{wl-draft-reply-myself-with-argument-list}
+instead of them.
+
+@node Thread Format, User-Agent Field, Draft for Reply, Advanced Settings
@subsection Appearance of Threads
@example
+@group
389 09/18(Fri)01:07 [ Teranishi ] wl-0.6.3
390 09/18(Fri)07:25 +-[ Tsumura-san ]
391 09/18(Fri)19:24 +-[ Murata-san ]
416 09/22(Tue)12:38 | +-[ Teranishi ]
395 09/20(Sun)21:49 +-[ Okunishi-san ]
397 09/21(Mon)00:15 +-[ Okunishi-san ]
+@end group
@end example
Settings to make appearance of threads like shown above:
@lisp
+@group
(setq wl-thread-indent-level 2)
(setq wl-thread-have-younger-brother-str "+")
(setq wl-thread-youngest-child-str "+")
(setq wl-thread-vertical-str "|")
(setq wl-thread-horizontal-str "-")
(setq wl-thread-space-str " ")
+@end group
@end lisp
If you do not want to see branches, do the following:
@lisp
+@group
(setq wl-thread-indent-level 2)
(setq wl-thread-have-younger-brother-str " ")
(setq wl-thread-youngest-child-str " ")
(setq wl-thread-vertical-str " ")
(setq wl-thread-horizontal-str " ")
(setq wl-thread-space-str " ")
+@end group
@end lisp
-@node User-Agent Header, , Thread Format, Advanced Settings
-@subsection User-Agent
+@node User-Agent Field, , Thread Format, Advanced Settings
+@subsection User-Agent Field
+@cindex X-Mailer
+@cindex User-Agent
+
+If you are eccentric enough to elaborate @samp{X-Mailer:} or
+@samp{User-Agent:} fields, define a function that generate appropriate
+strings as you like, and set it to variable
+@code{wl-generate-mailer-string-function}.
+
+If you do not want verbose @samp{User-Agent:} field, do the following:
-If you are eccentric enough to elaborate X-Mailer or User-Agent fields,
-define a function that inserts appropriate strings as you like, and set
-it to @code{wl-generate-mailer-string-func}.
+@lisp
+@group
+(setq wl-generate-mailer-string-function
+ (function
+ (lambda ()
+ (concat "User-Agent: "
+ (wl-generate-user-agent-string-1 nil)))))
+@end group
+@end lisp
-The following is an example.
+The following is a example:
@lisp
-(setq wl-generate-mailer-string-func
+@group
+(setq mime-edit-insert-user-agent-field nil)
+(setq wl-generate-mailer-string-function
(function
(lambda ()
- (concat "X-Mailer: "
- (format "%s/%s (%s)" wl-appname wl-version wl-codename)))))
+ (format "X-Mailer: %s" (product-string-1 'wl-version)))))
+@end group
@end lisp
-@node Customizable Variables, , Advanced Settings, Customization
+
+@node Customizable Variables, Hooks, Advanced Settings, Customization
@section Customizable Variables
Customizable variables that have not been described yet:
@table @code
@item wl-default-folder
@vindex wl-default-folder
-The initial setting is "%inbox". This is the default value for moving to
+The initial setting is @samp{%inbox}. This is the default value for moving to
a folder and the like.
@item wl-draft-folder
@vindex wl-draft-folder
-The initial setting is "+draft". It is the folder to which drafts are
+The initial setting is @samp{+draft}. It is the folder to which drafts are
saved. It must be a localdir folder.
@item wl-trash-folder
@vindex wl-trash-folder
-The initial setting is "+trash". It is the wastebasket folder.
+The initial setting is @samp{+trash}. It is the wastebasket folder.
If you changed this variable, you had better restart Wanderlust.
@item wl-interactive-exit
@vindex wl-interactive-exit
-The initial setting is t.
+The initial setting is @code{t}.
If non-nil, you are asked for confirmation when Wanderlust terminates.
@item wl-interactive-send
@vindex wl-interactive-send
-The initial setting is nil.
+The initial setting is @code{t}.
If non-nil, you are asked for confirmation when mail is sent.
@item wl-folder-sync-range-alist
@vindex wl-folder-sync-range-alist
-The initial setting is the list shown below:
-@example
+The initial setting is the alist shown below:
+
+@lisp
+@group
(("^&.*$" . "all")
("^\\+draft$\\|^\\+queue$" . "all"))
-@end example
+@end group
+@end lisp
+
+@noindent
This is an associative list of regular expressions of folder names and
-update range of the summary.
-Update range is one of the "all", "update", "rescan", "rescan-noscore", "first"
- and "last". If a folder do not match, "update" is used.
+update range of the summary. Update range is one of the @samp{all},
+@samp{update}, @samp{rescan}, @samp{rescan-noscore}, @samp{first} and
+@samp{last}. If a folder do not match, @samp{update} is used.
@item wl-ask-range
@vindex wl-ask-range
-The initial setting is t.
-If nil, the value of @code{wl-folder-sync-range-alist} is used for
-updating the summary when you changed folders.
+The initial setting is @code{t}.
+If @code{nil}, the value of @code{wl-folder-sync-range-alist} is used
+for updating the summary when you changed folders.
@item wl-mime-charset
@vindex wl-mime-charset
-The initial setting is 'x-ctext.
+The initial setting is @code{x-ctext}.
This is the MIME charset for messages that are not MIME (e.g. without
-Content-Type). This value also used as default charset for summary.
-(If you want to share Summary on Nemacs and other Emacsen,
-set this value as 'iso-2022-jp.)
-
-@item wl-search-mime-charset
-@vindex wl-search-mime-charset
-The initial setting is 'iso-2022-jp.
-This is used as a MIME charset for searching.
+@samp{Content-Type:}). This value also used as default charset for
+summary. (If you want to share Summary on Nemacs and other Emacsen, set
+this value as @code{iso-2022-jp}.)
@item wl-highlight-folder-with-icon
@vindex wl-highlight-folder-with-icon
-This is meaningful for XEmacs only. The initial setting depends on
-XEmacs (t for XEmacs with icons).
+This is meaningful for XEmacs or Emacs 21.. The initial setting depends
+on Emacsen (@code{t} for XEmacs or Emacs 21 with icons).
@item wl-strict-diff-folders
@vindex wl-strict-diff-folders
The folders matching this variable are seriously checked.
You may want to set this variable so as to match conditional filter
folders for IMAP4 folders.
-The initial setting is nil.
+The initial setting is @code{nil}.
@item wl-folder-use-server-diff
@vindex wl-folder-use-server-diff
When unread messages are checked, for example when you press @kbd{s} in
-the folder mode, usually (the number of messages on the server) - (the
-number of local messages) will be the number of unread messages.
+the folder mode, usually (the number of messages on the server) @minus{}
+(the number of local messages) will be the number of unread messages.
However, if this variable is non-nil, the number of unread messages on
the server is checked. This affects IMAP4 folders only, but IMAP4
folders in mail boxes matching
@code{elmo-imap4-disuse-server-flag-mailbox-regexp} are not checked for
the number of unread messages on the server, even if they matches this
-variable. The initial setting is t.
+variable. The initial setting is @code{t}.
@item wl-auto-check-folder-name
@vindex wl-auto-check-folder-name
-The initial setting is nil.
+The initial setting is @code{nil}.
If non-nil, the folder with the name of the value is checked for unread
messages at the start.
-If it is 'none, no folders are checked.
+If it is @code{none}, no folders are checked.
If it is a list, all folders in the list are checked at the start.
@item wl-auto-uncheck-folder-list
@vindex wl-auto-uncheck-folder-list
-The initial setting is '("\\$.*").
+The initial setting is the list shown below:
+
+@lisp
+@group
+("\\$.*")
+@end group
+@end lisp
+
+@noindent
Folders with the name matching this variable are not checked for unread
messages at the start, even if they are included in the groups in
@code{wl-auto-check-folder-name}.
@item wl-auto-check-folder-list
@vindex wl-auto-check-folder-list
-The initial setting is nil.
+The initial setting is @code{nil}.
Folders with the name matching this variable are always checked for
unread messages at the start, if they are included in the groups in
@code{wl-auto-check-folder-name}.
@item wl-no-save-folder-list
@vindex wl-no-save-folder-list
-The initial setting is '("^/.*$").
+The initial setting is the list shown below:
+
+@lisp
+@group
+("^/.*$")
+@end group
+@end lisp
+
+@noindent
This is a list of regular expressions of folders not to be saved.
@item wl-save-folder-list
@vindex wl-save-folder-list
-The initial setting is nil.
+The initial setting is @code{nil}.
This is a list of regular expressions of folders to be saved.
This takes precedence over @code{wl-no-save-folder-list}.
@item wl-folder-mime-charset-alist
@vindex wl-folder-mime-charset-alist
-The initial setting is the list shown below:
+The initial setting is the alist shown below:
@lisp
-'(("^-alt\\.chinese" . big5)
- ("^-relcom\\." . koi8-r)
- ("^-tw\\." . big5)
- ("^-han\\." . euc-kr)
- )
+@group
+(("^-alt\\.chinese" . big5)
+ ("^-relcom\\." . koi8-r)
+ ("^-tw\\." . big5)
+ ("^-han\\." . euc-kr))
+@end group
@end lisp
+@noindent
This is an associative list of regular expressions of folder names and
MIME charsets.
If a folder do not match, @code{wl-mime-charset} is used.
@item wl-folder-init-load-access-folders
@vindex wl-folder-init-load-access-folders
-The initial setting is nil.
+The initial setting is @code{nil}.
This is a list of access groups to be loaded specifically at the start.
-If it is nil, @code{wl-folder-init-no-load-access-folders} is referred.
+If it is @code{nil}, @code{wl-folder-init-no-load-access-folders} is referred.
@item wl-folder-init-no-load-access-folders
@vindex wl-folder-init-no-load-access-folders
-The initial setting is nil.
+The initial setting is @code{nil}.
This is a list of access groups not to be loaded specifically at the
start.
It is ignored if @code{wl-folder-init-load-access-folders} is non-nil.
@item wl-delete-folder-alist
@vindex wl-delete-folder-alist
-The initial setting is '(("^-" . remove)).
+The initial setting is the alist shown below:
+
+@lisp
+@group
+(("^-" . remove))
+@end group
+@end lisp
+
+@noindent
This list determines disposition of messages with delete marks.
Each item in the list is a folder and destination; you can specify any
one of the following in the place of destination:
@example
-'remove or 'null : deletes the messages instantly.
-string : moves the messages to the specific folder.
-'trash or others : moves the messages to `wl-trash-folder'.
+@code{remove} or @code{null} : deletes the messages instantly.
+string : moves the messages to the specific folder.
+@code{trash} or others : moves the messages to @code{wl-trash-folder}.
@end example
@item wl-refile-policy-alist
@vindex wl-refile-policy-alist
-The initial setting is '(("^[-=]" . copy) (".*" . move)).
+The initial setting is the list shown below:
+
+@lisp
+@group
+(("^[-=]" . copy)
+ (".*" . move))
+@end group
+@end lisp
+
+@noindent
This list determines whether messages with re-file marks are moved or
-copied.
-Each item in the list is a cons cell of a folder and copy or move.
+copied. Each item in the list is a cons cell of a folder and
+@code{copy} or @code{move}.
@item wl-x-face-file
@vindex wl-x-face-file
-The initial setting is "~/.xface".
+The initial setting is @file{~/.xface}.
The name of the file that contains encoded X-Face strings.
@xref{x-face-mule}.
@item wl-demo-display-logo
@vindex wl-demo-display-logo
-If non-nil, bitmap image is shown on the opening demo.
+If non-nil, bitmap image is shown on the opening demo. If you set
+@code{xpm} or @code{xbm}, (if possible) display selected image type
+logo.
@item elmo-use-database
@vindex elmo-use-database
This is meaningful for XEmacs only. The initial setting depends on
-XEmacs (t for XEmacs with dbm).
+XEmacs (@code{t} for XEmacs with dbm).
If non-nil, Message-ID is controlled by dbm.
@item elmo-passwd-alist-file-name
-@vindex elmo-passwd-alist-file-name
-The initial setting is "passwd".
+@vindex elmo-passwd-alist-file-name
+The initial setting is @file{passwd}.
This is the name of the file in which passwords are saved.
@code{elmo-passwd-alist-save} saves current passwords to the file.
@vindex elmo-nntp-list-folders-use-cache
The initial setting is 600 (in seconds).
This is period in seconds during which results of @samp{list} and
-@samp{list active} in NNTP are cached. If it is nil, they are not
-cached.
+@samp{list active} in NNTP are cached. If it is @code{nil}, they are
+not cached.
@item elmo-nntp-max-number-precedes-list-active
@vindex elmo-nntp-max-number-precedes-list-active
-The initial setting is nil.
+The initial setting is @code{nil}.
If non-nil, the number of article obtained by @samp{list active} in NNTP
are used as the maximum article number of the folder.
-Set this to t if you are using for example INN 2.3 as an NNTP server,
+Set this to @code{t} if you are using for example INN 2.3 as an NNTP server,
and if the number of read messages is not correct.
@item elmo-nntp-default-use-listgroup
@vindex elmo-nntp-default-use-listgroup
-The initial setting is t.
+The initial setting is @code{t}.
If non-nil, @samp{listgroup} is used for checking the total number of
-articles.
-If it is nil, @samp{group} is used. In the latter case, the processing
-will be a little faster at the sacrifice of accuracy.
+articles. If it is @code{nil}, @samp{group} is used. In the latter
+case, the processing will be a little faster at the sacrifice of
+accuracy.
@item elmo-pop3-send-command-synchronously
@vindex elmo-pop3-send-command-synchronously
-The initial setting is nil.
+The initial setting is @code{nil}.
If non-nil, POP3 commands are issued synchronously. Some implementation
of POP3 server fails to get summary information without this setting.
-You may have to set this variable to t, if the process hangs while
-looking up POP3.
+You may have to set this variable to @code{t}, if the process hangs
+while looking up POP3.
@item elmo-dop-flush-confirm
@vindex elmo-dop-flush-confirm
-The initial setting is t.
+The initial setting is @code{t}.
If non-nil, you are asked for confirmation if accumulated off-line
operations are executed.
+
+@item elmo-display-progress-threshold
+@vindex elmo-display-progress-threshold
+The initial setting is 20.
+Threshold for display of progress gauge. If number of renewal is more than
+this value, display progress gauge.
@end table
-@c
-@c Mailing List
-@c
+@node Hooks, , Customizable Variables, Customization
+@section Hooks
+
+(Not yet written)
+
+
@node Mailing List, Addition, Customization, Top
@chapter Wanderlust Mailing List
+@cindex Bug report
+@cindex Backtrace
@display
Wanderlust Mailing List @t{<wl@@lists.airs.net>}
@example
# guide
@end example
-Please send bug reports or patches to the mailing list.
-You can post to the mailing list even though you are not a member of it.
+Please send bug reports or patches to the mailing list. You can post to
+the mailing list even though you are not a member of it.
-I would like to express my thanks to the members of the mailing list for
+If you send a bug report, please attach Backtrace with it.
+@footnote{@uref{http://www.jpl.org/elips/BUGS-ja.html} describes how to
+in Japanese.}
+
+I would like to express my thanks to the members of the mailing list for
valuable advice and many pieces of code they contributed.
-@c
-@c Addition
-@c
@node Addition, Index, Mailing List, Top
@chapter Additional Information
1999 2/03 auto-refile by Tsumura-san.
4/28 wl-template by Murata-san.
5/18 Released 1.0.0 stable.
- 7/5 Scoring by Murata-san (2.1.0).
+ 7/05 Scoring by Murata-san (2.1.0).
+ 9/26 New plugged system by Murata-san (2.2.2).
+ 12/20 Support Modified UTF7.
+2000 3/24 Released 1.1.0 stable.
+ 4/03 CVS development started.
+ 5/07 Thread restoration & Its speed up with Murata-san.
+ 6/12 Address completion with LDAP with Chiba-san & Goto-san.
+ 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.
+2001 7/04 Released 2.6.0 stable.
+ 8/21 wl-addrmgr by Kitamoto-san.
@end example
See @file{ChangeLog} for details.
@end display
@noindent
-but I had no profound intention.
-(if farfetched, IMAP @t{=>} you can read mail anywhere @t{=>} desire to
-wander ?)
+but I had no profound intention. (if farfetched, IMAP @result{} you can
+read mail anywhere @result{} desire to wander ?)
Elmo is the abbreviation of @samp{Elisp Library for Message
-Orchestration}.
-At first I meant the red puppet in the Sesame Street, but you may
-associate it with
-Wandering @t{=>} Drifting @t{=>} Guidepost @t{=>} St.@: Elmo's fire @t{=>} elmo.
+Orchestration}. At first I meant the red puppet in the Sesame Street,
+but you may associate it with Wandering @result{} Drifting @result{}
+Guidepost @result{} St.@: Elmo's fire @result{} elmo.
@section Code Names
Currently they are picked up alphabetically from the top 40 hits of
U.S. Billboard magazines in 1980s.
-(@samp{http://www.summer.com.br/~pfilho/html/top40/index.html})
+(@uref{http://lyrics.natalnet.com.br/html/top40/index.html})
@node Index, , Addition, Top
@summarycontents
@contents
@bye
+
+@c Local Variables:
+@c fill-column: 72
+@c End:
projects / elisp / wanderlust.git / blobdiff