Merge the t-gnus-6_17-quimby branch.
[elisp/gnus.git-] / 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         Please note, this file has already been incorporated into the
30         lisp directory in T-gnus.
31
32 gpg-ring.el
33 gpg.el
34
35 hashcash.el
36
37 nnir.el
38
39         Interface to various full-text search engines.  Provides less
40         functionality than gnus-namazu.el, but also supports programs
41         other than Namazu.  Current implementation is restricted to
42         nnml folders, but could be extended for other backends.
43
44 one-line-cookie.diff
45
46 sendmail.el
47 smtpmail.el
48
49         Copies of the corresponding files from the Emacs lisp/mail/
50         directory, to provide features (occasionally) needed by Gnus which
51         may not be provided by the versions of these files in older Emacs
52         distributions.
53
54 ssl.el
55
56         Obsolete interface to OpenSSL.  Completely replaced by
57         lisp/tls.el, which supports both GnuTLS and OpenSSL.  This
58         file will be removed eventually.
59
60 ucs-tables.el
61
62         This file provides improved Unicode functionality.  It defines
63         functions unify-8859-on-encoding-mode and
64         unify-8859-on-decoding-mode which unify the Latin-N charsets.
65         Without unify-8859-on-encoding-mode, composing a Latin-9 reply
66         to a Latin-1 posting, say, will produce a multipart posting (a
67         Latin-1 part and a Latin-9 part), or perhaps UTF-8.  With
68         unify-8859-on-encoding-mode, the outgoing posting can be all
69         Latin-1 or all Latin-9 in most cases.
70
71         It is harmless to turn on unify-8859-on-encoding-mode, but
72         unify-8859-on-decoding-mode may unexpectedly change files in
73         certain situations.  (If the file contains different Latin-N
74         charsets which should not be unified.)
75
76         This is part of Emacs 21.3 and later, which also turns on
77         unify-8859-on-encoding-mode by default.
78
79 vcard.el
80
81 xml.el
82
83         This is used for parsing RSS feeds.  Part of Emacs 21.3 and later.
84         Note that the version of this file in the Gnus contrib/ directory is
85         out of date with respect to the version in the Emacs tree.