Rearrange and extend "external resources"
[emacs-jabber-www.git] / html / index.html
blob78ab80f281612756f05b0d4a72358100fc701018
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type"
5 content="text/html; charset=utf-8">
7 <title>jabber.el</title>
8 <meta name="generator" content="muse.el">
10 <style type="text/css">
11 body {
12 background: white; color: black;
13 margin-left: 3%; margin-right: 7%;
16 p { margin-top: 1% }
17 p.verse { margin-left: 3% }
19 .example { margin-left: 3% }
21 h2 {
22 margin-top: 25px;
23 margin-bottom: 0px;
25 h3 { margin-bottom: 0px; }
26 </style>
27 </head>
28 <body>
29 <h1>jabber.el</h1>
30 <!-- Page published by Emacs Muse begins here -->
32 <p><a href="http://sourceforge.net">
33 <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>
34 </p>
36 <p>jabber.el is a Jabber client for Emacs.</p>
38 <div class="contents">
39 <dl>
40 <dt>
41 <a href="#sec1">What is Jabber?</a>
42 </dt>
43 <dt>
44 <a href="#sec2">What is jabber.el?</a>
45 </dt>
46 <dt>
47 <a href="#sec3">Downloading and installing</a>
48 </dt>
49 <dd>
50 <dl>
51 <dt>
52 <a href="#sec4">Prepackaged</a>
53 </dt>
54 <dt>
55 <a href="#sec5">Dependencies</a>
56 </dt>
57 <dt>
58 <a href="#sec6">Downloading</a>
59 </dt>
60 <dt>
61 <a href="#sec7">Using</a>
62 </dt>
63 </dl>
64 </dd>
65 <dt>
66 <a href="#sec8">Reporting bugs</a>
67 </dt>
68 <dt>
69 <a href="#sec9">Latest source</a>
70 </dt>
71 <dd>
72 <dl>
73 <dt>
74 <a href="#sec10">CVS</a>
75 </dt>
76 <dt>
77 <a href="#sec11">GNU Arch</a>
78 </dt>
79 <dt>
80 <a href="#sec12">git</a>
81 </dt>
82 </dl>
83 </dd>
84 <dt>
85 <a href="#sec13">List of releases</a>
86 </dt>
87 </dl>
88 </div>
91 <p>For the impatient:</p>
93 <ul>
94 <li>Latest release: <a href="http://sourceforge.net/project/showfiles.php?group_id=88346&amp;package_id=92339&amp;release_id=482983">0.7.1</a> (31-Jan-2007)</li>
95 <li>Latest pretest release: <a href="http://sourceforge.net/project/showfiles.php?group_id=88346&amp;package_id=278300&amp;release_id=630770">0.7.92</a> (05-Oct-2008)</li>
96 <li>Full <a href="list-of-releases.html">list of releases</a>, including lists of features and changes</li>
97 </ul>
99 <p>External resources:</p>
101 <ul>
102 <li><a href="http://sourceforge.net/projects/emacs-jabber/">Sourceforge project page</a>, containing:
104 <ul>
105 <li>trackers for
106 <a href="http://sourceforge.net/tracker/?atid=586350&amp;group_id=88346&amp;func=browse">bugs</a>,
107 <a href="http://sourceforge.net/tracker/?atid=586353&amp;group_id=88346&amp;func=browse">feature requests</a>,
108 <a href="http://sourceforge.net/tracker/?atid=586352&amp;group_id=88346&amp;func=browse">patches</a> and
109 <a href="http://sourceforge.net/tracker/?atid=586351&amp;group_id=88346&amp;func=browse">support requests</a>, open for anonymous posters</li>
110 <li><a href="http://sourceforge.net/forum/?group_id=88346">forums</a>, open for anonymous posters</li>
111 </ul></li>
112 <li><a href="http://www.emacswiki.org/cgi-bin/wiki/JabberEl">the JabberEl page of EmacsWiki</a></li>
113 <li>Mailing lists (also available at <a href="http://gmane.net">Gmane</a>):
115 <ul>
116 <li><a href="http://lists.sourceforge.net/lists/listinfo/emacs-jabber-general">emacs-jabber-general</a>, for posts by humans (also <a href="http://dir.gmane.org/gmane.emacs.jabber.general">gmane.emacs.jabber.general</a>)</li>
117 <li><a href="http://lists.sourceforge.net/lists/listinfo/emacs-jabber-commit">emacs-jabber-commit</a>, read-only mailing list of CVS commits (also <a href="http://dir.gmane.org/gmane.emacs.jabber.scm">gmane.emacs.jabber.scm</a>)</li>
118 <li><a href="http://lists.sourceforge.net/lists/listinfo/emacs-jabber-bugs">emacs-jabber-bugs</a>, read-only mailing list of bug tracker activity (also <a href="http://dir.gmane.org/gmane.emacs.jabber.bugs">gmane.emacs.jabber.bugs</a>)</li>
119 </ul></li>
120 <li>the Jabber chat room <a href="xmpp:jabber.el@conference.jabber.se?join">jabber.el@conference.jabber.se</a>, and its <a href="http://www.jabber.se/muc-logs/jabber.el@conference.jabber.se/">logs</a></li>
121 <li>the <a href="manual-0.7.1/">manual for jabber.el 0.7.1</a> (also included in the release files)</li>
122 </ul>
124 <h2><a name="sec1" id="sec1"></a>
125 What is Jabber?</h2>
127 <p class="first">Jabber is an open instant messaging (IM) system, also known as XMPP.
128 It is described in <a href="http://www.xmpp.org/rfcs/">RFCs 3920-3923</a> and a series of <a href="http://www.xmpp.org/extensions/">XEPs</a> (XMPP Extension
129 Proposals). That is, unlike legacy IM systems (such as ICQ or MSN
130 Messenger), the protocol is published in the open, free for anyone to
131 implement. Therefore you shouldn't be surprised that there is a
132 Jabber client for Emacs, too. (If you are not of the Emacs
133 persuasion, see this <a href="http://www.jabber.org/software/clients.shtml">list of Jabber clients</a>.)</p>
135 <p>Jabber is, like e-mail, a decentralised system. A Jabber identifier
136 (JID) is of the form <code>username@server</code>, just like an e-mail address, and
137 every Jabber user whose server is open to Internet connections can
138 communicate with any other user. This is in stark contrast to the
139 legacy &quot;walled-garden&quot; IM systems, where you need a separate account
140 for each system to be able to communicate with its users. Note that
141 the <a href="http://talk.google.com">Google Talk</a> service is an XMPP service, so if you have a GMail
142 account, you already have a JID ending with <code>@gmail.com</code>.</p>
144 <p>In Jabber, you have a &quot;roster&quot;, a list of contacts. You can see
145 which of them are online at the moment, and chat with them. (You can
146 also send messages to an offline contact, and the message will be
147 stored on the server for later delivery.) Jabber also supports
148 IRC-style chat rooms.</p>
151 <h2><a name="sec2" id="sec2"></a>
152 What is jabber.el?</h2>
154 <p class="first">jabber.el is a Jabber client for Emacs. It may seem strange to have a
155 chat client in an editor, but consider that chatting is, after all,
156 just a special case of text editing.</p>
159 <h2><a name="sec3" id="sec3"></a>
160 Downloading and installing</h2>
162 <h3><a name="sec4" id="sec4"></a>
163 Prepackaged</h3>
165 <p class="first">Note that jabber.el is available as <a href="http://packages.debian.org/emacs-jabber">emacs-jabber in Debian</a>, and in
166 <a href="http://packages.ubuntu.com/emacs-jabber">Ubuntu's &quot;universe&quot; section</a>.</p>
169 <h3><a name="sec5" id="sec5"></a>
170 Dependencies</h3>
172 <p class="first">jabber.el requires either GNU Emacs 22, or GNU Emacs 21 combined with
173 Gnus 5.10. You should get these from your distribution, or from the
174 <a href="http://www.gnu.org/software/emacs/">Emacs</a> and <a href="http://gnus.org">Gnus</a> web sites.</p>
176 <p>However, if you want to connect to servers that use SRV records
177 (e.g. Google Talk), it is recommended to use either No Gnus or Gnus
178 5.13.</p>
180 <p>If you want encrypted connections (some servers, e.g. Google Talk,
181 require it), you need <a href="http://www.gnu.org/software/gnutls/">GnuTLS</a> installed.</p>
184 <h3><a name="sec6" id="sec6"></a>
185 Downloading</h3>
187 <p class="first">Download the <a href="http://sourceforge.net/project/showfiles.php?group_id=88346&amp;package_id=92339">latest release</a> and unpack it in a suitable location. Add
188 something like the following to your <code>.emacs</code> file:</p>
190 <pre class="example">
191 ;; adjust this path:
192 (add-to-list 'load-path &quot;/path/to/emacs-jabber&quot;)
193 (require 'jabber)
194 </pre>
196 <p>Either evaluate those lines, or restart Emacs.</p>
199 <h3><a name="sec7" id="sec7"></a>
200 Using</h3>
202 <p class="first">See the <a href="manual-0.7.1/Basic-operation.html">Basic Operation</a> in the manual.</p>
208 <h2><a name="sec8" id="sec8"></a>
209 Reporting bugs</h2>
211 <p class="first">Bug reports can be sent either to the mailing list
212 <a href="http://lists.sourceforge.net/lists/listinfo/emacs-jabber-general">emacs-jabber-general</a> or to the <a href="http://sourceforge.net/tracker/?group_id=88346&amp;atid=586350">bug tracker</a>.</p>
216 <h2><a name="sec9" id="sec9"></a>
217 Latest source</h2>
219 <p class="first">jabber.el releases are, unfortunately, less frequent than they would
220 be in an ideal world. You can get the latest development version
221 using various version control systems.</p>
223 <h3><a name="sec10" id="sec10"></a>
224 CVS</h3>
226 <p class="first">See <a href="http://sourceforge.net/cvs/?group_id=88346">the Sourceforge CVS page</a>. In short, run the following command:</p>
228 <pre class="example">
229 cvs -z3 -d:pserver:anonymous@emacs-jabber.cvs.sourceforge.net:/cvsroot/emacs-jabber co -P emacs-jabber
230 </pre>
233 <h3><a name="sec11" id="sec11"></a>
234 GNU Arch</h3>
236 <p class="first">The commands are:</p>
238 <pre class="example">
239 tla register-archive http://www.dtek.chalmers.se/~henoch/archive-2005
240 tla get mange@freemail.hu--2005/emacs-jabber--cvs-head--0 emacs-jabber
241 </pre>
243 <p>If you are using Bazaar 1, substitute <code>baz</code> for <code>tla</code>.</p>
246 <h3><a name="sec12" id="sec12"></a>
247 git</h3>
249 <pre class="example">
250 git-clone git://git.catap.ru/emacs-jabber.git
251 </pre>
256 <h2><a name="sec13" id="sec13"></a>
257 List of releases</h2>
259 <p class="first">The list of releases has been moved to a <a href="list-of-releases.html">separate page</a>.</p>
263 <!-- Page published by Emacs Muse ends here -->
265 </body>
266 </html>