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