Fixed.
[elisp/wanderlust.git] / doc / wl.texi
index c62a8ad..bcac64c 100644 (file)
@@ -495,10 +495,10 @@ The minimal requirement for settings is as the following.
 (autoload 'wl "wl" "Wanderlust" 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")
@@ -636,6 +636,26 @@ That means the folders you defined in the @file{~/.folders} are listed
 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
@@ -1566,7 +1586,7 @@ Format:
 @example
 @group
 'mark
-@r{or}
+'sendlog
 'cache/00 - 1F
 @end group
 @end example
@@ -1585,6 +1605,14 @@ message will have @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
@@ -2550,46 +2578,38 @@ 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.
+prefetches next message while you are reading.
 
 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 the list shown below:
-@lisp
-@group
-(nntp imap4)
-@end group
-@end lisp
-
-@noindent
-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
 @group
-(setq wl-cache-prefetch-folder-type-list
-      '(nntp imap4 localdir localnews))
+(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
+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
@@ -3305,6 +3325,7 @@ With prefix argument, it affects on the all messages in the thread tree.
 @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
@@ -3495,7 +3516,7 @@ folder is moved.
 @vindex  wl-summary-weekday-name-lang
 The initial setting is @samp{ja}.  Specify language of the weekday.
 @samp{en} displays English, @samp{fr} displays French, @samp{de}
-displays Deutsch.
+displays Deutsch. You should rescan summary view after changing this value.
 
 @item wl-summary-fix-timezone
 @vindex wl-summary-fix-timezone
@@ -3520,17 +3541,6 @@ The initial setting is '(1 . 4).
 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
@@ -3541,11 +3551,6 @@ displayed when there's no @samp{From:} 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 @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}.
@@ -3582,11 +3587,34 @@ 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 @code{nil}.  If non-nil, thread is split if
@@ -3620,10 +3648,16 @@ When you entered to summary by these commands and the target summary
 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
@@ -3659,11 +3693,17 @@ The initial setting is the list shown below:
 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
@@ -3679,13 +3719,6 @@ 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 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
@@ -3909,6 +3942,8 @@ Per default, there are 10 following sub-functions.
 '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
@@ -6135,13 +6170,8 @@ example of settings:
 
 @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
 
@@ -6222,13 +6252,11 @@ If you use @file{x-face-mule.el} in bitmap-mule
 @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/}),
+If you use @file{x-face-e21.el} (@uref{ftp://jpl.org/pub/elisp/}),
 do the following:
 
 @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