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:user-guide?feedback" type="help">GNOME Feedback Page</ulink>.
117 <abstract role="description">
119 &appname; is an application for instant messaging.
125 <indexterm zone="index">
126 <primary>Empathy</primary>
128 <indexterm zone="index">
129 <primary>empathy</primary>
130 <secondary>istant messaging</secondary>
133 <sect1 id="empathy-intro">
134 <title>Introduction</title>
136 &app; is a multi-protocol instant messaging program for the
137 GNOME Desktop. With &app; you can keep in touch with all of your
138 friends through lots of supported instant messaging services.
141 &app; supports the following services:
145 <acronym>AIM</acronym>
160 <acronym>IRC</acronym>
165 Jabber (or <acronym>XMPP</acronym>)
170 <acronym>MSN</acronym>
180 <acronym>SIP</acronym>
197 <sect1 id="empathy-getting-started">
198 <title>Getting Started</title>
200 <sect2 id="empathy-starting">
201 <title>Starting &appname;</title>
202 <para>You can start &app; in the following ways:
206 <term><guimenu>Applications</guimenu> menu</term>
210 <guisubmenu>Internet</guisubmenu>
211 <guimenuitem>Empathy Instant Messenger</guimenuitem>
217 <term>Command line</term>
219 <para>Type <command>empathy</command> and then press
220 <keycap>Enter</keycap>.
227 <sect2 id="emphaty-when-start">
228 <title>When You Start &appname;</title>
230 When you start &app; the following window is shown.
232 <figure id="empathy-FIG-mainwindow">
233 <title>&app; Main Window</title>
237 <imagedata fileref="figures/empathy-main-window.png" format="PNG"/>
241 Shows &app; main window. Contains the titlebar, the
242 menubar, contact list, status icon and status arrow
249 <!-- End of Figure -->
252 <xref linkend="empathy-TBL-1"/> describes the components of
254 <table frame="topbot" id="empathy-TBL-1">
255 <title>&app; Main Components</title>
256 <tgroup cols="2" colsep="0" rowsep="0">
257 <colspec colname="colspec0" colwidth="29.39*"/>
258 <colspec colname="colspec1" colwidth="70.61*"/>
262 <para>Component</para>
265 <para>Description</para>
276 Contains menus used to perform actions in &app;.
282 <para>Status Drop-Down List</para>
286 Allows to update the status.
292 <para>Account Button</para>
296 Opens the <guilabel>Accounts</guilabel> dialog.
302 <para>Contact List</para>
306 Shows all the available contacts and their
318 <sect1 id="empathy-accounts">
319 <title>Accounts</title>
321 To use &app; you need at least one account of the supported services.
324 If you don't already have an account and you don't have your <emphasis>user
325 name</emphasis> and <emphasis>password</emphasis>, you need to
326 register a new account (see <xref linkend="empathy-register-account" />).
329 In order to talk with other users, also called
330 <emphasis>contacts</emphasis>, you need to use the same service
331 they are using. If, for example, one contact is using the <emphasis
332 role="strong">Jabber</emphasis> service, you need to have an
333 account registered with that service.
336 &app; can handle as many accounts on any supported services as you want and
337 you can have them all open at the same time.
340 <sect2 id="empathy-register-account">
341 <title>Registering an Account</title>
343 You can freely register an account on any of the following
344 services. Follow the instructions reported on each website on
345 how to register your new account. At the end of the
346 registration process you should have a <emphasis>user
347 name</emphasis> (or an <emphasis>account ID</emphasis>) and
348 a <emphasis>password</emphasis> that you will use to
349 create the account in &app;.
352 Click on the name of the service to visit its website:
353 <!-- Need to do like that, if using only
354 <ulink>SERVICE</ulink> it wouldn't be possibile to
355 localize the links -->
358 <!-- Translators: try to find a localized version of the
359 registration service website -->
361 The <ulink type="http" url="&aim;">AIM</ulink> service.
365 <!-- Translators: try to find a localized version of the
366 registration service website -->
368 The <ulink type="http" url=">alk;">Google
369 Talk</ulink> service.
373 <!-- Translators: try to find a localized version of the
374 registration service website -->
376 The <ulink type="http" url="&icq;">ICQ</ulink> service.
380 <!-- Translators: try to find a localized version of the
381 registration service website -->
383 The <ulink type="http" url="&msn;">MSN</ulink> service.
387 <!-- Translators: try to find a localized version of the
388 registration service website -->
390 The <ulink type="http" url="&yahoo;">Yahoo</ulink> service.
396 For registering a <acronym>SIP</acronym> account, you can use one of the
402 <!-- Translators: try to find a localized version of the
403 registration service website -->
405 The <ulink type="http" url="&ekiga;">Ekiga</ulink> service.
409 <!-- Translators: try to find a localized version of the
410 registration service website -->
412 The <ulink type="http" url="&fwd;"><acronym>FWD</acronym></ulink> (Free
413 World Dialup) service.
417 <!-- Translators: try to find a localized version of the
418 registration service website -->
420 The <ulink type="http" url="&sipphone;">Sipphone</ulink> service.
426 For registering a <emphasis role="strong">Jabber</emphasis>
427 account, you can use the automatic
428 account creation of &app;. Not all Jabber service
429 providers support the automatic creation of accounts, one
430 service provider known to work with &app; is <ulink
431 type="http" url="&jabber;">jabber.org</ulink>.
434 If you already have a <emphasis
435 role="strong">Jabber</emphasis> account, you can use one of
436 the following services:
449 <sect2 id="empathy-create-account">
450 <title>Adding your Account to &app;</title>
452 To add your account to &app;, proceed as follows:
456 From the <link linkend="empathy-FIG-mainwindow">main window
457 </link> (<guilabel>Contact List</guilabel>)
458 click on the account button or press <keycap>F4</keycap> to open the
459 <guilabel>Accounts</guilabel> dialog.
464 If it is the first time you launch &app;:
468 From the <guilabel>Type</guilabel> drop-down list choose
469 the service you wish to add an account for, then click
470 on the <guibutton>Create</guibutton> button.
480 Click on the <guilabel>Add</guilabel> button.
485 From the <guilabel>Type</guilabel> drop-down list choose
486 the service you wish to add an account for, then click
487 on the <guibutton>Create</guibutton> button.
495 Fill the required fields with your <emphasis>user
497 <emphasis>password</emphasis>. Optionally, you can
498 modify some advanced options. For more information,
499 see <xref linkend="empathy-advanced-options"/>.
504 To enable the new account, select the
505 <guilabel>Enabled</guilabel> check-box next to
506 the name of the account in the box on the left.
512 <sect3 id="empathy-importing-accounts">
513 <title>Importing Accounts</title>
515 If you use another instant messaging program, you can import
516 the accounts from that program into &app;
521 At the moment &app; can import the accounts only from
522 the instant messaging program
523 <application>Pidgin</application>. For more information
524 about <application>Pidgin</application>, see the <ulink
525 type="http" url="http://www.pidgin.im/">Pidgin website</ulink>.
530 To import the accounts into &app;, proceed as follows:
534 From the <link linkend="empathy-FIG-mainwindow">main window
535 </link> (<guilabel>Contact List</guilabel>)
536 click on the account button or press <keycap>F4</keycap> to open the
537 <guilabel>Accounts</guilabel> dialog.
542 Click on the <guibutton>Import Accounts...</guibutton>
543 button to open the <guilabel>Import
544 Accounts</guilabel> dialog.
549 Select the accounts you would like to import by
550 clicking on the <guilabel>Import</guilabel> check-box.
555 When you have selected all the desired accounts, click
556 <guibutton>OK</guibutton> to import them. If you don't
557 want to import the accounts, click
558 <guibutton>Cancel</guibutton>.
563 When you import a new account into &app;, it will not be
567 To enable the new account, select the
568 <guilabel>Enabled</guilabel> check-box next to
569 the name of the account in the box on the left.
577 <sect2 id="empathy-edit-account">
578 <title>Editing an Account</title>
580 To edit one of your accounts, i.e. to change the
581 <emphasis>password</emphasis> or your <emphasis>user
582 name</emphasis>, proceed as follows:
586 From the <link linkend="empathy-FIG-mainwindow">main window
587 </link> (<guilabel>Contact List</guilabel>)
588 click on the account button or press <keycap>F4</keycap> to open the
589 <guilabel>Accounts</guilabel> dialog.
594 Select the account you wish to edit in the box on the
600 Modify the desired data.
608 Based on the type of the account, it is possibile to edit
614 To modify the identifier of an account, how &app; identifies
615 an account, proceed as follows:
619 From the <link linkend="empathy-FIG-mainwindow">main window
620 </link> (<guilabel>Contact List</guilabel>)
621 click on the account button or press <keycap>F4</keycap> to open the
622 <guilabel>Accounts</guilabel> dialog.
627 Select the account you wish to edit in the box on the
628 left and double-click on its name.
633 Change the name of the account as you desire.
640 <sect2 id="empathy-disabling-removing-account">
641 <title>Disabling and Removing an Account</title>
643 To disable an account, proceed as follows:
649 From the <link linkend="empathy-FIG-mainwindow">main window
650 </link> (<guilabel>Contact List</guilabel>)
651 click on the account button or press <keycap>F4</keycap>
653 <guilabel>Accounts</guilabel> dialog.
658 Select the account you wish to disable in the box on the
659 left of the dialog and deselect the
660 <guilabel>Enabled</guilabel> check-box.
666 To remove an account, proceed as follows:
672 From the <link linkend="empathy-FIG-mainwindow">main window
673 </link> (<guilabel>Contact List</guilabel>)
674 click on the account button or press <keycap>F4</keycap>
676 <guilabel>Accounts</guilabel> dialog.
681 Select the account you wish to disable in the box on the
687 Click on the <guibutton>Remove</guibutton> button.
692 A dialog will be shown asking for confirmation. Click on
693 the <guibutton>Remove</guibutton> button to remove the account.
700 <sect2 id="empathy-edit-personal-information">
701 <title>Editing Personal Information</title>
703 To change your personal information, your alias and your
704 icon (the image that other contacts will see of you), for each
705 of your accounts, proceed as follows:
711 From the <link linkend="empathy-FIG-mainwindow">main
712 window</link>, select <menuchoice>
713 <guimenu>Edit</guimenu>
714 <guimenuitem>Personal Information</guimenuitem>
720 From the <guilabel>Account</guilabel> drop-down list, choose
721 the account you want to edit.
726 In the <guilabel>Alias</guilabel> text box, write your new
732 To change your icon, click on the person-looking button and
733 choose an image file.
738 When done, click <guibutton>Close</guibutton>.
746 An <emphasis>alias</emphasis> is an alternative way you
747 can identify yourself. You can use your real
754 <sect2 id="empathy-advanced-options">
755 <title>Advanced Options</title>
757 Based on the service you are using, it is possible to
758 configure more advanced options to modify the normal behavior of
762 To configure these options, when you are <link
763 linkend="empathy-create-account">adding a new
764 account</link>, click on the drop-down section
765 <guilabel>Advanced</guilabel>.
768 <sect3 id="empathy-xmpp-advanced">
770 Jabber (or <acronym>XMPP</acronym>) and Google Talk
776 <guilabel>Encryption required (TLS/SSL)</guilabel>
780 Select this option in order to use some sort of
781 encryption during your conversations.
787 <guilabel>Ignore SSL certificate errors</guilabel>
791 Select this option in order to ignore the errors
792 that can be generated by some types of security
793 certificates. Usually these certificates are called
799 Select this option only if you are sure the
800 certificate is secure and you can trust it.
808 <guilabel>Resource</guilabel>
812 Use this text box to set a name with which you can
813 identify the running program based on where you are
814 running it. With this option, and the
815 <guilabel>Priority</guilabel> one, you can
816 use your account simultaneously in two different
817 devices. For example, if you set one device to
818 <replaceable>desktop</replaceable> and the other
819 one to <replaceable>mobile</replaceable>, you can
820 connect with both of them and based on the
821 <guilabel>Priority</guilabel> value you will receive
822 messages on one of the two devices or both.
825 This can be useful if you have two devices, a main
826 one and a portable one, and you move away from the
827 main one bringing with you the other: you can still
828 receive messages from your account with the portable
829 device even if you do not disconnet from the main one.
834 If you set the same value for this text box on
835 both the devices, when you connect with one of
836 them, the other one will be disconnected, even
837 if you set a different value with the
838 <guilabel>Priority</guilabel> spin box.
846 <guilabel>Priority</guilabel>
850 Use this spin box to indicate wich device, set in
851 the <guilabel>Resource</guilabel> text box, will
852 receive the new messages. The higher the number, the
853 higher the priority: you will receive the new
854 messages on the device with the highest number.
857 You can set values in the range from
858 <literal>-128</literal> to <literal>127</literal>.
863 If you set the same value of this spin box in
864 both the devices, you will receive messages on
874 In the <guilabel>Override server settings</guilabel> section
875 you can set options that take precedence over the default settings.
879 <guilabel>Server</guilabel>
883 Use this text box to write the name of the
884 server you want to use for this service.
890 <guilabel>Port</guilabel>
894 Use this spin box to set the number of the port of
898 You can set values in the range from
899 <literal>0</literal> to <literal>65,555</literal>.
905 <guilabel>Use old SSL</guilabel>
909 Select this option to use the old version of the
910 secure protocol for encrypting your connection.
918 <sect3 id="empathy-yahoo-advanced">
924 <guilabel>Ignore conference and chatrooms
925 invitations</guilabel>
929 Select this option to ignore the invitations that
930 other people may send you.
936 <guilabel>Room List locale</guilabel>
940 The value of this text box identifies the language
941 used to retrieve the room list when connecting to
945 If you need to change this value, use the two letter
946 code of your language.
952 <guilabel>Charset</guilabel>
956 The value of this text box identifies the set of the
957 characters used by &app;.
962 It is advise to leave this value to
963 <literal>UTF-8</literal>. Change it only
964 if that charset does not cover your language.
972 <guilabel>Server</guilabel>
976 Use this text box to write the name of the
977 server you want to use for this service.
983 <guilabel>Port</guilabel>
987 Use this spin box to set the number of the port of
991 You can set values in the range from
992 <literal>0</literal> to <literal>65,555</literal>.
998 <guilabel>Use Yahoo Japan</guilabel>
1002 Select this option only if you have a Yahoo! Japan
1003 account. With the Yahoo! Japan service you can only
1004 use a Yahoo! Japan account: if you have registered
1005 an account with the English version of the service,
1006 that account will not work.
1014 <sect3 id="empathy-msn-advanced">
1015 <title><acronym>AIM</acronym>, GroupWise and <acronym>MSN</acronym></title>
1020 <guilabel>Server</guilabel>
1024 Use this text box to write the name of the
1025 server you want to use for this service.
1031 <guilabel>Port</guilabel>
1035 Use this spin box to set the number of the port of
1039 You can set values in the range from
1040 <literal>0</literal> to <literal>65,555</literal>.
1048 <sect3 id="empathy-salut-advanced">
1049 <title>Salut</title>
1054 <guilabel>Published Name</guilabel>
1058 Use this text box to write the name that will be
1059 visible to the other users of the network.
1065 <guilabel>Email</guilabel>
1069 Use this text box to write your email.
1075 <guilabel>Jabber ID</guilabel>
1079 Use this text box to write your Jabber ID, if you
1088 <sect3 id="empathy-icq-advanced">
1094 <guilabel>Charset</guilabel>
1098 The value of this text box identifies the set of the
1099 characters used by &app;.
1104 It is advise to leave this value to
1105 <literal>UTF-8</literal>. Change it only
1106 if that charset does not cover your language.
1114 <guilabel>Server</guilabel>
1118 Use this text box to write the name of the
1119 server you want to use for this service.
1125 <guilabel>Port</guilabel>
1129 Use this spin box to set the number of the port of
1133 You can set values in the range from
1134 <literal>0</literal> to <literal>65,555</literal>.
1142 <sect3 id="empathy-gadugadu-advanced">
1143 <title>Gadu Gadu</title>
1147 <term><guilabel>Nick</guilabel></term>
1150 Use this text box to write an alternative name to
1151 use with this service.
1163 <sect1 id="empathy-contacts-groups">
1164 <title>Contacts and Groups</title>
1166 All the contacts are handled within &app;'s <link
1167 linkend="empathy-FIG-mainwindow">main window</link>.
1170 You can add or remove a contact or you can edit the information
1171 of a particular contact. It is also possibile to arrange
1172 contacts in groups. You can have a group for your work contacts,
1173 one for you family contacts, and so on.
1175 <sect2 id="empathy-add-contact">
1176 <title>Adding and Removing a Contact</title>
1178 To add a new contact, proceed as follows:
1184 From the <link linkend="empathy-FIG-mainwindow">main
1185 window</link> choose <menuchoice>
1186 <guimenu>Chat</guimenu>
1187 <guimenuitem>Add Contact...</guimenuitem>
1188 </menuchoice>. The <guilabel>New Contact</guilabel>
1189 dialog will be shown.
1194 From the <guilabel>Account</guilabel> drop-down list,
1195 choose the service used by the contact you are adding.
1200 In the <guilabel>Identifier</guilabel> text box type the
1201 <emphasis>address</emphasis> of the contact in the form
1203 <userinput><replaceable>user name</replaceable>@<replaceable>service
1204 domain</replaceable></userinput>.
1209 In the <guilabel>Alias</guilabel> text box type the name
1210 you want to give at the the new contact.
1215 Click on <guibutton>Add</guibutton> to add the new contact.
1221 To remove a contact, proceed as follows:
1227 From the <link linkend="empathy-FIG-mainwindow">main
1228 window</link>, select the contact you would like
1229 to remove and right-click on it.
1234 From the popup menu, choose <guilabel>Remove</guilabel> to
1243 An <emphasis>alias</emphasis> is an alternative way you
1244 can identify that particular contact. You can use the real
1245 name or the nickname of that person.
1250 <sect2 id="empathy-edit-contact">
1251 <title>Editing a Contact</title>
1253 To edit a contact, proceed as follows:
1259 From the <link linkend="empathy-FIG-mainwindow">main
1260 window</link>, select the contact you would like
1261 to modify and choose <menuchoice>
1262 <guimenu>Edit</guimenu>
1263 <guisubmenu>Contact</guisubmenu>
1264 <guimenuitem>Edit</guimenuitem>
1265 </menuchoice>, or right-click on it
1266 and choose <guilabel>Edit</guilabel>.
1272 From the <guilabel>Edit Contact Information</guilabel> dialog,
1273 you can modify the <emphasis>alias</emphasis>
1274 and the <emphasis>group</emphasis> of the contact.
1279 An <emphasis>alias</emphasis> is an alternative way you
1280 can identify that particular contact. You can use the real
1281 name or the nickname of that person.
1286 For more information about groups, see <xref
1287 linkend="empathy-add-contact-group"/> and <xref
1288 linkend="empathy-add-group"/>.
1292 <sect2 id="empathy-add-contact-group">
1293 <title>Adding a Contact to a Group</title>
1295 To add a contact to one or more groups, proceed as follows:
1301 From the <link linkend="empathy-FIG-mainwindow">main
1302 window</link>, select the contact you would like
1303 to modify and choose <menuchoice>
1304 <guimenu>Edit</guimenu>
1305 <guisubmenu>Contact</guisubmenu>
1306 <guimenuitem>Edit</guimenuitem>
1307 </menuchoice>, or right-click on it
1308 and choose <guilabel>Edit</guilabel>.
1313 From the <guilabel>Groups</guilabel> section, select the
1314 group, or groups, you want to add the contact to.
1319 When done, click <guibutton>Close</guibutton>.
1326 <sect2 id="empathy-add-group">
1327 <title>Adding a New Group</title>
1329 To add a new group, proceed as follows:
1335 From the <link linkend="empathy-FIG-mainwindow">main
1336 window</link>, select one contact and choose <menuchoice>
1337 <guimenu>Edit</guimenu>
1338 <guisubmenu>Contact</guisubmenu>
1339 <guimenuitem>Edit</guimenuitem>
1340 </menuchoice>, or right-click on it
1341 and choose <guilabel>Edit</guilabel>.
1346 In the <guilabel>Groups</guilabel> section, write the
1347 name of the group you want to add and then click on
1348 <guibutton>Add Group</guibutton>.
1353 When done, click <guibutton>Close</guibutton>.
1362 <sect1 id="empathy-send-receive-message">
1363 <title>Sending and Receiving Messages</title>
1368 <sect1 id="empathy-preferences">
1369 <title>Preferences</title>