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