This file documents Wanderlust, Yet another message interface on
Emacsen.
-Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
+Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @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}.
@page
@vskip 0pt plus 1filll
-Copyright @copyright{} 1998, 1999, 2000, 2001 @w{Yuuichi Teranishi},
+Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @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}.
You can read manual at the following URL:
@example
-http://www.gohome.org/wl/doc/wl-euc_toc.html
+http://www.gohome.org/wl/doc/wl_toc.html
@end example
@node Minimal Settings, Folder Definition, Install, Start Me Up
;; @r{autoload configuration}
;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
(autoload 'wl "wl" "Wanderlust" t)
+(autoload 'wl-other-frame "wl" "Wanderlust on new frame." t)
(autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
-;; @r{Directory where icons are placed (XEmacs or Emacs 21).}
-;; @r{Default: @code{nil}.}
-;; @r{(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")
;; @r{SMTP server for mail posting. Default: @code{nil}}
(setq wl-smtp-posting-server "your.smtp.example.com")
If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
can skip folder checking.
+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
@example
@group
-@samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
+@samp{&} [@var{username}][[@samp{/} @var{authenticate-type}][@samp{:} @var{numbering-method}][@samp{@@} @var{hostname}][@samp{:} @var{port}]][@samp{!}]
@end group
@end example
@samp{user} (plain password transmission) or @samp{apop} (APOP authentication)
as @var{authenticate-type}.
+You can specify @samp{uidl} (use UIDL command for message numbering) or
+@samp{list} (use LIST command for message numbering) as @samp{numbering-method}.
+
default:
@example
@var{username} -> The value of @code{elmo-pop3-default-user}.
@code{(user-login-name)}.
@var{authenticate-type} -> The value of @code{elmo-pop3-default-authenticate-type}.
Initial setting is @samp{user}.
+@var{numbering-method} -> Follow the value of @code{elmo-pop3-default-use-uidl}.
+ If t, use UIDL for numbering. Initial setting is t.
@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}.
@end group
@end example
+@subsection Variables About Shimbun Folder
+
+@table @code
+@item elmo-shimbun-update-overview-folder-list
+@vindex elmo-shimbun-update-overview-folder-list
+The initial setting is @code{nil}. You can specify a list of regular
+expressions of shimbun folder names. The overview of matched shimbun
+folder is updated when messages are fetched.
+You should @kbd{s rescan} after fetching to update summary.
+@end table
+
@node Namazu Folder, Multi Folder, Shimbun Folder, Folders
@section Namazu Folder
@end group
@end example
-Tips
+@subsection TIPS
+
+@subsubsection Enter space to separate keywords
If you want to use space in folder entry, @kbd{C-q @key{SPC}} will help you.
+@subsubsection Alias name for index
+
+You can define an alias name for index.
+
+Example:
+
+@example
+(setq elmo-nmz-index-alias-alist
+ '(("cache" . "~/.elmo/cache")
+ ("docs" . "~/documents")))
+@end example
+
+Above definition defines two index aliases.
+You can specify
+
+@example
+[wanderlust]cache
+@end example
+
+to execute a namazu search with keyword @samp{wanderlust} using a index in the
+directory @file{~/.elmo/cache}.
+
+@subsubsection Multiple indices
+
+You can specify a list for @code{elmo-nmz-default-index-path} and
+@code{elmo-nmz-index-alias-alist}.
+When list is specified, all index contained in the list is used as the
+namazu indices.
+
+Example:
+
+@example
+(setq elmo-nmz-index-alias-alist
+ '(("all" . ("~/.elmo/cache" "~/documents"))
+ ("cache" . "~/.elmo/cache")))
+@end example
+
+Using above alias setting, you can specify
+
+@example
+[wanderlust]all
+@end example
+
+to execute a namazu search with keyword @samp{wanderlust} using indices in the
+directory @file{~/.elmo/cache} and @file{~/documents}.
@node Multi Folder, Filter Folder, Namazu Folder, Folders
@section Multi Folder
and access it, messages are downloaded automatically from
@samp{&username@@popserver} to @samp{+inbox}.
+On the other hand, if you put @samp{|:} instead of second @samp{|},
+then messages are copied to the destination folder (not deleted from
+source-folder). At the next time you access that folder, only new
+messages will be copied.
+
+@example
+@samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
+@end example
+
+If you want to copy messages from POP server and view them, specify the
+folder as follows:
+
+@example
+|&username@@popserver|:+inbox
+@end example
+
+where messages will be kept on the server.
+
Example:
@example
@group
-%inbox|%myinbox -> Download %inbox to %myinbox.
-*&user@@popserver1,&user@@popserver2|+inbox
+|%inbox|%myinbox -> Download %inbox to %myinbox.
+|*&user@@popserver1,&user@@popserver2|+inbox
-> Download from &user@@popserver1 and &user@@popserver2 to +inbox.
+|-gnu.emacs.sources|:+sources
+ -> Copy messages from -gnu.emacs.sources to +sources.
@end group
@end example
@example
@group
'mark
-@r{or}
+'sendlog
'cache/00 - 1F
@end group
@end example
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
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.
+
+@item wl-fldmgr-add-complete-with-current-folder-list
+@vindex wl-fldmgr-add-complete-with-current-folder-list
+The initial setting is @code{nil}.
+Non-nil means call @code{elmo-folder-list-subfolders} and get completion
+candidate for @code{wl-fldmgr-add}.
@end table
@subsection Miscellanea
key (if already exists, the mark is deleted). It is convenient to put
this mark on the messages to remember (If you want to remember to write
a reply for the message, for example) because this mark remains after
-you exited Emacs. Messages with the @samp{$} mark remains in the folder
-even the message itself is deleted in the actual folder.
+you exited Emacs. Messages with the @samp{$} mark can be reviewed in the
+@samp{'mark} folder even the message itself is deleted in the actual folder.
@item None
If the message is read and cached (or local message),there are no
cache. Messages with the marks other than these, you can read them in
the offline status even they are in the IMAP folder or netnews folder.
+Among messages with persistent marks, ones with marks specified by
+@code{wl-summary-expire-reserve-marks} are excluded from the expiration
+(as a function of wanderlust) explained later. @xref{Expire and Archive}.
+
@subsection How To Read
Basically, you can read messages only typing space key again and again.
@vindex wl-message-buffer-prefetch-folder-list
The initial setting is @code{nil}.
A list of regexp of folders to enable message prefetching.
+
+@item wl-message-buffer-prefetch-depth
+@vindex wl-message-buffer-prefetch-depth
+The initial setting is 3. The number of messages for automatical prefetch.
+
+@item wl-message-buffer-prefetch-idle-time
+@vindex wl-message-buffer-prefetch-idle-time
+The initial setting is 0.2 (in seconds). The period of automatical prefetch.
+
+@item wl-message-buffer-prefetch-threshold
+@vindex wl-message-buffer-prefetch-threshold
+The initial setting is 30000 (bytes). If prefetching message has larger
+size than this value, Wanderlust does not prefetch automatically.
+If @code{wl-message-buffer-prefetch-threshold} is @code{nil},
+the message is not checked for the size.
@end table
("^Wanderlust" . "+wl")
("^Elisp" . "+elisp"))
(("To" "Cc")
- ("\\([a-z]+\\)@@gohome.org" . "+\\1"))
+ ("\\([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
@example
@group
all ...Discard current summary and update all message.
+all-visible ...Discard current summary and update all visible 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).
+cache-status ...Sync the all marks with the real status of cache.
first, last ...Move to the filter folder(partial filter).
@end group
@end example
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 @samp{nobody@@nowhere?}. A string which is
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 @code{nil}, summary line's width is as is.
-
@item wl-summary-use-frame
@vindex wl-summary-use-frame
The initial setting is @code{nil}.
@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 @code{nil}. If non-nil, thread is split if
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
+@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.
+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
If a message is already marked as temporal marks in this list, the
message is skipped at cursor move.
-@item wl-fetch-confirm-threshold
-@vindex wl-fetch-confirm-threshold
+@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. If @code{nil}, the message is fetched without confirmation.
+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
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 @code{nil}, any messages are prefetched by buffer caching
-mechanism.
-
@item elmo-imap4-use-cache
@vindex elmo-imap4-use-cache
The initial setting is @code{t}. If non-nil, messages read via IMAP4
@lisp
@group
(setq wl-draft-config-alist
- '(((string-match "aaa.example.com$" (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.example.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)}
expression can be specified as is. If the car part is a header field
and the cdr part is @code{nil}, the field will be deleted.
+If you want to use name of parent folder, you can refer the buffer local
+variable @code{wl-draft-parent-folder}.
+
See the next example as well:
@lisp
(setq wl-template-alist
'(("default"
("From" . wl-from)
- ("Organization" . "~/.wl sample")
+ ("Organization" . "Example Co.Ltd.")
(body . "Hello.\n"))
("report"
(template . "default") ;; @r{(a)}
Enter Address Manager.
@xref{Address Manager}.
(@code{wl-addrmgr})
+
+@item C-c C-d
+@kindex C-c C-d (Draft)
+@findex wl-draft-elide-region
+Elide the text between point and mark (@code{wl-draft-elide-region}).
+The text is killed and replaced with the contents of the variable
+@code{wl-draft-elide-ellipsis}. The default value is to use an ellipsis
+(@samp{[...]}).
@end table
@section Customizable Variables
The initial setting is @code{t}. If non-nil, @samp{Message-ID:} field
is automatically inserted on the transmission.
+@item wl-message-id-use-wl-from
+@vindex wl-message-id-use-wl-from
+The initial setting is @code{nil}. If non-nil, the value of
+@code{wl-from} will be used as the domain part of @samp{Message-ID:}.
+
@item wl-local-domain
@vindex wl-local-domain
The initial setting is @code{nil}. If @code{nil}, the return value of
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 @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-unique-id-suffix
+@vindex wl-unique-id-suffix
+The initial setting is @samp{.wl}. You can specify the string in generated
+Message-ID which appear just before @samp{@@}.
@item wl-draft-config-alist
@vindex wl-draft-config-alist
@code{wl-summary-expire-reserve-marks}, be careful in writing your own
function.
-These are three standard functions; they moves messages to an archive
+These are four standard functions; three of them move messages to an archive
folder in the specified way. This means old messages can be compressed
and saved in a file, being deleted from the original folder.
+The last one divides messages to some MH folders.
@table @code
@item 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.
If you omit the argument, consecutive numbers from 1 are assigned for
each archiving folder.
+
+@item wl-expire-localdir-date
+divedes messages depending on its date (year and month) to MH folders
+e.g. to @samp{+ml/wl/1999_11/}, @samp{+ml/wl/1999_12/}.
+@end table
@end table
@subsection Treatment for Important or Unread Messages
@end lisp
If paths to the score files are omitted, the directory specified in the
-variable @code{wl-score-files-dir} is assumed.
+variable @code{wl-score-files-directory} is assumed.
No matter what you write in @code{wl-score-folder-alist}, the default
score file @code{wl-score-default-file} (@file{all.SCORE}) is always
The initial setting is t.
If non-nil, scoring is enabled.
-@item wl-score-files-dir
-@vindex wl-score-files-dir
+@item wl-score-files-directory
+@vindex wl-score-files-directory
The initial setting is @file{~/.elmo/}.
The default directory for score files.
(setq bbdb-use-pop-up t)
;; @r{auto collection}
(setq bbdb/mail-auto-create-p t)
+;; @r{exceptional folders against auto collection}
+(setq bbdb-wl-ignore-folder-regexp "^@@")
(setq signature-use-bbdb t)
(setq bbdb-north-american-phone-numbers-p nil)
;; @r{shows the name of bbdb in the summary} :-)
@lisp
@group
-(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)
+(autoload 'sc-cite-original "supercite" nil t)
+(add-hook 'mail-citation-hook 'sc-cite-original)
@end group
@end lisp
@menu
* x-face-xmas:: XEmacs case
-* x-face-mule:: Emacs 19.34, 20.x case
-* x-face-e21:: Emacs 21.x case
+* x-face-mule:: Emacs case
@end menu
If there is an encoded X-Face string in a file @file{~/.xface} (the
@end group
@end lisp
-@node x-face-mule, x-face-e21, x-face-xmas, X-Face
-@subsubsection x-face-mule (for Emacs 19.34, 20.x)
+@node x-face-mule, , x-face-xmas, X-Face
+@subsubsection x-face-mule (for Emacs)
@pindex x-face-mule
@pindex bitmap-mule
@end group
@end lisp
-@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/})
-with bitmap-mule (@uref{ftp://ftp.jpl.org/pub/elisp/bitmap/}),
-do the following:
+With Emacs 21.x, you can use @file{x-face-e21.el}
+(@uref{ftp://jpl.org/pub/elisp/}) instead of @file{x-face-mule.el}
+to display X-Face. In this case, bitmap-mule is not required.
+Do as follows:
@lisp
@group
-(require 'bitmap)
(autoload 'x-face-decode-message-header "x-face-e21")
(setq wl-highlight-x-face-function 'x-face-decode-message-header)
@end group
@item wl-auto-check-folder-name
@vindex wl-auto-check-folder-name
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.
+You can specify a folder or a group which is checked for unread message
+at the start. You can also specify a list of folders (groups) to be checked.
+If the value is @code{nil}, whole Desktop is checked at the start.
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
@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}.
+You can set a list of regular expressions to specify folders
+which are not automatically checked even if they are included
+in some groups assigned by @code{wl-auto-check-folder-name}.
@item wl-auto-check-folder-list
@vindex wl-auto-check-folder-list
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}.
-This takes precedence over @code{wl-auto-uncheck-folder-list}.
+You can set a list of regular expressions to specify exceptions
+for @code{wl-auto-uncheck-folder-list}.
@item wl-no-save-folder-list
@vindex wl-no-save-folder-list
11/08 Released 2.4.0 stable.
2001 7/04 Released 2.6.0 stable.
8/21 wl-addrmgr by Kitamoto-san.
+ 12/27 Released 2.8.1 stable.
@end example
See @file{ChangeLog} for details.
projects / elisp / wanderlust.git / blobdiff