Applied patch from Tsuyoshi Kitamoto <tsuyoshi.kitamoto@city.sapporo.jp>.
[elisp/wanderlust.git] / doc / wl.texi
index b042065..3d72ae5 100644 (file)
@@ -5,7 +5,7 @@
 @c %**end of header
 @documentlanguage en
 @documentencoding us-ascii
-@set VERSION 2.5.8
+@include version.texi
 @synindex pg cp
 @finalout
 
@@ -152,7 +152,7 @@ The main features of Wanderlust:
 
 @section Environment
 
-Wanderlust is supposed to run on following Emacsen: 
+Wanderlust is supposed to run on following Emacsen:
 @c Wanderlust runs even on Nemacs 3.3.2 based on Emacs 18.55, 18.59 (with
 @c limited functionality).
 
@@ -173,15 +173,20 @@ 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, 2.0.5 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 4.0
+@item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
 @end itemize
 
-@c LDAP connectivity with following LDAPd are confirmed to work with
-@c Wanderlust:
+LDAP connectivity with following LDAPd are confirmed to work with
+Wanderlust:
+
+@itemize @bullet
+@item OpenLDAP 2.0.6 or later
+@end itemize
 
 
 @node Start Me Up, Folders, Introduction, Top
@@ -209,58 +214,12 @@ here.
 @cindex MIME modules
 @pindex APEL
 @pindex FLIM
+@pindex CLIME
 @pindex SEMI
 @pindex tm
 
-SEMI or tm must be installed to make Wanderlust work correctly.
-
-SEMI does not run on Emacs 19.28 or earlier
-@footnote{SEMI runs on Emacs 19.34. @*
-@uref{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.
-
-Refer to the documents of each package for detailed installation procedure.
-
-SEMI and tm can be downloaded from these sites:
-
-@example
-@group
-SEMI:   ftp://ftp.m17n.org/pub/mule/semi/
-tm:     http://cvs.m17n.org/tomo/comp/emacsen/tm/tm-8/
-@end group
-@end example
-
-You need packages named APEL and FLIM to use SEMI.
-You can download APEL and FLIM from following URLs:
-
-@example
-@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 following:
-
-@itemize @minus
-@item APEL 10.3, FLIM 1.14.2 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, the following combination are
-confirmed to work.
-
-@itemize @minus
-@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
+SEMI or tm must be installed to make Wanderlust work correctly.  Refer
+to the @file{INSTALL} for detailed installation procedure.
 
 You have to re-install Wanderlust if you upgraded APEL, FLIM, SEMI or
 tm.
@@ -305,8 +264,8 @@ Extract the obtained package to your working directory:
 @pindex OpenSSL
 @pindex starttls
 
-SSL (Secure Socket Layer) can be used for 
-SMTP, IMAP, NNTP and POP connections in Wanderlust.
+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
@@ -318,7 +277,7 @@ required to use @file{ssl.el}. 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
@@ -350,9 +309,9 @@ Then, please execute following commands.
 Destination directory is auto-probed if you leave @code{LISPDIR}
 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 @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28), 
-then you will see the error message:
+If you are using an Emacs variant which does not merge specified
+directory to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28), then
+you will see the error message:
 
 @example
 Cannot open load file: mime-setup
@@ -576,9 +535,9 @@ The format is very simple. Like this. @refill
 # @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"
+teranisi@@gohome.org            "YT"            "Yuuichi Teranishi"
+foo@@example.com                "Mr. Foo"       "John Foo"
+bar@@example.org                "Mr. Bar"       "Michael Bar"
 @end group
 @end example
 
@@ -762,12 +721,22 @@ You can omit the @var{hostname} from folder names if you set
 For example, you can specify a folder as @samp{foo%imap@@gateway} even
 if you have to go through a firewall.
 
+@lisp
+;; Example: imap4.exaple.org as main IMAP server
+(setq elmo-default-imap4-server "imap4.example.org")
+@end lisp
+
 SSL (Secure Socket Layer) connection will be used if a folder name ends
 with @samp{!}. Or, if the value of @code{elmo-default-imap4-stream-type}
-is non-nil, SSL will be the default connection.  If a folder name ends
-with @samp{!!}, STARTTLS connection will be established.  If the value
-of @code{elmo-default-imap4-stream-type} is @code{starttls}, STARTTLS
-will be the default connection.
+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-default-imap4-stream-type} is @code{starttls},
+STARTTLS will be the default connection.
+
+@lisp
+;; Example: Use SSL connection
+(setq elmo-default-imap4-stream-type 'ssl)
+@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
@@ -777,6 +746,11 @@ 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
+;; Example: password in raw format
+(setq elmo-default-imap4-authenticate-type 'clear)
+@end lisp
+
 Example:
 
 @example
@@ -1263,7 +1237,7 @@ Example:
 @end group
 @end example
 
-To use apop as an @var{authenticate-type}, @file{md5.el} is needed
+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
@@ -3423,8 +3397,10 @@ displays Deutsch.
 
 @item wl-summary-fix-timezone
 @vindex  wl-summary-fix-timezone
-The initial setting is @samp{JST}.  Timezone to adjust summary's
-timezone.  If @code{nil}, adjust to GMT.
+The initial setting is @samp{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
@@ -4253,8 +4229,8 @@ sent off-line.
 
 @item wl-draft-use-cache
 @vindex wl-draft-use-cache
-The initial setting is @code{nil}.
-If non-nil, cache the message which is sent.
+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-auto-flush-queue
 @vindex wl-auto-flush-queue
@@ -6763,6 +6739,7 @@ valuable advice and many pieces of code they contributed.
       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.
 @end example
 
 See @file{ChangeLog} for details.
@@ -6825,6 +6802,6 @@ U.S. Billboard magazines in 1980s.
 @contents
 @bye
 
-@c Local Variables: 
+@c Local Variables:
 @c fill-column: 72
 @c End: