2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
3 <!ENTITY legal SYSTEM "legal.xml">
4 <!ENTITY appversion "0.16">
5 <!ENTITY manrevision "2.1">
6 <!ENTITY date "December 2006">
7 <!ENTITY app "XChat-GNOME">
8 <!-- Information about the entities
9 The legal.xml file contains legal information, there is no need to edit the file.
10 Use the appversion entity to specify the version of the application.
11 Use the manrevision entity to specify the revision number of this manual.
12 Use the date entity to specify the release date of this manual.
13 Use the app entity to specify the name of the application. -->
17 (Do not remove this comment block.)
18 Maintained by the GNOME Documentation Project
19 http://developer.gnome.org/projects/gdp
20 Template version: 2.0 beta
21 Template last modified Apr 11, 2002
23 <!-- =============Document Header ============================= -->
24 <article id="index" lang="en">
25 <!-- please do not change the id; for translations, change lang to -->
26 <!-- appropriate code -->
28 <title><application>&app;</application> Manual</title>
31 <year>2005-2006</year>
32 <holder>Brian Pepple</holder>
36 <holder>Joachim Noreiko</holder>
38 <!-- translators: uncomment this:
42 <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
46 <!-- An address can be added to the publisher information. If a role is
47 not specified, the publisher/author is the same for all versions of the
50 <publishername>Brian Pepple</publishername>
54 <!-- This file contains link to license for the documentation (GNU FDL), and
55 other legal stuff such as "NO WARRANTY" statement. Please do not change
59 <author role="maintainer">
60 <firstname>Brian</firstname>
61 <surname>Pepple</surname>
63 <orgname>Fedora Project</orgname>
64 <address> <email>bpepple@fedoraproject.org</email> </address>
68 <firstname>Joachim</firstname>
69 <surname>Noreiko</surname>
71 <orgname>GNOME Documentation Project</orgname>
72 <address> <email>jnoreiko@yahoo.com</email> </address>
76 <!-- This is appropriate place for other contributors: translators,
77 maintainers, etc. Commented out by default.
79 <othercredit role="translator">
80 <firstname>Latin</firstname>
81 <surname>Translator 1</surname>
83 <orgname>Latin Translation Team</orgname>
84 <address> <email>translator@gnome.org</email> </address>
86 <contrib>Latin translation</contrib>
92 <!-- According to GNU FDL, revision history is mandatory if you are -->
93 <!-- modifying/reusing someone else's document. If not, you can omit it. -->
94 <!-- Remember to remove the &manrevision; entity from the revision entries other
96 <!-- than the current revision. -->
97 <!-- The revision numbering system for GNOME manuals is as follows: -->
98 <!-- * the revision number consists of two components -->
99 <!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
100 <!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
101 <!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
102 <!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
103 <!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
104 <!-- to V3.0, and so on. -->
107 <revnumber>&app; Manual &manrevision;</revnumber>
110 <para role="author">Joachim Noreiko
111 <email>jnoreiko@yahoo.com</email>
113 <para role="publisher">GNOME Documentation Project</para>
117 <revnumber>XChat-GNOME Manual V2.0</revnumber>
118 <date>November 2005</date>
120 <para role="author">Brian Pepple
121 <email>bpepple@fedoraproject.org</email>
123 <para role="publisher">GNOME Documentation Project</para>
128 <releaseinfo>This manual describes version &appversion; of XChat-GNOME.</releaseinfo>
130 <title>Feedback</title>
131 <para>To report a bug or make a suggestion regarding the <application>&app;</application>
132 application or this manual, follow the directions in the Feedback section of the
133 <ulink url="ghelp:user-guide?feedback-bugs" type="help">GNOME User Guide</ulink>.
135 <!-- Translators may also add here feedback address for translations -->
138 <abstract role="description">
139 <para>A user manual which describes the use of the XChat-GNOME IRC client.</para>
143 <indexterm zone="index">
144 <primary>&app;</primary>
146 <indexterm zone="index">
147 <primary>xchat-gnome</primary>
150 <!-- ============= Document Body ============================= -->
151 <!-- ============= Introduction ============================== -->
152 <!-- Use the Introduction section to give a brief overview of what
153 the application is and what it does. -->
154 <sect1 id="xchat-gnome-introduction">
155 <title>Introduction</title>
156 <para>The <application>&app;</application> application is an Internet Relay Chat (IRC) program for
159 <para><application>&app;</application> provides the following features:</para>
162 <para>Notification Area Icon Plugin</para>
165 <para>Direct Client-To-Client (DCC) Transfers</para>
168 <para>Direct Client-To-Client (DCC) Chats</para>
171 <para>Adherence to GNOME Human Interface Guidelines (HIG)</para>
176 <!-- =========== Getting Started ============================== -->
177 <!-- Use the Getting Started section to describe the steps required
178 to start the application and to describe the user interface components
179 of the application. If there is other information that it is important
180 for readers to know before they start using the application, you should
181 also include this information here.
182 If the information about how to get started is very short, you can
183 include it in the Introduction and omit this section. -->
185 <sect1 id="xchat-gnome-getting-started">
186 <title>Getting Started</title>
187 <sect2 id="xchat-gnome-start">
188 <title>Starting <application>&app;</application></title>
189 <para>You can start <application>&app;</application> in the following ways:
193 <term><guimenu>Applications</guimenu> menu</term>
197 <guisubmenu>Internet</guisubmenu>
198 <guimenuitem>XChat-GNOME IRC Chat</guimenuitem>
204 <term>Command line</term>
206 <para>To start <application>&app;</application> from a command line,
207 type <command>xchat-gnome</command>, then press <keycap>Return</keycap>:
210 <para>To view other command line options that are available,
211 type <command>xchat-gnome --help</command>, then press <keycap>Return</keycap>
219 <sect2 id="xchat-gnome-when-start">
220 <title>When You Start <application>&app;</application></title>
221 <para>When you start <application>&app;</application>, the following window is displayed.</para>
223 <!-- ==== Figure ==== -->
224 <figure id="xchat-gnome-fig">
225 <title><application>&app;</application> Main Window</title>
228 <imageobject><imagedata fileref="figures/xchat-gnome_main_window.png" format="PNG"/>
231 <phrase>Shows <application>&app;</application> main window. Contains titlebar,
232 menubar, display area, and scrollbars. Menubar contains IRC, Edit, Network,
233 Discussion, Go, and Help menus.
239 <!-- ==== End of Figure ==== -->
241 <!-- Include any descriptions of the GUI immediately after the screenshot of the main UI, -->
242 <!-- for example, the items on the menubar and on the toolbar. This section is optional. -->
244 <para>The <application>&app;</application> window contains the following elements:
250 <para>The menus on the menubar contain all of the commands you need to use in
251 <application>&app;</application>.</para>
255 <term>Server Pane</term>
257 <para>The Server Pane shows the Servers and Channels currently connected.</para>
261 <term>User Button</term>
263 <para>The User Button shows the number of users present in the selected Channel. Click the User Button to show a list of users.</para>
267 <term>Discussion Area</term>
269 <para>The Discussion Area presents the discussion occurring in the
270 selected Channel.</para>
271 <para>Type into the message input line at the bottom of the discussion area to chat in the selected Channel.</para>
277 <!-- ================ Usage ================================ -->
278 <!-- Use this section to describe how to use the application to perform the tasks for
279 which the application is designed. -->
280 <sect1 id="xchat-gnome-usage">
283 <!-- ================ Usage Subsection ================================ -->
284 <sect2 id="xchat-gnome-connect">
285 <title>Connecting to an Internet Relay Chat (IRC) Server</title>
286 <para>To connect to an Internet Relay Chat (IRC) Server, choose
288 <guimenu>IRC</guimenu>
289 <guimenuitem>Connect</guimenuitem>
291 <guilabel>Connect</guilabel> dialog is displayed. Select the Server
292 that you wish to connect to, then click
293 <guibutton>Connect</guibutton>.
296 <!-- ================ Usage Subsection ================================ -->
297 <sect2 id="xchat-gnome-transfers">
298 <title>Viewing Direct Client-To-Client (DCC) File Transfers Information</title>
299 <para>To view Direct Client-To-Client (DCC) file transfer information, choose
301 <guimenu>IRC</guimenu>
302 <guimenuitem>File Transfers</guimenuitem>
306 <!-- ================ Usage Subsection ================================ -->
307 <sect2 id="xchat-gnome-edit-text">
308 <title>Editing Text</title>
309 <para>You can edit text in the following ways:</para>
312 <para>To delete the selected text from the file and move the selected text to a buffer,
313 choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Cut</guimenuitem> </menuchoice>.
317 <para>To copy the selected text to a buffer, choose <menuchoice><guimenu>Edit</guimenu>
318 <guimenuitem>Copy</guimenuitem> </menuchoice>.
322 <para>To insert the contents of the buffer at the cursor position, choose
323 <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Paste</guimenuitem> </menuchoice>.
324 You must cut or copy text before you can paste text into the file.
328 <para>To clear all text from the Discussion Area for the currently selected
329 Channel, choose <menuchoice><guimenu>Edit</guimenu>
330 <guimenuitem>Clear</guimenuitem></menuchoice>.
335 <!-- ================ Usage Subsection ================================ -->
336 <sect2 id="xchat-gnome-network-reconnect">
337 <title>Reconnecting to a Server</title>
338 <para>To reconnect <application>&app;</application> to an Internet Relay Chat (IRC)
341 <guimenu>Network</guimenu>
342 <guimenuitem>Reconnect</guimenuitem>
346 <!-- ================ Usage Subsection ================================ -->
347 <sect2 id="xchat-gnome-network-disconnect">
348 <title>Disconnecting from a Server</title>
349 <para>To disconnect <application>&app;</application> from an Internet Relay Chat (IRC)
352 <guimenu>Network</guimenu>
353 <guimenuitem>Disconnect</guimenuitem>
357 <!-- ================ Usage Subsection ================================ -->
358 <sect2 id="xchat-gnome-discussion-save">
359 <title>Saving a Channel Transcript</title>
360 <para>To save a transcript of a Channel, choose
364 <keycap>Ctrl</keycap>
368 <guimenu>Discussion</guimenu>
369 <guimenuitem>Save Transcript</guimenuitem>
373 <!-- ================ Usage Subsection ================================ -->
374 <sect2 id="xchat-gnome-discussion-leave">
375 <title>Leaving a Channel</title>
376 <para>When you leave a channel, you are removed from the participants and can no longer chat in it, but the discussion up to that point remains in the Server Pane.</para>
377 <para>To leave a Channel, choose
381 <keycap>Ctrl</keycap>
385 <guimenu>Discussion</guimenu>
386 <guimenuitem>Leave</guimenuitem>
390 <!-- ================ Usage Subsection ================================ -->
391 <sect2 id="xchat-gnome-discussion-close">
392 <title>Closing a Channel</title>
393 <para>When you close a channel, the channel is removed from the list in the Server Pane.</para>
394 <para>To close a Channel, choose
398 <keycap>Ctrl</keycap>
402 <guimenu>Discussion</guimenu>
403 <guimenuitem>Close</guimenuitem>
407 <!-- ================ Usage Subsection ================================ -->
408 <sect2 id="xchat-gnome-discussion-navigate">
409 <title>Navigating through Channels</title>
412 <para>To view previous channel, choose
420 <guimenu>Go</guimenu>
421 <guimenuitem>Previous Discussion</guimenuitem>
426 <para>To view next channel, choose
431 <keycap>Down</keycap>
434 <guimenu>Go</guimenu>
435 <guimenuitem>Next Discussion</guimenuitem>
441 <!-- ================ Usage Subsection ================================ -->
442 <sect2 id="xchat-gnome-network-navigate">
443 <title>Navigating Through Servers</title>
446 <para>To view previous server, choose
450 <keycap>Ctrl</keycap>
454 <guimenu>Go</guimenu>
455 <guimenuitem>Previous Network</guimenuitem>
460 <para>To view next server, choose
464 <keycap>Ctrl</keycap>
465 <keycap>Down</keycap>
468 <guimenu>Go</guimenu>
469 <guimenuitem>Next Network</guimenuitem>
475 <!-- ================ Usage Subsection ================================ -->
476 <sect2 id="xchat-gnome-quit">
477 <title>Quitting &app;</title>
478 <para>To quit <application>&app;</application>, choose
482 <keycap>Ctrl</keycap>
486 <guimenu>IRC</guimenu>
487 <guimenuitem>Quit</guimenuitem>
492 <!-- ============= Customization ============================= -->
493 <!-- Use this section to describe how to customize the application. -->
494 <sect1 id="xchat-gnome-prefs">
495 <title>Preferences</title>
496 <para>To modify the preferences of <application>&app;</application>, choose
498 <guimenu>Edit</guimenu>
499 <guimenuitem>Preferences</guimenuitem>
501 <guilabel>Preferences</guilabel> dialog contains the following sections:</para>
503 <listitem><para><xref linkend="xchat-gnome-prefs-general"/></para></listitem>
504 <listitem><para><xref linkend="xchat-gnome-prefs-colors"/></para></listitem>
505 <listitem><para><xref linkend="xchat-gnome-prefs-transfers"/></para></listitem>
506 <listitem><para><xref linkend="xchat-gnome-prefs-networks"/></para></listitem>
507 <listitem><para><xref linkend="xchat-gnome-prefs-plugins"/></para></listitem>
509 <!-- =============== Customization Subsection ================ -->
510 <!-- Use a new section to describe different tabbed sections on the Settings or Preferences
512 <sect2 id="xchat-gnome-prefs-general">
513 <title>IRC Preferences</title>
516 <term><guilabel>General</guilabel></term>
518 <para>Enter the <guilabel>Nickname</guilabel> you wish to use in the Internet Relay Chat
519 (IRC) channel.</para>
520 <para>Enter your <guilabel>Real Name</guilabel>, which is displayed on
521 <command>/whois</command> requests.</para>
522 <para>Enter the <guilabel>Quit Message</guilabel> you wish to be shown to other users when you leave an Internet Relay Chat (IRC) network.</para>
523 <para>Enter the <guilabel>Part Message</guilabel> you wish to be shown to other users when you leave an Internet Relay Chat (IRC) channel but remain connected to that channel's network.</para>
524 <para>Enter the <guilabel>Away Message</guilabel> you wish to be shown to people who try to contact you when you are away.</para>
528 <term><guilabel>Highlighting</guilabel></term>
530 <para>Specify words or phrases that should be highlighted in a different text colour when another chat user says them. This is in addition to your nickname, which is always highlighted.</para>
534 <term><guilabel>Use Interface</guilabel></term>
536 <para>Select the <guilabel>Use System Terminal Font</guilabel> option to use the same
537 fonts as your system terminal.</para>
538 <para>Select the <guilabel>Use this font</guilabel> option to open the Font Selection
540 <para>Select the <guilabel>Show colors</guilabel> option to enable color nicknames in
541 discussion area.</para>
542 <para>Select the <guilabel>Show timestamps</guilabel> option to show timestamps of
548 <sect2 id="xchat-gnome-prefs-colors">
549 <title>Colors</title>
552 <term><guilabel>Text Colors</guilabel></term>
554 <para>Use the <guilabel>Built-in schemes</guilabel> drop-down box to specify how
555 <application>&app;</application> should display the text and backgroud color.
556 Select one of the following options:</para>
559 <para>Use the <guilabel>Black on White</guilabel> option to provide black text
560 on a white background.</para>
563 <para>Use the <guilabel>White on Black</guilabel> option to provide white text
564 on a black background.</para>
567 <para>Use the <guilabel>Custom</guilabel> option to create a custom color
572 <para>The following options are only able to be changed if
573 <guilabel>Built-in schemes</guilabel> is
574 set to <guilabel>Custom</guilabel>.</para>
576 <para>Click on the <guilabel>Foreground color</guilabel> button to display the color
577 selector dialog. Select a foreground color for the <application>&app;</application>
578 discussion area.</para>
579 <para>Click on the <guilabel>Background color</guilabel> button to display the color
580 selector dialog. Select the background color for the <application>&app;</application>
581 discussion area.</para>
582 <para>Click on the <guilabel>Foreground mark</guilabel> button to display the color
583 selector dialog. Select the forground mark color for the
584 <application>&app;</application> discussion area.</para>
585 <para>Click on the <guilabel>Background mark</guilabel> button to display the color
586 selector dialog. Select the background mark color for the
587 <application>&app;</application> discussion area.</para>
591 <term><guilabel>mIRC Colors</guilabel></term>
593 <para>Select the buttons of the colors that you wish to change, to display the color
594 selector dialog.</para>
596 <para>The colors are only able to be changed if <guilabel>Built-in schemes</guilabel>
597 is set to <guilabel>Custom</guilabel>.</para>
602 <term><guilabel>Extra Colors</guilabel></term>
604 <para>Selct the buttons of the colors that you wish to change, to display the color
605 selector dialog.</para>
607 <para>The colors are only able to be changed if <guilabel>Built-in
608 schemes</guilabel> is set to <guilabel>Custom</guilabel>.</para>
614 <sect2 id="xchat-gnome-prefs-transfers">
615 <title>File Transfers & DCC</title>
618 <term><guilabel>File Transfers</guilabel></term>
620 <para>Use the <guilabel>Download file to</guilabel> button to select the folder
621 where you wish to download file.</para>
622 <para>Use the <guilabel>Move completed files to</guilabel> button to select the
623 folder where you wish for completed downloads to be moved.</para>
624 <para>Select <guilabel>Convert spaces to underscore in filenames</guilabel> if you
625 wish to have spaces converted to underscores in the filename.</para>
626 <para>Select <guilabel>Save senders nickname in filenames</guilabel> to add the
627 senders nickname to the downloaded file name.</para>
631 <term><guilabel>DCC Settings</guilabel></term>
633 <para>Select the <guilabel>Auto-accept DCC Chat</guilabel> option to automatically
634 accept Direct Client-to-Client (DCC) chats.</para>
635 <para>Select the <guilabel>Auto-accept DCC File Transfers</guilabel> option to
636 automatically accept Direct Client-to-Client (DCC) file transfers.</para>
637 <para>Select the <guilabel>Get IP Address From Server</guilabel> option to use your
638 providers DNS to resolve an IP address.</para>
639 <para>Select the <guilabel>Use This IP Address</guilabel> option and enter your IP
640 address, to use a static IP address.</para>
644 <term><guilabel>Throttling</guilabel></term>
646 <para>Use the <guilabel>Individual send KB/s</guilabel> spin box to set your
647 individual maximum upload speed.</para>
648 <para>Use the <guilabel>Global send KB/s</guilabel> spin box to set your global
649 maximum upload speed.</para>
650 <para>Use the <guilabel>Individual receive KB/s</guilabel> spin box to set your
651 individual maximum download speed.</para>
652 <para>Use the <guilabel>Global receive KB/s</guilabel> spin box to set your global
653 maximum download speed.</para>
658 <sect2 id="xchat-gnome-prefs-networks">
659 <title>Networks</title>
662 <term>Internet Relay Chat (IRC) Servers</term>
664 <para>To add an Internet Relay Chat (IRC) server, click the <guibutton>Add</guibutton>
665 button to open the <guilabel>Network Properties</guilabel> dialog.
666 <xref linkend="xchat-gnome-network-properties"/></para>
667 <para>To edit an Internet Relay Chat (IRC) server, click the <guibutton>Edit</guibutton>
668 button to open the <guilabel>Network Properties</guilabel> dialog.
669 <xref linkend="xchat-gnome-network-properties"/></para>
670 <para>To remove an Internet Relay Chat (IRC) server, click the <guibutton>Remove</guibutton>
671 button. <xref linkend="xchat-gnome-network-properties"/></para>
676 <sect2 id="xchat-gnome-prefs-plugins">
677 <title>Scripts and Plugins</title>
680 <term>Script and Plugins</term>
682 <para>To enable or disable a plugin or script, select the <guilabel>Enable</guilabel> option next
683 to the appropriate item.</para>
684 <para>To add a new plugin or script, click the <guibutton>Open</guibutton> button to open the file
686 <para>To remove a plugin or script, select the appropriate item and click on the
687 <guibutton>Remove</guibutton> buton .</para>
694 <sect1 id="xchat-gnome-network-properties">
695 <title>Network Properties</title>
696 <para>The <guilabel>Network Properties</guilabel> dialog for
697 <application>&app;</application>, allows you to set the properties for
698 an Internet Relay Chat (IRC) server, and contains the following tabs:</para>
700 <listitem><para><xref linkend="xchat-gnome-network-settings"/></para></listitem>
701 <listitem><para><xref linkend="xchat-gnome-network-users"/></para></listitem>
702 <listitem><para><xref linkend="xchat-gnome-network-servers"/></para></listitem>
704 <sect2 id="xchat-gnome-network-settings">
705 <title>Network Settings</title>
708 <term><guilabel>General</guilabel></term>
710 <para>Enter the <guilabel>Name</guilabel> for the Internet Relay Chat (IRC) server.</para>
711 <para>Select the <guilabel>Automatically connect to network</guilabel> option to connect
712 to a network when starting <application>&app;</application>.</para>
713 <para>Select the <guilabel>Use secure connection (SSL)</guilabel> option to connect with Secure
714 Socket Layer (SSL).</para>
715 <para>Select the <guilabel>Cycle until connected</guilabel> option to continue attempts to
716 connect to network, until successful.</para>
717 <para>Use the <guilabel>Character encoding</guilabel> drop-down box to specify which character
718 encoding <application>&app;</application> should use.</para>
719 <para>Enter the <guilabel>Server Password</guilabel>, if the Internet Relay Chat (IRC)
720 server requires it.</para>
725 <sect2 id="xchat-gnome-network-users">
726 <title>Users and Channels</title>
729 <term><guilabel>Users Info</guilabel></term>
731 <para>Select the <guilabel>Use global user settings</guilabel> option to use the global settings
732 used in the <guilabel>General</guilabel> section of <xref linkend="xchat-gnome-prefs-general"/>.
734 <para>Select the <guilabel>Use the user settings</guilabel> option to set the <guilabel>Nick
735 name</guilabel> and <guilabel>Real Name</guilabel> specific to this Internet Relay Chat (IRC)
740 <term><guilabel>Automatically Join Channels</guilabel></term>
742 <para>Click the <guibutton>Add</guibutton> button to add a new channel.</para>
743 <para>Click the <guibutton>Edit</guibutton> button to edit the selected channel.</para>
744 <para>Click the <guibutton>Remove</guibutton> button to remove the selected channel.</para>
745 <note><para>The channel name should begin with a pound sign (#).</para></note>
750 <sect2 id="xchat-gnome-network-servers">
751 <title>Servers</title>
756 <para>Click the <guibutton>Add</guibutton> button to add a new Internet Relay Chat (IRC)
758 <para>Click the <guibutton>Edit</guibutton> button to edit the selected Internet Relay Chat (IRC)
760 <para>Click the <guibutton>Remove</guibutton> button to remove the selected Internet Relay
761 Chat (IRC) server.</para>
768 <!-- ============= About ================================== -->
769 <!-- This section contains info about the program (not docs), such as
770 author's name(s), web page, license, feedback address. This
771 section is optional: primary place for this info is "About.." box of
772 the program. However, if you do wish to include this info in the
773 manual, this is the place to put it. Alternatively, you can put this information in the title page.-->
774 <sect1 id="xchat-gnome-about">
775 <title>About <application>&app;</application></title>
776 <para>To find more information about
777 <application>&app;</application>, please visit the
778 <ulink url="http://xchat-gnome.navi.cx/" type="http">&app; Web
779 page</ulink>. </para>
781 To report a bug or make a suggestion regarding this application or
782 this manual, see the Feedback section of the
783 <ulink url="ghelp:user-guide?feedback-bugs" type="help">GNOME User Guide</ulink>.
786 <para> This program is distributed under the terms of the GNU
787 General Public license as published by the Free Software
788 Foundation; either version 2 of the License, or (at your option)
789 any later version. A copy of this license can be found at this
790 <ulink url="ghelp:gpl" type="help">link</ulink>, or in the file
791 COPYING included with the source code of this program. </para>