X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=doc%2Fwl.texi;h=23636336a5f6a2990fc98921d3142c3182aae492;hb=1aea60c398450e878e3d35bd4b03f003c9858ef5;hp=b6dae65c7dc11f11be6952cebde584e7453260cb;hpb=e22cc6adeeb5e455b5b0264508801555b1d965b5;p=elisp%2Fwanderlust.git diff --git a/doc/wl.texi b/doc/wl.texi index b6dae65..2363633 100644 --- a/doc/wl.texi +++ b/doc/wl.texi @@ -145,7 +145,7 @@ The main features of Wanderlust: @item Manages unread messages. @item Interactive thread display. @item Folder Mode shows the list of subscribed folders. -@item Message Cache, Disconnected Operation (Read Only). +@item Message Cache, Disconnected Operation. @item MH-like FCC. (Fcc: %Backup and Fcc: $Backup is allowed). @item MIME compliant (by SEMI). @item Transmission of news and mail are unified by Message transmitting draft. @@ -254,7 +254,7 @@ may help you.}. Recommended combination of APEL, FLIM and SEMI are following: @itemize @minus -@item APEL 10.4, FLIM 1.14.4 and SEMI 1.14.5 +@item APEL 10.6, FLIM 1.14.6 and SEMI 1.14.6 @end itemize You can also use many other FLIM/SEMI variants. Combination of the @@ -262,8 +262,8 @@ latest versions should work. For example, the following combination are confirmed to work. @itemize @minus -@item APEL 10.4, SLIM 1.14.9, SEMI 1.14.5 -@item APEL 10.4, CLIME 1.14.5, EMIKO 1.14.1 +@item APEL 10.6, SLIM 1.14.9, SEMI 1.14.5 +@item APEL 10.6, CLIME 1.14.5, EMIKO 1.14.1 @end itemize You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI. @@ -284,12 +284,10 @@ Mirrored ftp/http sites: @example @group -ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/ +@c ftp://ftp.jaist.ac.jp/pub/GNU/elisp/ftp.gohome.org/wl/ 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 @@ -672,9 +670,9 @@ This chapter describes the folder types which Wanderlust is able to handle. 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, -Pipe and Internal folder types. +As of version @value{VERSION}, 13 types of folders are predefined. These +are IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP, +Shimbun, Namazu, Multi, Filter, Pipe and Internal folder types. @menu * IMAP Folder:: @samp{%} -- IMAP folder @@ -1653,25 +1651,22 @@ Format: @example @group -'mark -'sendlog -'cache/00 - 1F +@samp{'flag} [@samp{/} @var{global-flag}] +@samp{'sendlog} +@samp{'cache/00} - @samp{'cache/1F} @end group @end example -A folder named @samp{'mark} is a special virtual folder which collects -messages which have important mark @samp{$}. +A folder named @samp{'flag} is a special virtual folder which collects +messages which have @var{global-flag}. -You can review important messages at once after you put important marks -on the messages in the different folders. +Now, @samp{important} flag is supported as @var{global-flag}. You can +review important messages at once after you put important marks on the +messages in the different folders. -In this folder, if you delete message, important mark @samp{$} put on -the message is removed. If you append messages to this folder, the -message will have @samp{$} mark. - -(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.) +In this folder, if you delete message, @var{global-flag} put on the +message is removed. If you append messages to this folder, the message +will have @var{global-flag}. A folder named @samp{'sendlog} is a virtual folder which collects @@ -1905,7 +1900,7 @@ Flush queue. @item V @kindex V (Folder) @findex wl-folder-virtual -Move to the virtual folder with the condition specified. +Move to the virtual folder (filter folder) with the condition specified. (@code{wl-folder-virtual}) @item ? @@ -2544,7 +2539,7 @@ message has empty subject field. @cindex Mark, Temporary There are four temporary marks, -@samp{*}, @samp{D}, @samp{o} and @samp{O}. +@samp{*}, @samp{d}, @samp{D}, @samp{o}, @samp{O}, @samp{i} and @samp{~}. Temporary marks indicates message operations. @table @samp @@ -2553,8 +2548,11 @@ Target mark. You can execute a command on the all messages that have @samp{*} mark, with the key bindings which begins with @kbd{m}. +@item d +The mark to dispose. You can put @samp{d} by typing @kbd{d} key. + @item D -The mark to delete. You can put @samp{D} by typing @kbd{d} key. +The mark to force delete. You can put @samp{D} by typing @kbd{D} key. @item o The mark to refile. @@ -2566,14 +2564,23 @@ The mark to refile. You can put this mark by typing @kbd{O} key. The difference between this mark and refile mark is, this mark does not delete the message while latter does. + +@item i +The mark to prefetch reserved. +You can put this mark by typing @kbd{i} key. + +@item ~ +The mark to resend reserved. +After you type @kbd{~} key, prompt appears to input address to resend. +Your answer is printed in the summary line. @end table -@kbd{x} key executes @samp{D}, @samp{o} and @samp{O} marks. +@kbd{x} key executes action for temporary marks, respectively. @subsection Persistent Marks -There are five persistent marks, -@samp{N}, @samp{U}, @samp{!}, @samp{u} and @samp{$}. +There are five persistent marks, @samp{N}, @samp{?}, @samp{U}, @samp{!}, +@samp{u}, @samp{A}, @samp{&} and @samp{$}. The persistent mark indicates the message's status and it is saved. Each persistent mark indicates: @@ -2581,12 +2588,18 @@ Each persistent mark indicates: @table @samp @item N It is new message. +@item ? +It is new but cached message. @item U It is unread message. @item ! It is unread but cached message. @item u It is read but it is not cached. +@item A +It is already replied message. +@item & +It is already replied but cached message. @item $ It is important message. You can put @samp{$} mark by typing @kbd{$} key (if already exists, the mark is deleted). It is convenient to put @@ -2600,9 +2613,10 @@ If the message is read and cached (or local message),there are no persistent mark. @end table -@samp{N}, @samp{U} and @samp{u} indicates that the message have 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. +@samp{N}, @samp{U}, @samp{u}, @samp{A} indicates that the message have +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 @@ -3094,7 +3108,7 @@ A draft for forwarding the message at current cursor point is prepared. @kindex $ (Summary) @findex wl-summary-mark-as-important Put @samp{$} mark on the message at current cursor point. -If already marked as @samp{$}, delete it. +If already marked as @samp{$}, remove the mark. (@code{wl-summary-mark-as-important}) @item y @@ -3268,18 +3282,29 @@ Mark as unread the message at current cursor point. @item s @kindex s (Summary) @findex wl-summary-sync -Synchronize summary view after prompting the update range -(@samp{all}, @samp{update}, @samp{rescan}, @samp{first}, @samp{last}). +Synchronize summary view after prompting the update range. +You can specify one of the follows. @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). +all Discard present msgdb and retrieve all informations. + Do not retrieve killed messages. +all-entirely Discard present msgdb and retrieve all informations. + Retrieve killed messages, too. +update Update the difference between informations in present + msgdb and in current folder instance. + Do not retrieve killed messages. +update-entirely Update the difference between informations in present + msgdb and in current folder instance. + Retrieve killed messages, too. +rescan Redisplay summary by rescanning present msgdb. +rescan-noscore Redisplay summary by rescanning present msgdb. + Display messages killed by score, too. +cache-status Sync the all marks with the real status of cache. +mark Update marks. +no-sync Do nothing. +first:NUM Move to the filter folder(partial filter). +last:NUM Move to the filter folder(partial filter). @end group @end example @@ -3296,7 +3321,9 @@ You can sort by @samp{date}, @samp{from}, @samp{number} and @samp{subject}. @item T @kindex T (Summary) @findex wl-summary-toggle-thread -Toggle the threading. +Toggle the threading. The state will be preserved after exiting +Wanderlust. You can alter default state for newly created summary +by @code{wl-summary-default-view} or @code{wl-summary-default-view-alist}. Threading status is displayed on the modeline. @samp{@{S@}} means threading is off (Sequence) and @samp{@{T@}} means threading is on (Thread). @@ -3316,7 +3343,7 @@ Toggle displaying of message window. @item V @kindex V (Summary) -Move to the virtual folder with the condition specified. +Move to the virtual folder (filter folder) with the condition specified. If called with prefix argument and current folder is virtual, exit it. @findex wl-summary-virtual (@code{wl-summary-virtual}) @@ -3339,16 +3366,9 @@ Put @samp{*} mark on the messages that satisfies the specified condition. Mark as read the message at the current cursor point. (@code{wl-summary-mark-as-read}) -@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 x @kindex x (Summary) -Execute @samp{D}, @samp{o} and @samp{O} marks. +Execute action for all temporary marks in the summary buffer. @findex wl-summary-exec (@code{wl-summary-exec}) @@ -3385,10 +3405,30 @@ previously specified. @item d @kindex d (Summary) +@findex wl-summary-dispose +Put disposal mark on the message at the current cursor point. +The result of disposal is controlled by @code{wl-dispose-folder-alist}, +refiled to @code{wl-trash-folder} by default. +(@code{wl-summary-dispose}) + +@item D +@kindex D (Summary) @findex wl-summary-delete -Put delete mark on the message at the current cursor point. +Put force deletion mark on the message at the current cursor point. (@code{wl-summary-delete}) +@item i +@kindex i (Summary) +Put prefetch reservation mark on the message at the current cursor point. +@findex wl-summary-prefetch +(@code{wl-summary-prefetch}) + +@item ~ +@kindex ~ (Summary) +@findex wl-summary-resend +Put resend reservation mark on the message at the current cursor point. +(@code{wl-summary-resend}) + @item u @kindex u (Summary) @findex wl-summary-unmark @@ -3411,7 +3451,7 @@ Mark as read messages in the specified region. @kindex r $ (Summary) @findex wl-summary-mark-as-important-region Mark as important @samp{$} messages in the specified region. -If @samp{$} already exists, it is deleted. +If @samp{$} mark already exists, remove the mark. (@code{wl-summary-mark-as-important-region}) @item r ! @@ -3420,16 +3460,10 @@ If @samp{$} already exists, it is deleted. Mark as unread messages in the specified region. (@code{wl-summary-mark-as-unread-region}) -@item r i -@kindex r i (Summary) -@findex wl-summary-prefetch-region -Prefetch messages in the specified region. -(@code{wl-summary-prefetch-region}) - @item r x @kindex r x (Summary) @findex wl-summary-exec-region -Execute @samp{D}, @samp{o} and @samp{O} marks on the messages in the +Execute action for each temporary marks on the messages in the specified region. (@code{wl-summary-exec-region}) @@ -3453,9 +3487,15 @@ Put copy mark on the messages in the specified region. @item r d @kindex r d (Summary) -@findex wl-summary-delete-region -Put delete mark on the messages in the specified region. -(@code{wl-summary-delete-region}) +@findex wl-summary-dispose-region +Put disposal mark on the messages in the specified region. +(@code{wl-summary-dispose-region}) + +@item r i +@kindex r i (Summary) +@findex wl-summary-prefetch-region +Put prefetch reservation mark on messages in the specified region. +(@code{wl-summary-prefetch-region}) @item r u @kindex r u (Summary) @@ -3481,7 +3521,7 @@ With prefix argument, it affects on the all messages in the thread tree. @findex wl-thread-mark-as-important Put important mark @samp{$} on the messages which are the descendant of the current thread. -If @samp{$} mark exists, it is deleted. +If @samp{$} mark exists, remove the mark. With prefix argument, it affects on the all messages in the thread tree. (@code{wl-thread-mark-as-important}) @@ -3492,17 +3532,10 @@ Mark as unread messages which are the descendant of the current thread. With prefix argument, it affects on the all messages in the thread tree. (@code{wl-thread-mark-as-unread}) -@item t i -@kindex t i (Summary) -@findex wl-thread-prefetch -Prefetch messages which are the descendant of the current thread. -With prefix argument, it affects on the all messages in the thread tree. -(@code{wl-thread-prefetch}) - @item t x @kindex t x (Summary) @findex wl-thread-exec -Execute @samp{D}, @samp{o} and @samp{O} marks on the messages which are +Execute action for temporary marks on the messages which are the descendant of the current thread. With prefix argument, it affects on the all messages in the thread tree. (@code{wl-thread-exec}) @@ -3531,10 +3564,17 @@ With prefix argument, it affects on the all messages in the thread tree. @item t d @kindex t d (Summary) -@findex wl-thread-delete -Put delete mar on the messages which are the descendant of the current thread. +@findex wl-thread-dispose +Put disposal 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. -(@code{wl-thread-delete}) +(@code{wl-thread-dispose}) + +@item t i +@kindex t i (Summary) +@findex wl-thread-prefetch +Put prefetch reservation mark on messages which are the descendant of +the current thread. +(@code{wl-thread-prefetch}) @item t u @kindex t u (Summary) @@ -3551,13 +3591,6 @@ Save messages which are the descendant of the current thread. With prefix argument, it affects on the all messages in the thread tree. (@code{wl-thread-save}) -@item m i -@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 @kindex m R (Summary) @findex wl-summary-target-mark-mark-as-read @@ -3568,7 +3601,7 @@ Mark as read all messages which have target mark @samp{*}. @kindex m $ (Summary) @findex wl-summary-target-mark-mark-as-important Mark as important all messages which have target mark @samp{*}. -If already marked as @samp{$}, it is deleted. +If already marked as @samp{$}, remove the mark. (@code{wl-summary-target-mark-mark-as-important}) @item m ! @@ -3591,9 +3624,15 @@ Put copy mark on the messages which have target mark @samp{*}. @item m d @kindex m d (Summary) -@findex wl-summary-target-mark-delete -Put delete mark on the messages which have target mark @samp{*}. -(@code{wl-summary-target-mark-delete}) +@findex wl-summary-target-mark-dispose +Put disposal mark on the messages which have target mark @samp{*}. +(@code{wl-summary-target-mark-dispose}) + +@item m i +@kindex m i (Summary) +@findex wl-summary-target-mark-prefetch +Put prefetch reservation mark on messages which have target mark @samp{*}. +(@code{wl-summary-target-mark-prefetch}) @item m y @kindex m y (Summary) @@ -3664,12 +3703,6 @@ Pipe content of each message with target mark @samp{*} to some specified external process. (@code{wl-summary-target-mark-pipe}) -@item D -@kindex D (Summary) -@findex wl-summary-erase -Actually erase the message at once, without moving it to trash. -(@code{wl-summary-erase}) - @item M-t @kindex M-t (Summary) @findex wl-toggle-plugged @@ -3770,7 +3803,7 @@ folder is moved. @item wl-summary-weekday-name-lang @vindex wl-summary-weekday-name-lang -The initial setting is @samp{ja}. Specify language of the weekday. +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. @@ -3797,16 +3830,38 @@ 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-from-function +@vindex wl-summary-from-function +Format function to display sender in summary. +The initial setting is @code{wl-summary-default-from}. + @item wl-summary-no-from-message @vindex wl-summary-no-from-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-subject-function +@vindex wl-summary-subject-function +Format function to display subject in summary. +The initial setting is @code{wl-summary-default-subject} and +it will cut the list name part etc. on the top of the subject. +To display subject as it is, set as follows. + +@lisp +(setq wl-summary-subject-function 'identity) +@end lisp + @item wl-summary-no-subject-message @vindex wl-summary-no-subject-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-default-view +@vindex wl-summary-default-view +The initial setting is @code{'thread}. +The default state for newly created summary. You can set either +@code{'thread} for thread view or @code{'sequence} for sequential view. + @item wl-summary-use-frame @vindex wl-summary-use-frame The initial setting is @code{nil}. @@ -3848,6 +3903,12 @@ want to aware of reading direction, set this to @code{t}. The initial setting is 80. Width of summary line. If @code{nil}, summary line's width is as is. +@item wl-summary-print-argument-within-window +@vindex wl-summary-print-argument-within-window +The initial setting is @code{nil}. +If non-nil, the action argument is always printed on right side of +window. + @item wl-summary-from-width @vindex wl-summary-from-width The initial setting is 17. @@ -3861,6 +3922,12 @@ indent level. If you set this to @code{nil} you should set @code{wl-summary-width} to @code{nil}, too. +@item wl-summary-max-thread-depth +@vindex wl-summary-max-thread-depth +The initial setting is 15. +If thread depth of the message is larger than this value, +the thread is divided. + @item wl-summary-recenter @vindex wl-summary-recenter The initial setting is t. @@ -3922,7 +3989,7 @@ The initial setting is the list shown below: @lisp @group -("o" "O" "D") +("o" "O" "D" "d" "i") @end group @end lisp @@ -3936,7 +4003,7 @@ The initial setting is the list shown below: @lisp @group -("D") +("D" "d") @end group @end lisp @@ -4252,7 +4319,7 @@ The format of @code{wl-draft-config-alist} is: @end group @end example -Per default, there are 10 following sub-functions. +Per default, there are 13 following sub-functions. @example 'header: Inserts the specified string at the bottom of the header. @@ -5593,7 +5660,8 @@ The initial setting is the list below. @lisp @group (list wl-summary-important-mark - wl-summary-new-mark + wl-summary-new-uncached-mark + wl-summary-new-cached-mark wl-summary-unread-mark wl-summary-unread-uncached-mark wl-summary-unread-cached-mark) @@ -6115,7 +6183,8 @@ The initial setting is the list shown below: @lisp @group -(list wl-summary-new-mark) +(list wl-summary-new-uncached-mark + wl-summary-new-cached-mark) @end group @end lisp @@ -6352,18 +6421,27 @@ pop3 N E E E @chapter Message splitting @cindex Split messages -You can use @code{elmo-split} to split message in folder -@code{elmo-split-folder} a la @command{procmail} according to some -specified rules. To use this feature, set as follows in your +You can use @code{elmo-split} to split message in folder specified by +the variable @code{elmo-split-folder} a la @command{procmail} according +to some specified rules. To use this feature, set as follows in your @file{~/.emacs} at first. @lisp (autoload 'elmo-split "elmo-split" "Split messages on the folder." t) @end lisp +Set source folder like following. + +@lisp +(setq elmo-split-folder "%inbox") +@end lisp + +And specify the rule in the variable @code{elmo-split-rule} (its format +will be is described below). Then you can invoke @kbd{M-x elmo-split} to split messages according to @code{elmo-split-rule}. On the other hand, invoke @kbd{C-u M-x elmo-split} -to do a rehearsal (do not split actually). +to do a rehearsal and show result (do not split actually). + We will describe how to specify the rule. First of all, see following example, please. @@ -6432,7 +6510,7 @@ from matching @code{\(\)} patterns in the previous @samp{VALUE}. @end table @item -Functions which accept an argument @samp{SIZE}, @samp{SIZE} is some number. +Functions which accept an integer argument (@samp{SIZE}). @table @code @item @code{<} @@ -6500,6 +6578,7 @@ summary displayed with nicknames. * Address Manager:: Address Manager @end menu + @node Mail Addresses, Address Manager, Address Book, Address Book @section Address book @cindex Address book Definition @@ -7415,6 +7494,13 @@ If non-nil, you are asked for confirmation when Wanderlust terminates. The initial setting is @code{t}. If non-nil, you are asked for confirmation when mail is sent. +@item wl-default-sync-range +@vindex wl-default-sync-range +The initial setting is @samp{update}. +Default update range of the summary. You can specify +@samp{all}, @samp{update}, @samp{rescan} or @samp{no-sync}. +See description of @code{wl-summary-sync} for the meaning of ranges. + @item wl-folder-sync-range-alist @vindex wl-folder-sync-range-alist The initial setting is the alist shown below: @@ -7429,8 +7515,10 @@ The initial setting is the alist shown below: @noindent This is an associative list of regular expressions of folder names and 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. +@samp{update}, @samp{rescan} or @samp{no-sync}. If the folder do not +match any of them, the value of @code{wl-default-sync-range} is used +(@samp{update} by default). +See description of @code{wl-summary-sync} for the meaning of ranges. @item wl-ask-range @vindex wl-ask-range @@ -7787,6 +7875,7 @@ valuable advice and many pieces of code they contributed. 2001 7/04 Released 2.6.0 stable. 8/21 wl-addrmgr by Kitamoto-san. 12/27 Released 2.8.1 stable. +2002 12/11 Released 2.10.0 stable. @end example See @file{ChangeLog} for details.