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 File hexrgb.el (http://www.emacswiki.org/emacs/hexrgb.el) needed for
  22 MUC nick coloring feature. It also placed in compat directory and used
  23 if nessesary.
  24
  25 XEmacs
  26 ======
  27
  28 You need an XEmacs with Mule support, and recent versions of the gnus,
  29 net-utils and mule-ucs packages.  jabber.el basically works on XEmacs,
  30 but some features are missing (in particular mouse support).  Testing
  31 and patches are very welcome.
  32
  33 SASL
  34 ====
  35 jabber.el will use the SASL library of Emacs (from version 23) or Gnus
  36 (from No Gnus 0.3) if it's present.  If not, it will fall back to
  37 XEP-0077 authentication.
  38
  39 TLS/SSL
  40 =======
  41 To get an encrypted connection, the most convenient option is to use
  42 starttls.el (from Emacs 22 or Gnus 5.10).  This requires GnuTLS (in
  43 particular the command line tool gnutls-cli) to be installed, but
  44 requires no configuration at all.
  45
  46 You can also use either tls.el (from Emacs 22 or Gnus 5.10) or ssl.el.
  47 These are interfaces to GnuTLS and OpenSSL, respectively; use the
  48 appropriate one.  Recent versions of tls.el support both programs,
  49 though.  The version of ssl.el distributed with Gnus is outdated; use
  50 the one from W3 CVS instead:
  51 http://cvs.savannah.gnu.org/viewcvs/w3/lisp/ssl.el?root=w3
  52
  53 To use the latter form of encryption, customize jabber-account-list.
  54
  55 Note that only the connection from you to the server is encrypted;
  56 there is no guarantee of other connections being encrypted.
  57
  58 Installation
  59 ============
  60 jabber.el can be installed using the commands:
  61 ./configure
  62 make
  63 make install
  64
  65 You can specify which emacs you want to use:
  66 ./configure EMACS=emacs-or-xemacs-21.4
  67
  68 You can also install jabber.el by hand.  Put all .el files somewhere
  69 in your load-path, or have your load-path include the directory
  70 they're in.  To install the Info documentation, copy jabber.info to
  71 /usr/local/info and run "install-info /usr/local/info/jabber.info".
  72
  73 After installation by either method, add (load "jabber-autoloads") to
  74 your .emacs file.  (If you got the code from GIT, you still need the
  75 makefile to generate jabber-autoloads.el.)
  76
  77 If you are upgrading from 0.7-0.7.x, you need to update your
  78 configuration.  See the section "Account settings" in the manual.
  79
  80 Special notes for GIT version
  81 =============================
  82 If you are running jabber.el from GIT, you need to generate the
  83 jabber-autoloads.el file yourself.  The simplest way to do this is by
  84 using the "./configure && make" process.
  85
  86 To generate the configure script, make sure that autoconf and automake
  87 are installed and run "autoreconf -i".
  88
  89 Usage
  90 =====
  91
  92 To connect to a Jabber server, type C-x C-j C-c (or equivalently M-x
  93 jabber-connect-all) and enter your JID.  With prefix argument,
  94 register a new account.  You can set your JID permanently with M-x
  95 jabber-customize.
  96
  97 Your roster is displayed in a buffer called *-jabber-*.  To
  98 disconnect, type C-x C-j C-d or M-x jabber-disconnect.
  99
 100 You may want to use the menu bar to execute Jabber commands.  To
 101 enable the Jabber menu, type M-x jabber-menu.
 102
 103 For a less terse description, read the enclosed manual.
 104
 105 For bug reports, help requests and other feedback, use the trackers
 106 and forums at the project page mentioned above.
 107
 108 Configuration
 109 =============
 110 All available configuration options are described in the manual.  This
 111 section only serves to point out the most important ones.
 112
 113 To change how you are notified about incoming events, type M-x
 114 customize-group RET jabber-alerts.
 115
 116 To activate logging of all chats, set jabber-history-enabled to t.  By
 117 default, history will be saved in ~/.jabber_global_message_log; make
 118 sure that this file has appropriate permissions.  Type M-x
 119 customize-group RET jabber-history for more options.
 120
 121 By default, jabber.el will send a confirmation when messages sent to
 122 you are delivered and displayed, and also send "contact is typing"
 123 notifications.  To change this, type M-x customize-group RET
 124 jabber-events, and set the three jabber-events-confirm-* variables to
 125 nil.
 126
 127 File transfer
 128 =============
 129 This release of jabber.el contains support for file transfer.  You may
 130 need to configure some variables to make it work; see the manual for
 131 details.
 132
 133 XMPP URIs
 134 =========
 135 It is possible to make various web browsers pass links starting with
 136 "xmpp:" to jabber.el.  In the ideal case, this works right after
 137 running "make install".  Otherwise, see the manual, section "XMPP
 138 URIs".