README

   1 This is jabber.el 0.8, a Jabber client for Emacs.  Jabber (also known
   2 as XMPP) is an instant messaging system; see http://www.jabber.org for
   3 more information.
   4
   5 Home page:    http://emacs-jabber.sourceforge.net
   6 Project page: http://sourceforge.net/projects/emacs-jabber
   7 Wiki page:    http://www.emacswiki.org/cgi-bin/wiki/JabberEl
   8 Mailing list: http://lists.sourceforge.net/lists/listinfo/emacs-jabber-general
   9 and:          http://dir.gmane.org/gmane.emacs.jabber.general
  10 MUC room:     jabber.el@conference.jabber.se and emacs@conference.jabber.ru (Russian, English)
  11
  12 GNU Emacs
  13 =========
  14
  15 jabber.el depends on GNU Emacs (21, 22, 23 works fine), in particular
  16 xml.el, and some files from Gnus 5.10. If you don't have Gnus 5.10
  17 (M-x gnus-version will tell), you can get sha1.el and hex-util.el
  18 from the compat subdirectory.  (The configure script tries to detect
  19 this situation and include the files in the build)
  20
  21
  22 XEmacs
  23 ======
  24
  25 You need an XEmacs with Mule support, and recent versions of the gnus,
  26 net-utils and mule-ucs packages.  jabber.el basically works on XEmacs,
  27 but some features are missing (in particular mouse support).  Testing
  28 and patches are very welcome.
  29
  30 SASL
  31 ====
  32 jabber.el will use the SASL library of FLIM (Faithful Library about
  33 Internet Message; it is also included in newer versions of Gnus) if
  34 it's present.  If not, it will fall back to XEP-0077 authentication.
  35
  36 TLS/SSL
  37 =======
  38 To get an encrypted connection, the most convenient option is to
  39 install starttls.el from Gnus (currently only present in the
  40 development version).  This requires GnuTLS to be installed, but
  41 requires no configuration at all.
  42
  43 You can also use either tls.el (from Gnus) or ssl.el.  These are
  44 interfaces to GnuTLS and OpenSSL, respectively; use the appropriate
  45 one.  Recent versions of tls.el support both programs, though.  The
  46 version of ssl.el distributed with Gnus is outdated; use the one from
  47 W3 CVS instead:
  48 http://cvs.savannah.gnu.org/viewcvs/w3/lisp/ssl.el?root=w3
  49
  50 To actually use encryption with one of these libraries, customize the
  51 variables jabber-connection-type and jabber-connection-ssl-program.
  52
  53 Note that only the connection from you to the server is encrypted;
  54 there is no guarantee of other connections being encrypted.
  55
  56 Installation
  57 ============
  58 jabber.el can be installed using the commands:
  59 ./configure
  60 make
  61 make install
  62
  63 You can specify which emacs you want to use:
  64 ./configure EMACS=emacs-or-xemacs-21.4
  65
  66 You can also install jabber.el by hand.  Put all .el files somewhere
  67 in your load-path, or have your load-path include the directory
  68 they're in.  To install the Info documentation, copy jabber.info to
  69 /usr/local/info and run "install-info /usr/local/info/jabber.info".
  70
  71 After installation by either method, add (load "jabber-autoloads") to
  72 your .emacs file.  (If you got the code from CVS, you still need the
  73 makefile to generate jabber-autoloads.el.)
  74
  75 If you are upgrading from 0.7-0.7.x, you need to update your
  76 configuration.  See the section "Account settings" in the manual.
  77
  78 Special notes for CVS version
  79 =============================
  80 If you are running jabber.el from CVS, you need to generate the
  81 jabber-autoloads.el file yourself.  The simplest way to do this is by
  82 using the "./configure && make" process.
  83
  84 To generate the configure script, make sure that autoconf and automake
  85 are installed and run "autoreconf -i".
  86
  87 Usage
  88 =====
  89
  90 To connect to a Jabber server, type C-x C-j C-c (or equivalently M-x
  91 jabber-connect-all) and enter your JID.  With prefix argument,
  92 register a new account.  You can set your JID permanently with M-x
  93 jabber-customize.
  94
  95 Your roster is displayed in a buffer called *-jabber-*.  To
  96 disconnect, type C-x C-j C-d or M-x jabber-disconnect.
  97
  98 You may want to use the menu bar to execute Jabber commands.  To
  99 enable the Jabber menu, type M-x jabber-menu.
 100
 101 For a less terse description, read the enclosed manual.
 102
 103 For bug reports, help requests and other feedback, use the trackers
 104 and forums at the project page mentioned above.
 105
 106 Configuration
 107 =============
 108 All available configuration options are described in the manual.  This
 109 section only serves to point out the most important ones.
 110
 111 To change how you are notified about incoming events, type M-x
 112 customize-group RET jabber-alerts.
 113
 114 To activate logging of all chats, set jabber-history-enabled to t.  By
 115 default, history will be saved in ~/.jabber_global_message_log; make
 116 sure that this file has appropriate permissions.  Type M-x
 117 customize-group RET jabber-history for more options.
 118
 119 By default, jabber.el will send a confirmation when messages sent to
 120 you are delivered and displayed, and also send "contact is typing"
 121 notifications.  To change this, type M-x customize-group RET
 122 jabber-events, and set the three jabber-events-confirm-* variables to
 123 nil.
 124
 125 File transfer
 126 =============
 127 This release of jabber.el contains support for file transfer.  You may
 128 need to configure some variables to make it work; see the manual for
 129 details.
 130
 131 XMPP URIs
 132 =========
 133 It is possible to make various web browsers pass links starting with
 134 "xmpp:" to jabber.el.  See the manual, section "XMPP URIs".