1This is jabber.el 0.8.92, a Jabber client for Emacs. Jabber (also known
2as XMPP) is an instant messaging system; see http://www.jabber.org for
3more information.
4
5Home page: http://emacs-jabber.sourceforge.net
6Project page: http://sourceforge.net/projects/emacs-jabber
7Wiki page: http://www.emacswiki.org/cgi-bin/wiki/JabberEl
8Mailing list: http://lists.sourceforge.net/lists/listinfo/emacs-jabber-general
9and: http://dir.gmane.org/gmane.emacs.jabber.general
10MUC room: jabber.el@conference.jabber.se and emacs@conference.jabber.ru (Russian, English)
11
12GNU Emacs
13=========
14
15jabber.el runs on GNU Emacs 23.1 or later.
16
17The file hexrgb.el (http://www.emacswiki.org/emacs/hexrgb.el) is
18needed for MUC nick coloring feature. A copy is located in the compat
19directory, and used if the configure script doesn't find another copy
20already installed.
21
22XEmacs
23======
24
25You need an XEmacs with Mule support, and recent versions of the gnus,
26net-utils and mule-ucs packages. jabber.el basically works on XEmacs,
27but some features are missing (in particular mouse support). Testing
28and patches are very welcome.
29
30Encrypted connections
31=====================
32Many Jabber servers require encrypted connections, and even if yours
33doesn't it may be good idea. To get an encrypted connection, the most
34convenient option is to use GNU Emacs 24 with GnuTLS support compiled
35in. You can check whether you have that by typing:
36
37M-: (gnutls-available-p)
38
39If that commands shows `t' in the echo area, then you have working
40GnuTLS support. If it shows `nil' or signals an error, then you
41don't.
42
43Failing that, jabber.el will use the starttls.el library, which
44requires that the GnuTLS command line tool "gnutls-cli" is installed.
45In Debian-based distributions, "gnutls-cli" is in the "gnutls-bin"
46package.
47
48The above applies to STARTTLS connections, the most common way to
49encrypt a Jabber connection and the only one specified in the
50standards. STARTTLS connections start out unencrypted, but switch to
51encrypted after negotiation. jabber.el also supports connections that
52are encrypted from start. For this it uses the tls.el library, which
53requires either "gnutls-cli" or the OpenSSL command line tool
54"openssl" to be installed.
55
56To use the latter form of encryption, customize jabber-account-list.
57
58Note that only the connection from you to the server is encrypted;
59there is no guarantee of connections from your server to your
60contacts' server being encrypted.
61
62Installation
63============
64jabber.el can be installed using the commands:
65./configure
66make
67make install
68
69You can specify which emacs you want to use:
70./configure EMACS=emacs-or-xemacs-21.4
71
72You can also install jabber.el by hand. Put all .el files somewhere
73in your load-path, or have your load-path include the directory
74they're in. To install the Info documentation, copy jabber.info to
75/usr/local/info and run "install-info /usr/local/info/jabber.info".
76
77After installation by either method, add (load "jabber-autoloads") to
78your .emacs file. (If you got the code from GIT, you still need the
79makefile to generate jabber-autoloads.el.)
80
81If you are upgrading from 0.7-0.7.x, you need to update your
82configuration. See the section "Account settings" in the manual.
83
84Special notes for GIT version
85=============================
86If you are running jabber.el from GIT, you need to generate the
87jabber-autoloads.el file yourself. The simplest way to do this is by
88using the "./configure && make" process.
89
90To generate the configure script, make sure that autoconf and automake
91are installed and run "autoreconf -i".
92
93Usage
94=====
95
96To connect to a Jabber server, type C-x C-j C-c (or equivalently M-x
97jabber-connect-all) and enter your JID. With prefix argument,
98register a new account. You can set your JID permanently with M-x
99jabber-customize.
100
101Your roster is displayed in a buffer called *-jabber-*. To
102disconnect, type C-x C-j C-d or M-x jabber-disconnect.
103
104You may want to use the menu bar to execute Jabber commands. To
105enable the Jabber menu, type M-x jabber-menu.
106
107For a less terse description, read the enclosed manual.
108
109For bug reports, help requests and other feedback, use the trackers
110and forums at the project page mentioned above.
111
112Configuration
113=============
114All available configuration options are described in the manual. This
115section only serves to point out the most important ones.
116
117To change how you are notified about incoming events, type M-x
118customize-group RET jabber-alerts.
119
120To activate logging of all chats, set jabber-history-enabled to t. By
121default, history will be saved in ~/.jabber_global_message_log; make
122sure that this file has appropriate permissions. Type M-x
123customize-group RET jabber-history for more options.
124
125By default, jabber.el will send a confirmation when messages sent to
126you are delivered and displayed, and also send "contact is typing"
127notifications. To change this, type M-x customize-group RET
128jabber-events, and set the three jabber-events-confirm-* variables to
129nil.
130
131File transfer
132=============
133This release of jabber.el contains support for file transfer. You may
134need to configure some variables to make it work; see the manual for
135details.
136
137XMPP URIs
138=========
139It is possible to make various web browsers pass links starting with
140"xmpp:" to jabber.el. In the ideal case, this works right after
141running "make install". Otherwise, see the manual, section "XMPP
142URIs".
143