(sendmail.el, smtpmail.el): Clarify relevant Emacs versions.
[gnus] / contrib / README
1 The files in this directory are not (yet) part of the Gnus
2 distribution proper.  They may later become part of the distribution,
3 or they may disappear altogether.
4
5 Please note that it is not good to just add this directory to
6 load-path: a number of files in this directory will become part of
7 more recent Emacs versions, so that you might be running obsolete
8 libraries with all kinds of ill effects.
9
10 The suggested method for installation is to copy those files that you
11 need to a directory which is in load-path.
12
13 Here is an overview of the files:
14
15 compface.el
16
17         Provides the ELisp-based uncompface program.  It is excellent
18         and practical (actually you can replace lisp/compface.el with
19         it), however the author is missing and the copyright has not
20         been assigned yet.
21
22 gnus-namazu.el
23
24         This file defines the command to search mails and persistent
25         articles with Namazu, which is a full-text search engine
26         distributed at http://namazu.org, and to browse its results
27         with Gnus.
28
29 gpg-ring.el
30 gpg.el
31
32 nnir.el
33
34         Interface to various full-text search engines.  Provides less
35         functionality than gnus-namazu.el, but also supports programs
36         other than Namazu.  Current implementation is restricted to
37         nnml folders, but could be extended for other backends.
38
39 one-line-cookie.diff
40
41 sendmail.el
42 smtpmail.el
43
44         Copies of the corresponding files from the Emacs lisp/mail/ directory,
45         to provide features (occasionally) needed by Gnus which may not be
46         provided by the versions of these files in older Emacs distributions
47         (Emacs < 22).  XEmacs users should NOT use this, since it doesn't work.
48         See the XEmacs mail-lib module instead.
49
50 ssl.el
51
52         Obsolete interface to OpenSSL.  Completely replaced by
53         lisp/tls.el, which supports both GnuTLS and OpenSSL.  This
54         file will be removed eventually.
55
56 ucs-tables.el
57
58         This file provides improved Unicode functionality.  It defines
59         functions unify-8859-on-encoding-mode and
60         unify-8859-on-decoding-mode which unify the Latin-N charsets.
61         Without unify-8859-on-encoding-mode, composing a Latin-9 reply
62         to a Latin-1 posting, say, will produce a multipart posting (a
63         Latin-1 part and a Latin-9 part), or perhaps UTF-8.  With
64         unify-8859-on-encoding-mode, the outgoing posting can be all
65         Latin-1 or all Latin-9 in most cases.
66
67         It is harmless to turn on unify-8859-on-encoding-mode, but
68         unify-8859-on-decoding-mode may unexpectedly change files in
69         certain situations.  (If the file contains different Latin-N
70         charsets which should not be unified.)
71
72         This is part of Emacs 21.3 and later, which also turns on
73         unify-8859-on-encoding-mode by default.
74
75 vcard.el
76
77 xml.el
78
79         This is used for parsing RSS feeds.  Part of Emacs 21.3 and later.
80         Note that the version of this file in the Gnus contrib/ directory is
81         out of date with respect to the version in the Emacs tree.