Rearrange and extend "external resources"
[emacs-jabber-www.git] / index.muse
blob5bd3244bffc1e77efedf9a416a26a3f74ef8812a
1 #title jabber.el
3 <literal>
4 <a href="http://sourceforge.net">
5 <img border="0" src="http://sourceforge.net/sflogo.php?group_id=88346&amp;type=2" width="125" height="37" alt="SourceForge.net Logo" style="position: absolute; top: 0em; right: 0em;"></a>
6 </literal>
8 jabber.el is a Jabber client for Emacs.
10 <contents>
12 For the impatient:
14  - Latest release: [[http://sourceforge.net/project/showfiles.php?group_id=88346&package_id=92339&release_id=482983][0.7.1]] (31-Jan-2007)
15  - Latest pretest release: [[http://sourceforge.net/project/showfiles.php?group_id=88346&package_id=278300&release_id=630770][0.7.92]] (05-Oct-2008)
16  - Full [[list-of-releases][list of releases]], including lists of features and changes
18 External resources:
20  - [[http://sourceforge.net/projects/emacs-jabber/][Sourceforge project page]], containing:
21    - trackers for
22      [[http://sourceforge.net/tracker/?atid=586350&group_id=88346&func=browse][bugs]],
23      [[http://sourceforge.net/tracker/?atid=586353&group_id=88346&func=browse][feature requests]],
24      [[http://sourceforge.net/tracker/?atid=586352&group_id=88346&func=browse][patches]] and
25      [[http://sourceforge.net/tracker/?atid=586351&group_id=88346&func=browse][support requests]], open for anonymous posters
26    - [[http://sourceforge.net/forum/?group_id=88346][forums]], open for anonymous posters
27  - [[http://www.emacswiki.org/cgi-bin/wiki/JabberEl][the JabberEl page of EmacsWiki]]
28  - Mailing lists (also available at [[http://gmane.net][Gmane]]):
29    - [[http://lists.sourceforge.net/lists/listinfo/emacs-jabber-general][emacs-jabber-general]], for posts by humans (also [[http://dir.gmane.org/gmane.emacs.jabber.general][gmane.emacs.jabber.general]])
30    - [[http://lists.sourceforge.net/lists/listinfo/emacs-jabber-commit][emacs-jabber-commit]], read-only mailing list of CVS commits (also [[http://dir.gmane.org/gmane.emacs.jabber.scm][gmane.emacs.jabber.scm]])
31    - [[http://lists.sourceforge.net/lists/listinfo/emacs-jabber-bugs][emacs-jabber-bugs]], read-only mailing list of bug tracker activity (also [[http://dir.gmane.org/gmane.emacs.jabber.bugs][gmane.emacs.jabber.bugs]])
32  - the Jabber chat room [[xmpp:jabber.el@conference.jabber.se?join][jabber.el@conference.jabber.se]], and its [[http://www.jabber.se/muc-logs/jabber.el@conference.jabber.se/][logs]]
33  - the [[manual-0.7.1/][manual for jabber.el 0.7.1]] (also included in the release files)
35 * What is Jabber?
37 Jabber is an open instant messaging (IM) system, also known as XMPP.
38 It is described in [[http://www.xmpp.org/rfcs/][RFCs 3920-3923]] and a series of [[http://www.xmpp.org/extensions/][XEPs]] (XMPP Extension
39 Proposals).  That is, unlike legacy IM systems (such as ICQ or MSN
40 Messenger), the protocol is published in the open, free for anyone to
41 implement.  Therefore you shouldn't be surprised that there is a
42 Jabber client for Emacs, too.  (If you are not of the Emacs
43 persuasion, see this [[http://www.jabber.org/software/clients.shtml][list of Jabber clients]].)
45 Jabber is, like e-mail, a decentralised system.  A Jabber identifier
46 (JID) is of the form =username@server=, just like an e-mail address, and
47 every Jabber user whose server is open to Internet connections can
48 communicate with any other user.  This is in stark contrast to the
49 legacy "walled-garden" IM systems, where you need a separate account
50 for each system to be able to communicate with its users.  Note that
51 the [[http://talk.google.com][Google Talk]] service is an XMPP service, so if you have a GMail
52 account, you already have a JID ending with =@gmail.com=.
54 In Jabber, you have a "roster", a list of contacts.  You can see
55 which of them are online at the moment, and chat with them.  (You can
56 also send messages to an offline contact, and the message will be
57 stored on the server for later delivery.)  Jabber also supports
58 IRC-style chat rooms.
60 * What is jabber.el?
62 jabber.el is a Jabber client for Emacs.  It may seem strange to have a
63 chat client in an editor, but consider that chatting is, after all,
64 just a special case of text editing.
66 * Downloading and installing
68 ** Prepackaged
70 Note that jabber.el is available as [[http://packages.debian.org/emacs-jabber][emacs-jabber in Debian]], and in
71 [[http://packages.ubuntu.com/emacs-jabber][Ubuntu's "universe" section]].
73 ** Dependencies
75 jabber.el requires either GNU Emacs 22, or GNU Emacs 21 combined with
76 Gnus 5.10.  You should get these from your distribution, or from the
77 [[http://www.gnu.org/software/emacs/][Emacs]] and [[http://gnus.org][Gnus]] web sites.
79 However, if you want to connect to servers that use SRV records
80 (e.g. Google Talk), it is recommended to use either No Gnus or Gnus
81 5.13.
83 If you want encrypted connections (some servers, e.g. Google Talk,
84 require it), you need [[http://www.gnu.org/software/gnutls/][GnuTLS]] installed.
86 ** Downloading
88 Download the [[http://sourceforge.net/project/showfiles.php?group_id=88346&package_id=92339][latest release]] and unpack it in a suitable location.  Add
89 something like the following to your =.emacs= file:
91 <example>
92 ;; adjust this path:
93 (add-to-list 'load-path "/path/to/emacs-jabber")
94 (require 'jabber)
95 </example>
97 Either evaluate those lines, or restart Emacs.
99 ** Using
101 See the [[manual-0.7.1/Basic-operation.html][Basic Operation]] in the manual.
105 * Reporting bugs
107 Bug reports can be sent either to the mailing list
108 [[http://lists.sourceforge.net/lists/listinfo/emacs-jabber-general][emacs-jabber-general]] or to the [[http://sourceforge.net/tracker/?group_id=88346&atid=586350][bug tracker]].
111 * Latest source
113 jabber.el releases are, unfortunately, less frequent than they would
114 be in an ideal world.  You can get the latest development version
115 using various version control systems.
117 ** CVS
119 See [[http://sourceforge.net/cvs/?group_id=88346][the Sourceforge CVS page]].  In short, run the following command:
121 <example>
122 cvs -z3 -d:pserver:anonymous@emacs-jabber.cvs.sourceforge.net:/cvsroot/emacs-jabber co -P emacs-jabber
123 </example>
125 ** GNU Arch
127 The commands are:
129 <example>
130 tla register-archive http://www.dtek.chalmers.se/~henoch/archive-2005
131 tla get mange@freemail.hu--2005/emacs-jabber--cvs-head--0 emacs-jabber
132 </example>
134 If you are using Bazaar 1, substitute =baz= for =tla=.
136 ** git
138 <example>
139 git-clone git://git.catap.ru/emacs-jabber.git
140 </example>
143 * List of releases
145 The list of releases has been moved to a [[list-of-releases][separate page]].