(wl-summary-create-line): Bind variable `entity' for backward compatibility.
[elisp/wanderlust.git] / doc / wl.texi
index 6292bb4..ac3e422 100644 (file)
@@ -162,7 +162,7 @@ The main features of Wanderlust:
 
 @section Environment
 
-Wanderlust is supposed to run on following Emacsen:
+We confirm Wanderlust works on following Emacsen:
 
 @itemize @bullet
 @item Mule 2.3 based on Emacs 19.34
@@ -220,9 +220,9 @@ here.
 @pindex FLIM
 @pindex SEMI
 
-SEMI must be installed to make Wanderlust work correctly.
+You must install SEMI beforehand to use Wanderlust.
 
-SEMI can be downloaded from these sites:
+SEMI can be downloaded from following site:
 
 @example
 @group
@@ -492,14 +492,14 @@ The minimal requirement for settings is as the following.
 (require 'mime-setup)
 
 ;; @r{autoload configuration}
-;; @r{(These are not required if Wanderlust is installed as XEmacs package)}
+;; @r{(Not required if you have installed Wanderlust 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.}
 ;; @r{Default: the peculiar value to the running version of Emacs.}
-;; @r{(This is not required if the default value has been set properly)}
+;; @r{(Not required if the default value points properly)}
 (setq wl-icon-directory "~/work/wl/etc")
 
 ;; @r{SMTP server for mail posting. Default: @code{nil}}
@@ -665,8 +665,8 @@ Details of each ones are explained later.
 
 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.
+Wanderlust uses ELMO as it's interface, so you can use every folder types
+supported by ELMO.
 
 As of version @value{VERSION}, 11 types of folders are predefined. These are
 IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, Multi, Filter,
@@ -1623,13 +1623,13 @@ For example, if you specify following
 @end example
 
 @noindent
-and access it, messages are downloaded automatically from
-@samp{&username@@popserver} to @samp{+inbox}.
+and access it, Wanderlust downloads messages from
+@samp{&username@@popserver} to @samp{+inbox} automatically.
 
 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.
+source-folder). At the next time you access that folder, copies new
+messages only.
 
 @example
 @samp{|} @var{source-folder} @samp{|:} @var{destination-folder}
@@ -2090,7 +2090,7 @@ For example, if you specify
 @end lisp
 
 @noindent
-such access group hierarchy is obtained.
+you obtain the access group hierarchy as follows.
 
 @example
 @group
@@ -2165,9 +2165,9 @@ To append new folder to the empty folder group
 (after you create folder group by typing @kbd{m g}),
 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.
+the folder group above. It is difficult to explain by words so try it.
 In other words, appended position depends on the
-above folder group's open/close status.
+open/close status of the upper one.
 
 @subsubsection Charset of the Folders File.
 
@@ -2808,8 +2808,8 @@ 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 @var{target} part, you can refer matched substring of @var{regexp}.
-To refer substring, specify following in @var{target}:
+You can refer matched substring of @var{regexp} to specify @var{target} part.
+To refer substring, use following keys:
 
 @table @samp
 @item \&
@@ -3568,6 +3568,19 @@ That is, @samp{*} marks on the messages are remained
 if the specified condition is satisfied.
 (@code{wl-summary-target-mark-pick})
 
+@item m #
+@kindex m # (Summary)
+@findex wl-summary-target-mark-print
+Print out all messages which have target mark @samp{*}.
+(@code{wl-summary-target-mark-print})
+
+@item m |
+@kindex m | (Summary)
+@findex wl-summary-target-mark-pipe
+Pipe content of each message with target mark @samp{*} to some specified
+external process.
+(@code{wl-summary-target-mark-pipe})
+
 @item M-t
 @kindex M-t (Summary)
 @findex wl-toggle-plugged
@@ -4847,9 +4860,10 @@ re-filed or copied to the specified folders are appended to the folder
 @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,
-if folders failed to be created on the servers for any reasons, messages
-re-filed to such folders are appended to the folder @samp{+lost+found}.
+reflected in the servers when Wanderlust becomes on-line.  If the creation
+of those folders fails at that time for some reasons, messages
+to be re-filed into those are appended to the folder @samp{+lost+found}
+instead.
 
 
 @node Marking, Pre-fetching Reservations, Creation of Folders, Enable Operations
@@ -6271,7 +6285,8 @@ Examples with other packages.
 
 @menu
 * imput::                       imput (im-wl.el)
-* BBDB::                        BBDB
+* BBDB::                        The Insidious Big Brother Database
+* LSDB::                        The Lovely Sister Database
 * supercite::                   supercite.el
 * mu-cite::                     mu-cite.el
 * X-Face::                      x-face,bitmap-mule
@@ -6301,7 +6316,7 @@ If @command{imput} is on the @code{exec-path} at the installation,
 @end lisp
 
 
-@node BBDB, supercite, imput, Living with other packages
+@node BBDB, LSDB, imput, Living with other packages
 @subsection bbdb.el
 @pindex BBDB
 
@@ -6337,7 +6352,27 @@ You can complete address with BBDB by @kbd{M-@key{TAB}}
 in draft buffer.
 
 
-@node supercite, mu-cite, BBDB, Living with other packages
+@node LSDB, supercite, BBDB, Living with other packages
+@subsection lsdb.el
+@pindex LSDB
+
+The following is an example of settings:
+
+@lisp
+@group
+(require 'lsdb)
+(lsdb-wl-insinuate)
+(add-hook 'wl-draft-mode-hook
+          (lambda ()
+             (define-key wl-draft-mode-map "\M-\t" 'lsdb-complete-name)))
+@end group
+@end lisp
+
+In this example, bind @kbd{M-@key{TAB}} to @code{lsdb-complete-name}
+(complete address with LSDB).
+
+
+@node supercite, mu-cite, LSDB, Living with other packages
 @subsection sc.el(supercite), sc-register.el
 @pindex sc
 @pindex supercite
@@ -6976,10 +7011,7 @@ If you do not want verbose @samp{User-Agent:} field, do the following:
 @lisp
 @group
 (setq wl-generate-mailer-string-function
-      (function
-       (lambda ()
-         (concat "User-Agent: "
-                 (wl-generate-user-agent-string-1 nil)))))
+      'wl-generate-user-agent-string-1)
 @end group
 @end lisp
 
@@ -6987,11 +7019,10 @@ The following is a example:
 
 @lisp
 @group
-(setq mime-edit-insert-user-agent-field nil)
-(setq wl-generate-mailer-string-function
-      (function
-       (lambda ()
-         (format "X-Mailer: %s" (product-string-1 'wl-version)))))
+(setq wl-generate-mailer-string-function nil)
+(setq wl-draft-additional-header-alist
+      (list
+       (cons 'X-Mailer (lambda () (product-string-1 'wl-version)))))
 @end group
 @end lisp