2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3 "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
4 <!ENTITY legal SYSTEM "legal.xml">
5 <!ENTITY appversion "2.26">
6 <!ENTITY manrevision "2.1">
7 <!ENTITY date "January 2009">
8 <!ENTITY app "<application>Empathy</application>">
9 <!ENTITY appname "Empathy">
10 <!ENTITY gtalk "http://www.google.com/talk/">
11 <!ENTITY icq "https://www.icq.com/register/">
12 <!ENTITY aim "http://dashboard.aim.com/aim">
13 <!ENTITY msn "https://accountservices.passport.net">
14 <!ENTITY yahoo "https://login.yahoo.com/config/login">
16 "http://account2.freeworlddialup.com/index.php?section_id=94">
17 <!ENTITY ekiga "https://www.ekiga.net/index.php?page=register">
19 "https://signup.sipphone.com/new-users/app?class=NewUser;proc=start">
20 <!ENTITY jabber "http://www.jabber.org/web/Jabber.org">
22 <?db.chunk.max_depth 2?>
23 <article id="index" lang="en">
24 <!-- please do not change the id; for translations, change lang to -->
25 <!-- appropriate code -->
27 <title>&app; Manual V&manrevision;</title>
30 <year>2008, 2009</year>
31 <holder>Ubuntu Documentation Project</holder>
33 <!-- An address can be added to the publisher information. If a role is
34 not specified, the publisher/author is the same for all versions of the
37 <publishername>Ubuntu Documentation Project</publishername>
40 <!-- licence stuff -->
44 <author role="maintainer">
45 <firstname>Milo</firstname>
46 <surname>Casagrande</surname>
48 <orgname>Ubuntu Documentation Project</orgname>
49 <address><email>milo@ubuntu.com</email></address>
53 <firstname>Seth</firstname>
54 <surname>Dudenhofer</surname>
56 <orgname>Ubuntu Documentation Project</orgname>
57 <address><email>sdudenhofer@gmail.com</email></address>
62 <releaseinfo revision="2.26" role="incomplete">
63 <ulink type="bug" url="http://bugzilla.gnome.org/show_bug.cgi?id=561033" />
64 <ulink type="planning" url="http://live.gnome.org/Empathy/Documentation" />
67 <!-- According to GNU FDL, revision history is mandatory if you are -->
68 <!-- modifying/reusing someone else's document. If not, you can omit it. -->
69 <!-- Remember to remove the &manrevision; entity from the revision -->
70 <!-- entries other than the current revision. -->
71 <!-- The revision numbering system for GNOME manuals is as follows: -->
72 <!-- * the revision number consists of two components -->
73 <!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
74 <!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
75 <!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
76 <!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
77 <!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
78 <!-- to V3.0, and so on. -->
81 <revnumber>Empathy Manual V&manrevision;</revnumber>
84 <para role="author">Milo Casagrande
85 <email>milo@ubuntu.com</email>
87 <para role="publisher">Ubuntu Documentation Project</para>
92 <revnumber>Empathy Manual V2.0</revnumber>
93 <date>April 2008</date>
95 <para role="author">Milo Casagrande
96 <email>milo@ubuntu.com</email>
98 <para role="author">Seth Dudenhofer
99 <email>sdudenhofer@gmail.com</email>
101 <para role="publisher">Ubuntu Documentation Project</para>
107 This manual describes version &appversion; of &appname;.
110 <title>Feedback</title>
112 To report a bug or make a suggestion regarding the &app; application or
113 this manual, follow the directions in the <ulink url="ghelp:gnome-feedback"
114 type="help">GNOME Feedback Page</ulink>.
118 <abstract role="description">
120 &appname; is an application for instant messaging.
126 <indexterm zone="index">
127 <primary>Empathy</primary>
129 <indexterm zone="index">
130 <primary>empathy</primary>
131 <secondary>istant messaging</secondary>
134 <sect1 id="empathy-intro">
135 <title>Introduction</title>
137 &app; is a multi-protocol instant messaging program for the
138 GNOME Desktop. With &app; you can keep in touch with all of your
139 friends through lots of supported instant messaging services.
142 &app; supports the following services:
146 <acronym>AIM</acronym>
161 <acronym>IRC</acronym>
166 Jabber (or <acronym>XMPP</acronym>)
171 <acronym>MSN</acronym>
181 <acronym>SIP</acronym>
198 <sect1 id="empathy-getting-started">
199 <title>Getting Started</title>
201 <sect2 id="empathy-starting">
202 <title>Starting &appname;</title>
203 <para>You can start &app; in the following ways:
207 <term><guimenu>Applications</guimenu> menu</term>
211 <guisubmenu>Internet</guisubmenu>
212 <guimenuitem>Empathy Instant Messenger</guimenuitem>
218 <term>Command line</term>
220 <para>Type <command>empathy</command> and then press
221 <keycap>Enter</keycap>.
228 <sect2 id="emphaty-when-start">
229 <title>When You Start &appname;</title>
231 When you start &app; the following window is shown.
233 <figure id="empathy-FIG-mainwindow">
234 <title>&app; Main Window</title>
238 <imagedata fileref="figures/empathy-main-window.png" format="PNG"/>
242 Shows &app; main window. Contains the titlebar, the
243 menubar, contact list, status icon and status arrow
250 <!-- End of Figure -->
253 <xref linkend="empathy-TBL-1"/> describes the components of
255 <table frame="topbot" id="empathy-TBL-1">
256 <title>&app; Main Components</title>
257 <tgroup cols="2" colsep="0" rowsep="0">
258 <colspec colname="colspec0" colwidth="29.39*"/>
259 <colspec colname="colspec1" colwidth="70.61*"/>
263 <para>Component</para>
266 <para>Description</para>
277 Contains menus used to perform actions in &app;.
283 <para>Status Drop-Down List</para>
287 Allows to update the status.
293 <para>Account Button</para>
297 Opens the <guilabel>Accounts</guilabel> dialog.
303 <para>Contact List</para>
307 Shows all the available contacts and their
319 <sect1 id="empathy-accounts">
320 <title>Accounts</title>
322 To use &app; you need at least one account of the supported services.
325 If you don't already have an account and you don't have your <emphasis>user
326 name</emphasis> and <emphasis>password</emphasis>, you need to
327 register a new account (see <xref linkend="empathy-register-account" />).
330 In order to talk with other users, also called
331 <emphasis>contacts</emphasis>, you need to use the same service
332 they are using. If, for example, one contact is using the <emphasis
333 role="strong">Jabber</emphasis> service, you need to have an
334 account registered with that service.
337 &app; can handle as many accounts on any supported services as you want and
338 you can have them all open at the same time.
341 <sect2 id="empathy-register-account">
342 <title>Registering an Account</title>
344 You can freely register an account on any of the following
345 services. Follow the instructions reported on each website on
346 how to register your new account. At the end of the
347 registration process you should have a <emphasis>user
348 name</emphasis> (or an <emphasis>account ID</emphasis>) and
349 a <emphasis>password</emphasis> that you will use to
350 create the account in &app;.
353 Click on the name of the service to visit its website:
354 <!-- Need to do like that, if using only
355 <ulink>SERVICE</ulink> it wouldn't be possibile to
356 localize the links -->
359 <!-- Translators: try to find a localized version of the
360 registration service website -->
362 The <ulink type="http" url="&aim;">AIM</ulink> service.
366 <!-- Translators: try to find a localized version of the
367 registration service website -->
369 The <ulink type="http" url=">alk;">Google
370 Talk</ulink> service.
374 <!-- Translators: try to find a localized version of the
375 registration service website -->
377 The <ulink type="http" url="&icq;">ICQ</ulink> service.
381 <!-- Translators: try to find a localized version of the
382 registration service website -->
384 The <ulink type="http" url="&msn;">MSN</ulink> service.
388 <!-- Translators: try to find a localized version of the
389 registration service website -->
391 The <ulink type="http" url="&yahoo;">Yahoo</ulink> service.
397 For registering a <acronym>SIP</acronym> account, you can use one of the
403 <!-- Translators: try to find a localized version of the
404 registration service website -->
406 The <ulink type="http" url="&ekiga;">Ekiga</ulink> service.
410 <!-- Translators: try to find a localized version of the
411 registration service website -->
413 The <ulink type="http" url="&fwd;"><acronym>FWD</acronym></ulink> (Free
414 World Dialup) service.
418 <!-- Translators: try to find a localized version of the
419 registration service website -->
421 The <ulink type="http" url="&sipphone;">Sipphone</ulink> service.
427 For registering a <emphasis role="strong">Jabber</emphasis>
428 account, you can use the automatic
429 account creation of &app;. Not all Jabber service
430 providers support the automatic creation of accounts, one
431 service provider known to work with &app; is <ulink
432 type="http" url="&jabber;">jabber.org</ulink>.
435 If you already have a <emphasis
436 role="strong">Jabber</emphasis> account, you can use one of
437 the following services:
450 <sect2 id="empathy-create-account">
451 <title>Adding your Account to &app;</title>
453 To add your account to &app;, proceed as follows:
457 From the <link linkend="empathy-FIG-mainwindow">main window
458 </link> (<guilabel>Contact List</guilabel>)
459 click on the account button or press <keycap>F4</keycap> to open the
460 <guilabel>Accounts</guilabel> dialog.
465 If it is the first time you launch &app;:
469 From the <guilabel>Type</guilabel> drop-down list choose
470 the service you wish to add an account for, then click
471 on the <guibutton>Create</guibutton> button.
481 Click on the <guilabel>Add</guilabel> button.
486 From the <guilabel>Type</guilabel> drop-down list choose
487 the service you wish to add an account for, then click
488 on the <guibutton>Create</guibutton> button.
496 Fill the required fields with your <emphasis>user
498 <emphasis>password</emphasis>. Optionally, you can
499 modify some advanced options. For more information,
500 see <xref linkend="empathy-advanced-options"/>.
505 To enable the new account, select the
506 <guilabel>Enabled</guilabel> check-box next to
507 the name of the account in the box on the left.
513 <sect3 id="empathy-importing-accounts">
514 <title>Importing Accounts</title>
516 If you use another instant messaging program, you can import
517 the accounts from that program into &app;
522 At the moment &app; can import the accounts only from
523 the instant messaging program
524 <application>Pidgin</application>. For more information
525 about <application>Pidgin</application>, see the <ulink
526 type="http" url="http://www.pidgin.im/">Pidgin website</ulink>.
531 To import the accounts into &app;, proceed as follows:
535 From the <link linkend="empathy-FIG-mainwindow">main window
536 </link> (<guilabel>Contact List</guilabel>)
537 click on the account button or press <keycap>F4</keycap> to open the
538 <guilabel>Accounts</guilabel> dialog.
543 Click on the <guibutton>Import Accounts...</guibutton>
544 button to open the <guilabel>Import
545 Accounts</guilabel> dialog.
550 Select the accounts you would like to import by
551 clicking on the <guilabel>Import</guilabel> check-box.
556 When you have selected all the desired accounts, click
557 <guibutton>OK</guibutton> to import them. If you don't
558 want to import the accounts, click
559 <guibutton>Cancel</guibutton>.
564 When you import a new account into &app;, it will not be
568 To enable the new account, select the
569 <guilabel>Enabled</guilabel> check-box next to
570 the name of the account in the box on the left.
578 <sect2 id="empathy-edit-account">
579 <title>Editing an Account</title>
581 To edit one of your accounts, i.e. to change the
582 <emphasis>password</emphasis> or your <emphasis>user
583 name</emphasis>, proceed as follows:
587 From the <link linkend="empathy-FIG-mainwindow">main window
588 </link> (<guilabel>Contact List</guilabel>)
589 click on the account button or press <keycap>F4</keycap> to open the
590 <guilabel>Accounts</guilabel> dialog.
595 Select the account you wish to edit in the box on the
601 Modify the desired data.
609 Based on the type of the account, it is possibile to edit
615 To modify the identifier of an account, how &app; identifies
616 an account, proceed as follows:
620 From the <link linkend="empathy-FIG-mainwindow">main window
621 </link> (<guilabel>Contact List</guilabel>)
622 click on the account button or press <keycap>F4</keycap> to open the
623 <guilabel>Accounts</guilabel> dialog.
628 Select the account you wish to edit in the box on the
629 left and double-click on its name.
634 Change the name of the account as you desire.
641 <sect2 id="empathy-disabling-removing-account">
642 <title>Disabling and Removing an Account</title>
644 To disable an account, proceed as follows:
650 From the <link linkend="empathy-FIG-mainwindow">main window
651 </link> (<guilabel>Contact List</guilabel>)
652 click on the account button or press <keycap>F4</keycap>
654 <guilabel>Accounts</guilabel> dialog.
659 Select the account you wish to disable in the box on the
660 left of the dialog and deselect the
661 <guilabel>Enabled</guilabel> check-box.
667 To remove an account, proceed as follows:
673 From the <link linkend="empathy-FIG-mainwindow">main window
674 </link> (<guilabel>Contact List</guilabel>)
675 click on the account button or press <keycap>F4</keycap>
677 <guilabel>Accounts</guilabel> dialog.
682 Select the account you wish to disable in the box on the
688 Click on the <guibutton>Remove</guibutton> button.
693 A dialog will be shown asking for confirmation. Click on
694 the <guibutton>Remove</guibutton> button to remove the account.
701 <sect2 id="empathy-edit-personal-information">
702 <title>Editing Personal Information</title>
704 To change your personal information, your alias and your
705 icon (the image that other contacts will see of you), for each
706 of your accounts, proceed as follows:
712 From the <link linkend="empathy-FIG-mainwindow">main
713 window</link>, select <menuchoice>
714 <guimenu>Edit</guimenu>
715 <guimenuitem>Personal Information</guimenuitem>
721 From the <guilabel>Account</guilabel> drop-down list, choose
722 the account you want to edit.
727 In the <guilabel>Alias</guilabel> text box, write your new
733 To change your icon, click on the person-looking button and
734 choose an image file.
739 When done, click <guibutton>Close</guibutton>.
747 An <emphasis>alias</emphasis> is an alternative way you
748 can identify yourself. You can use your real
755 <sect2 id="empathy-advanced-options">
756 <title>Advanced Options</title>
758 Based on the service you are using, it is possible to
759 configure more advanced options to modify the normal behavior of
763 To configure these options, when you are <link
764 linkend="empathy-create-account">adding a new
765 account</link>, click on the drop-down section
766 <guilabel>Advanced</guilabel>.
769 <sect3 id="empathy-xmpp-advanced">
771 Jabber (or <acronym>XMPP</acronym>) and Google Talk
777 <guilabel>Encryption required (TLS/SSL)</guilabel>
781 Select this option in order to use some sort of
782 encryption during your conversations.
788 <guilabel>Ignore SSL certificate errors</guilabel>
792 Select this option in order to ignore the errors
793 that can be generated by some types of security
794 certificates. Usually these certificates are called
800 Select this option only if you are sure the
801 certificate is secure and you can trust it.
809 <guilabel>Resource</guilabel>
813 Use this text box to set a name with which you can
814 identify the running program based on where you are
815 running it. With this option, and the
816 <guilabel>Priority</guilabel> one, you can
817 use your account simultaneously in two different
818 devices. For example, if you set one device to
819 <replaceable>desktop</replaceable> and the other
820 one to <replaceable>mobile</replaceable>, you can
821 connect with both of them and based on the
822 <guilabel>Priority</guilabel> value you will receive
823 messages on one of the two devices or both.
826 This can be useful if you have two devices, a main
827 one and a portable one, and you move away from the
828 main one bringing with you the other: you can still
829 receive messages from your account with the portable
830 device even if you do not disconnet from the main one.
835 If you set the same value for this text box on
836 both the devices, when you connect with one of
837 them, the other one will be disconnected, even
838 if you set a different value with the
839 <guilabel>Priority</guilabel> spin box.
847 <guilabel>Priority</guilabel>
851 Use this spin box to indicate wich device, set in
852 the <guilabel>Resource</guilabel> text box, will
853 receive the new messages. The higher the number, the
854 higher the priority: you will receive the new
855 messages on the device with the highest number.
858 You can set values in the range from
859 <literal>-128</literal> to <literal>127</literal>.
864 If you set the same value of this spin box in
865 both the devices, you will receive messages on
875 In the <guilabel>Override server settings</guilabel> section
876 you can set options that take precedence over the default settings.
880 <guilabel>Server</guilabel>
884 Use this text box to write the name of the
885 server you want to use for this service.
891 <guilabel>Port</guilabel>
895 Use this spin box to set the number of the port of
899 You can set values in the range from
900 <literal>0</literal> to <literal>65,555</literal>.
906 <guilabel>Use old SSL</guilabel>
910 Select this option to use the old version of the
911 secure protocol for encrypting your connection.
919 <sect3 id="empathy-yahoo-advanced">
925 <guilabel>Ignore conference and chatrooms
926 invitations</guilabel>
930 Select this option to ignore the invitations that
931 other people may send you.
937 <guilabel>Room List locale</guilabel>
941 The value of this text box identifies the language
942 used to retrieve the room list when connecting to
946 If you need to change this value, use the two letter
947 code of your language.
953 <guilabel>Charset</guilabel>
957 The value of this text box identifies the set of the
958 characters used by &app;.
963 It is advise to leave this value to
964 <literal>UTF-8</literal>. Change it only
965 if that charset does not cover your language.
973 <guilabel>Server</guilabel>
977 Use this text box to write the name of the
978 server you want to use for this service.
984 <guilabel>Port</guilabel>
988 Use this spin box to set the number of the port of
992 You can set values in the range from
993 <literal>0</literal> to <literal>65,555</literal>.
999 <guilabel>Use Yahoo Japan</guilabel>
1003 Select this option only if you have a Yahoo! Japan
1004 account. With the Yahoo! Japan service you can only
1005 use a Yahoo! Japan account: if you have registered
1006 an account with the English version of the service,
1007 that account will not work.
1015 <sect3 id="empathy-msn-advanced">
1016 <title><acronym>AIM</acronym>, GroupWise and <acronym>MSN</acronym></title>
1021 <guilabel>Server</guilabel>
1025 Use this text box to write the name of the
1026 server you want to use for this service.
1032 <guilabel>Port</guilabel>
1036 Use this spin box to set the number of the port of
1040 You can set values in the range from
1041 <literal>0</literal> to <literal>65,555</literal>.
1049 <sect3 id="empathy-salut-advanced">
1050 <title>Salut</title>
1055 <guilabel>Published Name</guilabel>
1059 Use this text box to write the name that will be
1060 visible to the other users of the network.
1066 <guilabel>Email</guilabel>
1070 Use this text box to write your email.
1076 <guilabel>Jabber ID</guilabel>
1080 Use this text box to write your Jabber ID, if you
1089 <sect3 id="empathy-icq-advanced">
1095 <guilabel>Charset</guilabel>
1099 The value of this text box identifies the set of the
1100 characters used by &app;.
1105 It is advise to leave this value to
1106 <literal>UTF-8</literal>. Change it only
1107 if that charset does not cover your language.
1115 <guilabel>Server</guilabel>
1119 Use this text box to write the name of the
1120 server you want to use for this service.
1126 <guilabel>Port</guilabel>
1130 Use this spin box to set the number of the port of
1134 You can set values in the range from
1135 <literal>0</literal> to <literal>65,555</literal>.
1143 <sect3 id="empathy-gadugadu-advanced">
1144 <title>Gadu Gadu</title>
1148 <term><guilabel>Nick</guilabel></term>
1151 Use this text box to write an alternative name to
1152 use with this service.
1164 <sect1 id="empathy-contacts-groups">
1165 <title>Contacts and Groups</title>
1167 All the contacts are handled within &app;'s <link
1168 linkend="empathy-FIG-mainwindow">main window</link>.
1171 You can add or remove a contact or you can edit the information
1172 of a particular contact. It is also possibile to arrange
1173 contacts in groups. You can have a group for your work contacts,
1174 one for you family contacts, and so on.
1176 <sect2 id="empathy-add-contact">
1177 <title>Adding and Removing a Contact</title>
1179 To add a new contact, proceed as follows:
1185 From the <link linkend="empathy-FIG-mainwindow">main
1186 window</link> choose <menuchoice>
1187 <guimenu>Chat</guimenu>
1188 <guimenuitem>Add Contact...</guimenuitem>
1189 </menuchoice>. The <guilabel>New Contact</guilabel>
1190 dialog will be shown.
1195 From the <guilabel>Account</guilabel> drop-down list,
1196 choose the service used by the contact you are adding.
1201 In the <guilabel>Identifier</guilabel> text box type the
1202 <emphasis>address</emphasis> of the contact in the form
1204 <userinput><replaceable>user name</replaceable>@<replaceable>service
1205 domain</replaceable></userinput>.
1210 In the <guilabel>Alias</guilabel> text box type the name
1211 you want to give at the the new contact.
1216 Click on <guibutton>Add</guibutton> to add the new contact.
1222 To remove a contact, proceed as follows:
1228 From the <link linkend="empathy-FIG-mainwindow">main
1229 window</link>, select the contact you would like
1230 to remove and right-click on it.
1235 From the popup menu, choose <guilabel>Remove</guilabel> to
1244 An <emphasis>alias</emphasis> is an alternative way you
1245 can identify that particular contact. You can use the real
1246 name or the nickname of that person.
1251 <sect2 id="empathy-edit-contact">
1252 <title>Editing a Contact</title>
1254 To edit a contact, proceed as follows:
1260 From the <link linkend="empathy-FIG-mainwindow">main
1261 window</link>, select the contact you would like
1262 to modify and choose <menuchoice>
1263 <guimenu>Edit</guimenu>
1264 <guisubmenu>Contact</guisubmenu>
1265 <guimenuitem>Edit</guimenuitem>
1266 </menuchoice>, or right-click on it
1267 and choose <guilabel>Edit</guilabel>.
1273 From the <guilabel>Edit Contact Information</guilabel> dialog,
1274 you can modify the <emphasis>alias</emphasis>
1275 and the <emphasis>group</emphasis> of the contact.
1280 An <emphasis>alias</emphasis> is an alternative way you
1281 can identify that particular contact. You can use the real
1282 name or the nickname of that person.
1287 For more information about groups, see <xref
1288 linkend="empathy-add-contact-group"/> and <xref
1289 linkend="empathy-add-group"/>.
1293 <sect2 id="empathy-add-contact-group">
1294 <title>Adding a Contact to a Group</title>
1296 To add a contact to one or more groups, proceed as follows:
1302 From the <link linkend="empathy-FIG-mainwindow">main
1303 window</link>, select the contact you would like
1304 to modify and choose <menuchoice>
1305 <guimenu>Edit</guimenu>
1306 <guisubmenu>Contact</guisubmenu>
1307 <guimenuitem>Edit</guimenuitem>
1308 </menuchoice>, or right-click on it
1309 and choose <guilabel>Edit</guilabel>.
1314 From the <guilabel>Groups</guilabel> section, select the
1315 group, or groups, you want to add the contact to.
1320 When done, click <guibutton>Close</guibutton>.
1327 <sect2 id="empathy-add-group">
1328 <title>Adding a New Group</title>
1330 To add a new group, proceed as follows:
1336 From the <link linkend="empathy-FIG-mainwindow">main
1337 window</link>, select one contact and choose <menuchoice>
1338 <guimenu>Edit</guimenu>
1339 <guisubmenu>Contact</guisubmenu>
1340 <guimenuitem>Edit</guimenuitem>
1341 </menuchoice>, or right-click on it
1342 and choose <guilabel>Edit</guilabel>.
1347 In the <guilabel>Groups</guilabel> section, write the
1348 name of the group you want to add and then click on
1349 <guibutton>Add Group</guibutton>.
1354 When done, click <guibutton>Close</guibutton>.
1363 <sect1 id="empathy-send-receive-message">
1364 <title>Sending and Receiving Messages</title>
1369 <sect1 id="empathy-preferences">
1370 <title>Preferences</title>