Synch to No Gnus 200601260917.
[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 ssl.el
47
48         Obsolete interface to OpenSSL.  Completely replaced by
49         lisp/tls.el, which supports both GnuTLS and OpenSSL.  This
50         file will be removed eventually.
51
52 ucs-tables.el
53
54         This file provides improved Unicode functionality.  It defines
55         functions unify-8859-on-encoding-mode and
56         unify-8859-on-decoding-mode which unify the Latin-N charsets.
57         Without unify-8859-on-encoding-mode, composing a Latin-9 reply
58         to a Latin-1 posting, say, will produce a multipart posting (a
59         Latin-1 part and a Latin-9 part), or perhaps UTF-8.  With
60         unify-8859-on-encoding-mode, the outgoing posting can be all
61         Latin-1 or all Latin-9 in most cases.
62
63         It is harmless to turn on unify-8859-on-encoding-mode, but
64         unify-8859-on-decoding-mode may unexpectedly change files in
65         certain situations.  (If the file contains different Latin-N
66         charsets which should not be unified.)
67
68         This is part of Emacs 21.3 and later, which also turns on
69         unify-8859-on-encoding-mode by default.
70
71 vcard.el
72
73 xml.el
74
75         This is used for parsing RSS feeds.  Part of Emacs 21.3 and
76         later.