help/C/empathy.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 <!ENTITY legal SYSTEM "legal.xml">
   5 <!ENTITY appversion "2.24">
   6 <!ENTITY manrevision "2.0">
   7 <!ENTITY date "April 2008">
   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">
  15 <!ENTITY fwd
  16 "http://account2.freeworlddialup.com/index.php?section_id=94">
  17 <!ENTITY ekiga
  18 "http://www.ekiga.net/user/reg/index.php?phplib_Session=c1d85267756241f8190e5fc21b029a62">
  19 <!ENTITY sipphone "https://signup.sipphone.com/new-users/app?class=NewUser;proc=start">
  20 ]>
  21 <?db.chunk.max_depth 2?>
  22 <article id="index" lang="en">
  23   <!-- please do not change the id; for translations, change lang to -->
  24   <!-- appropriate code -->
  25   <articleinfo>
  26     <title>&app; Manual V&manrevision;</title>
  27
  28     <copyright>
  29       <year>2008</year>
  30       <holder>Ubuntu Documentation Project</holder>
  31     </copyright>
  32     <!-- An address can be added to the publisher information.  If a role is
  33     not specified, the publisher/author is the same for all versions of the
  34     document.  -->
  35     <publisher>
  36       <publishername>Ubuntu Documentation Project</publishername>
  37     </publisher>
  38
  39     <!-- licence stuff -->
  40     &legal;
  41
  42     <authorgroup>
  43       <author role="maintainer">
  44         <firstname>Milo</firstname>
  45         <surname>Casagrande</surname>
  46         <affiliation>
  47           <orgname>Ubuntu Documentation Project</orgname>
  48           <address><email>milo_casagrande@yahoo.it</email></address>
  49         </affiliation>
  50       </author>
  51       <author>
  52         <firstname>Seth</firstname>
  53         <surname>Dudenhofer</surname>
  54         <affiliation>
  55           <orgname>Ubuntu Documentation Project</orgname>
  56           <address><email>sdudenhofer@gmail.com</email></address>
  57         </affiliation>
  58       </author>
  59     </authorgroup>
  60
  61 <!-- According to GNU FDL, revision history is mandatory if you are -->
  62 <!-- modifying/reusing someone else's document.  If not, you can omit it. -->
  63 <!-- Remember to remove the &manrevision; entity from the revision -->
  64 <!-- entries other than the current revision. -->
  65 <!-- The revision numbering system for GNOME manuals is as follows: -->
  66 <!-- * the revision number consists of two components -->
  67 <!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
  68 <!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
  69 <!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
  70 <!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
  71 <!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
  72 <!-- to V3.0, and so on. -->
  73     <revhistory>
  74       <revision>
  75         <revnumber>Empathy Manual V&manrevision;</revnumber>
  76         <date>&date;</date>
  77         <revdescription>
  78           <para role="author">Milo Casagrande
  79             <email>milo_casagrande@yahoo.it</email>
  80           </para>
  81           <para role="author">Seth Dudenhofer
  82             <email>sdudenhofer@gmail.com</email>
  83           </para>
  84           <para role="publisher">Ubuntu Documentation Project</para>
  85         </revdescription>
  86       </revision>
  87     </revhistory>
  88
  89     <releaseinfo>
  90       This manual describes version &appversion; of &appname;.
  91     </releaseinfo>
  92     <legalnotice>
  93       <title>Feedback</title>
  94       <para>
  95         To report a bug or make a suggestion regarding the &app; application or
  96         this manual, follow the directions in the <ulink url="ghelp:gnome-feedback"
  97           type="help">GNOME Feedback Page</ulink>.
  98       </para>
  99     </legalnotice>
 100
 101     <abstract role="description">
 102       <para>
 103         &appname; is an application for instant messaging.
 104       </para>
 105     </abstract>
 106
 107   </articleinfo>
 108
 109   <indexterm zone="index">
 110     <primary>Empathy</primary>
 111   </indexterm>
 112   <indexterm zone="index">
 113     <primary>empathy</primary>
 114     <secondary>istant messaging</secondary>
 115   </indexterm>
 116
 117   <sect1 id="empathy-intro">
 118     <title>Introduction</title>
 119     <para>
 120       &app; is a multi-protocol instant messaging program for the
 121       GNOME Desktop. With &app; you can keep in touch with all of your
 122       friends through lots of supported instant messaging services.
 123     </para>
 124     <para>
 125       &app; supports the following services:
 126       <itemizedlist>
 127         <listitem>
 128           <para>
 129             <acronym>AIM</acronym>
 130           </para>
 131         </listitem>
 132         <listitem>
 133           <para>
 134             Google Talk
 135           </para>
 136         </listitem>
 137         <listitem>
 138           <para>
 139             ICQ
 140           </para>
 141         </listitem>
 142         <listitem>
 143           <para>
 144             <acronym>IRC</acronym>
 145           </para>
 146         </listitem>
 147         <listitem>
 148           <para>
 149             Jabber
 150           </para>
 151         </listitem>
 152         <listitem>
 153           <para>
 154             <acronym>MSN</acronym>
 155           </para>
 156         </listitem>
 157         <listitem>
 158           <para>
 159             Salut
 160           </para>
 161         </listitem>
 162         <listitem>
 163           <para>
 164             <acronym>SIP</acronym>
 165           </para>
 166         </listitem>
 167         <listitem>
 168           <para>
 169             Yahoo
 170           </para>
 171         </listitem>
 172       </itemizedlist>
 173     </para>
 174   </sect1>
 175
 176   <sect1 id="empathy-getting-started">
 177     <title>Getting Started</title>
 178
 179     <sect2 id="empathy-starting">
 180       <title>Starting &appname;</title>
 181       <para>You can start &app; in the following ways:
 182       </para>
 183       <variablelist>
 184         <varlistentry>
 185           <term><guimenu>Applications</guimenu> menu</term>
 186           <listitem>
 187             <para>Choose
 188               <menuchoice>
 189                 <guisubmenu>Internet</guisubmenu>
 190                 <guimenuitem>Empathy Instant Messenger</guimenuitem>
 191               </menuchoice>.
 192             </para>
 193           </listitem>
 194         </varlistentry>
 195         <varlistentry>
 196           <term>Command line</term>
 197           <listitem>
 198             <para>Type <command>empathy</command> and then press
 199               <keycap>Enter</keycap>.
 200             </para>
 201           </listitem>
 202         </varlistentry>
 203       </variablelist>
 204     </sect2>
 205
 206     <sect2 id="emphaty-when-start">
 207       <title>When You Start &appname;</title>
 208       <para>
 209         When you start &app; the following window is shown.
 210         <!-- Figure 1 -->
 211         <figure id="empathy-FIG-mainwindow">
 212           <title>&app; Main Window</title>
 213           <screenshot>
 214             <mediaobject>
 215               <imageobject>
 216                 <imagedata fileref="figures/empathy-main-window.png" format="PNG"/>
 217               </imageobject>
 218               <textobject>
 219                 <phrase>
 220                   Shows &app; main window. Contains the titlebar, the
 221                   menubar, contact list, status icon and status arrow
 222                   button list.
 223                 </phrase>
 224               </textobject>
 225             </mediaobject>
 226           </screenshot>
 227         </figure>
 228         <!-- End of Figure -->
 229       </para>
 230       <para>
 231         <xref linkend="empathy-TBL-1"/> describes the components of
 232         &app;'s main window.
 233         <table frame="topbot" id="empathy-TBL-1">
 234           <title>&app; Main Components</title>
 235           <tgroup cols="2" colsep="0" rowsep="0">
 236             <colspec colname="colspec0" colwidth="29.39*"/>
 237             <colspec colname="colspec1" colwidth="70.61*"/>
 238             <thead>
 239               <row rowsep="1">
 240                 <entry valign="top">
 241                   <para>Component</para>
 242                 </entry>
 243                 <entry valign="top">
 244                   <para>Description</para>
 245                 </entry>
 246               </row>
 247             </thead>
 248             <tbody>
 249               <row>
 250                 <entry valign="top">
 251                   <para>Menubar</para>
 252                 </entry>
 253                 <entry valign="top">
 254                   <para>
 255                     Contains menus used to perform actions in &app;.
 256                   </para>
 257                 </entry>
 258               </row>
 259               <row>
 260                 <entry valign="top">
 261                   <para>Status Drop-Down List</para>
 262                 </entry>
 263                 <entry valign="top">
 264                   <para>
 265                     Allows to update the user's status.
 266                   </para>
 267                 </entry>
 268               </row>
 269               <row>
 270                 <entry valign="top">
 271                   <para>Account Button</para>
 272                 </entry>
 273                 <entry valign="top">
 274                   <para>
 275                     Opens the <guilabel>Accounts</guilabel> dialog.
 276                   </para>
 277                 </entry>
 278               </row>
 279               <row>
 280                 <entry valign="top">
 281                   <para>Contact List</para>
 282                 </entry>
 283                 <entry valign="top">
 284                   <para>
 285                     Shows all the available contacts and their
 286                     associated status.
 287                   </para>
 288                 </entry>
 289               </row>
 290             </tbody>
 291           </tgroup>
 292         </table>
 293       </para>
 294     </sect2>
 295
 296     <sect2 id="empathy-when-start-new">
 297       <title>When You Start &appname; for the First Time</title>
 298       <para>
 299         When you start &app; for the first time and you don't have
 300         configured any account yet, the following dialog is shown.
 301         <!-- Figure 2 -->
 302         <figure id="empathy-FIG-newaccount">
 303           <title>&app; Accounts Dialog</title>
 304           <screenshot>
 305             <mediaobject>
 306               <imageobject>
 307                 <imagedata fileref="figures/empathy-new-account.png" format="PNG"/>
 308               </imageobject>
 309               <textobject>
 310                 <phrase>
 311                   Shows &app; account creation dialog.
 312                 </phrase>
 313               </textobject>
 314             </mediaobject>
 315           </screenshot>
 316         </figure>
 317         <!-- End of Figure -->
 318       </para>
 319       <para>
 320         From here, you can configure and create your accounts. See
 321         <xref linkend="empathy-accounts" /> for more information.
 322       </para>
 323     </sect2>
 324
 325   </sect1>
 326
 327   <sect1 id="empathy-accounts">
 328     <title>Accounts</title>
 329     <para>
 330       To use &app; you need at least one account of the supported services.
 331     </para>
 332     <para>
 333       If you don't already have an account and you don't have your <emphasis>user
 334         name</emphasis> and <emphasis>password</emphasis>, you need to
 335         register a new account (see <xref linkend="empathy-register-account" />).
 336     </para>
 337     <para>
 338       In order to talk with other users (called
 339       <emphasis>contatcs</emphasis>), you need to use the same service
 340       they are using. If, for example, one contact is using the <emphasis
 341       role="strong">Jabber</emphasis> service, you need to have an
 342       account registerd with that service.
 343     </para>
 344     <para>
 345       &app; can handle as many accounts on any supported services as you want and
 346       you can have them all open at the same time.
 347     </para>
 348
 349     <sect2 id="empathy-register-account">
 350       <title>Registering an Account</title>
 351       <para>
 352         You can freely register an account on any of the following
 353         services. Follow the instructions reported on each website on
 354         how to register your new account. At the end of the
 355         registration process you should have a <emphasis>user
 356           name</emphasis> (or an <emphasis>account ID</emphasis>) and
 357         a <emphasis>password</emphasis> that you will use to
 358         create the account in &app;.
 359       </para>
 360       <para>
 361         Click on the name of the service to visit its website:
 362         <!-- Need to do like that, if using only
 363         <ulink>SERVICE</ulink> it wouldn't be possibile to
 364         localize the links -->
 365         <itemizedlist>
 366           <listitem>
 367             <!-- Translators: try to find a localized version of the
 368             registration service website -->
 369             <para>
 370               The <ulink type="http" url="&aim;">AIM</ulink> service.
 371             </para>
 372           </listitem>
 373           <listitem>
 374             <!-- Translators: try to find a localized version of the
 375             registration service website -->
 376             <para>
 377               The <ulink type="http" url="&gtalk;">Google
 378               Talk</ulink> service.
 379             </para>
 380           </listitem>
 381           <listitem>
 382             <!-- Translators: try to find a localized version of the
 383             registration service website -->
 384            <para>
 385               The <ulink type="http" url="&icq;">ICQ</ulink> service.
 386             </para>
 387           </listitem>
 388           <listitem>
 389             <!-- Translators: try to find a localized version of the
 390             registration service website -->
 391             <para>
 392               The <ulink type="http" url="&msn;">MSN</ulink> service.
 393             </para>
 394           </listitem>
 395           <listitem>
 396             <!-- Translators: try to find a localized version of the
 397             registration service website -->
 398             <para>
 399               The <ulink type="http" url="&yahoo;">Yahoo</ulink> service.
 400             </para>
 401           </listitem>
 402         </itemizedlist>
 403       </para>
 404       <para>
 405         For registering a <acronym>SIP</acronym> account, you can use one of the
 406         following service:
 407       </para>
 408       <para>
 409         <itemizedlist>
 410           <listitem>
 411             <!-- Translators: try to find a localized version of the
 412             registration service website -->
 413             <para>
 414               The <ulink type="http" url="&ekiga;">Ekiga</ulink> service.
 415             </para>
 416           </listitem>
 417           <listitem>
 418             <!-- Translators: try to find a localized version of the
 419             registration service website -->
 420             <para>
 421               The <ulink type="http" url="&fwd;"><acronym>FWD</acronym></ulink> (Free
 422               World Dialup) service.
 423             </para>
 424           </listitem>
 425           <listitem>
 426             <!-- Translators: try to find a localized version of the
 427             registration service website -->
 428             <para>
 429               The <ulink type="http" url="&sipphone;">Sipphone</ulink> service.
 430             </para>
 431           </listitem>
 432         </itemizedlist>
 433       </para>
 434       <para>
 435         You can use one of the following services if you already have
 436         a <emphasis role="strong">Jabber</emphasis> account:
 437       </para>
 438       <para>
 439         <itemizedlist>
 440           <listitem>
 441             <para>
 442               Salut
 443             </para>
 444           </listitem>
 445         </itemizedlist>
 446       </para>
 447     </sect2>
 448
 449     <sect2 id="empathy-create-account">
 450       <title>Creating an Account</title>
 451       <para>
 452         To create an account, proceed as follow:
 453         <orderedlist>
 454           <listitem>
 455             <para>
 456               From the <link linkend="empathy-FIG-mainwindow">main window
 457               </link> (<guilabel>Contact List</guilabel>)
 458               click on the account button to open the
 459               <guilabel>Accounts</guilabel> dialog.
 460             </para>
 461           </listitem>
 462           <listitem>
 463             <para>
 464               Click on the <guibutton>Add</guibutton> button.
 465             </para>
 466           </listitem>
 467           <listitem>
 468             <para>
 469               From the <guilabel>Type</guilabel> drop-down list choose
 470               the service you wish to create an account for, then click
 471               on the <guibutton>Create</guibutton> button.
 472             </para>
 473           </listitem>
 474           <listitem>
 475             <para>
 476               Fill the required fields with your <emphasis>user
 477                 name</emphasis> and <emphasis>password</emphasis>.
 478             </para>
 479           </listitem>
 480           <listitem>
 481             <para>
 482               To enable the new account, select the
 483               <guilabel>Enabled</guilabel> check-box next to
 484               the name of the account.
 485               <!-- in the box on the left of the
 486               <guilabel>Accounts</guilabel> dialog. -->
 487             </para>
 488           </listitem>
 489         </orderedlist>
 490       </para>
 491     </sect2>
 492
 493     <sect2 id="empathy-disabling-removing-account">
 494       <title>Disabling and Removing an Account</title>
 495       <para>
 496         To disable an account, proceed as follow:
 497       </para>
 498       <para>
 499         <orderedlist>
 500           <listitem>
 501             <para>
 502               From the <link linkend="empathy-FIG-mainwindow">main window
 503               </link> (<guilabel>Contact List</guilabel>)
 504               click on the account button to open the
 505               <guilabel>Accounts</guilabel> dialog.
 506             </para>
 507           </listitem>
 508           <listitem>
 509             <para>
 510               Select the account you wish to disable in the box on the
 511               left of the dialog and deselect the
 512               <guilabel>Enabled</guilabel> check-box.
 513             </para>
 514           </listitem>
 515         </orderedlist>
 516       </para>
 517       <para>
 518         To remove an account, proceed as follow:
 519       </para>
 520       <para>
 521         <orderedlist>
 522           <listitem>
 523             <para>
 524               From the <link linkend="empathy-FIG-mainwindow">main window
 525               </link> (<guilabel>Contact List</guilabel>)
 526               click on the account button to open the
 527               <guilabel>Accounts</guilabel> dialog.
 528             </para>
 529           </listitem>
 530           <listitem>
 531             <para>
 532               Select the account you wish to disable in the box on the
 533               left of the dialog.
 534             </para>
 535           </listitem>
 536           <listitem>
 537             <para>
 538               Click on the <guibutton>Remove</guibutton> button.
 539             </para>
 540           </listitem>
 541           <listitem>
 542             <para>
 543               A dialog will be shown asking for confirmation. Click on
 544               the <guibutton>Remove</guibutton> button to remove the account.
 545             </para>
 546           </listitem>
 547         </orderedlist>
 548       </para>
 549     </sect2>
 550   </sect1>
 551
 552   <sect1 id="empathy-contacts">
 553     <title>Contacts</title>
 554     <para>
 555       All the contacts are handled within &app;'s <link
 556       linkend="empathy-FIG-mainwindow">main window</link>.
 557     </para>
 558     <sect2 id="empathy-add-contact">
 559       <title>Adding a Contact</title>
 560       <para>
 561         To add a new contact, proceed as follow:
 562       </para>
 563       <para>
 564         <orderedlist>
 565           <listitem>
 566             <para>
 567               From the <link linkend="empathy-FIG-mainwindow">main
 568                 window</link> choose <menuchoice>
 569                 <guimenu>Chat</guimenu>
 570                 <guimenuitem>Add Contact...</guimenuitem>
 571               </menuchoice>. The <guilabel>New Contact</guilabel>
 572                 dialog will be shown.
 573             </para>
 574           </listitem>
 575           <listitem>
 576             <para>
 577               From the <guilabel>Account</guilabel> drop-down list,
 578               choose the service used by the contact you are adding.
 579             </para>
 580           </listitem>
 581           <listitem>
 582             <para>
 583               In the <guilabel>Identifier</guilabel> text-box type the
 584               <emphasis>address</emphasis> of the contact in the form
 585               of
 586               <userinput><replaceable>user name</replaceable>@<replaceable>service
 587               domain</replaceable></userinput>.
 588             </para>
 589           </listitem>
 590           <listitem>
 591             <para>
 592               In the <guilabel>Alias</guilabel> text-box type the name
 593               you want to give at the the new contact.
 594             </para>
 595           </listitem>
 596           <listitem>
 597             <para>
 598               Click on <guibutton>Add</guibutton> to add the new contact.
 599             </para>
 600           </listitem>
 601         </orderedlist>
 602       </para>
 603     </sect2>
 604     <sect2 id="empathy-remove-contact">
 605       <title>Removing a Contact</title>
 606       <para>
 607         To remove a contact, proceed as follow:
 608       </para>
 609       <para>
 610         <orderedlist>
 611           <listitem>
 612             <para>
 613               From the <link linkend="empathy-FIG-mainwindow">main
 614               window</link>, select the contact you would like
 615               to remove and right-click on it.
 616             </para>
 617           </listitem>
 618           <listitem>
 619             <para>
 620               From the popup menu, choose <guilabel>Remove</guilabel> to
 621               remove the contact.
 622             </para>
 623           </listitem>
 624         </orderedlist>
 625       </para>
 626     </sect2>
 627     <sect2>
 628       <title>Modifying a Contact</title>
 629       <para>
 630       </para>
 631     </sect2>
 632   </sect1>
 633
 634
 635 </article>