~ubuntu-branches/ubuntu/lucid/konversation/lucid-updates

« back to all changes in this revision

Viewing changes to doc/konversation/index.docbook

  • Committer: Bazaar Package Importer
  • Author(s): Modestas Vainius
  • Date: 2009-05-15 11:24:24 UTC
  • mfrom: (1.15.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 47.
  • Revision ID: james.westby@ubuntu.com-20090515112424-b74i26lciabf4qnk
Tags: 1.1.75+svn968012-1
* New upstream development snapshot:
  - Last Changed Author: hein
  - Last Changed Rev: 968012
  - Last Changed Date: 2009-05-14 21:03:55 +0300
* Update README.source.
* Use dh --quilt instead of custom patch handling, build depend on
  quilt 0.46-7~.
* Update patches to upstream changes.
* Update konversation.install: remove docs.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0" ?>
2
 
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
3
 
  <!-- Define an entity for your application if it is not part of KDE
4
 
       CVS -->
5
 
  <!ENTITY kappname "&konversation;">
6
 
  <!ENTITY package "kdeextragear-2">
7
 
  <!ENTITY irc "<acronym>IRC</acronym>">
8
 
  <!ENTITY CTCP "<acronym>CTCP</acronym>">
9
 
  <!ENTITY nickname "<acronym>nickname</acronym>">
10
 
  <!ENTITY Nickname "<acronym>Nickname</acronym>">
11
 
  <!ENTITY led "<acronym>LED</acronym>">
12
 
  <!ENTITY osd "<acronym>OSD</acronym>">
13
 
  <!ENTITY url "<acronym>URL</acronym>">
14
 
  <!ENTITY mime "<acronym>MIME</acronym>">
15
 
  <!ENTITY konviwebsite "http://konversation.kde.org">
16
 
  <!ENTITY % imageobjectco.module "INCLUDE">
17
 
  <!ENTITY % addindex "IGNORE">
18
 
  <!ENTITY % English "INCLUDE"> <!-- ONLY If you are writing non-English
19
 
                                     original documentation, change
20
 
                                     the language here -->
21
 
 
22
 
  <!-- Do not define any other entities; instead, use the entities
23
 
       from entities/general.entities and $LANG/user.entities. -->
24
 
]>
25
 
 
26
 
 
27
 
<!-- ................................................................ -->
28
 
 
29
 
<!-- The language must NOT be changed here. -->
30
 
<!-- If you are writing original documentation in a language other -->
31
 
<!-- than English, change the language above ONLY, not here -->
32
 
<book lang="&language;">
33
 
 
34
 
<!-- This header contains all of the meta-information for the document such
35
 
as Authors, publish date, the abstract, and Keywords -->
36
 
 
37
 
<bookinfo>
38
 
<title>The &konversation; Handbook</title>
39
 
 
40
 
<authorgroup>
41
 
<author>
42
 
<!-- This is just put in as an example.  For real documentation, please
43
 
     define a general entity in entities/contributor.entities, e.g.
44
 
<!ENTITY George.N.Ugnacious "<personname><firstname>George</firstname><othername>N.</othername><surname>Ugnacious</surname></personname>">
45
 
<!ENTITY George.N.Ugnacious.mail "<email>gnu@kde.org</email>">
46
 
and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element.
47
 
 -->
48
 
<personname>
49
 
<firstname>Gary</firstname>
50
 
<othername>R.</othername>
51
 
<surname>Cramblitt</surname>
52
 
</personname>
53
 
<email>garycramblitt@comcast.net</email>
54
 
</author>
55
 
<!-- TRANS:ROLES_OF_TRANSLATORS -->
56
 
</authorgroup>
57
 
 
58
 
<!-- Note to Translators:
59
 
        This document contains a number of screen images with callouts.  Because the stylesheets do not currently
60
 
        support merging callout images with screen images, the "areaspec" elements herein are dummy entries
61
 
        used to satisfy the "callout" elements.
62
 
 
63
 
        -grc
64
 
-->
65
 
 
66
 
<copyright>
67
 
<year>2003-2005</year>
68
 
<holder>Gary R. Cramblitt</holder>
69
 
</copyright>
70
 
 
71
 
<!-- Translators: put here the copyright notice of the translation -->
72
 
<!-- Put here the FDL notice.  Read the explanation in fdl-notice.docbook
73
 
     and in the FDL itself on how to use it. -->
74
 
<legalnotice>&FDLNotice;</legalnotice>
75
 
 
76
 
<!-- Date and version information of the documentation
77
 
Don't forget to include this last date and this last revision number, we
78
 
need them for translation coordination !
79
 
Please respect the format of the date (YYYY-MM-DD) and of the version
80
 
(V.MM.LL), it could be used by automation scripts.
81
 
Do NOT change these in the translation. -->
82
 
 
83
 
<date>2005-05-23</date>
84
 
<releaseinfo>0.18</releaseinfo>
85
 
 
86
 
<!-- Abstract about this handbook -->
87
 
 
88
 
<abstract>
89
 
<para>
90
 
&konversation; is a user-friendly &irc; client for the K Desktop Environment.
91
 
</para>
92
 
</abstract>
93
 
 
94
 
<!-- This is a set of Keywords for indexing by search engines.
95
 
Please at least include KDE, the KDE package it is in, the name
96
 
 of your application, and a few relevant keywords. -->
97
 
 
98
 
<keywordset>
99
 
<keyword>KDE</keyword>
100
 
<keyword>kdeextragear-2</keyword>
101
 
<keyword>Konversation</keyword>
102
 
<keyword>irc</keyword>
103
 
<keyword>internet relay chat</keyword>
104
 
<keyword>chat</keyword>
105
 
<keyword>communications</keyword>
106
 
</keywordset>
107
 
 
108
 
</bookinfo>
109
 
 
110
 
<!-- The contents of the documentation begin here.  Label
111
 
each chapter so with the id attribute. This is necessary for two reasons: it
112
 
allows you to easily reference the chapter from other chapters of your
113
 
document, and if there is no ID, the name of the generated HTML files will vary
114
 
from time to time making it hard to manage for maintainers and for the CVS
115
 
system. Any chapter labelled (OPTIONAL) may be left out at the author's
116
 
discretion. Other chapters should not be left out in order to maintain a
117
 
consistent documentation style across all KDE apps. -->
118
 
 
119
 
<!-- CODE SNIPPETS
120
 
The following are useful snippets for cross-referencing to sections of this document.
121
 
If using the snippets plugin, copy them to your snippets.
122
 
Please keep synced with id attributes.
123
 
 
124
 
See <link linkend="irc-basics">If you haven't used &irc; before...</link> for more information
125
 
See <link linkend="identity">Setting your identity</link> for more information
126
 
See <link linkend="identity-away">Setting your identity</link> for more information
127
 
See <link linkend="identity-advanced">Setting your identity</link> for more information
128
 
See <link linkend="serverlist">Defining new networks, servers and auto join channels</link> for more information
129
 
See <link linkend="serverlist-addnetwork">Defining new networks, servers and auto join channels</link> for more information
130
 
See <link linkend="serverlist-addserver">Defining new networks, servers and auto join channels</link> for more information
131
 
See <link linkend="serverlist-addchannel">Defining new networks, servers and auto join channels</link> for more information
132
 
See <link linkend="list-channels">Listing available channels</link> for more information
133
 
See <link linkend="channel-screen-tour">A tour of the main screen</link> for more information
134
 
See <link linkend="quickconnect">Quick Connect</link> for more information
135
 
See <link linkend="irc-cmds">Frequently-used &irc; commands</link> for more information
136
 
See <link linkend="query">Private conversations (queries)</link> for more information
137
 
See <link linkend="cfg-notifications">Setting notifications</link> for more information
138
 
See <link linkend="nicksonline">Monitoring who is online</link> for more information
139
 
See <link linkend="highlighting">Message highlighting</link> for more information
140
 
See <link linkend="cfg-osd">Configuring On Screen Display (&osd;)</link> for more information
141
 
See <link linkend="color-msgs">Sending colorful messages</link> for more information
142
 
See <link linkend="nickthemes">Configuring &nickname; themes</link> for more information.
143
 
See <link linkend="quick-buttons">Configuring Quick Buttons</link> for more information
144
 
See <link linkend="dcc">Sending and receiving files</link> for more information
145
 
See <link linkend="linkaddressbook">Integrating with &kaddressbook;</link> for more information
146
 
See <link linkend="urlcatcher">Capturing &URL;s from messages.</link> for more information
147
 
See <link linkend="webbrowser">Setting your preferred web browser.</link> for more information
148
 
See <link linkend="rememberlines">Marking Channel and Query Logs</link> for more information
149
 
See <link linkend="logging">Logging</link> for more information
150
 
See <link linkend="konvi-cmds">&konversation; commands</link> for more information
151
 
See <link linkend="scripting">Scripting</link> for more information
152
 
See <link linkend="kapp-mainwindow">The main &konversation; window</link> for more information
153
 
See <link linkend="getting-kapp">How to obtain &konversation;</link> for more information
154
 
See <link linkend="requirements">Requirements</link> for more information
155
 
 
156
 
-->
157
 
 
158
 
<chapter id="introduction">
159
 
<title>Introduction</title>
160
 
 
161
 
<!-- The introduction chapter contains a brief introduction for the
162
 
application that explains what it does and where to report
163
 
problems. Basically a long version of the abstract.  Don't include a
164
 
revision history. (see installation appendix comment) -->
165
 
 
166
 
<para>
167
 
&konversation; is an &irc; client for &kde; 3.2 or later.  It offers the following features:
168
 
</para>
169
 
 
170
 
<para>
171
 
<itemizedlist>
172
 
<listitem><para>SSL support.</para></listitem>
173
 
<listitem><para>User-friendly tabbed interface.</para></listitem>
174
 
<listitem><para>Customizable Quick Buttons for often-used commands</para></listitem>
175
 
<listitem><para>Automatic reconnect and rejoin.</para></listitem>
176
 
<listitem><para>DCC send and receive.</para></listitem>
177
 
<listitem><para>&Nickname; watch list.</para></listitem>
178
 
<listitem><para>Visual and auditory notifications for a wide variety of events, such as messages containing
179
 
 your &nickname;, or &nickname;s on your watch list going online or offline.
180
 
</para></listitem>
181
 
<listitem><para>Customizable highlighting of messages by &nickname; or
182
 
regular expression pattern.</para></listitem>
183
 
<listitem><para>&Nickname; completion.</para></listitem>
184
 
<listitem><para>Capture and save all &URL;s appearing in messages.</para></listitem>
185
 
<listitem><para>On-screen display of messages, even when minimized.</para></listitem>
186
 
<listitem><para>&Nickname; ignore list.</para></listitem>
187
 
<listitem><para>Automatic logging and log management.</para></listitem>
188
 
<listitem><para>Marking of lines in logs.</para></listitem>
189
 
<listitem><para>Scripting.</para></listitem>
190
 
<listitem><para>Integration with &kaddressbook;.</para></listitem>
191
 
</itemizedlist>
192
 
</para>
193
 
 
194
 
<para>The &konversation; website is
195
 
<ulink url="&konviwebsite;">&konviwebsite;</ulink>.
196
 
 Questions and answers for &konversation; can be discussed on the
197
 
 <ulink url="http://lists.sourceforge.net/mailman/listinfo/konversation-users">&konversation;-Users</ulink> mailing list. Please subscribe to learn about new features, bug reports and the like. To stay informed of new releases, you can join our
198
 
 <ulink url="http://lists.sourceforge.net/mailman/listinfo/konversation-announce">&konversation;-Announce</ulink> mailing list. This is a low volume mailing list only used to announce new releases or patches.
199
 
</para>
200
 
 
201
 
<para>Developers for &konversation; can often be contacted via &irc; at  <ulink url="irc://irc.kde.org/%23konversation">irc.kde.org channel #konversation</ulink>.
202
 
</para>
203
 
 
204
 
</chapter>
205
 
 
206
 
<chapter id="using-kapp">
207
 
<title>Using &konversation;</title>
208
 
 
209
 
<!-- =================================================================== -->
210
 
 
211
 
<sect1 id="irc-basics">
212
 
<title>If you haven't used &irc; before...</title>
213
 
 
214
 
<para>Simply put, &irc; is a chat protocol, defined by official Internet
215
 
standards, and capable of stealing many hours of your life. To use
216
 
&irc;, you must connect to a server, and then join a channel (equivalent
217
 
to a chat room) or just engage in private conversations.</para>
218
 
 
219
 
<para>To connect to a server and channel, open &konversation;.  The <guilabel>Server List</guilabel> screen appears.</para>
220
 
 
221
 
<para>
222
 
<screenshot>
223
 
<screeninfo>Server List</screeninfo>
224
 
        <mediaobjectco>
225
 
                <imageobjectco>
226
 
                        <areaspec units="calspair">
227
 
                                <area id="pt-first-serverlist-1" coords="1 1"/>
228
 
                                <area id="pt-first-serverlist-2" coords="1 1"/>
229
 
                                <area id="pt-first-serverlist-3" coords="1 1"/>
230
 
                        </areaspec>
231
 
                        <imageobject>
232
 
                                <imagedata fileref="first_serverlist_co.png" format="PNG"/>
233
 
                        </imageobject>
234
 
                </imageobjectco>
235
 
                <textobject>
236
 
                        <phrase>Server List</phrase>
237
 
                </textobject>
238
 
        </mediaobjectco>
239
 
</screenshot>
240
 
</para>
241
 
 
242
 
<para>
243
 
<calloutlist>
244
 
<callout arearefs="pt-first-serverlist-1"><para>The list of configured &irc;
245
 
<guilabel>Networks</guilabel> are listed here.  An &irc; network is a collection of cooperating servers.  You need
246
 
only connect to one of the servers in the network to be connected to the entire
247
 
&irc; network.  Once connected, &konversation; will automatically join the
248
 
<guilabel>Channels</guilabel> shown.  When &konversation; is started for the first time, the
249
 
<userinput><replaceable>Freenode</replaceable></userinput> network
250
 
and <userinput><replaceable>#kde</replaceable></userinput> channel are already entered for you.  Click on a network to select it.</para></callout>
251
 
<callout arearefs="pt-first-serverlist-2"><para>Click here to define a new <guilabel>Network</guilabel>, including the server
252
 
to connect to, and the <guilabel>Channels</guilabel> to automatically join once connected.  See <link  linkend="serverlist">Defining new networks, servers, and auto join channels</link> for more information.</para></callout>
253
 
<callout arearefs="pt-first-serverlist-3"><para>Click here to connect to the selected &irc; network and channel.</para></callout>
254
 
</calloutlist>
255
 
</para>
256
 
 
257
 
<note>
258
 
<para>When you click the <guibutton>Connect</guibutton> button the first time you open
259
 
&konversation;, you may see the following message, telling you that your
260
 
default <guilabel>identity</guilabel> is not set up correctly.</para>
261
 
 
262
 
<para>
263
 
<screenshot>
264
 
        <screeninfo>Check Identities</screeninfo>
265
 
        <mediaobject>
266
 
                <imageobject>
267
 
                        <imagedata fileref="checkidentities.png" format="PNG"/>
268
 
                </imageobject>
269
 
                <textobject>
270
 
                        <phrase>Check Identities</phrase>
271
 
                </textobject>
272
 
        </mediaobject>
273
 
</screenshot>
274
 
</para>
275
 
 
276
 
<para>The first time you open &konversation; it obtains information
277
 
about the current user from the operating system and fills in defaults
278
 
for the Identity.  If the operating system user information is not
279
 
complete, for example, no Full Name is defined, you may see the message
280
 
above.  To correct this problem, click <guibutton>OK</guibutton> and
281
 
see <link linkend="identity">Setting your identity</link> for more
282
 
information.</para>
283
 
</note>
284
 
 
285
 
<para>
286
 
The <interface>Main</interface> screen will be displayed showing the messages sent by the server to the client.
287
 
(If &konversation; will not connect to the server, see <link linkend="faq">Questions and Answers</link>.)  When the server messages have finished scrolling past, &konversation; will join the channel or channels chosen.
288
 
</para>
289
 
 
290
 
<para>
291
 
<screenshot>
292
 
<screeninfo>Channel.</screeninfo>
293
 
        <mediaobjectco>
294
 
                <imageobjectco>
295
 
                        <areaspec units="calspair">
296
 
                                <area id="pt-first-channel-1" coords="1 1"/>
297
 
                                <area id="pt-first-channel-2" coords="1 1"/>
298
 
                                <area id="pt-first-channel-3" coords="1 1"/>
299
 
                        </areaspec>
300
 
                        <imageobject>
301
 
                                <imagedata fileref="first_channel_co.png" format="PNG"/>
302
 
                        </imageobject>
303
 
                </imageobjectco>
304
 
                <textobject>
305
 
                        <phrase>Channel</phrase>
306
 
                </textobject>
307
 
        </mediaobjectco>
308
 
</screenshot>
309
 
</para>
310
 
 
311
 
<para>
312
 
<calloutlist>
313
 
 
314
 
<callout arearefs="pt-first-channel-1"><para>This is called the <interface>Input Line</interface>.  To send a message to everyone in the channel, type the message here and press &Enter;.
315
 
 Your message, as well as everyone else's messages appear in the channel scroll above.
316
 
 Each message is preceded by the time and user's &nickname;.</para></callout>
317
 
 
318
 
<callout arearefs="pt-first-channel-2"><para>You may join additional servers and channels.  Each server, channel, channel list, and other screen gets a separate tab here.
319
 
To display a list of available channels, see <link linkend="list-channels">Listing available channels</link>.
320
 
To join a channel,
321
 
type: <userinput><command>/join</command> <replaceable>#channelname</replaceable></userinput> in
322
 
the Input Line.  (The <userinput>#</userinput> is required.) You may also type <userinput><command>/j</command></userinput> as a shorthand to <userinput><command>/join</command></userinput>. To leave a channel, just type <userinput><command>/part</command></userinput>.  To switch the display to a different server or channel, click the corresponding tab.
323
 
</para></callout>
324
 
 
325
 
<callout arearefs="pt-first-channel-3"><para>This is called the <interface>Nick Panel</interface>.  It lists the &nickname;s of all the users who have joined the channel, including yourself.</para></callout>
326
 
 
327
 
</calloutlist>
328
 
</para>
329
 
 
330
 
<para>That's the basics, for more detailed information, read on...</para>
331
 
 
332
 
</sect1>
333
 
 
334
 
<!-- =================================================================== -->
335
 
 
336
 
<sect1 id="identity">
337
 
<title>Setting your identity</title>
338
 
 
339
 
<para>Before you start using &konversation; regularly, you should set how you will be identified on the network.</para>
340
 
 
341
 
<para>Click
342
 
<menuchoice>
343
 
        <guisubmenu>Settings</guisubmenu>
344
 
        <guisubmenu>Identities</guisubmenu>
345
 
</menuchoice>
346
 
 on the main menu.  <action>The <guilabel>Identities</guilabel> screen will appear.  You can also display the <guilabel>Identities</guilabel> screen by clicking the <guibutton>Edit</guibutton> button on the
347
 
 <guilabel>Add Network</guilabel> screen.</action>
348
 
</para>
349
 
 
350
 
<para>
351
 
<screenshot>
352
 
<screeninfo>Identities (General tab)</screeninfo>
353
 
        <mediaobjectco>
354
 
                <imageobjectco>
355
 
                        <areaspec units="calspair">
356
 
                                <area id="pt-identity-gen-1" coords="1 1"/>
357
 
                                <area id="pt-identity-gen-2" coords="1 1"/>
358
 
                                <area id="pt-identity-gen-3" coords="1 1"/>
359
 
                                <area id="pt-identity-gen-4" coords="1 1"/>
360
 
                                <area id="pt-identity-gen-5" coords="1 1"/>
361
 
                                <area id="pt-identity-gen-6" coords="1 1"/>
362
 
                                <area id="pt-identity-gen-7" coords="1 1"/>
363
 
                        </areaspec>
364
 
                        <imageobject>
365
 
                                <imagedata fileref="identities_gen_co.png" format="PNG"/>
366
 
                        </imageobject>
367
 
                </imageobjectco>
368
 
                <textobject>
369
 
                        <phrase>Identities (General tab)</phrase>
370
 
                </textobject>
371
 
        </mediaobjectco>
372
 
</screenshot>
373
 
</para>
374
 
 
375
 
<para>
376
 
<calloutlist>
377
 
<callout arearefs="pt-identity-gen-1"><para>Click here to select an <guilabel>Identity</guilabel> to edit.</para></callout>
378
 
<callout arearefs="pt-identity-gen-2"><para>Use these buttons to add,
379
 
duplicate, rename, or remove an <guilabel>Identity</guilabel>.</para></callout>
380
 
<callout arearefs="pt-identity-gen-3"><para>Enter your real name here.  &irc; is not intended to keep you hidden from your friends or enemies. Keep this in mind if you are tempted to behave maliciously. A fake "real name" can be a good way to mask your gender from all the nerds out there, but the PC you use can always be traced so you will never be truly anonymous.</para></callout>
381
 
<callout arearefs="pt-identity-gen-4"><para>Use these buttons to
382
 
<guibutton>Add</guibutton>, <guilabel>Edit</guilabel>, or <guilabel>Delete</guilabel> a &nickname;.</para></callout>
383
 
<callout arearefs="pt-identity-gen-5"><para>This is your list of &nickname;s.
384
 
A &nickname; is the name that other users will know you by.
385
 
You may use any name you desire.  The first character must be a letter.  Other characters may be letters, numbers, or the special characters <literal>-[]\`_^{}|</literal>.</para>
386
 
 
387
 
<para>Since &nickname;s must be unique across an entire &irc; network, your desired name may be rejected by the server because someone else is already using that &nickname;.  Enter alternate &nickname;s for yourself.  If your first choice is rejected by the server, &konversation; will try the alternate &nickname;s.
388
 
</para>
389
 
 
390
 
<para>
391
 
According to RFC 2812, the maximum &nickname; length is 9, but
392
 
this is actually determined by the server.  To determine the maximum for a server, connect to the server.  In the
393
 
<interface>Server Messages</interface> tab, look for a <computeroutput>[Support]</computeroutput> message.
394
 
For example</para>
395
 
 
396
 
<para>
397
 
<computeroutput>
398
 
[18:51] *Eisfuchs* [21:45] [Support] Eisfuchs MODES=4 MAXCHANNELS=20 NICKLEN=16 USERLEN=10 HOSTLEN=63 TOPICLEN=450 KICKLEN=450 CHANNELLEN=30 KEYLEN=23 CHANTYPES=# PREFIX=@+ CASEMAPPING=ascii CAPAB IRCD=dancer
399
 
</computeroutput>
400
 
</para>
401
 
 
402
 
<para>
403
 
The <computeroutput>NICKLEN</computeroutput> parameter specifies the maximum &nickname; length.
404
 
</para>
405
 
</callout>
406
 
 
407
 
<callout arearefs="pt-identity-gen-6"><para>Use these buttons to change the
408
 
order of the &nickname;s.  The top &nickname; is tried first, then the next
409
 
&nickname;, and so on.</para></callout>
410
 
<callout arearefs="pt-identity-gen-7"><para>If you have registered your &nickname; with the &irc; network, enter the service and password to authenticate your &nickname;.
411
 
When &konversation; connects, it will automatically send
412
 
<userinput><command>/msg</command> <replaceable>service</replaceable> <command>IDENTIFY</command> <replaceable>password</replaceable></userinput> to the server.
413
 
If you don't know what this is, leave these boxes blank.</para></callout>
414
 
</calloutlist>
415
 
</para>
416
 
 
417
 
<anchor id="identity-away"/>
418
 
 
419
 
<para>Click the <guilabel>Away</guilabel> tab.</para>
420
 
 
421
 
<para>
422
 
        <screenshot>
423
 
                <screeninfo>Identities (Away tab)</screeninfo>
424
 
                <mediaobjectco>
425
 
                        <imageobjectco>
426
 
                                <areaspec units="calspair">
427
 
                                        <area id="pt-identity-away-1" coords="1 1"/>
428
 
                                        <area id="pt-identity-away-2" coords="1 1"/>
429
 
                                        <area id="pt-identity-away-3" coords="1 1"/>
430
 
                                </areaspec>
431
 
                                <imageobject>
432
 
                                        <imagedata fileref="identities_away_co.png" format="PNG"/>
433
 
                                </imageobject>
434
 
                        </imageobjectco>
435
 
                        <textobject>
436
 
                                <phrase>Identities (Away tab)</phrase>
437
 
                        </textobject>
438
 
                </mediaobjectco>
439
 
        </screenshot>
440
 
</para>
441
 
 
442
 
<para>
443
 
<calloutlist>
444
 
<callout arearefs="pt-identity-away-1"><para>
445
 
Enter a &nickname; that indicates you are away.  Whenever you perform an
446
 
<userinput><command>/away </command><replaceable>msg</replaceable></userinput> command in
447
 
any channel joined with this <guilabel>Identity</guilabel>,
448
 
&konversation; will automatically change your &nickname; to the <guilabel>Away nickname</guilabel>.  Other users will be able to tell you are away
449
 
from your computer.
450
 
Whenever you perform an <userinput><command>/away</command></userinput> command
451
 
in any channel in which
452
 
you are away, &konversation; will automatically change your &nickname; back
453
 
to the original.  If you do not wish to automatically change your
454
 
&nickname; when going away, leave blank.</para></callout>
455
 
<callout arearefs="pt-identity-away-2"><para>If you check this box,
456
 
whenever you perform an <userinput><command>/away</command></userinput> command, a horizontal line will appear in the channel, marking the point where you
457
 
went away.  Other &irc; users do not see this horizontal line.
458
 
</para></callout>
459
 
<callout arearefs="pt-identity-away-3"><para>If you check this box,
460
 
&konversation; will automatically send the <guilabel>Away message</guilabel> to all channels joined with this <guilabel>Identity</guilabel>.
461
 
<userinput><replaceable>%s</replaceable></userinput> is replaced with
462
 
<userinput><replaceable>msg</replaceable></userinput>.
463
 
Whenever you perform an
464
 
<userinput><command>/away</command></userinput> command, the <guilabel>Return message</guilabel> will be displayed in all channels joined with this <guilabel>Identity</guilabel>.</para>
465
 
 
466
 
<note><para>Away messages are often considered annoying by other users.
467
 
Use this option carefully, with consideration for your fellow &irc; users.
468
 
</para></note>
469
 
</callout>
470
 
</calloutlist>
471
 
</para>
472
 
 
473
 
<anchor id="identity-advanced"/>
474
 
 
475
 
<para>Click the <guilabel>Advanced</guilabel> tab.</para>
476
 
 
477
 
<para>
478
 
        <screenshot>
479
 
                <screeninfo>Identities (Advanced tab)</screeninfo>
480
 
                <mediaobjectco>
481
 
                        <imageobjectco>
482
 
                                <areaspec units="calspair">
483
 
                                        <area id="pt-identity-adv-1" coords="1 1"/>
484
 
                                        <area id="pt-identity-adv-2" coords="1 1"/>
485
 
                                        <area id="pt-identity-adv-3" coords="1 1"/>
486
 
                                        <area id="pt-identity-adv-4" coords="1 1"/>
487
 
                                        <area id="pt-identity-adv-5" coords="1 1"/>
488
 
                                        <area id="pt-identity-adv-6" coords="1 1"/>
489
 
                                </areaspec>
490
 
                                <imageobject>
491
 
                                        <imagedata fileref="identities_adv_co.png" format="PNG"/>
492
 
                                </imageobject>
493
 
                        </imageobjectco>
494
 
                        <textobject>
495
 
                                <phrase>Identities (Advanced tab)</phrase>
496
 
                        </textobject>
497
 
                </mediaobjectco>
498
 
        </screenshot>
499
 
</para>
500
 
 
501
 
<para>
502
 
<calloutlist>
503
 
<callout arearefs="pt-identity-adv-1"><para>You can enter a command
504
 
here that will be executed before connecting to the server.  If this identity
505
 
is used for more than one server, the command will be executed for
506
 
each server.</para></callout>
507
 
<callout arearefs="pt-identity-adv-2"><para>This setting affects how
508
 
characters you type are encoded for sending to the server.  It also affects
509
 
how messages are displayed.  When you first open &konversation;, it
510
 
automatically retrieves this setting from the operating system.  If you
511
 
seem to be having trouble seeing other user's messages correctly, try
512
 
changing this setting.</para></callout>
513
 
<callout arearefs="pt-identity-adv-3"><para>When you connect, many servers
514
 
query your computer for an IDENT response.  If you computer is not running
515
 
an IDENT server, this response is sent by &konversation;.  No spaces
516
 
are allowed.  Your first name is suggested.</para></callout>
517
 
<callout arearefs="pt-identity-adv-4"><para>Whenever you leave a channel,
518
 
this message is sent to the channel.</para></callout>
519
 
<callout arearefs="pt-identity-adv-5"><para>Whenever you are kicked from
520
 
a channel (usually by an &irc; operator), this message is sent to the
521
 
channel.</para></callout>
522
 
<callout arearefs="pt-identity-adv-6"><para>Click to apply your changes.  In order for all the changes to take effect, you must disconnect from the server and re-connect.  The easiest way to do that is to quit &konversation; and restart.</para></callout>
523
 
</calloutlist>
524
 
</para>
525
 
 
526
 
<!--
527
 
<para>TODO:
528
 
<itemizedlist>
529
 
 
530
 
<listitem><para>
531
 
The characters allowed in a nick given above comes from RFC 2812.  Any special Konversation considerations?
532
 
</para></listitem>
533
 
 
534
 
<listitem><para>
535
 
Limits on Real Name and Ident?
536
 
</para></listitem>
537
 
 
538
 
</itemizedlist>
539
 
</para>
540
 
-->
541
 
 
542
 
</sect1>
543
 
 
544
 
<!-- =================================================================== -->
545
 
 
546
 
<sect1 id="serverlist">
547
 
<title>Defining new networks, servers and auto join channels</title>
548
 
 
549
 
<para>The <guilabel>Server List</guilabel> screen appears when you open the
550
 
&konversation; program.  It also appears when you choose
551
 
<menuchoice>
552
 
<guisubmenu>File</guisubmenu>
553
 
<guisubmenu>Server List</guisubmenu>
554
 
</menuchoice>
555
 
on the main menu.  <action>The <guilabel>Server List</guilabel></action> screen
556
 
lists your existing defined &irc; <guilabel>Network</guilabel>s, listed by group.
557
 
An &irc; network is a collection of cooperating servers.  When you connect
558
 
to any server in a network, you have access to all the channels of the network.
559
 
Examples of &irc; networks are
560
 
<userinput><replaceable>Freenode</replaceable></userinput> and
561
 
<userinput><replaceable>Undernet</replaceable></userinput>.
562
 
</para>
563
 
 
564
 
<para>
565
 
<screenshot>
566
 
        <screeninfo>Server List</screeninfo>
567
 
        <mediaobjectco>
568
 
                <imageobjectco>
569
 
                        <areaspec units="calspair">
570
 
                                <area id="pt-serverlist-1" coords="1 1"/>
571
 
                                <area id="pt-serverlist-2" coords="1 1"/>
572
 
                                <area id="pt-serverlist-3" coords="1 1"/>
573
 
                                <area id="pt-serverlist-4" coords="1 1"/>
574
 
                        </areaspec>
575
 
                        <imageobject>
576
 
                                <imagedata fileref="serverlist_co.png" format="PNG"/>
577
 
                        </imageobject>
578
 
                </imageobjectco>
579
 
                <textobject>
580
 
                        <phrase>Server List</phrase>
581
 
                </textobject>
582
 
        </mediaobjectco>
583
 
</screenshot>
584
 
</para>
585
 
 
586
 
<para>
587
 
<calloutlist>
588
 
<callout arearefs="pt-serverlist-1"><para>Your existing defined
589
 
<guilabel>Network</guilabel>s are listed here along with
590
 
the <guilabel>Identity</guilabel> used to connect to the network,
591
 
and the <guilabel>Channels</guilabel> automatically joined when connected.
592
 
If you have specified a group for your networks, networks are listed
593
 
indented under the group.  Click on a network to select it.
594
 
</para></callout>
595
 
<callout arearefs="pt-serverlist-2"><para>Use these buttons to
596
 
<guibutton>Add</guibutton> a new network, <guibutton>Edit</guibutton>
597
 
a highlighted network, or <guibutton>Delete</guibutton> a highlighted network.
598
 
</para></callout>
599
 
<callout arearefs="pt-serverlist-3"><para>Click this button to connect
600
 
to the highlighted <guilabel>Network</guilabel> and close the
601
 
<guilabel>Server List</guilabel> screen.  You may highlight
602
 
more than one network if you wish, which will connect to all the
603
 
highlighted networks.</para></callout>
604
 
<callout arearefs="pt-serverlist-4"><para>Clicking this button does not
605
 
discard the changes you have made.  It merely means you do not wish to
606
 
connect to any networks at this time.</para></callout>
607
 
</calloutlist>
608
 
</para>
609
 
 
610
 
<anchor id="serverlist-addnetwork" />
611
 
 
612
 
<para>When you click the <guibutton>Add</guibutton> button,
613
 
the <guilabel>Add Network</guilabel> screen appears.</para>
614
 
 
615
 
<para>
616
 
<screenshot>
617
 
        <screeninfo>Add Network</screeninfo>
618
 
        <mediaobjectco>
619
 
                <imageobjectco>
620
 
                        <areaspec units="calspair">
621
 
                                <area id="pt-addnetwork-1" coords="1 1"/>
622
 
                                <area id="pt-addnetwork-2" coords="1 1"/>
623
 
                                <area id="pt-addnetwork-3" coords="1 1"/>
624
 
                                <area id="pt-addnetwork-4" coords="1 1"/>
625
 
                                <area id="pt-addnetwork-5" coords="1 1"/>
626
 
                                <area id="pt-addnetwork-6" coords="1 1"/>
627
 
                                <area id="pt-addnetwork-7" coords="1 1"/>
628
 
                                <area id="pt-addnetwork-8" coords="1 1"/>
629
 
                                <area id="pt-addnetwork-9" coords="1 1"/>
630
 
                        </areaspec>
631
 
                        <imageobject>
632
 
                                <imagedata fileref="addnetwork_co.png" format="PNG"/>
633
 
                        </imageobject>
634
 
                </imageobjectco>
635
 
                <textobject>
636
 
                        <phrase>Add Network</phrase>
637
 
                </textobject>
638
 
        </mediaobjectco>
639
 
</screenshot>
640
 
</para>
641
 
 
642
 
<para>
643
 
<calloutlist>
644
 
<callout arearefs="pt-addnetwork-1"><para>Enter the name of the
645
 
<guilabel>Network</guilabel> here.  You may create as many entries
646
 
in the <guilabel>Server List</guilabel> screen with the same
647
 
<guilabel>Network</guilabel> as you like.</para></callout>
648
 
<callout arearefs="pt-addnetwork-2"><para>Optional.  If you enter something
649
 
here, all the <guilabel>Network</guilabel>s with the same
650
 
<guilabel>Group</guilabel> will be listed together in the
651
 
<guilabel>Server List</guilabel> screen.</para></callout>
652
 
<callout arearefs="pt-addnetwork-3"><para>Choose an existing
653
 
<guilabel>Identity</guilabel> or click the <guibutton>Edit</guibutton>
654
 
button to add a new Identity or edit an existing one.  The
655
 
<guilabel>Identity</guilabel> will identify you and determine
656
 
your &nickname; when you connect to the network.</para></callout>
657
 
<callout arearefs="pt-addnetwork-4"><para>Optional.  This command will be sent to the server after connecting.  Example: <userinput>/msg NickServ IDENTIFY
658
 
<replaceable>konvirocks</replaceable></userinput>.  This example is for the freenode network, which requires users to register their &nickname;
659
 
with a password and login when connecting.  <userinput><replaceable>konvirocks</replaceable></userinput>
660
 
is the password for the &nickname; given in <guilabel>Identity</guilabel>.
661
 
You may enter more than one command by separating them with semicolons.</para></callout>
662
 
<callout arearefs="pt-addnetwork-5"><para>Check here if you want
663
 
&konversation; to automatically connect to this network whenever
664
 
you open &konversation;.</para></callout>
665
 
<callout arearefs="pt-addnetwork-6"><para>This is a list of &irc;
666
 
<guilabel>Servers</guilabel> in the network.  When connecting to the network,
667
 
&konversation; will
668
 
attempt to connect to the top server first.  If this fails,
669
 
it will attempt the second server.  If this fails, it will attempt
670
 
the third, and so on.  At least one server must be specified.
671
 
Click a server to highlight it.</para></callout>
672
 
<callout arearefs="pt-addnetwork-7"><para>Use these buttons to
673
 
<guibutton>Add</guibutton> a server, <guibutton>Edit</guibutton> a
674
 
highlighted server, or <guibutton>Delete</guibutton> a highlighted
675
 
server.  You can also adjust the order of the server list and therefore
676
 
the order of connection attempts.</para></callout>
677
 
<callout arearefs="pt-addnetwork-8"><para>Optional.  This is a list of the
678
 
channels that will be automatically joined once &konversation;
679
 
has connected to a server.  You may leave this blank if you
680
 
wish to not automatically join any channels.</para></callout>
681
 
<callout arearefs="pt-addnetwork-9"><para>Use these buttons to
682
 
<guibutton>Add</guibutton> a channel, <guibutton>Edit</guibutton> a
683
 
highlighted channel, or <guibutton>Delete</guibutton> a highlighted
684
 
channel.  You may also change the order the channels are joined.
685
 
</para></callout>
686
 
</calloutlist>
687
 
</para>
688
 
 
689
 
<note><para>Avoid mixing servers on different &irc; networks under the same
690
 
<guilabel>Network</guilabel>.  Avoid entering the same server under
691
 
two different <guilabel>Network</guilabel>s.  Otherwise, &konversation;
692
 
<link linkend="linkaddressbook">integration with your address book</link> and
693
 
<link linkend="nicksonline">monitoring of online &nickname;s</link> will not function
694
 
correctly.</para>
695
 
</note>
696
 
 
697
 
<anchor id="serverlist-addserver" />
698
 
 
699
 
<para>When you click the <guibutton>Add</guibutton> button in the <guilabel>Servers</guilabel> frame, the Add Server screen appears.</para>
700
 
 
701
 
<para>
702
 
<screenshot>
703
 
        <screeninfo>Add Server</screeninfo>
704
 
        <mediaobjectco>
705
 
                <imageobjectco>
706
 
                        <areaspec units="calspair">
707
 
                                <area id="pt-addserver-1" coords="1 1"/>
708
 
                                <area id="pt-addserver-2" coords="1 1"/>
709
 
                                <area id="pt-addserver-3" coords="1 1"/>
710
 
                                <area id="pt-addserver-4" coords="1 1"/>
711
 
                        </areaspec>
712
 
                        <imageobject>
713
 
                                <imagedata fileref="addserver_co.png" format="PNG"/>
714
 
                        </imageobject>
715
 
                </imageobjectco>
716
 
                <textobject>
717
 
                        <phrase>Add Server</phrase>
718
 
                </textobject>
719
 
        </mediaobjectco>
720
 
</screenshot>
721
 
</para>
722
 
 
723
 
<para>
724
 
<calloutlist>
725
 
<callout arearefs="pt-addserver-1"><para>The name or IP number of the server.  irchelp.org maintains a
726
 
<ulink url="http://www.irchelp.org/irchelp/networks/">list</ulink> of servers.</para></callout>
727
 
<callout arearefs="pt-addserver-2"><para>Enter the port number required to connect to the server.  For most servers, this should be <userinput>6667</userinput>.</para></callout>
728
 
<callout arearefs="pt-addserver-3"><para>If the server requires a password
729
 
in order to connect, enter it here, otherwise leave blank.</para></callout>
730
 
<callout arearefs="pt-addserver-4"><para>Check if you want to use
731
 
Secure Socket Layer (SSL) protocol to communicate with the server.
732
 
This protects the privacy of your communications between your computer
733
 
and the &irc; server.  The server must
734
 
support SSL protocol for this to work.  In most cases, if the server
735
 
does not support SSL, the connection will fail.</para></callout>
736
 
</calloutlist>
737
 
</para>
738
 
 
739
 
<anchor id="serverlist-addchannel" />
740
 
 
741
 
<para>When you click the <guibutton>Add</guibutton> button in the
742
 
<guilabel>Auto Join Channels</guilabel> frame, the <guilabel>Add Channel</guilabel>
743
 
screen appears.</para>
744
 
 
745
 
<para>
746
 
<screenshot>
747
 
        <screeninfo>Add Channel</screeninfo>
748
 
        <mediaobject>
749
 
                <imageobject>
750
 
                        <imagedata fileref="addchannel.png" format="PNG"/>
751
 
                </imageobject>
752
 
                <textobject>
753
 
                        <phrase>Add Channel</phrase>
754
 
                </textobject>
755
 
        </mediaobject>
756
 
</screenshot>
757
 
</para>
758
 
 
759
 
<para>Enter a channel name.  Do not forget leading <userinput><replaceable>#</replaceable></userinput>.  If the channel requires
760
 
a password in order to join, enter it, otherwise leave blank.
761
 
</para>
762
 
 
763
 
</sect1>
764
 
 
765
 
<!-- =================================================================== -->
766
 
 
767
 
<sect1 id="list-channels">
768
 
<title>Listing available channels</title>
769
 
 
770
 
<para>To display a list of available channels, choose
771
 
<menuchoice>
772
 
 <guisubmenu>Windows</guisubmenu>
773
 
 <guisubmenu>Channel List</guisubmenu>
774
 
</menuchoice> on the main menu.
775
 
  <action>After a warning screen, a new tab is created called the <guilabel>Channel List</guilabel>.</action>
776
 
</para>
777
 
 
778
 
<para>
779
 
<screenshot>
780
 
<screeninfo>The Channel List tab.</screeninfo>
781
 
        <mediaobjectco>
782
 
                <imageobjectco>
783
 
                        <areaspec units="calspair">
784
 
                                <area id="pt-channellist-1" coords="1 1"/>
785
 
                                <area id="pt-channellist-2" coords="1 1"/>
786
 
                                <area id="pt-channellist-3" coords="1 1"/>
787
 
                                <area id="pt-channellist-4" coords="1 1"/>
788
 
                                <area id="pt-channellist-5" coords="1 1"/>
789
 
                                <area id="pt-channellist-6" coords="1 1"/>
790
 
                        </areaspec>
791
 
                        <imageobject>
792
 
                                <imagedata fileref="channellist_screen_co.png" format="PNG"/>
793
 
                        </imageobject>
794
 
                </imageobjectco>
795
 
                <textobject>
796
 
                        <phrase>The Channel List tab.</phrase>
797
 
                </textobject>
798
 
        </mediaobjectco>
799
 
</screenshot>
800
 
</para>
801
 
 
802
 
<para>
803
 
<calloutlist>
804
 
 
805
 
<callout arearefs="pt-channellist-1"><para>Enter a filter string here.</para></callout>
806
 
 
807
 
<callout arearefs="pt-channellist-2"><para>You can limit the channel list to those channels with a minimum or maximum number of users here. Choosing 0 disables the respective criteria.</para></callout>
808
 
 
809
 
<callout arearefs="pt-channellist-3"><para>Click here to retrieve the list of channels from the server and apply the filter.</para></callout>
810
 
 
811
 
<callout arearefs="pt-channellist-4"><para>The filtered list of channels is displayed here.  Notice that if you don't use regular expressions, &konversation; lists any channel whose name contains the filter string you entered.  The channel name does not have to start with the string you entered.</para></callout>
812
 
 
813
 
<callout arearefs="pt-channellist-5"><para>Select a channel you want to join by clicking on it. Right click on the channel to get a list of all web addresses mentioned in the channel's topic.</para></callout>
814
 
 
815
 
<callout arearefs="pt-channellist-6"><para>Click here to join the channel.  A new tab is created for the channel.</para></callout>
816
 
 
817
 
</calloutlist>
818
 
</para>
819
 
 
820
 
<para>You should avoid clicking the <guibutton>Refresh List</guibutton> button.  Most servers have thousands
821
 
of channels, and performing this puts a high load on the server.  Besides, it can require several minutes to complete,
822
 
depending upon your network bandwidth.  If your client is too slow, the server may even disconnect you.
823
 
</para>
824
 
 
825
 
<para>Sometimes there are "secret" channels on servers.  Such channels are not listed in the <guilabel>Channel List</guilabel>.
826
 
You can still join these channels if you know their name.  In any <interface>Input Line</interface>, type: <userinput><command>/join</command>
827
 
<replaceable>#channelname</replaceable></userinput>.  (The <userinput>#</userinput> is required.)  A new tab is created for the channel.  If you join a channel and the Nick Panel lists only your &nickname;, it means that the channel did not exist before.  The server created the channel and you are the operator.  In this case, you probably want to close the channel by typing: <userinput><command>/part</command></userinput>.
828
 
</para>
829
 
 
830
 
</sect1>
831
 
 
832
 
<!-- =================================================================== -->
833
 
 
834
 
<sect1 id="channel-screen-tour">
835
 
<title>A tour of the main screen</title>
836
 
 
837
 
<para>Let's learn more about the <interface>Main</interface> screen.
838
 
The screen is shown below with a channel tab selected.</para>
839
 
 
840
 
<para>
841
 
<screenshot>
842
 
<screeninfo>The Main screen.</screeninfo>
843
 
        <mediaobjectco>
844
 
                <imageobjectco>
845
 
                        <areaspec units="calspair">
846
 
                                <area id="pt-channeltour-1" coords="1 1"/>
847
 
                                <area id="pt-channeltour-2" coords="1 1"/>
848
 
                                <area id="pt-channeltour-3" coords="1 1"/>
849
 
                                <area id="pt-channeltour-4" coords="1 1"/>
850
 
                                <area id="pt-channeltour-5" coords="1 1"/>
851
 
                                <area id="pt-channeltour-6" coords="1 1"/>
852
 
                                <area id="pt-channeltour-7" coords="1 1"/>
853
 
                                <area id="pt-channeltour-8" coords="1 1"/>
854
 
                                <area id="pt-channeltour-9" coords="1 1"/>
855
 
                        </areaspec>
856
 
                        <imageobject>
857
 
                                <imagedata fileref="channel_screen_tour_co.png" format="PNG"/>
858
 
                        </imageobject>
859
 
                </imageobjectco>
860
 
                <textobject>
861
 
                        <phrase>The Main screen</phrase>
862
 
                </textobject>
863
 
        </mediaobjectco>
864
 
</screenshot>
865
 
</para>
866
 
 
867
 
<para>
868
 
<calloutlist>
869
 
 
870
 
<callout arearefs="pt-channeltour-1"><para>This is called the <interface>Input Line</interface>.
871
 
It appears only when the current tab is a channel.
872
 
To send a message to everyone in the channel, type the message here and press &Enter;.
873
 
 Your message, as well as everyone else's messages appear in the channel scroll above.
874
 
 Each message is preceded by the time and user's &nickname;.</para>
875
 
 
876
 
 <para>You can also paste text from the clipboard.  If the pasted text has more than one line (newlines),
877
 
 a dialog box appears.  Edit the text as desired and click <guibutton>OK</guibutton>.
878
 
 </para>
879
 
 
880
 
 <para>If the pasted text is longer than 256 characters, or it contains more than one line, a warning message
881
 
 appears advising you that large postings can cause connection resets and flooding.  You can still proceed with
882
 
 the input, but doing so is a bad idea, as flooding will annoy other users in the channel, or you may
883
 
 be disconnected from the server.  It is better to send the message in shorter chunks.</para>
884
 
 
885
 
 <!-- Uncomment when this is implemented.
886
 
 &konversation; will automatically split messages that exceed the 510 character RFC limit into multiple messages.
887
 
 -->
888
 
 
889
 
 <para>
890
 
 A convention used in many channels is to precede messages directed at one user with their &nickname;.  &konversation;
891
 
 provides a convenient &nickname; completion feature.  Start typing the user's &nickname;, then press <keycap>Tab</keycap>.  &konversation; will complete the rest of the user's &nickname; followed by a colon.  To customize the completion feature, choose
892
 
<menuchoice>
893
 
        <guisubmenu>Settings</guisubmenu>
894
 
        <guisubmenu>Configure Konversation</guisubmenu>
895
 
</menuchoice> from the main menu, expand <guilabel>Behavior</guilabel>,
896
 
click on <guilabel>General</guilabel>, and click the
897
 
<guilabel>Completion mode</guilabel> box.
898
 
 </para>
899
 
 
900
 
 <para>
901
 
 You can also enter an &irc; command here by first typing <userinput><command>/</command></userinput>
902
 
 followed by a valid &irc; command.   See <link linkend="irc-cmds">Frequently-used &irc; commands</link>.  On some servers, you can type <userinput><command>/help</command></userinput> for a list of available commands, or type <userinput><command>/help </command><replaceable>command</replaceable></userinput> for help
903
 
 on a specific command.
904
 
 </para></callout>
905
 
 
906
 
<callout arearefs="pt-channeltour-2">
907
 
 
908
 
<para>You may join additional servers and channels.  Each server and each channel gets a separate tab here.
909
 
To display a list of available channels, see <link linkend="list-channels">Listing available channels</link>.
910
 
To join a channel, type: <userinput><command>/join</command>
911
 
<replaceable>#channelname</replaceable></userinput> in the Input Line.  (The <userinput>#</userinput> is required.)  To leave a channel, just type <userinput><command>/part</command></userinput>.
912
 
Tabs also appear here if you open a <link linkend="list-channels">Channel List</link>, participate in a <link linkend="query">private conversation (query)</link>, open the <link linkend="urlcatcher">&URL; Catcher</link>, or open one or more <guilabel>Konsole</guilabel>s.  To switch the display to a different screen, click the corresponding tab,
913
 
or use the mouse wheel to cycle through the tabs.
914
 
</para>
915
 
 
916
 
<para>  To set other options for tabs, choose
917
 
<menuchoice>
918
 
        <guisubmenu>Settings</guisubmenu>
919
 
        <guisubmenu>Configure Konversation</guisubmenu>
920
 
</menuchoice> from the main menu, expand <guilabel>Behavior</guilabel>,
921
 
click on <guilabel>General</guilabel>.
922
 
</para>
923
 
 
924
 
</callout>
925
 
 
926
 
<callout arearefs="pt-channeltour-3"><para>These &led;s will blink when there is something you haven't seen in that tab.
927
 
The &led; will blink slower when the only unseen messages are <command>join</command>, <command>part</command>,  <command>quit</command>, or &nickname; changes.  They blink faster if there are unseen regular messages.
928
 
  The colors are as follows:
929
 
<itemizedlist>
930
 
<listitem>
931
 
<para><inlinemediaobject><imageobject><imagedata fileref="led_green_on.png" format="PNG"  /></imageobject></inlinemediaobject>
932
 
Channel
933
 
</para>
934
 
</listitem>
935
 
<listitem>
936
 
<para><inlinemediaobject><imageobject><imagedata fileref="led_blue_on.png" format="PNG"  /></imageobject></inlinemediaobject>
937
 
<interface>Server Messages</interface>, <link linkend="list-channels">Channel List</link>, or
938
 
<link linkend="urlcatcher">&URL; catcher</link>
939
 
</para>
940
 
</listitem>
941
 
<listitem>
942
 
<para><inlinemediaobject><imageobject><imagedata fileref="led_yellow_on.png" format="PNG"  /></imageobject></inlinemediaobject>
943
 
<guilabel>Konsole</guilabel> or <link linkend="dcc">DCC Status</link>.
944
 
</para>
945
 
</listitem>
946
 
<listitem>
947
 
<para><inlinemediaobject><imageobject><imagedata fileref="led_red_on.png" format="PNG"  /></imageobject></inlinemediaobject>
948
 
<link linkend="query">Private Message (Query)</link>.
949
 
</para>
950
 
</listitem>
951
 
</itemizedlist>
952
 
</para></callout>
953
 
 
954
 
<callout arearefs="pt-channeltour-4"><para>Click here to close the current tab.  Closing a <interface>Channel</interface> tab will leave the channel.  Closing a <interface>Server Messages</interface> tab will leave all channels you've joined, close all open queries at that server and disconnect from the server.</para></callout>
955
 
 
956
 
<callout arearefs="pt-channeltour-5"><para>Click this button to change your own &nickname;. It appears only when the current tab is a channel.  To hide this button, choose
957
 
<menuchoice>
958
 
        <guisubmenu>Settings</guisubmenu>
959
 
        <guisubmenu>Configure Konversation</guisubmenu>
960
 
</menuchoice> from the main menu, expand <guilabel>Appearance</guilabel>,
961
 
click on <guilabel>Chat Window</guilabel>, and uncheck the
962
 
<guilabel>Show box to change own nickname</guilabel> box.
963
 
</para></callout>
964
 
 
965
 
<callout arearefs="pt-channeltour-6"><para>The channel topic is displayed here.
966
 
Hover the mouse over the topic to see long topics.  You can change the topic by
967
 
clicking the button to the left of the topic.  To hide channel topics, choose
968
 
<menuchoice>
969
 
        <guisubmenu>Settings</guisubmenu>
970
 
        <guisubmenu>Configure Konversation</guisubmenu>
971
 
</menuchoice> from the main menu, expand <guilabel>Appearance</guilabel>,
972
 
click on <guilabel>Chat Window</guilabel>, and uncheck the
973
 
<guilabel>Show channel topic</guilabel> box.
974
 
</para></callout>
975
 
 
976
 
<callout arearefs="pt-channeltour-7"><para>These buttons display the current state of channel modes.  A button is down if that mode is on.  If you have the correct privileges, you can also change channel modes by clicking on these buttons, or click the button to the
977
 
left of the topic.  To hide channel mode buttons, choose
978
 
<menuchoice>
979
 
        <guisubmenu>Settings</guisubmenu>
980
 
        <guisubmenu>Configure Konversation</guisubmenu>
981
 
</menuchoice> from the main menu, expand <guilabel>Appearance</guilabel>,
982
 
click on <guilabel>Chat Window</guilabel>, and uncheck the
983
 
<guilabel>Show channel mode buttons</guilabel> box.
984
 
</para></callout>
985
 
 
986
 
<callout arearefs="pt-channeltour-8">
987
 
<para>
988
 
This is called the <interface>Nick Panel</interface>.  It is displayed whenever the current tab is a channel.  It lists the &nickname;s of all the users who have joined the channel, including yourself.  Hover the mouse pointer over a &nickname; to display additional information
989
 
about the user.  You may change how the icons are displayed next to each &nickname; by changing
990
 
the &nickname; icon theme.  See <link linkend="nickthemes">Configuring &nickname; themes</link>
991
 
 for more information.
992
 
The <guilabel>Big Bullets</guilabel> theme, as shown in the screen above, uses the following icons:
993
 
<itemizedlist>
994
 
 
995
 
<listitem>
996
 
<para><inlinemediaobject><imageobject><imagedata fileref="irc_normal.png" format="PNG"  /></imageobject></inlinemediaobject>
997
 
normal user
998
 
</para>
999
 
</listitem>
1000
 
 
1001
 
<listitem>
1002
 
<para><inlinemediaobject><imageobject><imagedata fileref="irc_voice.png" format="PNG"  /></imageobject></inlinemediaobject>
1003
 
voiced user.  User may talk in a moderated channel.<!-- (see TODO) -->
1004
 
</para>
1005
 
</listitem>
1006
 
 
1007
 
<listitem>
1008
 
<para><inlinemediaobject><imageobject><imagedata fileref="irc_halfop.png" format="PNG"  /></imageobject></inlinemediaobject>
1009
 
channel halfop <!-- (see TODO) -->
1010
 
</para>
1011
 
</listitem>
1012
 
 
1013
 
<listitem>
1014
 
<para><inlinemediaobject><imageobject><imagedata fileref="irc_op.png" format="PNG"  /></imageobject></inlinemediaobject>
1015
 
channel operator
1016
 
</para>
1017
 
</listitem>
1018
 
 
1019
 
<listitem>
1020
 
<para><inlinemediaobject><imageobject><imagedata fileref="irc_owner.png" format="PNG"  /></imageobject></inlinemediaobject>
1021
 
channel owner <!-- (see TODO) -->
1022
 
</para>
1023
 
</listitem>
1024
 
 
1025
 
<listitem>
1026
 
<para><inlinemediaobject><imageobject><imagedata fileref="irc_admin.png" format="PNG"  /></imageobject></inlinemediaobject>
1027
 
channel admin <!-- (see TODO) -->
1028
 
</para>
1029
 
</listitem>
1030
 
 
1031
 
</itemizedlist>
1032
 
</para>
1033
 
 
1034
 
<para>In addition, if a user is away, a small red cross will be drawn in the corner of the icon.
1035
 
<inlinemediaobject><imageobject><imagedata fileref="irc_away.png" format="PNG"  /></imageobject></inlinemediaobject></para>
1036
 
 
1037
 
<para>
1038
 
Click with the &RMB; on any &nickname; to display a context menu of operations you can perform with that &nickname;.
1039
 
For example, you can <link linkend="dcc">send a file</link> to the &nickname;.
1040
 
This is also the place where you can <link linkend="linkaddressbook">associate a &nickname; to a contact in your address book.</link>
1041
 
</para>
1042
 
 
1043
 
<para>To hide the <interface>Nick Panel</interface>, choose
1044
 
<menuchoice>
1045
 
        <guisubmenu>Window</guisubmenu>
1046
 
        <guisubmenu>Hide Nicklist</guisubmenu>
1047
 
</menuchoice> from the main menu.
1048
 
</para>
1049
 
 
1050
 
</callout>
1051
 
 
1052
 
<callout arearefs="pt-channeltour-9"><para>These are called the <interface>Quick Buttons</interface>.
1053
 
By default, they are not shown.  To display them, see
1054
 
<link linkend="quick-buttons">Configuring Quick Buttons</link>.
1055
 
You can customize their definitions to whatever commands you wish.</para></callout>
1056
 
 
1057
 
</calloutlist>
1058
 
</para>
1059
 
 
1060
 
<para><emphasis>Note </emphasis>You can control how messages are displayed in the
1061
 
message scroll of channel and query tabs.  For example, you can change the color
1062
 
of messages, play a sound when a message containing a string
1063
 
is received, or automatically reply to messages.
1064
 
See <link linkend="highlighting">
1065
 
Message highlighting</link> for more information.
1066
 
</para>
1067
 
 
1068
 
<para><emphasis>Note: </emphasis>Channel names sometimes begin with <userinput>&amp;</userinput>, <userinput>&plus;</userinput>,
1069
 
or <userinput>!</userinput>.  The first character of a channel name determines the type of channel (RFC 2811) as follows:
1070
 
<itemizedlist>
1071
 
<listitem><para>
1072
 
<userinput>#</userinput>  - Regular channels.
1073
 
</para></listitem>
1074
 
<listitem><para>
1075
 
<userinput>!</userinput>  - Regular channels.
1076
 
</para></listitem>
1077
 
<listitem><para>
1078
 
<userinput>&amp;</userinput>  - Local.  Channels that can only be joined from the server hosting the channel.
1079
 
  All other channels can be joined from any server in the network.
1080
 
</para></listitem>
1081
 
<listitem><para>
1082
 
<userinput>&plus;</userinput>  - Channels that do not support channel modes.  This means
1083
 
   that all the modes are unset, with the exception of the 't' channel flag which is set.
1084
 
</para></listitem>
1085
 
</itemizedlist>
1086
 
Channel names are up to 50 characters long and may contain any characters except for space, comma, and Ctrl-G.
1087
 
</para>
1088
 
 
1089
 
</sect1>
1090
 
 
1091
 
<!-- =================================================================== -->
1092
 
 
1093
 
<sect1 id="quickconnect">
1094
 
<title>Quick Connect</title>
1095
 
 
1096
 
<para>Sometimes you want to connect to a server without going through the trouble
1097
 
of creating a new server in the <link linkend="serverlist">Server List</link>.
1098
 
</para>
1099
 
 
1100
 
<para>Choose
1101
 
<menuchoice>
1102
 
        <guisubmenu>File</guisubmenu>
1103
 
        <guisubmenu>Quick Connect</guisubmenu>
1104
 
</menuchoice>
1105
 
 on the main menu.  <action>The <guilabel>Quick Connect</guilabel> screen will appear.</action>
1106
 
</para>
1107
 
 
1108
 
<para>
1109
 
<screenshot>
1110
 
<screeninfo>The Quick Connect screen.</screeninfo>
1111
 
        <mediaobject>
1112
 
                <imageobject>
1113
 
                        <imagedata fileref="quickconnect_screen.png" format="PNG"/>
1114
 
                </imageobject>
1115
 
                <textobject>
1116
 
                        <phrase>The Quick Connect screen</phrase>
1117
 
                </textobject>
1118
 
        </mediaobject>
1119
 
</screenshot>
1120
 
</para>
1121
 
 
1122
 
<para>Enter the server address in the <guilabel>Server host</guilabel> box, your desired
1123
 
&nickname; in the <guilabel>Nick</guilabel> box, and click the <guibutton>Connect</guibutton> button.
1124
 
When &konversation; has connected to the server, enter command
1125
 
<userinput><command>/join</command> <replaceable>#channelname</replaceable></userinput> to
1126
 
join a channel.
1127
 
</para>
1128
 
 
1129
 
</sect1>
1130
 
 
1131
 
<!-- =================================================================== -->
1132
 
 
1133
 
<sect1 id="irc-cmds">
1134
 
<title>Frequently-used &irc; commands</title>
1135
 
 
1136
 
<para>The following is a short list of frequently-used &irc; commands.  See <ulink url="http://www.faqs.org/rfcs/rfc2812.html">RFC 2812</ulink> for a complete list of all commands, or
1137
 
visit <ulink url="http://www.irchelp.org/">irchelp.org</ulink>.  For a list of commands
1138
 
treated specially by &konversation;, see <link linkend="konvi-cmds">&konversation; commands</link>
1139
 
</para>
1140
 
 
1141
 
<para>
1142
 
<variablelist>
1143
 
 
1144
 
<varlistentry>
1145
 
<term><userinput><command>/help</command></userinput></term>
1146
 
<listitem><para>Lists commands available on the current server.  Not supported by all servers.</para></listitem>
1147
 
</varlistentry>
1148
 
 
1149
 
<varlistentry>
1150
 
<term><userinput><command>/help </command><replaceable>cmd</replaceable></userinput></term>
1151
 
<listitem><para>Provides help for <userinput><replaceable>cmd</replaceable></userinput>.  Not supported by all servers.</para></listitem>
1152
 
</varlistentry>
1153
 
 
1154
 
<varlistentry>
1155
 
<term><userinput><command>/join <replaceable>#channel</replaceable></command></userinput></term>
1156
 
<listitem><para>Joins <userinput><replaceable>#channel</replaceable></userinput>.  If the channel does not already exist, it is created and you are the channel operator.</para></listitem>
1157
 
</varlistentry>
1158
 
 
1159
 
<varlistentry>
1160
 
<term><userinput><command>/part</command></userinput></term>
1161
 
<listitem><para>Leaves the current channel and closes the <interface>channel</interface> tab.</para></listitem>
1162
 
</varlistentry>
1163
 
 
1164
 
<varlistentry>
1165
 
<term><userinput><command>/part </command> <replaceable>#channel</replaceable></userinput></term>
1166
 
<listitem><para>Leaves <userinput><replaceable>#channel</replaceable></userinput> and closes the corresponding <interface>channel</interface> tab.
1167
 
Synonym for <userinput><command>/leave</command></userinput></para></listitem>
1168
 
</varlistentry>
1169
 
 
1170
 
<varlistentry>
1171
 
<term><userinput><command>/me </command><replaceable>msg</replaceable></userinput></term>
1172
 
<listitem><para>Sends <userinput><replaceable>msg</replaceable></userinput> to the channel preceded by your &nickname;.  For example, if
1173
 
your &nickname; were <userinput><replaceable>Tux</replaceable></userinput>, typing <userinput><replaceable>/me brews a cup a tea.</replaceable></userinput> displays the message <interface>Tux brews a cup of tea.</interface>  Unless they've filtered against these types of messages, all users see it.  This kind of message is typically used to convey non-verbal information, such as your current emotional state, or what you are physically doing.  If you are leaving your workstation for a short time, use the /away command instead.</para></listitem>
1174
 
</varlistentry>
1175
 
 
1176
 
<varlistentry>
1177
 
<term><userinput><command>/away </command> <replaceable>msg</replaceable></userinput></term>
1178
 
<listitem><para>If anyone tries to send you a private message or invite you to a channel, they will be told that you are
1179
 
away from your workstation with <userinput><replaceable>msg</replaceable></userinput>.</para></listitem>
1180
 
</varlistentry>
1181
 
 
1182
 
<varlistentry>
1183
 
<term><userinput><command>/away</command></userinput></term>
1184
 
<listitem><para>Cancels an <userinput><command>/away </command> <replaceable>msg</replaceable></userinput> command.</para></listitem>
1185
 
</varlistentry>
1186
 
 
1187
 
<varlistentry>
1188
 
<term><userinput><command>/query </command><replaceable>nick</replaceable></userinput></term>
1189
 
<listitem><para>Creates a new tab with the user's <userinput><replaceable>nick</replaceable></userinput> for private conversation, commonly known on &irc; as a <link linkend="query">Query</link>. Everything written here is only visible to you and your query partner.</para></listitem>
1190
 
</varlistentry>
1191
 
 
1192
 
<varlistentry>
1193
 
<term><userinput><command>/msg </command><replaceable>nick</replaceable>  <replaceable>msg</replaceable></userinput></term>
1194
 
<listitem><para>Sends <userinput><replaceable>msg</replaceable></userinput> to the user with &nickname;  <userinput><replaceable>nick</replaceable></userinput>.
1195
 
Only <userinput><replaceable>nick</replaceable></userinput> sees the message.
1196
 
Use <userinput><command>/query</command></userinput> for longer conversations.</para></listitem>
1197
 
</varlistentry>
1198
 
 
1199
 
<varlistentry>
1200
 
<term><userinput><command>/invite </command><replaceable>nick</replaceable></userinput></term>
1201
 
<listitem><para>Invites the user with &nickname; <userinput><replaceable>nick</replaceable></userinput> to join a channel.  This command is especially useful if the channel is invite-only.</para></listitem>
1202
 
</varlistentry>
1203
 
 
1204
 
</variablelist>
1205
 
</para>
1206
 
 
1207
 
</sect1>
1208
 
 
1209
 
<!-- =================================================================== -->
1210
 
 
1211
 
<sect1 id="query">
1212
 
<title>Private conversations (queries)</title>
1213
 
 
1214
 
<para>
1215
 
A private conversation is one that only you and one other person can see.  Private conversations are called "queries" in &konversation;.  To initiate a private conversation,
1216
 
type <userinput><command>/query </command><replaceable>nick</replaceable></userinput> in any input line,
1217
 
where <replaceable>nick</replaceable> is the &nickname; of the person you want to talk with.  You can also
1218
 
click with the &RMB; on the person's &nickname; in the <guilabel>Nick Panel</guilabel> and choose
1219
 
<menuchoice>
1220
 
        <guisubmenu>Open Query</guisubmenu>
1221
 
</menuchoice>
1222
 
<action>A new tab will be created</action>.  Announce yourself by sending a message.
1223
 
</para>
1224
 
 
1225
 
<para>
1226
 
Queries are just like channels, except that only you and the other person can participate in the channel.</para>
1227
 
 
1228
 
<para>
1229
 
To leave the query, just close the tab.  Note however, that if the other person sends you another message in the query, the tab will open again.</para>
1230
 
 
1231
 
<para>To leave all queries, choose
1232
 
<menuchoice>
1233
 
        <guisubmenu>Window</guisubmenu>
1234
 
        <guisubmenu>Close All Open Queries</guisubmenu>
1235
 
</menuchoice> on the main menu, or press
1236
 
press <keycap>F11</keycap>.</para>
1237
 
 
1238
 
<para>
1239
 
When someone else initiates a query with you, &konversation; creates a new tab with their
1240
 
&nickname;.  If you don't wish to talk with the person, close the tab.
1241
 
</para>
1242
 
 
1243
 
</sect1>
1244
 
 
1245
 
<!-- =================================================================== -->
1246
 
 
1247
 
<sect1 id="cfg-notifications">
1248
 
<title>Setting notifications</title>
1249
 
 
1250
 
<para>
1251
 
<guilabel>Notifications</guilabel> are actions that &konversation; will perform whenever an event occurs.  Suppose you have &konversation; running, but minimized or hidden behind other application windows on your desktop.  If someone wants to communicate with you, or your buddy joins a channel, you'd like to be alerted.  Notifications will accomplish this.
1252
 
</para>
1253
 
 
1254
 
<para>
1255
 
To configure notifications, choose
1256
 
<menuchoice>
1257
 
        <guisubmenu>Settings</guisubmenu>
1258
 
        <guisubmenu>Configure Notifications</guisubmenu>
1259
 
</menuchoice>
1260
 
 on the main menu.  <action>The <guilabel>Notification Settings</guilabel> screen will appear.</action>
1261
 
 </para>
1262
 
 
1263
 
<para>Immediately click the <guibutton>More Options</guibutton> button.</para>
1264
 
 
1265
 
<para>
1266
 
<screenshot>
1267
 
<screeninfo>The Notification Settings screen.</screeninfo>
1268
 
        <mediaobjectco>
1269
 
                <imageobjectco>
1270
 
                        <areaspec units="calspair">
1271
 
                                <area id="pt-notification-1" coords="1 1"/>
1272
 
                                <area id="pt-notification-2" coords="1 1"/>
1273
 
                                <area id="pt-notification-3" coords="1 1"/>
1274
 
                        </areaspec>
1275
 
                        <imageobject>
1276
 
                                <imagedata fileref="notification_screen_co.png" format="PNG"/>
1277
 
                        </imageobject>
1278
 
                </imageobjectco>
1279
 
                <textobject>
1280
 
                        <phrase>The Notification Settings screen</phrase>
1281
 
                </textobject>
1282
 
        </mediaobjectco>
1283
 
</screenshot>
1284
 
</para>
1285
 
 
1286
 
<para>
1287
 
<calloutlist>
1288
 
 
1289
 
<callout arearefs="pt-notification-1"><para>Click here to select an event.</para></callout>
1290
 
 
1291
 
<callout arearefs="pt-notification-2"><para>Check the types of notifications you'd like to happen when the event occurs.  (<guilabel>Mark taskbar entry</guilabel> causes the entry in the taskbar to flash when the event occurs.)</para></callout>
1292
 
 
1293
 
</calloutlist>
1294
 
</para>
1295
 
 
1296
 
<para>Repeat by selecting another event and checking the notifications desired.  When you've configured all the desired notifications, click the <guibutton>Apply</guibutton> button.</para>
1297
 
 
1298
 
<para>
1299
 
<calloutlist>
1300
 
 
1301
 
<callout arearefs="pt-notification-3"><para>Once you've set up your notifications, you can enable or disable all notification actions here.  For example, you can choose to play a sound whenever your &nickname; is mentioned in a message.  When you are at your workstation, you can disable the sounds, but while you are away from your workstation but nearby, you can enable the sounds in order to get your attention.</para></callout>
1302
 
 
1303
 
</calloutlist>
1304
 
</para>
1305
 
 
1306
 
<tip><para>You can also alert yourself when someone mentions your &nickname;
1307
 
in a message using &konversation;'s
1308
 
<link linkend="highlighting">highlighting feature</link>.</para></tip>
1309
 
 
1310
 
</sect1>
1311
 
 
1312
 
<!-- =================================================================== -->
1313
 
 
1314
 
<sect1 id="nicksonline">
1315
 
<title>Monitoring who is online</title>
1316
 
 
1317
 
<para>
1318
 
&konversation; will keep you informed when your buddies are connected to the &irc; network
1319
 
or not.
1320
 
</para>
1321
 
 
1322
 
<para>You can associate online &nickname;s with contact entries in your address book.
1323
 
When you do this, the &nickname; and &irc; network where the &nickname; is online are
1324
 
entered into the contact in the address book.  The &irc; network is recorded because &nickname;s
1325
 
are unique across a single &irc; network.  The &nickname; in two different &irc; networks
1326
 
is not necessarily the same person, but the same &nickname; on two different servers
1327
 
within the same &irc; network generally is the same person.</para>
1328
 
 
1329
 
<note><para>This is why it is important to use the same <guilabel>Network</guilabel>
1330
 
for all servers in the same &irc; network, when <link linkend="serverlist">
1331
 
defining networks, servers, and auto join channels</link>.</para></note>
1332
 
 
1333
 
<para>You can also define &nickname;s you want watched that are not in your address book.
1334
 
In this case also, each &nickname; has an associated &irc; network.  See below.</para>
1335
 
 
1336
 
<para>To activate the &nickname; watching feature, choose
1337
 
<menuchoice>
1338
 
        <guisubmenu>Windows</guisubmenu>
1339
 
        <guisubmenu>Watched Nicks Online</guisubmenu>
1340
 
</menuchoice>
1341
 
 on the main menu.  <action>The <guilabel>Watched Nicks Online</guilabel> screen will appear.</action>
1342
 
</para>
1343
 
 
1344
 
<para>
1345
 
<screenshot>
1346
 
        <screeninfo>Watched Nicks Online.</screeninfo>
1347
 
        <mediaobjectco>
1348
 
                <imageobjectco>
1349
 
                        <areaspec units="calspair">
1350
 
                                <area id="pt-nicksonline-1" coords="1 1"/>
1351
 
                                <area id="pt-nicksonline-2" coords="1 1"/>
1352
 
                                <area id="pt-nicksonline-3" coords="1 1"/>
1353
 
                                <area id="pt-nicksonline-4" coords="1 1"/>
1354
 
                                <area id="pt-nicksonline-5" coords="1 1"/>
1355
 
                                <area id="pt-nicksonline-6" coords="1 1"/>
1356
 
                        </areaspec>
1357
 
                        <imageobject>
1358
 
                                <imagedata fileref="nicksonline_co.png" format="PNG"/>
1359
 
                        </imageobject>
1360
 
                </imageobjectco>
1361
 
                <textobject>
1362
 
                        <phrase>Watched Nicks Online</phrase>
1363
 
                </textobject>
1364
 
        </mediaobjectco>
1365
 
</screenshot>
1366
 
</para>
1367
 
 
1368
 
<para>
1369
 
<calloutlist>
1370
 
<callout arearefs="pt-nicksonline-1"><para>The &nickname;s in your watch list and
1371
 
also the &nickname;s associated with entries in your address book are listed here.
1372
 
They are listed under their associated &irc; network.  If no &nickname;s are listed,
1373
 
either you haven't specified any &nickname;s to watch, or you need to activate
1374
 
the &nickname; watching feature (see below).  Expand each online &nickname; to see a list
1375
 
of channels the &nickname; has joined.  The icons next to each channel are the same as
1376
 
the icons that appear in the <interface>Nick Panel</interface> in the
1377
 
<link linkend="channel-screen-tour">channel</link> screens.
1378
 
</para></callout>
1379
 
<callout arearefs="pt-nicksonline-2"><para>The information known about the &nickname;
1380
 
is displayed here.  When the <guilabel>Watched Nicks Online</guilabel> screen is first
1381
 
displayed, this information is sparse.  Every 8 seconds,
1382
 
one <userinput><command>WHOIS</command></userinput> command is automatically sent to the server
1383
 
to request information for &nickname;s that do not have any information.  This continues until
1384
 
all &nickname;s have information.
1385
 
</para></callout>
1386
 
<callout arearefs="pt-nicksonline-3"><para>Nicknames that are not connected to any
1387
 
of the &irc; networks you are connected to are listed in the <guilabel>Offline</guilabel>
1388
 
part of the listing.
1389
 
</para></callout>
1390
 
<callout arearefs="pt-nicksonline-4"><para>Nicknames that are associated with
1391
 
a contact entry in your address book have this icon
1392
 
(<inlinemediaobject><imageobject><imagedata fileref="kaddressbook.png" format="PNG"  /></imageobject></inlinemediaobject>) next to their information.
1393
 
</para></callout>
1394
 
<callout arearefs="pt-nicksonline-5"><para>Use these buttons to associate a &nickname;
1395
 
with a contact in your address book, remove an association, or open the address book
1396
 
to edit the contact information.  See the
1397
 
<ulink url="help:kaddressbook">&kaddressbook; Handbook</ulink> for additional instructions
1398
 
on using the &kde; address book.
1399
 
</para></callout>
1400
 
</calloutlist>
1401
 
</para>
1402
 
 
1403
 
<para>
1404
 
To add additional &nickname;s to watch, click the <guilabel>Edit Watch List</guilabel> button.
1405
 
The <guilabel>Watched Nicknames</guilabel> screen appears.
1406
 
</para>
1407
 
 
1408
 
<para>
1409
 
<screenshot>
1410
 
<screeninfo>Watched Nicknames</screeninfo>
1411
 
        <mediaobjectco>
1412
 
                <imageobjectco>
1413
 
                        <areaspec units="calspair">
1414
 
                                <area id="pt-notifylist-1" coords="1 1"/>
1415
 
                                <area id="pt-notifylist-2" coords="1 1"/>
1416
 
                                <area id="pt-notifylist-3" coords="1 1"/>
1417
 
                                <area id="pt-notifylist-4" coords="1 1"/>
1418
 
                                <area id="pt-notifylist-5" coords="1 1"/>
1419
 
                        </areaspec>
1420
 
                        <imageobject>
1421
 
                                <imagedata fileref="notifylist_screen_co.png" format="PNG"/>
1422
 
                        </imageobject>
1423
 
                </imageobjectco>
1424
 
                <textobject>
1425
 
                        <phrase>Watched Nicknames</phrase>
1426
 
                </textobject>
1427
 
        </mediaobjectco>
1428
 
</screenshot>
1429
 
</para>
1430
 
 
1431
 
<para>
1432
 
<calloutlist>
1433
 
 
1434
 
<callout arearefs="pt-notifylist-1"><para>Check this box to activate the <guilabel>nickname watcher</guilabel> feature.</para></callout>
1435
 
 
1436
 
<callout arearefs="pt-notifylist-2"><para>If you want the
1437
 
<guilabel>Watched Nicks Online</guilabel> screen to automatically display when you
1438
 
open &konversation;, check this box.</para></callout>
1439
 
 
1440
 
<callout arearefs="pt-notifylist-3"><para>The &nickname;s of the users you want to monitor are listed here.  Each &nickname; has an associated &irc; network.</para></callout>
1441
 
 
1442
 
<callout arearefs="pt-notifylist-4"><para>Click these buttons to add or remove &nickname;s from the list.</para></callout>
1443
 
 
1444
 
<callout arearefs="pt-notifylist-5"><para>The <guilabel>Watched Nicks Online</guilabel> feature works by periodically polling the server.  This box sets how often that occurs.  Avoid numbers less than 20 seconds because it places excessive load on the server.</para></callout>
1445
 
 
1446
 
<callout arearefs="pt-notifylist-5"><para>In the <guilabel>Watched Nicks Online</guilabel>
1447
 
screen above, you may double click on any &nickname; and this command will be sent to the
1448
 
server.  <userinput><command>%u</command></userinput> will be replaced with the
1449
 
&nickname;.  The <userinput><command>%n</command></userinput> is required at the
1450
 
end of the command.</para></callout>
1451
 
 
1452
 
</calloutlist>
1453
 
</para>
1454
 
 
1455
 
<para>Click the <guibutton>OK</guibutton> button when you have finished adding or removing &nickname;s.</para>
1456
 
 
1457
 
<para><emphasis>Note: </emphasis>Whenever you display the <guilabel>Watched Nicks Online</guilabel> screen, it may take a while before any &nickname;s are displayed until &konversation; has polled the server.  Normally, you leave the <guilabel>Watched Nicks Online</guilabel> screen running.
1458
 
</para>
1459
 
 
1460
 
<para>&konversation; also displays a message in all the <link linkend="channel-screen-tour">channels</link> whenever a user in
1461
 
your <guilabel>Watched Nicknames</guilabel> list connects or disconnects from the server.  The message looks like this:
1462
 
</para>
1463
 
 
1464
 
<para><computeroutput>[17:52] [Notify] psn is online (irc.kde.org).</computeroutput></para>
1465
 
 
1466
 
</sect1>
1467
 
 
1468
 
<!-- =================================================================== -->
1469
 
 
1470
 
<sect1 id="highlighting">
1471
 
<title>Message highlighting</title>
1472
 
 
1473
 
<para>You can control how messages are displayed in channel and query screens.</para>
1474
 
 
1475
 
<para>To activate the highlighting feature, choose
1476
 
<menuchoice>
1477
 
        <guisubmenu>Settings</guisubmenu>
1478
 
        <guisubmenu>Configure &konversation;</guisubmenu>
1479
 
</menuchoice>
1480
 
 on the main menu.  <action>The <guilabel>Edit Preferences</guilabel> screen will appear.</action>
1481
 
 </para>
1482
 
 
1483
 
<para>
1484
 
<screenshot>
1485
 
<screeninfo>The Highlighting screen.</screeninfo>
1486
 
        <mediaobjectco>
1487
 
                <imageobjectco>
1488
 
                        <areaspec units="calspair">
1489
 
                                <area id="pt-highlight-1" coords="1 1"/>
1490
 
                                <area id="pt-highlight-2" coords="1 1"/>
1491
 
                                <area id="pt-highlight-3" coords="1 1"/>
1492
 
                                <area id="pt-highlight-4" coords="1 1"/>
1493
 
                                <area id="pt-highlight-5" coords="1 1"/>
1494
 
                                <area id="pt-highlight-6" coords="1 1"/>
1495
 
                                <area id="pt-highlight-7" coords="1 1"/>
1496
 
                                <area id="pt-highlight-8" coords="1 1"/>
1497
 
                                <area id="pt-highlight-9" coords="1 1"/>
1498
 
                        </areaspec>
1499
 
                        <imageobject>
1500
 
                                <imagedata fileref="highlighting_screen_co.png" format="PNG"/>
1501
 
                        </imageobject>
1502
 
                </imageobjectco>
1503
 
                <textobject>
1504
 
                        <phrase>The Highlighting screen</phrase>
1505
 
                </textobject>
1506
 
        </mediaobjectco>
1507
 
</screenshot>
1508
 
</para>
1509
 
 
1510
 
<para>
1511
 
<calloutlist>
1512
 
 
1513
 
<callout arearefs="pt-highlight-1"><para>Click here to select the <guilabel>Highlighting</guilabel> screen.</para></callout>
1514
 
<callout arearefs="pt-highlight-2"><para>Click here to add a new item
1515
 
to the <guilabel>Highlight list</guilabel>.
1516
 
When an item in the list is selected, you may edit it in the panel below.</para></callout>
1517
 
<callout arearefs="pt-highlight-3"><para>Enter a string pattern here.
1518
 
Any message received that matches this pattern, anywhere in the message, will activate
1519
 
the highlighting for the message.  If you have the &kde; Regular Expression Editor
1520
 
utility installed on your system, the button to the right of the pattern will
1521
 
be enabled.  Click to display the editor, which will assist you
1522
 
in preparing more complex patterns.  (The &kde; Regular Expression Editor
1523
 
is part of the <command>kdeutils</command> package.)
1524
 
</para></callout>
1525
 
<callout arearefs="pt-highlight-4"><para>If the pattern is found
1526
 
in a message, the entire message will be displayed
1527
 
in the color you select here.</para></callout>
1528
 
<callout arearefs="pt-highlight-5"><para>If you wish, &konversation; will
1529
 
play a sound when the pattern is matched.  Click the button to choose
1530
 
an audio file to be played.  Click the test button to hear the sound.</para></callout>
1531
 
<callout arearefs="pt-highlight-6"><para>If you'd like for &konversation; to
1532
 
automatically send a reply message when the pattern is matched, enter the
1533
 
message here.  Use this feature with caution, as you may annoy &irc; users
1534
 
with too much chatter if not careful.  You can also enter
1535
 
&irc; or &konversation; commands here.</para></callout>
1536
 
<callout arearefs="pt-highlight-7"><para>If you have configured sounds
1537
 
for any of your highlights, you can disable all of them by unchecking
1538
 
this box.</para></callout>
1539
 
<callout arearefs="pt-highlight-8"><para>If you check this box,
1540
 
whenever someone mentions your &nickname; in a message, the message
1541
 
will be displayed in the color you choose at the right.</para></callout>
1542
 
<callout arearefs="pt-highlight-9"><para>Normally, highlighting
1543
 
does not apply to messages you type.  If you wish to highlight the
1544
 
messages you type, check this box and choose a color at the right.</para></callout>
1545
 
 
1546
 
</calloutlist>
1547
 
</para>
1548
 
 
1549
 
</sect1>
1550
 
 
1551
 
<!-- =================================================================== -->
1552
 
 
1553
 
<sect1 id="cfg-osd">
1554
 
<title>Configuring On Screen Display (&osd;)</title>
1555
 
 
1556
 
<para><acronym>On Screen Display</acronym> (&osd;) is a unique feature of &konversation;.  With &osd; turned on,
1557
 
 channel messages will appear on your desktop screen, even if &konversation; is minimized.  Here's an example of &osd; in
1558
 
  action.  The message in the upper lefthand part of the screen is from &konversation;, which is running
1559
 
minimized in the system tray.</para>
1560
 
 
1561
 
<para>
1562
 
<screenshot>
1563
 
<screeninfo>Example of On Screen Display</screeninfo>
1564
 
        <mediaobject>
1565
 
                <imageobject>
1566
 
                        <imagedata fileref="osd_demo.png" format="PNG"/>
1567
 
                </imageobject>
1568
 
                <textobject>
1569
 
                        <phrase>Example of On Screen Display</phrase>
1570
 
                </textobject>
1571
 
        </mediaobject>
1572
 
</screenshot>
1573
 
</para>
1574
 
 
1575
 
<para>To activate &osd;, choose
1576
 
<menuchoice>
1577
 
        <guisubmenu>Settings</guisubmenu>
1578
 
        <guisubmenu>Configure &konversation;</guisubmenu>
1579
 
</menuchoice>
1580
 
 on the main menu.  <action>The <guilabel>Edit Preferences</guilabel> screen will appear.</action>
1581
 
 </para>
1582
 
 
1583
 
<para>
1584
 
<screenshot>
1585
 
<screeninfo>The On Screen Display screen.</screeninfo>
1586
 
        <mediaobjectco>
1587
 
                <imageobjectco>
1588
 
                        <areaspec units="calspair">
1589
 
                                <area id="pt-osd-1" coords="1 1"/>
1590
 
                                <area id="pt-osd-2" coords="1 1"/>
1591
 
                                <area id="pt-osd-3" coords="1 1"/>
1592
 
                                <area id="pt-osd-4" coords="1 1"/>
1593
 
                                <area id="pt-osd-5" coords="1 1"/>
1594
 
                        </areaspec>
1595
 
                        <imageobject>
1596
 
                                <imagedata fileref="osd_screen_co.png" format="PNG"/>
1597
 
                        </imageobject>
1598
 
                </imageobjectco>
1599
 
                <textobject>
1600
 
                        <phrase>The On Screen Display screen</phrase>
1601
 
                </textobject>
1602
 
        </mediaobjectco>
1603
 
</screenshot>
1604
 
</para>
1605
 
 
1606
 
<para>
1607
 
<calloutlist>
1608
 
 
1609
 
<callout arearefs="pt-osd-1"><para>Click here to expand the <guilabel>Notification</guilabel> item.</para></callout>
1610
 
 
1611
 
<callout arearefs="pt-osd-2"><para>Click here to select the <guilabel>On Screen Display</guilabel> screen.</para></callout>
1612
 
 
1613
 
<callout arearefs="pt-osd-3"><para>Check this box to activate &osd;.</para></callout>
1614
 
 
1615
 
<callout arearefs="pt-osd-4"><para>Click this button to choose a font for &osd;.  (<emphasis>Note: </emphasis> Not all fonts work.  Luxi Sans 22 and Impact 22 are known to work.)</para></callout>
1616
 
 
1617
 
<callout arearefs="pt-osd-5"><para>Check the boxes here to select the types of messages you'd like to appear on screen, then click the <guibutton>Apply</guibutton> button.</para></callout>
1618
 
 
1619
 
</calloutlist>
1620
 
</para>
1621
 
 
1622
 
</sect1>
1623
 
 
1624
 
<!-- =================================================================== -->
1625
 
 
1626
 
<sect1 id="color-msgs">
1627
 
<title>Sending colorful messages</title>
1628
 
 
1629
 
<para>
1630
 
You can add color to the messages you send in any channel.  In the <interface>Input Line</interface> of any channel, start typing your message.  Click the
1631
 
<inlinemediaobject>
1632
 
        <imageobject>
1633
 
                <imagedata fileref="colorize.png" format="PNG" />
1634
 
        </imageobject>
1635
 
        <textobject>
1636
 
                <phrase>Insert &irc; Color Button</phrase>
1637
 
        </textobject>
1638
 
</inlinemediaobject>
1639
 
Insert &irc; Color button or choose
1640
 
<menuchoice>
1641
 
        <guisubmenu>Insert</guisubmenu>
1642
 
        <guisubmenu>&irc; Color</guisubmenu>
1643
 
</menuchoice>
1644
 
 on the main menu.  <action>The <guilabel>&irc; Color Chooser</guilabel> screen will appear.</action>
1645
 
</para>
1646
 
 
1647
 
<para>
1648
 
<screenshot>
1649
 
<screeninfo>The &irc; Color Chooser screen.</screeninfo>
1650
 
        <mediaobject>
1651
 
                <imageobject>
1652
 
                        <imagedata fileref="colorchooser_screen.png" format="PNG"/>
1653
 
                </imageobject>
1654
 
                <textobject>
1655
 
                        <phrase>The &irc; Color Chooser screen</phrase>
1656
 
                </textobject>
1657
 
        </mediaobject>
1658
 
</screenshot>
1659
 
</para>
1660
 
 
1661
 
<para>
1662
 
Choose a color and click <guibutton>OK</guibutton>.  Continue typing your message in the <interface>Input Line</interface>.
1663
 
To change the color again, click the <guibutton>Insert &irc; Color</guibutton>  button.  Choose a different color
1664
 
and click <guibutton>OK</guibutton>.
1665
 
</para>
1666
 
 
1667
 
</sect1>
1668
 
 
1669
 
<!-- =================================================================== -->
1670
 
 
1671
 
<sect1 id="nickthemes">
1672
 
<title>Configuring &nickname; themes</title>
1673
 
 
1674
 
<para>You can change the icons displayed next to &nickname;s in the
1675
 
<interface>Nick Panel</interface> of channel tabs.
1676
 
To change the &nickname; theme, choose
1677
 
<menuchoice>
1678
 
        <guisubmenu>Settings</guisubmenu>
1679
 
        <guisubmenu>Configure Konversation</guisubmenu>
1680
 
</menuchoice>
1681
 
 on the main menu.  <action>The <guilabel>Edit Preferences</guilabel> screen will appear.</action>
1682
 
 Click <guilabel>Appearance</guilabel> to expand it, then click <guilabel>Themes</guilabel>
1683
 
 to display the <guilabel>Themes</guilabel> screen.
1684
 
 </para>
1685
 
 
1686
 
<para>
1687
 
<screenshot>
1688
 
<screeninfo>The Themes screen.</screeninfo>
1689
 
        <mediaobjectco>
1690
 
                <imageobjectco>
1691
 
                        <areaspec units="calspair">
1692
 
                                <area id="pt-themes-1" coords="1 1"/>
1693
 
                                <area id="pt-themes-2" coords="1 1"/>
1694
 
                                <area id="pt-themes-3" coords="1 1"/>
1695
 
                                <area id="pt-themes-4" coords="1 1"/>
1696
 
                        </areaspec>
1697
 
                        <imageobject>
1698
 
                                <imagedata fileref="nickthemes_screen_co.png" format="PNG"/>
1699
 
                        </imageobject>
1700
 
                </imageobjectco>
1701
 
                <textobject>
1702
 
                        <phrase>The Themes screen</phrase>
1703
 
                </textobject>
1704
 
        </mediaobjectco>
1705
 
</screenshot>
1706
 
</para>
1707
 
 
1708
 
<para>
1709
 
<calloutlist>
1710
 
 
1711
 
<callout arearefs="pt-themes-1"><para>Click to select the nick <guilabel>Themes</guilabel> screen.</para></callout>
1712
 
<callout arearefs="pt-themes-2"><para>Select a theme.</para></callout>
1713
 
<callout arearefs="pt-themes-3"><para>Sample icons are displayed here in the chosen theme.</para></callout>
1714
 
<callout arearefs="pt-themes-4"><para>If you have downloaded a nick theme
1715
 
from elsewhere, click to install it.</para></callout>
1716
 
 
1717
 
</calloutlist>
1718
 
</para>
1719
 
 
1720
 
</sect1>
1721
 
 
1722
 
<!-- =================================================================== -->
1723
 
 
1724
 
<sect1 id="quick-buttons">
1725
 
<title>Configuring Quick Buttons</title>
1726
 
 
1727
 
<para>You can enable a feature to display <interface>Quick Buttons</interface> on the <link linkend="channel-screen-tour">Main</link> screen, eight <interface>Quick Buttons</interface> appear.  To display the Quick Buttons, choose
1728
 
<menuchoice>
1729
 
    <guisubmenu>Settings</guisubmenu>
1730
 
    <guisubmenu>Configure Konversation</guisubmenu>
1731
 
</menuchoice>
1732
 
on the main menu.  <action>The <guilabel>Edit Preferences</guilabel> screen will appear.</action>
1733
 
Click <guilabel>Appearance</guilabel> to expand it, then click <guilabel>Chat Window</guilabel>.
1734
 
Check the <guilabel>Show quick buttons</guilabel> box and click <guibutton>OK</guibutton>.
1735
 
</para>
1736
 
 
1737
 
<para>The buttons may be customized to your liking for performing often-used &irc;
1738
 
commands.
1739
 
To customize the <interface>Quick Buttons</interface>, choose
1740
 
<menuchoice>
1741
 
        <guisubmenu>Settings</guisubmenu>
1742
 
        <guisubmenu>Configure Konversation</guisubmenu>
1743
 
</menuchoice>
1744
 
 on the main menu.  <action>The <guilabel>Edit Preferences</guilabel> screen will appear.</action>
1745
 
 Click <guilabel>Behavior</guilabel> to expand it, then click <guilabel>Quick Buttons</guilabel>
1746
 
 to display the <guilabel>Quick Buttons</guilabel> screen.
1747
 
 </para>
1748
 
 
1749
 
<para>
1750
 
<screenshot>
1751
 
<screeninfo>The Quick Buttons screen</screeninfo>
1752
 
        <mediaobject>
1753
 
                <imageobject>
1754
 
                        <imagedata fileref="quickbuttons_screen.png" format="PNG"/>
1755
 
                </imageobject>
1756
 
                <textobject>
1757
 
                        <phrase>The Quick Buttons screen</phrase>
1758
 
                </textobject>
1759
 
        </mediaobject>
1760
 
</screenshot>
1761
 
</para>
1762
 
 
1763
 
<para>
1764
 
There are 8 <interface>Quick Button</interface>s.  Click on an entry to change it.
1765
 
The <guilabel>Button name</guilabel> column is the name that
1766
 
will appear on the button in the <link linkend="channel-screen-tour">Main</link> screen.  Keep the names short.
1767
 
The <guilabel>Button Action</guilabel> column is the action that will be performed when you click the
1768
 
<interface>Quick Button</interface>.  Tips for creating actions are given on the screen.
1769
 
</para>
1770
 
 
1771
 
<para>
1772
 
Click <guibutton>OK</guibutton> to complete the changes.
1773
 
</para>
1774
 
 
1775
 
<para>Example:</para>
1776
 
 
1777
 
<para>
1778
 
<variablelist>
1779
 
        <varlistentry>
1780
 
                <term>
1781
 
                        <guilabel>Button Name</guilabel>: <userinput><replaceable>Msg</replaceable></userinput>
1782
 
                </term>
1783
 
                <listitem>
1784
 
                        <para>
1785
 
                                <guilabel>Button Action</guilabel>: <userinput><replaceable>Msg %u </replaceable></userinput> (there is a space after <userinput><replaceable>%u</replaceable></userinput>)
1786
 
                        </para>
1787
 
                </listitem>
1788
 
        </varlistentry>
1789
 
</variablelist>
1790
 
</para>
1791
 
 
1792
 
<para>
1793
 
To use this button in the <link linkend="channel-screen-tour">Main</link> screen,
1794
 
click on a &nickname; in the <interface>Nick Panel</interface>, then click the button.
1795
 
<computeroutput>/MSG </computeroutput> will appear in the <interface>Input Line</interface>
1796
 
followed by the chosen &nickname;.  Type a message you want to send to that person and press
1797
 
&Enter;.  The message will be sent to the user.  Only that user will see the message.
1798
 
</para>
1799
 
 
1800
 
<para>
1801
 
<emphasis>Note: </emphasis>You cannot add or delete <interface>Quick Buttons</interface>.
1802
 
</para>
1803
 
 
1804
 
</sect1>
1805
 
 
1806
 
<!-- =================================================================== -->
1807
 
 
1808
 
<sect1 id="dcc">
1809
 
<title>Sending and receiving files</title>
1810
 
 
1811
 
<para>
1812
 
You may send files via &irc; to other users online, or they may send you files.
1813
 
</para>
1814
 
 
1815
 
<para>
1816
 
<emphasis>WARNING: Never open a file someone sends you unless they are a trusted source.  It could be a virus.</emphasis>
1817
 
</para>
1818
 
 
1819
 
<para>
1820
 
To send a file to someone in a channel, click with the &RMB; on the &nickname; of the person in the
1821
 
<interface>Nick Panel</interface> of the <link linkend="channel-screen-tour">Main</link> screen.
1822
 
Choose
1823
 
<menuchoice>
1824
 
        <guisubmenu>Send File</guisubmenu>
1825
 
</menuchoice>
1826
 
<action>A dialog appears for you to choose a file to send.</action>  Next, a new <guilabel>DCC Status</guilabel> tab appears.
1827
 
</para>
1828
 
 
1829
 
<para>
1830
 
<screenshot>
1831
 
<screeninfo>DCC Status tab</screeninfo>
1832
 
        <mediaobjectco>
1833
 
                <imageobjectco>
1834
 
                        <areaspec units="calspair">
1835
 
                                <area id="pt-dccstatus-1" coords="1 1"/>
1836
 
                                <area id="pt-dccstatus-2" coords="1 1"/>
1837
 
                                <area id="pt-dccstatus-3" coords="1 1"/>
1838
 
                        </areaspec>
1839
 
                        <imageobject>
1840
 
                                <imagedata fileref="dccstatus_screen_co.png" format="PNG"/>
1841
 
                        </imageobject>
1842
 
                </imageobjectco>
1843
 
                <textobject>
1844
 
                        <phrase>DCC Status tab</phrase>
1845
 
                </textobject>
1846
 
        </mediaobjectco>
1847
 
</screenshot>
1848
 
</para>
1849
 
 
1850
 
<para>
1851
 
<calloutlist>
1852
 
 
1853
 
<callout arearefs="pt-dccstatus-1"><para>The &nickname; of the recipient and file name appear here.</para></callout>
1854
 
 
1855
 
<callout arearefs="pt-dccstatus-2">
1856
 
<para>The <guilabel>Status</guilabel> column indicates the status of the file send or receive as follows:</para>
1857
 
 
1858
 
<para>
1859
 
<variablelist>
1860
 
        <varlistentry>
1861
 
                <term>
1862
 
                        <guilabel>Offering</guilabel>
1863
 
                </term>
1864
 
                <listitem>
1865
 
                        <para>You are trying to send a file to the recipient.  &konversation; is waiting for the recipient to accept the file.
1866
 
                        </para>
1867
 
                </listitem>
1868
 
        </varlistentry>
1869
 
        <varlistentry>
1870
 
                <term>
1871
 
                        <guilabel>Connecting</guilabel>
1872
 
                </term>
1873
 
                <listitem>
1874
 
                        <para>&konversation; is trying to establish a connection with the other end.
1875
 
                        </para>
1876
 
                </listitem>
1877
 
        </varlistentry>
1878
 
        <varlistentry>
1879
 
                <term>
1880
 
                        <guilabel>Sending</guilabel>
1881
 
                </term>
1882
 
                <listitem>
1883
 
                        <para>&konversation; is sending the file to the other end.
1884
 
                        </para>
1885
 
                </listitem>
1886
 
        </varlistentry>
1887
 
        <varlistentry>
1888
 
                <term>
1889
 
                        <guilabel>Receiving</guilabel>
1890
 
                </term>
1891
 
                <listitem>
1892
 
                        <para>&konversation; is receiving the file from the other end.
1893
 
                        </para>
1894
 
                </listitem>
1895
 
        </varlistentry>
1896
 
        <varlistentry>
1897
 
                <term>
1898
 
                        <guilabel>Done</guilabel>
1899
 
                </term>
1900
 
                <listitem>
1901
 
                        <para>The file has been successfully transfered.
1902
 
                        </para>
1903
 
                </listitem>
1904
 
        </varlistentry>
1905
 
        <varlistentry>
1906
 
                <term>
1907
 
                        <guilabel>Stalled</guilabel>
1908
 
                </term>
1909
 
                <listitem>
1910
 
                        <para>The transfer was started but is not currently progressing.
1911
 
                        </para>
1912
 
                </listitem>
1913
 
        </varlistentry>
1914
 
        <varlistentry>
1915
 
                <term>
1916
 
                        <guilabel>Aborted</guilabel>
1917
 
                </term>
1918
 
                <listitem>
1919
 
                        <para>Either you clicked the <guibutton>Abort</guibutton> button, or the other person aborted the transfer.
1920
 
                        </para>
1921
 
                </listitem>
1922
 
        </varlistentry>
1923
 
        <varlistentry>
1924
 
                <term>
1925
 
                        <guilabel>Failed</guilabel>
1926
 
                </term>
1927
 
                <listitem>
1928
 
                        <para>An error occurred and the transfer was not successful..
1929
 
                        </para>
1930
 
                </listitem>
1931
 
        </varlistentry>
1932
 
        <varlistentry>
1933
 
                <term>
1934
 
                        <guilabel>Queued</guilabel>
1935
 
                </term>
1936
 
                <listitem>
1937
 
                        <para>The transfer has been accepted and will begin when the software on the receiving end acknowledges.
1938
 
                        </para>
1939
 
                </listitem>
1940
 
        </varlistentry>
1941
 
        <varlistentry>
1942
 
                <term>
1943
 
                        <guilabel>Lookup</guilabel>
1944
 
                </term>
1945
 
                <listitem>
1946
 
                        <para>&konversation; is trying to get the IP number of the sender.
1947
 
                        </para>
1948
 
                </listitem>
1949
 
        </varlistentry>
1950
 
        <varlistentry>
1951
 
                <term>
1952
 
                        <guilabel>Resuming</guilabel>
1953
 
                </term>
1954
 
                <listitem>
1955
 
                        <para>When a transfer begins but the file already exists on the user's system, the user will be prompted <interface>File already exists.  Resume transfer?</interface> This status indicates the user resumed the transfer.
1956
 
                        </para>
1957
 
                </listitem>
1958
 
        </varlistentry>
1959
 
</variablelist>
1960
 
</para>
1961
 
 
1962
 
</callout>
1963
 
 
1964
 
<callout arearefs="pt-dccstatus-3">
1965
 
<para>When someone wants to send you a file, the <guilabel>DCC Status</guilabel> tab will be created (if not already created).  Click the <guilabel>DCC Status</guilabel> tab to display it.  Click the file to select it, then click this button to accept the file and the transfer will begin.  <emphasis>Note: </emphasis>You may configure &konversation; to automatically accept sends from other
1966
 
people by choosing
1967
 
<menuchoice>
1968
 
        <guisubmenu>Settings</guisubmenu>
1969
 
        <guisubmenu>Configure Konversation</guisubmenu>
1970
 
        <guisubmenu>DCC Settings</guisubmenu>
1971
 
</menuchoice> on the main menu.
1972
 
</para>
1973
 
</callout>
1974
 
 
1975
 
</calloutlist>
1976
 
</para>
1977
 
 
1978
 
<para>
1979
 
If you have trouble sending or receiving files, your firewall or router may be blocking DCC ports.
1980
 
See <link linkend="faq">Questions and Answers</link>.
1981
 
</para>
1982
 
 
1983
 
</sect1>
1984
 
 
1985
 
<!-- =================================================================== -->
1986
 
 
1987
 
<sect1 id="linkaddressbook">
1988
 
<title>Integrating with &kaddressbook;</title>
1989
 
 
1990
 
<para>You can associate any &nickname; with a contact in &kaddressbook;.
1991
 
Once you've done this, &konversation; will display the contact real name
1992
 
in parenthesis after the &nickname; in the <interface>Nick Panel</interface>.
1993
 
</para>
1994
 
 
1995
 
<para>
1996
 
To associate a &nickname; with a contact in &kaddressbook;,
1997
 
click with the &RMB; on the &nickname; of the person in the
1998
 
<interface>Nick Panel</interface> of the <link linkend="channel-screen-tour">Main</link> screen.  Choose
1999
 
<menuchoice>
2000
 
        <guisubmenu>Whois</guisubmenu>
2001
 
</menuchoice>
2002
 
to <action>display information to help you determine the user's real name</action>.
2003
 
Next, click with the &RMB; on the &nickname; of the person again and choose
2004
 
<menuchoice>
2005
 
        <guisubmenu>Addressbook associations</guisubmenu>
2006
 
</menuchoice>.
2007
 
  <action>A submenu appears</action>.  If the &nickname; is not already associated with a contact,
2008
 
choose
2009
 
<menuchoice>
2010
 
        <guisubmenu>Create new contact</guisubmenu>
2011
 
</menuchoice>.
2012
 
  <action>The <guilabel>Edit Contact</guilabel> screen appears</action>.
2013
 
</para>
2014
 
 
2015
 
<para>
2016
 
<screenshot>
2017
 
<screeninfo>The Edit Contact screen.</screeninfo>
2018
 
        <mediaobjectco>
2019
 
                <imageobjectco>
2020
 
                        <areaspec units="calspair">
2021
 
                                <area id="pt-kimproxy-create-1" coords="1 1"/>
2022
 
                                <area id="pt-kimproxy-create-2" coords="1 1"/>
2023
 
                                <area id="pt-kimproxy-create-3" coords="1 1"/>
2024
 
                        </areaspec>
2025
 
                        <imageobject>
2026
 
                                <imagedata fileref="kimproxy_create_screen_co.png" format="PNG"/>
2027
 
                        </imageobject>
2028
 
                </imageobjectco>
2029
 
                <textobject>
2030
 
                        <phrase>The Edit Contact screen.</phrase>
2031
 
                </textobject>
2032
 
        </mediaobjectco>
2033
 
</screenshot>
2034
 
</para>
2035
 
 
2036
 
<para>
2037
 
<calloutlist>
2038
 
 
2039
 
<callout arearefs="pt-kimproxy-create-1"><para>The &nickname; is automatically filled in here.
2040
 
If you know the person's real name, replace the &nickname; with the real name.
2041
 
</para></callout>
2042
 
 
2043
 
<callout arearefs="pt-kimproxy-create-2">
2044
 
<para>Notice that the &nickname; does <emphasis>not</emphasis> appear here.  Instead, ..</para>
2045
 
</callout>
2046
 
 
2047
 
<callout arearefs="pt-kimproxy-create-3">
2048
 
<para>Click here.  The <guilabel>IM Addresses</guilabel> window appears.</para></callout>
2049
 
 
2050
 
</calloutlist>
2051
 
</para>
2052
 
 
2053
 
<para>
2054
 
<screenshot>
2055
 
        <screeninfo>The IM Addresses Window.</screeninfo>
2056
 
        <mediaobject>
2057
 
                <imageobject>
2058
 
                        <imagedata fileref="kimproxy_create_screen2.png" format="PNG"/>
2059
 
                </imageobject>
2060
 
                <textobject>
2061
 
                        <phrase>The IM Addresses Window.</phrase>
2062
 
                </textobject>
2063
 
        </mediaobject>
2064
 
</screenshot>
2065
 
</para>
2066
 
 
2067
 
<para>Notice that &konversation; fills in the &nickname; for you with protocol
2068
 
<guilabel>IRC</guilabel>.
2069
 
</para>
2070
 
 
2071
 
<para>See the
2072
 
<ulink url="help:kaddressbook">&kaddressbook; Handbook</ulink> for additional instructions
2073
 
on using the &kde; address book.</para>
2074
 
 
2075
 
<para>Fill in any additional information about the &nickname; you know and click
2076
 
<guilabel>OK</guilabel>.  The real name of the person will appear inside
2077
 
parenthesis next to the &nickname; in the <guilabel>Nick Panel</guilabel>
2078
 
of &konversation;.  The real name also appears when the mouse hovers over
2079
 
the &nickname;.</para>
2080
 
 
2081
 
<para>Once a &nickname; has been associated with a contact in &kaddressbook;,
2082
 
you can click with the &RMB; on the &nickname; of the person in the
2083
 
<interface>Nick Panel</interface> and edit the associated contact, associate
2084
 
the &nickname; with a different contact, or delete the association.
2085
 
</para>
2086
 
 
2087
 
<para>If you have associated a &nickname; with a contact, and the user changes their &nickname; while you are running &konversation;,
2088
 
it will automatically associate the new &nickname; with the contact, keeping the
2089
 
original association as well.</para>
2090
 
 
2091
 
<para>If you associate an &irc; &nickname; with a contact in
2092
 
<ulink url="help:kopete">&kopete;</ulink>,
2093
 
the association will also appear in &konversation;, and vice versa.</para>
2094
 
 
2095
 
<para>Note: It is possible to highlight more than one &nickname; in the
2096
 
<interface>Nick Panel</interface>, click with the mouse &RMB;, and perform
2097
 
multiple associations.
2098
 
</para>
2099
 
 
2100
 
</sect1>
2101
 
 
2102
 
<!-- =================================================================== -->
2103
 
 
2104
 
<sect1 id="urlcatcher">
2105
 
<title>Capturing &URL;s from messages</title>
2106
 
 
2107
 
<para>In any <link linkend="channel-screen-tour">channel</link>, users sometimes post the &URL;s of interesting
2108
 
websites or other resources on the web.  You can double-click any such &URL; and &konversation; will launch
2109
 
the application associated with the &URL;.
2110
 
The application launched depends upon the &MIME; type of the &URL;.
2111
 
For example, a &URL; beginning with
2112
 
<interface>http:</interface> will activate your default &kde; web browser and display the web page.
2113
 
(You can also specify the <link linkend="webbrowser">web browser</link> to use.)
2114
 
If the &URL; scrolls off the screen, you might have trouble finding it
2115
 
again.  &konversation; can keep a convenient list of all &URL;s for you.  To activate this feature, choose
2116
 
<menuchoice>
2117
 
        <guisubmenu>Windows</guisubmenu>
2118
 
        <guisubmenu>&url; Catcher</guisubmenu>
2119
 
</menuchoice> on the main menu.
2120
 
<action>A new tab called <guilabel>&url; Catcher</guilabel> is created.</action>
2121
 
</para>
2122
 
 
2123
 
<para>
2124
 
<screenshot>
2125
 
<screeninfo>The &url; Catcher tab.</screeninfo>
2126
 
        <mediaobjectco>
2127
 
                <imageobjectco>
2128
 
                        <areaspec units="calspair">
2129
 
                                <area id="pt-urlcatcher-1" coords="1 1"/>
2130
 
                                <area id="pt-urlcatcher-2" coords="1 1"/>
2131
 
                                <area id="pt-urlcatcher-3" coords="1 1"/>
2132
 
                                <area id="pt-urlcatcher-4" coords="1 1"/>
2133
 
                                <area id="pt-urlcatcher-5" coords="1 1"/>
2134
 
                                <area id="pt-urlcatcher-6" coords="1 1"/>
2135
 
                        </areaspec>
2136
 
                        <imageobject>
2137
 
                                <imagedata fileref="urlcatcher_screen_co.png" format="PNG"/>
2138
 
                        </imageobject>
2139
 
                </imageobjectco>
2140
 
                <textobject>
2141
 
                        <phrase>The &url; Catcher tab.</phrase>
2142
 
                </textobject>
2143
 
        </mediaobjectco>
2144
 
</screenshot>
2145
 
</para>
2146
 
 
2147
 
<para>
2148
 
<calloutlist>
2149
 
 
2150
 
<callout arearefs="pt-urlcatcher-1"><para>This is the list of &URL;s seen since you started &konversation;.  The <guilabel>Nick</guilabel> column is the &nickname; of the person who posted the &URL;.  If the &nickname; is blank, the &url; appeared in a <interface>Server Messages</interface> tab.  (&URL;s appearing in join and leave messages
2151
 
are not listed.)  Click on a &URL; to select it.</para></callout>
2152
 
 
2153
 
<callout arearefs="pt-urlcatcher-2"><para>Click here to activate the application associated with the selected &URL;.
2154
 
The application launched depends upon the &MIME; type of the &URL;.  For example, a &URL; beginning with
2155
 
<interface>http:</interface> will activate your default web browser and display the web page.  For web pages, you can
2156
 
also specify the <link linkend="webbrowser">web browser</link> to use.</para></callout>
2157
 
 
2158
 
<callout arearefs="pt-urlcatcher-3"><para>Click here to copy the selected &URL; to the &kde; clipboard..</para></callout>
2159
 
 
2160
 
<callout arearefs="pt-urlcatcher-4"><para>Click here to delete the selected  &URL; from the list.</para></callout>
2161
 
 
2162
 
<callout arearefs="pt-urlcatcher-5"><para>Click here to save the list of &URL;s to a file.</para></callout>
2163
 
 
2164
 
<callout arearefs="pt-urlcatcher-6"><para>Click here to clear the list.</para></callout>
2165
 
 
2166
 
</calloutlist>
2167
 
</para>
2168
 
 
2169
 
</sect1>
2170
 
 
2171
 
<!-- =================================================================== -->
2172
 
 
2173
 
<sect1 id="webbrowser">
2174
 
<title>Setting your preferred web browser</title>
2175
 
 
2176
 
<para>When you click on a highlighted &URL; anywhere in &konversation;, it will launch the default
2177
 
&kde; application associated with the &MIME; type of the &URL;.  For example, when clicking on
2178
 
a &URL; beginning with <interface>http</interface>, &konqueror; is launched to display the
2179
 
web page.  You can specify an application different from the &kde; default.  For example, you can
2180
 
use Mozilla instead.
2181
 
</para>
2182
 
 
2183
 
<para>To choose a different web browser, choose
2184
 
<menuchoice>
2185
 
        <guisubmenu>Settings</guisubmenu>
2186
 
        <guisubmenu>Configure &konversation;</guisubmenu>
2187
 
</menuchoice>
2188
 
 on the main menu.  <action>The <guilabel>Edit Preferences</guilabel> screen will appear.</action>
2189
 
 </para>
2190
 
 
2191
 
 <para>
2192
 
<screenshot>
2193
 
<screeninfo>The Web Browser screen</screeninfo>
2194
 
        <mediaobjectco>
2195
 
                <imageobjectco>
2196
 
                        <areaspec units="calspair">
2197
 
                                <area id="pt-webbrowser-1" coords="1 1"/>
2198
 
                                <area id="pt-webbrowser-2" coords="1 1"/>
2199
 
                                <area id="pt-webbrowser-3" coords="1 1"/>
2200
 
                        </areaspec>
2201
 
                        <imageobject>
2202
 
                                <imagedata fileref="webbrowser_screen_co.png" format="PNG"/>
2203
 
                        </imageobject>
2204
 
                </imageobjectco>
2205
 
                <textobject>
2206
 
                        <phrase>The Web Browser screen</phrase>
2207
 
                </textobject>
2208
 
        </mediaobjectco>
2209
 
</screenshot>
2210
 
</para>
2211
 
 
2212
 
<para>
2213
 
<calloutlist>
2214
 
 
2215
 
<callout arearefs="pt-webbrowser-1"><para>Click here to display the <guilabel>Web Browser</guilabel> screen.</para></callout>
2216
 
 
2217
 
<callout arearefs="pt-webbrowser-2"><para>Click here to specify that you want to use a custom web browser.</para></callout>
2218
 
 
2219
 
<callout arearefs="pt-webbrowser-3"><para>Enter the command to launch your desired web browser.
2220
 
When you click on a &URL; <userinput><replaceable>%u</replaceable></userinput> will be replaced with the &URL;.</para></callout>
2221
 
 
2222
 
</calloutlist>
2223
 
</para>
2224
 
 
2225
 
<para><emphasis>Tip: </emphasis>(&UNIX; systems only) The default command is <userinput>mozilla '%u'</userinput>, which will
2226
 
start a new instance of Mozilla each time you click on a &URL;.  If you prefer that Mozilla display the web page
2227
 
in a new tab of an already-running instance, create a file containing the following:
2228
 
</para>
2229
 
 
2230
 
<para>
2231
 
<literallayout>
2232
 
#!/bin/sh
2233
 
mozilla -remote "openURL($@, new-tab)" || exec mozilla "$@";
2234
 
</literallayout>
2235
 
</para>
2236
 
 
2237
 
<para>Name the file <userinput><replaceable>moz</replaceable></userinput>, place it in the PATH, and
2238
 
make it executable (<userinput>chmod a+x moz</userinput>).  Then enter <userinput>
2239
 
<replaceable>moz '%u'</replaceable></userinput> for the web browser command in the screen above.
2240
 
</para>
2241
 
 
2242
 
<para><emphasis>Note: </emphasis>The <guilabel>Web Browser</guilabel> setting does not apply to
2243
 
<interface>mailto:</interface> &URL;s.  <interface>mailto:</interface> &URL;s always launch the default
2244
 
&kde; mailer.
2245
 
</para>
2246
 
 
2247
 
<para>Click <guibutton>Apply</guibutton> to save your changes.  You must reconnect to each server and
2248
 
channel for the changes to take effect.  The easiest way to do this is to quit and restart &konversation;.
2249
 
</para>
2250
 
 
2251
 
</sect1>
2252
 
 
2253
 
<!-- =================================================================== -->
2254
 
 
2255
 
<sect1 id="rememberlines">
2256
 
<title>Marking Channel and Query Logs</title>
2257
 
 
2258
 
<para>You can insert a marker into <link linkend="channel-screen-tour">channel</link>
2259
 
and <link linkend="query">query</link> screens
2260
 
to help you quickly locate information.  To do this, choose
2261
 
<menuchoice>
2262
 
        <guisubmenu>Insert</guisubmenu>
2263
 
        <guisubmenu>Remember Line</guisubmenu>
2264
 
</menuchoice>
2265
 
on the main menu, or press <keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo>.
2266
 
  <action>A line will appear at the bottom of the text on the screen.
2267
 
 The line will scroll with the rest of the text in the screen.</action>
2268
 
</para>
2269
 
 
2270
 
<para>To make the <interface>Remember Line</interface>
2271
 
be inserted in all channels and queries at once, choose
2272
 
<menuchoice>
2273
 
        <guisubmenu>Settings</guisubmenu>
2274
 
        <guisubmenu>Configure Konversation</guisubmenu>
2275
 
</menuchoice> from the main menu, expand <guilabel>Behavior</guilabel>,
2276
 
click on <guilabel>Chat Window</guilabel>, and check the
2277
 
<guilabel>Show remember line in all channels/queries</guilabel> box.
2278
 
</para>
2279
 
 
2280
 
<para>To make &konversation; automatically insert a
2281
 
<interface>Remember Line</interface> whenever you do an
2282
 
<userinput><command>/away</command> <replaceable>msg</replaceable></userinput>
2283
 
command, see <link linkend="identity-away">Setting your identity</link>.
2284
 
</para>
2285
 
 
2286
 
</sect1>
2287
 
 
2288
 
<!-- =================================================================== -->
2289
 
 
2290
 
<sect1 id="logging">
2291
 
<title>Logging</title>
2292
 
 
2293
 
<para>If logging is enabled, &konversation; keeps a log of each <interface>Server</interface>,
2294
 
<link linkend="channel-screen-tour">Channel</link>, and
2295
 
<link linkend="query">Private conversation (query)</link> session.
2296
 
Each session is stored in a log file on disk.
2297
 
When you open the same session again, &konversation; appends to the log.
2298
 
The log grows to a limit you can set (see below).  When the limit is reached, the oldest
2299
 
messages are discarded.
2300
 
</para>
2301
 
 
2302
 
<para>Whenever you open a session again, approximately the last 1024 characters
2303
 
of the previous session are read from the tail of the log and shown on the screen.
2304
 
</para>
2305
 
 
2306
 
<para>As your session continues, messages scroll off the top of the display.
2307
 
You can scroll backwards to view these messages.  Eventually, in order to conserve
2308
 
memory, the oldest messages are discarded from the scroll.  This is called
2309
 
the <guilabel>Scrollback limit</guilabel>.  Messages that disappear from the display
2310
 
because of the <guilabel>Scrollback limit</guilabel> are still available in the log
2311
 
file, if logging is enabled.</para>
2312
 
 
2313
 
<para>To view the logfile for a session, click the tab for the session to make it the
2314
 
current session and choose
2315
 
<menuchoice>
2316
 
        <guisubmenu>Window</guisubmenu>
2317
 
        <guisubmenu>Open Logfile</guisubmenu>
2318
 
</menuchoice> from the main menu.  <action>A new tab appears</action> displaying
2319
 
the log file.
2320
 
</para>
2321
 
 
2322
 
<para>
2323
 
<screenshot>
2324
 
<screeninfo>Logfile</screeninfo>
2325
 
        <mediaobjectco>
2326
 
                <imageobjectco>
2327
 
                        <areaspec units="calspair">
2328
 
                                <area id="pt-logviewer-1" coords="1 1"/>
2329
 
                                <area id="pt-logviewer-2" coords="1 1"/>
2330
 
                                <area id="pt-logviewer-3" coords="1 1"/>
2331
 
                                <area id="pt-logviewer-4" coords="1 1"/>
2332
 
                                <area id="pt-logviewer-5" coords="1 1"/>
2333
 
                        </areaspec>
2334
 
                        <imageobject>
2335
 
                                <imagedata fileref="logviewer_co.png" format="PNG"/>
2336
 
                        </imageobject>
2337
 
                </imageobjectco>
2338
 
                <textobject>
2339
 
                        <phrase>Logfile</phrase>
2340
 
                </textobject>
2341
 
        </mediaobjectco>
2342
 
</screenshot>
2343
 
</para>
2344
 
 
2345
 
<para>
2346
 
<calloutlist>
2347
 
<callout arearefs="pt-logviewer-1"><para>The messages in the log file are displayed here.
2348
 
The oldest messages are at the top and the most recent are at the bottom.</para></callout>
2349
 
<callout arearefs="pt-logviewer-2"><para>Click this button to save the log file to another file.</para></callout>
2350
 
<callout arearefs="pt-logviewer-3"><para>Click to refresh the log file display.
2351
 
While you are viewing a log file, newer messages in the corresponding
2352
 
session are <emphasis>not</emphasis> automatically added to the log file
2353
 
display.  Use this button to view the most recent messages.</para></callout>
2354
 
<callout arearefs="pt-logviewer-4"><para>Click to erase the log file display
2355
 
and the log file on disk.</para></callout>
2356
 
<callout arearefs="pt-logviewer-5"><para>Use this box to set the maximum size
2357
 
of the log file.  This setting does not take effect until you restart
2358
 
&konversation;.  Each log file may have a separate setting.</para></callout>
2359
 
</calloutlist>
2360
 
</para>
2361
 
 
2362
 
<para>The <guilabel>Scrollback limit</guilabel> can be changed by choosing
2363
 
<menuchoice>
2364
 
        <guisubmenu>Settings</guisubmenu>
2365
 
        <guisubmenu>Configure &konversation;</guisubmenu>
2366
 
</menuchoice> on the main menu, then expand <guilabel>Behavior</guilabel> and
2367
 
click on <guilabel>Chat Window</guilabel>.  The <guilabel>Scrollback limit</guilabel>
2368
 
box appears on this screen.  If you set it to <guilabel>Unlimited</guilabel>,
2369
 
messages are not discarded from the scroll.
2370
 
</para>
2371
 
 
2372
 
<para>You can enable or disable logging and set other logging options, by choosing
2373
 
<menuchoice>
2374
 
        <guisubmenu>Settings</guisubmenu>
2375
 
        <guisubmenu>Configure &konversation;</guisubmenu>
2376
 
</menuchoice> on the main menu, then expand <guilabel>Behavior</guilabel> and
2377
 
click on <guilabel>Logging</guilabel>.
2378
 
</para>
2379
 
 
2380
 
</sect1>
2381
 
 
2382
 
<!-- =================================================================== -->
2383
 
 
2384
 
<sect1 id="konvi-cmds">
2385
 
<title>&konversation; commands</title>
2386
 
 
2387
 
<para>The following commands are interpreted by &konversation; and may differ from standard
2388
 
&irc; commands.  Items inside square brackets are optional.  Items separated by bar (|) are
2389
 
alternate forms of the command.  Commands not listed here are sent to the server as entered.
2390
 
</para>
2391
 
 
2392
 
<para>
2393
 
<variablelist>
2394
 
 
2395
 
<varlistentry>
2396
 
<term><userinput><command>/me</command> <replaceable>msg</replaceable></userinput></term>
2397
 
<listitem><para>Sends <userinput><replaceable>msg</replaceable></userinput> to the channel preceded by your &nickname;.  For example, if
2398
 
your &nickname; were <userinput><replaceable>Tux</replaceable></userinput>, typing <userinput><replaceable>/me brews a cup a tea.</replaceable></userinput> displays the message <interface>Tux brews a cup of tea.</interface>  Unless they've filtered against these types of messages, all users see it.  This kind of message is typically used to convey non-verbal information, such as your current emotional state, or what you are physically doing.  If you are leaving your workstation for a short time, use the /away command instead.</para></listitem>
2399
 
</varlistentry>
2400
 
 
2401
 
<varlistentry>
2402
 
<term><userinput><command>/ame</command> <replaceable>msg</replaceable></userinput></term>
2403
 
<listitem><para>Like the <userinput><command>/me</command></userinput> command above except that
2404
 
the message is sent to all the channels and queries you have open on all the servers you have connected in &konversation;.</para></listitem>
2405
 
</varlistentry>
2406
 
 
2407
 
<varlistentry>
2408
 
<term><userinput><command>/join</command> <replaceable>channel</replaceable> <replaceable>[pwd]</replaceable></userinput></term>
2409
 
<listitem><para>Joins <userinput><replaceable>channel</replaceable></userinput>.  If the server permits it,
2410
 
and if the channel does not already exist, it is created and you are the channel operator.  If the channel requires a password in order to join, specify as <userinput><replaceable>pwd</replaceable></userinput>.  Most channel names begin with <userinput><replaceable>#</replaceable></userinput></para></listitem>
2411
 
</varlistentry>
2412
 
 
2413
 
<varlistentry>
2414
 
<term><userinput><command>/j</command> <replaceable>channel</replaceable> <replaceable>[pwd]</replaceable></userinput></term>
2415
 
<listitem><para>Same as <userinput><command>/join</command></userinput> above.</para></listitem>
2416
 
</varlistentry>
2417
 
 
2418
 
<varlistentry>
2419
 
<term><userinput><command>/part</command> <replaceable>[channel]</replaceable> <replaceable>[reason]</replaceable></userinput></term>
2420
 
<listitem><para>Leaves <userinput><replaceable>channel</replaceable></userinput> with <userinput><replaceable>reason</replaceable></userinput> and closes the corresponding <interface>channel</interface> tab.
2421
 
Within a &konversation; channel or query tab, you can just enter  <userinput><command>/part</command></userinput> which closes that channel or query with your default reason
2422
 
as given in the <link linkend="identity">Settings</link>.</para></listitem>
2423
 
</varlistentry>
2424
 
 
2425
 
<varlistentry><term><userinput><command>/leave</command> <replaceable>[channel]</replaceable> <replaceable>[reason]</replaceable></userinput></term>
2426
 
<listitem><para>Same as <userinput><command>/part</command></userinput> above.</para></listitem>
2427
 
</varlistentry>
2428
 
 
2429
 
<varlistentry><term><userinput><command>/quit</command></userinput></term>
2430
 
<listitem><para>When entered in any channel, query, or DCC tab, disconnects from the corresponding server
2431
 
and closes all channel, query, or DCC tabs open on that server.</para></listitem>
2432
 
</varlistentry>
2433
 
 
2434
 
<varlistentry><term><userinput><command>/notice</command> <replaceable>nick|channel</replaceable> <replaceable>msg</replaceable></userinput></term>
2435
 
<listitem><para>Sends <userinput><replaceable>msg</replaceable></userinput> to the user with &nickname; <userinput><replaceable>nick</replaceable></userinput> or to everyone in <userinput><replaceable>channel</replaceable></userinput>.  The following is an example
2436
 
of what appears to you in the channel tab</para>
2437
 
 
2438
 
<para><computeroutput>[17:14] [Notice] Sending notice "I think I understand" to #konversation</computeroutput></para>
2439
 
 
2440
 
<para>And this is what the recipients see</para>
2441
 
 
2442
 
<para><computeroutput>[17:15] [Notice] -Eisfuchs- I think I understand</computeroutput></para>
2443
 
 
2444
 
</listitem></varlistentry>
2445
 
 
2446
 
<varlistentry>
2447
 
<term><userinput><command>/query </command><replaceable>nick</replaceable></userinput></term>
2448
 
<listitem><para>Creates a new tab with the user's <userinput><replaceable>nick</replaceable></userinput> for private conversation, commonly known on &irc; as a <link linkend="query">Query</link>. Everything written here is only visible to you and your query partner.  You may enter more than one &nickname; separated by spaces and a query tab will be opened for each &nickname;.  Each such query tab will be private between you and the query partner.</para></listitem>
2449
 
</varlistentry>
2450
 
 
2451
 
<varlistentry>
2452
 
<term><userinput><command>/msg </command><replaceable>nick|channel</replaceable></userinput>
2453
 
 <userinput><replaceable>message</replaceable></userinput></term>
2454
 
<listitem><para>Sends a private message to the user with &nickname; <userinput><replaceable>nick</replaceable></userinput> or to all users in <userinput><replaceable>channel</replaceable></userinput>.  Unlike <userinput><command>/query</command></userinput>,
2455
 
does not open a new tab.  If <userinput><replaceable>message</replaceable></userinput> begins with <userinput><command>/me </command></userinput>, the message is formatted in the same manner as a
2456
 
<userinput><command>/me</command></userinput> command.</para>
2457
 
 
2458
 
<para>Examples</para>
2459
 
 
2460
 
<para><userinput><replaceable>/msg Eisfuchs I need some help with the msg command</replaceable></userinput></para>
2461
 
 
2462
 
<para><userinput><replaceable>/msg #konversation New version of Konvi is online!</replaceable></userinput></para>
2463
 
 
2464
 
<para><userinput><replaceable>/msg Eisfuchs /me is compiling the Handbook right now.</replaceable></userinput></para>
2465
 
 
2466
 
</listitem>
2467
 
</varlistentry>
2468
 
 
2469
 
<varlistentry>
2470
 
<term><userinput><command>/smsg </command><replaceable>nick|channel</replaceable></userinput>
2471
 
<userinput><replaceable>message</replaceable></userinput></term>
2472
 
<listitem><para>Same as <userinput><command>/msg</command></userinput> except the message is not
2473
 
displayed on your screen.  This is useful for preventing passwords and other sensitive information from remaining exposed on your screen or being logged.</para>
2474
 
</listitem></varlistentry>
2475
 
 
2476
 
<varlistentry>
2477
 
<term><userinput><command>/amsg </command><replaceable>nick|channel</replaceable></userinput>
2478
 
 <userinput><replaceable>message</replaceable></userinput></term>
2479
 
<listitem><para>Like the <userinput><command>/msg</command></userinput> command above except that
2480
 
the message is sent to all the channels and queries you have open on all the servers you have connected in &konversation;.</para></listitem>
2481
 
</varlistentry>
2482
 
 
2483
 
<varlistentry>
2484
 
<term><userinput><command>/op </command> <replaceable>nick</replaceable></userinput></term>
2485
 
<listitem><para>When entered into a channel tab, attempts to give
2486
 
 <userinput><replaceable>nick</replaceable></userinput> operator privilege for the
2487
 
channel.  May not work if you lack sufficient privilege in the channel (you must be a
2488
 
channel operator yourself).  You may enter more than one &nickname; separated by spaces.</para>
2489
 
</listitem></varlistentry>
2490
 
 
2491
 
<varlistentry>
2492
 
<term><userinput><command>/deop </command><replaceable>nick</replaceable></userinput></term>
2493
 
<listitem><para>When entered into a channel tab, takes away channel operator privilege from
2494
 
<userinput><replaceable>nick</replaceable></userinput>.  You may enter more than one &nickname; separated by spaces.</para>
2495
 
</listitem></varlistentry>
2496
 
 
2497
 
<varlistentry>
2498
 
<term><userinput><command>/oper </command><replaceable>[nick]</replaceable></userinput></term>
2499
 
<listitem><para>Grants the user with &nickname; <userinput><replaceable>nick</replaceable></userinput> &irc;-Op (Administrator) privilege.  This only works if the &nickname; is listed in the server's O: line.  &irc;-Ops
2500
 
have the privilege to <userinput><command>/kill</command></userinput> &nickname;s,
2501
 
<userinput><command>/connect</command></userinput> servers to the &irc; network, and more.
2502
 
If <userinput><replaceable>nick</replaceable></userinput> is not entered,
2503
 
attempts to grant yourself &irc;-Op privilege.  You will be prompted for your &irc;-Op user name and password in either case.</para>
2504
 
</listitem></varlistentry>
2505
 
 
2506
 
<varlistentry>
2507
 
<term><userinput><command>/voice </command> <replaceable>nick</replaceable></userinput></term>
2508
 
<listitem><para>In certain channels (with +m flag), users cannot send messages unless they have voice privilege.
2509
 
This command attempts to give <userinput><replaceable>nick</replaceable></userinput> voice privilege.
2510
 
You must have channel operator privilege to execute this command.  This command is mostly used
2511
 
when you are an operator for a moderated channel.</para>
2512
 
</listitem></varlistentry>
2513
 
 
2514
 
<varlistentry>
2515
 
<term><userinput><command>/unvoice </command> <replaceable>nick</replaceable></userinput></term>
2516
 
<listitem><para>Takes away voice privilege from <userinput><replaceable>nick</replaceable></userinput> in the channel.</para>
2517
 
</listitem></varlistentry>
2518
 
 
2519
 
<varlistentry>
2520
 
<term><userinput><command>/topic </command><replaceable>[channel]</replaceable> <replaceable>[message]</replaceable></userinput></term>
2521
 
<listitem><para>Attempts to set the topic of <userinput><replaceable>channel</replaceable></userinput> to
2522
 
<userinput><replaceable>message</replaceable></userinput>.  When entered in a channel tab,  <userinput><replaceable>channel</replaceable></userinput> may be omitted and defaults to the channel active in the tab.  If <userinput><replaceable>message</replaceable></userinput> is omitted, displays the current
2523
 
topic of the channel.  Changing a channel topic may fail if you lack sufficient privilege.</para>
2524
 
</listitem></varlistentry>
2525
 
 
2526
 
<varlistentry>
2527
 
<term><userinput><command>/away </command> <replaceable>reason</replaceable></userinput></term>
2528
 
<listitem><para>If anyone tries to send you a private message or invite you to a channel, they will be told that you are
2529
 
away from your workstation for <userinput><replaceable>reason</replaceable></userinput>.  To change your state back to normal, enter <userinput><command>/away</command></userinput> without a reason.</para></listitem>
2530
 
</varlistentry>
2531
 
 
2532
 
<varlistentry>
2533
 
<term><userinput><command>/aaway </command> <replaceable>reason</replaceable></userinput></term>
2534
 
<listitem><para>Like the <userinput><command>/away</command></userinput> command above except that
2535
 
the command is sent to all the servers you have connected in &konversation;.</para></listitem>
2536
 
</varlistentry>
2537
 
 
2538
 
<varlistentry>
2539
 
<term><userinput><command>/invite </command><replaceable>nick</replaceable> <replaceable>[channel]</replaceable></userinput></term>
2540
 
<listitem><para>Invites the user with &nickname; <userinput><replaceable>nick</replaceable></userinput> to join <userinput><replaceable>channel</replaceable></userinput>.  This command is especially useful if the channel is invite-only.  When entered in a channel tab, <userinput><replaceable>channel</replaceable></userinput> may be omitted.</para></listitem>
2541
 
</varlistentry>
2542
 
 
2543
 
<varlistentry>
2544
 
<term><userinput><command>/exec </command><replaceable>script</replaceable> <replaceable>[parameters]</replaceable></userinput></term>
2545
 
<listitem><para>Executes the &konversation;-compatible shell script named
2546
 
<userinput><replaceable>script</replaceable></userinput>, passing it
2547
 
<userinput><replaceable>parameters</replaceable></userinput>.  See
2548
 
<link linkend="scripting">Scripting</link> for more information on using and writing
2549
 
scripts.</para>
2550
 
<para>Examples:</para>
2551
 
 
2552
 
<para><userinput><replaceable>/exec kdeversion</replaceable></userinput></para>
2553
 
 
2554
 
<para>Sends your system's &kde; and &Qt; version numbers to the channel.</para>
2555
 
 
2556
 
<para><userinput><replaceable>/exec cmd uname -a</replaceable></userinput></para>
2557
 
 
2558
 
<para>Sends your &Linux; version string to the channel.</para>
2559
 
 
2560
 
</listitem>
2561
 
</varlistentry>
2562
 
 
2563
 
<varlistentry>
2564
 
<term><userinput><command>/notify </command><replaceable>[nick]</replaceable></userinput></term>
2565
 
<listitem><para>Adds or removes <userinput><replaceable>nick</replaceable></userinput> from
2566
 
your <link linkend="nicksonline">Watched Nicks Online</link> list.  If the &nickname; is already
2567
 
in the list, it is removed.  If it is not in the list, it is added.  If <userinput><replaceable>nick</replaceable></userinput> is omitted, displays the current list
2568
 
of watched &nickname;s.</para>
2569
 
</listitem>
2570
 
</varlistentry>
2571
 
 
2572
 
<varlistentry>
2573
 
<term><userinput><command>/prefs </command>[<command>list</command>|<replaceable>group</replaceable>]  [<command>list</command>|<replaceable>option</replaceable>]  [<replaceable>value</replaceable>]</userinput></term>
2574
 
<listitem><para>Displays or sets &konversation; settings without using the Settings screen.
2575
 
If a parameter contains spaces, surround it with quotes.</para>
2576
 
 
2577
 
<para>Examples:</para>
2578
 
 
2579
 
<para><userinput><replaceable>/prefs list</replaceable></userinput></para>
2580
 
 
2581
 
<para>lists the available option groups.</para>
2582
 
 
2583
 
<para><userinput><replaceable>/prefs "General Options" list</replaceable></userinput></para>
2584
 
 
2585
 
<para>lists the options available in group <userinput><replaceable>General Options</replaceable></userinput> along with their current values</para>
2586
 
 
2587
 
<para><userinput><replaceable>/prefs "General Options" ShowTrayIcon</replaceable></userinput></para>
2588
 
 
2589
 
<para>Displays the current value of the setting for displaying the &konversation; icon in the system tray.</para>
2590
 
 
2591
 
<para><userinput><replaceable>/prefs "General Options" ShowTrayIcon false</replaceable></userinput></para>
2592
 
 
2593
 
<para>Turns off the &konversation; icon in the system tray.</para>
2594
 
 
2595
 
</listitem></varlistentry>
2596
 
 
2597
 
<varlistentry>
2598
 
<term><userinput><command>/kick </command><replaceable>nick</replaceable> <replaceable>reason</replaceable></userinput></term>
2599
 
<listitem><para>When entered in a channel tab, attempts to kick the user with &nickname;
2600
 
<userinput><replaceable>nick</replaceable></userinput> from the channel with
2601
 
<userinput><replaceable>reason</replaceable></userinput>.  If <userinput><replaceable>reason</replaceable></userinput> is not entered, defaults to the
2602
 
reason in the <link linkend="identity">Settings</link>.  This command may only be used in
2603
 
a channel tab.</para>
2604
 
</listitem></varlistentry>
2605
 
 
2606
 
<varlistentry>
2607
 
<term><userinput><command>/ban </command> [<command>-host</command>|<command>-domain</command>|
2608
 
<command>-userhost</command>|<command>-userdomain</command>] <replaceable>[channel]</replaceable> <replaceable>user</replaceable>|<replaceable>mask</replaceable></userinput></term>
2609
 
<listitem><para>Attempts to ban the <userinput><replaceable>user</replaceable></userinput> or <userinput><replaceable>mask</replaceable></userinput> from <userinput><replaceable>channel</replaceable></userinput>.  When entered in a channel tab,
2610
 
<userinput><replaceable>channel</replaceable></userinput> may be omitted.  For more information
2611
 
on hosts, domains, and masks, see the documents at <ulink url="http://www.irchelp.org/">irchelp.org</ulink>.
2612
 
Too get the current ban list for a channel, enter
2613
 
<userinput><command>/mode </command><replaceable>channel</replaceable> <command>b</command></userinput>.
2614
 
</para></listitem>
2615
 
</varlistentry>
2616
 
 
2617
 
<varlistentry>
2618
 
<term><userinput><command>/unban </command> <replaceable>[channel]</replaceable> <replaceable>pattern</replaceable></userinput></term>
2619
 
<listitem><para>Reverts a previous banning from a channel.  When entered in a channel tab,
2620
 
<userinput><replaceable>channel</replaceable></userinput> may be omitted.
2621
 
</para></listitem>
2622
 
</varlistentry>
2623
 
 
2624
 
<varlistentry>
2625
 
<term><userinput><command>/ignore </command> [<command>-all</command>] <replaceable>nick</replaceable> </userinput></term>
2626
 
<listitem><para>Adds <userinput><replaceable>nick</replaceable></userinput> to your Ignore list.
2627
 
You may specify more than one &nickname; separated by spaces.  Channel messages from users on your Ignore
2628
 
list are not displayed.  In addition, if you enter <userinput><command>-all</command></userinput>, all message types
2629
 
(queries, notices, &CTCP;, DCC, and Exceptions) from the user are ignored as well as channel messages.
2630
 
</para></listitem>
2631
 
</varlistentry>
2632
 
 
2633
 
<varlistentry>
2634
 
<term><userinput><command>/quote </command> <replaceable>cmd</replaceable></userinput></term>
2635
 
<listitem><para>Sends <userinput><replaceable>cmd</replaceable></userinput> to the server.
2636
 
</para></listitem>
2637
 
</varlistentry>
2638
 
 
2639
 
<varlistentry>
2640
 
<term><userinput><command>/say </command> <replaceable>msg</replaceable></userinput></term>
2641
 
<listitem><para>When entered in a channel tab, sends <userinput><replaceable>msg</replaceable></userinput> to the channel.  This is the same as entering <userinput><replaceable>msg</replaceable></userinput>
2642
 
in the channel <interface>Input Line</interface>.  Useful for sending &irc; commands when you don't want
2643
 
to execute the command.  Two command characters (//) in a row does the same thing as
2644
 
<userinput><command>/say</command></userinput>.  Also used by <link linkend="scripting">scripts</link> to send messages.
2645
 
</para></listitem>
2646
 
</varlistentry>
2647
 
 
2648
 
<varlistentry>
2649
 
<term><userinput><command>/raw </command> [<command>open</command>|<command>close</command>]</userinput></term>
2650
 
<listitem><para>Places the server log in raw mode (<command>open</command>) or stops raw mode (<command>close</command>).  If neither <command>open</command> or <command>close</command> is entered, defaults to <command>open</command>.  In raw mode, the log displays every message received from the server in native &irc; format.
2651
 
</para></listitem>
2652
 
</varlistentry>
2653
 
 
2654
 
<varlistentry>
2655
 
<term><userinput><command>/konsole </command></userinput></term>
2656
 
<listitem><para>Opens a new tab running a &kde; &konsole;.
2657
 
</para></listitem>
2658
 
</varlistentry>
2659
 
 
2660
 
<varlistentry>
2661
 
<term><userinput><command>/server </command> <replaceable>[url]</replaceable> <replaceable>[pwd]</replaceable></userinput></term>
2662
 
<listitem><para>Connects to the server at address <userinput><replaceable>url</replaceable></userinput>.  If
2663
 
<userinput><replaceable>url</replaceable></userinput> is omitted, connects to the server associated
2664
 
with the tab where you enter the command.  This is useful for re-connecting to a server when
2665
 
disconnected.  If the server
2666
 
requires a password in order to connect to it, enter it for <userinput><replaceable>pwd</replaceable></userinput>.  If
2667
 
the server requires a port number other than the default (6667), enter the <userinput><replaceable>url</replaceable></userinput> like this: <replaceable>irc.kde.org:6665</replaceable>.
2668
 
</para></listitem>
2669
 
</varlistentry>
2670
 
 
2671
 
<varlistentry>
2672
 
<term><userinput><command>/dcc </command> <command>SEND </command><replaceable>nick</replaceable>
2673
 
<replaceable>[filename]</replaceable></userinput></term>
2674
 
<listitem><para>Sends <userinput><replaceable>filename</replaceable></userinput> to the user with
2675
 
&nickname; <userinput><replaceable>nick</replaceable></userinput>.
2676
 
If <userinput><replaceable>filename</replaceable></userinput> is omitted, a dialog appears for you to select
2677
 
a file.
2678
 
</para></listitem>
2679
 
</varlistentry>
2680
 
 
2681
 
<varlistentry>
2682
 
<term><userinput><command>/dcc </command></userinput></term>
2683
 
<listitem><para>Opens a DCC Status tab.
2684
 
</para></listitem>
2685
 
</varlistentry>
2686
 
 
2687
 
<varlistentry>
2688
 
<term><userinput><command>/ctcp </command><replaceable>nick|channel</replaceable> <command>ping</command></userinput></term>
2689
 
<listitem><para>Sends a PING message to <userinput><replaceable>nick</replaceable></userinput>
2690
 
or <userinput><replaceable>channel</replaceable></userinput>.  This is useful for
2691
 
determining if someone you are talking with has a high network lag, or (when sent to
2692
 
a channel) if your system has a high lag.
2693
 
</para></listitem>
2694
 
</varlistentry>
2695
 
 
2696
 
<varlistentry>
2697
 
<term><userinput><command>/ctcp </command><replaceable>nick|channel</replaceable> <replaceable>msg</replaceable></userinput></term>
2698
 
<listitem><para>Sends a message to <userinput><replaceable>nick</replaceable></userinput>
2699
 
or all users in <userinput><replaceable>channel</replaceable></userinput>.  This
2700
 
is similar to the <userinput><command>/msg</command></userinput> command above, except that
2701
 
the message is sent using the &CTCP; protocol.  The response on the other end
2702
 
depends on the &irc; client program the user is running.  For example, when
2703
 
conversing with another &konversation; user,
2704
 
<userinput><replaceable>/ctcp Eisfuchs TIME</replaceable></userinput> will return
2705
 
the system time on Eisfuch's computer.  <userinput><replaceable>/ctcp Eisfuchs VERSION</replaceable></userinput> will return the &konversation; version number
2706
 
from Eisfuch's computer.
2707
 
</para></listitem>
2708
 
</varlistentry>
2709
 
 
2710
 
</variablelist>
2711
 
</para>
2712
 
 
2713
 
</sect1>
2714
 
 
2715
 
<!-- =================================================================== -->
2716
 
 
2717
 
<sect1 id="scripting">
2718
 
<title>Scripting</title>
2719
 
 
2720
 
<para>&konversation; comes with some handy scripts you can run from the program.  To
2721
 
run a script, in a channel, query, DCC, or server tab, type a command of the form</para>
2722
 
 
2723
 
<para><userinput><command>/exec </command> <replaceable>script</replaceable>
2724
 
 [<replaceable>parameters</replaceable>]</userinput></para>
2725
 
 
2726
 
<para>which executes the script named <userinput><replaceable>script</replaceable></userinput>
2727
 
passing it (optional) <userinput><replaceable>parameters</replaceable></userinput>.</para>
2728
 
 
2729
 
<para>For example, type the following command in a channel tab</para>
2730
 
 
2731
 
<para><userinput><replaceable>/exec kdeversion</replaceable></userinput></para>
2732
 
 
2733
 
<para>to send your &kde; and &Qt; version numbers to the channel.</para>
2734
 
 
2735
 
<para><userinput><replaceable>/exec cmd uname -a</replaceable></userinput></para>
2736
 
 
2737
 
<para>executes the <userinput><replaceable>cmd</replaceable></userinput> script,
2738
 
passing it <userinput><replaceable>uname -a</replaceable></userinput>.  This sends your
2739
 
&Linux; version string to the channel.</para>
2740
 
 
2741
 
<para>To get a list of all available scripts, type the following command in a
2742
 
&konsole; screen.</para>
2743
 
 
2744
 
<para><userinput><replaceable>ls $KDEDIR/share/apps/konversation/scripts</replaceable></userinput></para>
2745
 
 
2746
 
<para>You can write your own scripts.  Scripts are shell scripts and can be written in
2747
 
any shell language, such as bash, perl, or python.  When &konversation; runs a script, the
2748
 
first three parameters sent to the script are:</para>
2749
 
 
2750
 
<itemizedlist>
2751
 
 
2752
 
<listitem><para>The port number for the &irc; server of the tab where the
2753
 
<userinput><command>/exec</command></userinput> command was entered.</para>
2754
 
</listitem>
2755
 
 
2756
 
<listitem><para>The address of the server.</para></listitem>
2757
 
 
2758
 
<listitem><para>The channel name.</para></listitem>
2759
 
 
2760
 
</itemizedlist>
2761
 
 
2762
 
<para>Here is a sample shell script (cmd).</para>
2763
 
 
2764
 
<para>
2765
 
<programlisting>
2766
 
#!/bin/sh
2767
 
 
2768
 
# Executes a command and prints the output into Konversation.
2769
 
 
2770
 
PORT=$1;
2771
 
SERVER=$2;
2772
 
TARGET=$3;
2773
 
shift;shift;shift;
2774
 
 
2775
 
$@ | while read line; do dcop $PORT Konversation say $SERVER "$TARGET" "$@: $line"; done
2776
 
</programlisting>
2777
 
</para>
2778
 
 
2779
 
<para>Notice that the script uses &DCOP; to communicate with &konversation;.  The <computeroutput>say</computeroutput> command causes
2780
 
the output to be sent to the channel as a normal message.  To display something
2781
 
in the tab without sending it to other users, use <computeroutput>info</computeroutput>
2782
 
instead.  Look at the existing script files for more examples of writing scripts.</para>
2783
 
 
2784
 
<para>To be able to run a script you have written, you must install it by copying
2785
 
it to $KDEDIR/share/apps/konversation/scripts or to $HOME/.kde/share/apps/konversation/scripts.  You must also give the file execute
2786
 
privilege, for example <userinput><replaceable>chmod a+x myscript</replaceable></userinput>.</para>
2787
 
 
2788
 
</sect1>
2789
 
 
2790
 
</chapter>
2791
 
 
2792
 
<!-- =================================================================== -->
2793
 
 
2794
 
<chapter id="commands">
2795
 
<title>Command Reference</title>
2796
 
 
2797
 
<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the
2798
 
application windows and their menubar and toolbar commands for easy reference.
2799
 
Also include any keys that have a special function but have no equivalent in the
2800
 
menus or toolbars. This may not be necessary for small apps or apps with no tool
2801
 
or menu bars. -->
2802
 
 
2803
 
<!-- =================================================================== -->
2804
 
 
2805
 
<sect1 id="kapp-mainwindow">
2806
 
<title>The main &konversation; window</title>
2807
 
 
2808
 
<sect2>
2809
 
<title>The File Menu</title>
2810
 
<para>
2811
 
<variablelist>
2812
 
        <varlistentry>
2813
 
                <term><menuchoice>
2814
 
                                <shortcut>
2815
 
                                        <keycap>F2</keycap>
2816
 
                                </shortcut>
2817
 
                        <guimenu>File</guimenu>
2818
 
                        <guimenuitem>Server List</guimenuitem>
2819
 
                </menuchoice></term>
2820
 
                <listitem><para><action>Displays the <link linkend="irc-basics">list of servers and channels</link>.
2821
 
                </action></para></listitem>
2822
 
        </varlistentry>
2823
 
        <varlistentry>
2824
 
                <term><menuchoice>
2825
 
                                <shortcut>
2826
 
                                        <keycap>F7</keycap>
2827
 
                                </shortcut>
2828
 
                        <guimenu>File</guimenu>
2829
 
                        <guimenuitem>Quick Connect</guimenuitem>
2830
 
                </menuchoice></term>
2831
 
                <listitem><para><action>Displays the <link linkend="quickconnect">Quick Connect</link> screen for connecting to a server.
2832
 
                </action></para></listitem>
2833
 
        </varlistentry>
2834
 
        <varlistentry>
2835
 
                <term><menuchoice>
2836
 
                        <guimenu>File</guimenu>
2837
 
                        <guimenuitem>Reconnect</guimenuitem>
2838
 
                </menuchoice></term>
2839
 
                <listitem><para><action>Reconnects to all servers that were disconnected
2840
 
        by a network error or other problem.
2841
 
                </action></para></listitem>
2842
 
        </varlistentry>
2843
 
        <varlistentry>
2844
 
                <term><menuchoice>
2845
 
                        <shortcut>
2846
 
                                <keycombo action="simul">&Ctrl;<keycap>J</keycap></keycombo>
2847
 
                        </shortcut>
2848
 
                        <guimenu>File</guimenu>
2849
 
                        <guimenuitem>Join Channel</guimenuitem>
2850
 
                </menuchoice></term>
2851
 
                <listitem><para><action>Displays a dialog for you to enter the name
2852
 
        of a channel to join.  Does the same thing as entering
2853
 
        <command>/join <userinput>#channelname</userinput></command> in a channel
2854
 
        or server tab.</action></para></listitem>
2855
 
        </varlistentry>
2856
 
        <varlistentry>
2857
 
                <term><menuchoice>
2858
 
                        <shortcut>
2859
 
                                <keycombo action="simul">&Alt; &Ctrl;<keycap>Q</keycap></keycombo>
2860
 
                        </shortcut>
2861
 
                        <guimenu>File</guimenu>
2862
 
                        <guimenuitem>Set Away Globally</guimenuitem>
2863
 
                </menuchoice></term>
2864
 
                <listitem><para><action>Changes your &nickname; status to away in all channels.
2865
 
                </action></para></listitem>
2866
 
        </varlistentry>
2867
 
        <varlistentry>
2868
 
                <term><menuchoice>
2869
 
                        <shortcut>
2870
 
                                <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
2871
 
                        </shortcut>
2872
 
                        <guimenu>File</guimenu>
2873
 
                        <guimenuitem>Quit</guimenuitem>
2874
 
                </menuchoice></term>
2875
 
                <listitem><para><action>Quits</action> &konversation;</para></listitem>
2876
 
        </varlistentry>
2877
 
</variablelist>
2878
 
</para>
2879
 
</sect2>
2880
 
 
2881
 
<sect2>
2882
 
<title>The <guimenu>Edit</guimenu> Menu</title>
2883
 
<para>
2884
 
<variablelist>
2885
 
        <varlistentry>
2886
 
                <term><menuchoice>
2887
 
                                <shortcut>
2888
 
                                        <keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo>
2889
 
                                </shortcut>
2890
 
                                <guimenu>Edit</guimenu>
2891
 
                                <guimenuitem>Find</guimenuitem>
2892
 
                        </menuchoice></term>
2893
 
                <listitem><para>
2894
 
                                <action>Searches for text strings in the current screen.</action>
2895
 
                        </para></listitem>
2896
 
        </varlistentry>
2897
 
        <varlistentry>
2898
 
                <term><menuchoice>
2899
 
                                <shortcut>
2900
 
                                        <keycap>F3</keycap>
2901
 
                                </shortcut>
2902
 
                                <guimenu>Edit</guimenu>
2903
 
                                <guimenuitem>Find Next</guimenuitem>
2904
 
                        </menuchoice></term>
2905
 
                <listitem><para>
2906
 
                                <action>Searches again for text strings in the current screen
2907
 
                                using the previous search string.</action>
2908
 
                        </para></listitem>
2909
 
        </varlistentry>
2910
 
        <varlistentry>
2911
 
                <term><menuchoice>
2912
 
                                <shortcut>
2913
 
                                        <keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo>
2914
 
                                </shortcut>
2915
 
                                <guimenu>Edit</guimenu>
2916
 
                                <guimenuitem>Clear Window</guimenuitem>
2917
 
                        </menuchoice></term>
2918
 
                <listitem><para>
2919
 
                                <action>Clears the current screen.</action>
2920
 
                        </para></listitem>
2921
 
        </varlistentry>
2922
 
        <varlistentry>
2923
 
                <term><menuchoice>
2924
 
                                <shortcut>
2925
 
                                        <keycombo action="simul">&Ctrl; &Shift;<keycap>L</keycap></keycombo>
2926
 
                                </shortcut>
2927
 
                                <guimenu>Edit</guimenu>
2928
 
                                <guimenuitem>Clear All Windows</guimenuitem>
2929
 
                        </menuchoice></term>
2930
 
                <listitem><para>
2931
 
                                <action>Clears all screens.</action>
2932
 
                        </para></listitem>
2933
 
        </varlistentry>
2934
 
</variablelist>
2935
 
</para>
2936
 
</sect2>
2937
 
 
2938
 
<sect2>
2939
 
<title>The <guimenu>Insert</guimenu> Menu</title>
2940
 
<para>
2941
 
<variablelist>
2942
 
        <varlistentry>
2943
 
                <term><menuchoice>
2944
 
                        <shortcut>
2945
 
                                <keycombo action="simul">&Ctrl;<keycap>K</keycap></keycombo>
2946
 
                        </shortcut>
2947
 
                        <guimenu>Insert</guimenu>
2948
 
                        <guimenuitem>&irc; Color</guimenuitem>
2949
 
                </menuchoice></term>
2950
 
                <listitem><para>
2951
 
                        <action>See <link linkend="color-msgs">Sending colorful messages</link>.</action>
2952
 
                </para></listitem>
2953
 
        </varlistentry>
2954
 
        <varlistentry>
2955
 
                <term><menuchoice>
2956
 
                                <shortcut>
2957
 
                                        <keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo>
2958
 
                                </shortcut>
2959
 
                                <guimenu>Insert</guimenu>
2960
 
                                <guimenuitem>Remember Line</guimenuitem>
2961
 
                        </menuchoice></term>
2962
 
                <listitem><para>
2963
 
                                <action>See <link linkend="rememberlines">Marking Channel and Query Logs</link>.</action>
2964
 
                        </para></listitem>
2965
 
        </varlistentry>
2966
 
        <varlistentry>
2967
 
                <term><menuchoice>
2968
 
                                <shortcut>
2969
 
                                        <keycombo action="simul">&Alt; &Shift;<keycap>C</keycap></keycombo>
2970
 
                                </shortcut>
2971
 
                        <guimenu>Insert</guimenu>
2972
 
                        <guimenuitem>Special Character</guimenuitem>
2973
 
                        </menuchoice></term>
2974
 
                <listitem><para>
2975
 
                                <action>Used to enter special characters, such as foreign
2976
 
                                characters.</action>
2977
 
                        </para></listitem>
2978
 
        </varlistentry>
2979
 
</variablelist>
2980
 
</para>
2981
 
</sect2>
2982
 
 
2983
 
<sect2>
2984
 
<title>The <guimenu>Bookmarks</guimenu> Menu</title>
2985
 
<para>
2986
 
<variablelist>
2987
 
        <varlistentry>
2988
 
                <term><menuchoice>
2989
 
                        <shortcut>
2990
 
                                <keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo>
2991
 
                        </shortcut>
2992
 
                        <guimenu>Bookmarks</guimenu>
2993
 
                        <guimenuitem>Add Bookmark</guimenuitem>
2994
 
                </menuchoice></term>
2995
 
                <listitem><para>
2996
 
                    <action>Bookmarks current network &amp; channel</action>
2997
 
                </para></listitem>
2998
 
        </varlistentry>
2999
 
        <varlistentry>
3000
 
                <term><menuchoice>
3001
 
                                <guimenu>Bookmarks</guimenu>
3002
 
                                <guimenuitem>Edit Bookmarks</guimenuitem>
3003
 
                        </menuchoice></term>
3004
 
                <listitem><para>
3005
 
                                <action>Opens bookmark editor</action>
3006
 
                        </para></listitem>
3007
 
        </varlistentry>
3008
 
        <varlistentry>
3009
 
                <term><menuchoice>
3010
 
                        <guimenu>Bookmarks</guimenu>
3011
 
                        <guimenuitem>New Bookmark Folder</guimenuitem>
3012
 
                        </menuchoice></term>
3013
 
                <listitem><para>
3014
 
                                <action>Creates a new bookmark folder</action>
3015
 
                        </para></listitem>
3016
 
        </varlistentry>
3017
 
</variablelist>
3018
 
</para>
3019
 
</sect2>
3020
 
 
3021
 
<sect2>
3022
 
<title>The <guimenu>Settings</guimenu> Menu</title>
3023
 
<para>
3024
 
<variablelist>
3025
 
        <varlistentry>
3026
 
                <term><menuchoice>
3027
 
                        <shortcut>
3028
 
                                <keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo>
3029
 
                        </shortcut>
3030
 
                        <guimenu>Settings</guimenu>
3031
 
                        <guimenuitem>Hide Menubar</guimenuitem>
3032
 
                </menuchoice></term>
3033
 
                <listitem><para>
3034
 
                        <action>Hides the main menu.  Hit
3035
 
                                <keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo>
3036
 
                to display it again.</action>
3037
 
                </para></listitem>
3038
 
        </varlistentry>
3039
 
        <varlistentry>
3040
 
                <term><menuchoice>
3041
 
                        <guimenu>Settings</guimenu>
3042
 
                        <guimenuitem>Hide Toolbar</guimenuitem>
3043
 
                </menuchoice></term>
3044
 
                <listitem><para>
3045
 
                        <action>Hides the toolbar.</action>
3046
 
                </para></listitem>
3047
 
        </varlistentry>
3048
 
        <varlistentry>
3049
 
                <term><menuchoice>
3050
 
                        <guimenu>Settings</guimenu>
3051
 
                        <guimenuitem>Hide Statusbar</guimenuitem>
3052
 
                </menuchoice></term>
3053
 
                <listitem><para>
3054
 
                        <action>Hides the status bar at the bottom of the main screen.</action>
3055
 
                </para></listitem>
3056
 
        </varlistentry>
3057
 
        <varlistentry>
3058
 
                <term><menuchoice>
3059
 
                                <guimenu>Settings</guimenu>
3060
 
                                <guimenuitem>Identities</guimenuitem>
3061
 
                        </menuchoice></term>
3062
 
                <listitem><para><action>Displays the <link linkend="identity">Identities</link> screen
3063
 
                for setting your identification information.
3064
 
                </action></para></listitem>
3065
 
        </varlistentry>
3066
 
        <varlistentry>
3067
 
                <term><menuchoice>
3068
 
                        <guimenu>Settings</guimenu>
3069
 
                        <guimenuitem>Configure Shortcuts</guimenuitem>
3070
 
                </menuchoice></term>
3071
 
                <listitem><para>
3072
 
                        <action>Allows you to change keyboard shortcuts for &konversation;.</action>
3073
 
                </para></listitem>
3074
 
        </varlistentry>
3075
 
        <varlistentry>
3076
 
                <term><menuchoice>
3077
 
                        <guimenu>Settings</guimenu>
3078
 
                        <guimenuitem>Configure Toolbars</guimenuitem>
3079
 
                </menuchoice></term>
3080
 
                <listitem><para>
3081
 
                        <action>Allows you to add or remove buttons from the &konversation; toolbar.</action>
3082
 
                </para></listitem>
3083
 
        </varlistentry>
3084
 
        <varlistentry>
3085
 
                <term><menuchoice>
3086
 
                        <guimenu>Settings</guimenu>
3087
 
                        <guimenuitem>Configure Notifications</guimenuitem>
3088
 
                </menuchoice></term>
3089
 
                <listitem><para>
3090
 
                        <action>Displays the <link linkend="cfg-notifications">Notifications Settings</link> screen.</action>
3091
 
                </para></listitem>
3092
 
        </varlistentry>
3093
 
        <varlistentry>
3094
 
                <term><menuchoice>
3095
 
                        <guimenu>Settings</guimenu>
3096
 
                        <guimenuitem>Configure &konversation;</guimenuitem>
3097
 
                </menuchoice></term>
3098
 
                <listitem><para>
3099
 
                        <action>Displays the <guilabel>Edit Preferences</guilabel> screen.</action>
3100
 
                </para></listitem>
3101
 
        </varlistentry>
3102
 
</variablelist>
3103
 
</para>
3104
 
</sect2>
3105
 
 
3106
 
<sect2>
3107
 
<title>The <guimenu>Window</guimenu> Menu</title>
3108
 
<para>
3109
 
<variablelist>
3110
 
        <varlistentry>
3111
 
                <term><menuchoice>
3112
 
                                <shortcut>
3113
 
                                        <keycombo action="simul">&Ctrl;<keycap>.</keycap></keycombo>
3114
 
                                </shortcut>
3115
 
                                <guimenu>Window</guimenu>
3116
 
                                <guimenuitem>Previous Tab</guimenuitem>
3117
 
                        </menuchoice></term>
3118
 
                <listitem><para>
3119
 
                                <action>Displays the screen corresponding to the previous tab.</action>
3120
 
                        </para></listitem>
3121
 
        </varlistentry>
3122
 
        <varlistentry>
3123
 
                <term><menuchoice>
3124
 
                                <shortcut>
3125
 
                                        <keycombo action="simul">&Ctrl;<keycap>,</keycap></keycombo>
3126
 
                                </shortcut>
3127
 
                                <guimenu>Window</guimenu>
3128
 
                                <guimenuitem>Next Tab</guimenuitem>
3129
 
                        </menuchoice></term>
3130
 
                <listitem><para>
3131
 
                                <action>Displays the screen corresponding to the next tab.</action>
3132
 
                        </para></listitem>
3133
 
        </varlistentry>
3134
 
        <varlistentry>
3135
 
                <term><menuchoice>
3136
 
                                <shortcut>
3137
 
                                        <keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo>
3138
 
                                </shortcut>
3139
 
                                <guimenu>Window</guimenu>
3140
 
                                <guimenuitem>Close Tab</guimenuitem>
3141
 
                        </menuchoice></term>
3142
 
                <listitem><para>
3143
 
                                <action>Closes the current screen.  If closing a channel, leaves the channel.  If closing a
3144
 
                                        <interface>Server Messages</interface> tab, closes all open channels on that server
3145
 
                                        and disconnects from the server.
3146
 
                                </action>
3147
 
                        </para></listitem>
3148
 
        </varlistentry>
3149
 
        <varlistentry>
3150
 
                <term><menuchoice>
3151
 
                                <shortcut>
3152
 
                                        <keycap>F11</keycap>
3153
 
                                </shortcut>
3154
 
                                <guimenu>Window</guimenu>
3155
 
                                <guimenuitem>Close All Open Queries</guimenuitem>
3156
 
                        </menuchoice></term>
3157
 
                <listitem><para>
3158
 
                                <action>Closes all <link linkend="query">Private conversations (queries)</link>.
3159
 
                                </action>
3160
 
                        </para></listitem>
3161
 
        </varlistentry>
3162
 
        <varlistentry>
3163
 
                <term><menuchoice>
3164
 
                                <shortcut>
3165
 
                                        <keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
3166
 
                                </shortcut>
3167
 
                                <guimenu>Window</guimenu>
3168
 
                                <guimenuitem>Hide Nicklist</guimenuitem>
3169
 
                        </menuchoice></term>
3170
 
                <listitem><para>
3171
 
                                <action>Hides (or displays) the panel of &nickname;s in channel tabs.
3172
 
                                </action>
3173
 
                        </para></listitem>
3174
 
        </varlistentry>
3175
 
        <varlistentry>
3176
 
                <term><menuchoice>
3177
 
                                <shortcut>
3178
 
                                        <keycap>F4</keycap>
3179
 
                                </shortcut>
3180
 
                        <guimenu>Window</guimenu>
3181
 
                        <guimenuitem>Watched Nicks Online</guimenuitem>
3182
 
                </menuchoice></term>
3183
 
                <listitem><para>
3184
 
                        <action>Displays the <guilabel>Watched Nicks Online</guilabel> screen.   See <link linkend="nicksonline">Monitoring who is online</link>.</action>
3185
 
                </para></listitem>
3186
 
        </varlistentry>
3187
 
        <varlistentry>
3188
 
                <term><menuchoice>
3189
 
                                <shortcut>
3190
 
                                        <keycap>F5</keycap>
3191
 
                                </shortcut>
3192
 
                        <guimenu>Window</guimenu>
3193
 
                        <guimenuitem>Channel List</guimenuitem>
3194
 
                </menuchoice></term>
3195
 
                <listitem><para>
3196
 
                        <action>Displays a <link linkend="list-channels">list of channels</link> available on the server.</action>
3197
 
                </para></listitem>
3198
 
        </varlistentry>
3199
 
        <varlistentry>
3200
 
                <term><menuchoice>
3201
 
                                <shortcut>
3202
 
                                        <keycap>F6</keycap>
3203
 
                                </shortcut>
3204
 
                        <guimenu>Window</guimenu>
3205
 
                        <guimenuitem>&url; Catcher</guimenuitem>
3206
 
                </menuchoice></term>
3207
 
                <listitem><para>
3208
 
                        <action>Displays the <link linkend="urlcatcher">&url; Catcher</link> screen.</action>
3209
 
                </para></listitem>
3210
 
        </varlistentry>
3211
 
        <varlistentry>
3212
 
                <term><menuchoice>
3213
 
                        <guimenu>Window</guimenu>
3214
 
                        <guimenuitem>New Konsole</guimenuitem>
3215
 
                </menuchoice></term>
3216
 
                <listitem><para>
3217
 
                        <action>Displays a terminal screen.  You may open as many <guilabel>Konsole</guilabel> tabs as you like.</action>
3218
 
                </para></listitem>
3219
 
        </varlistentry>
3220
 
        <varlistentry>
3221
 
                <term><menuchoice>
3222
 
                                <shortcut>
3223
 
                                        <keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>
3224
 
                                </shortcut>
3225
 
                        <guimenu>Window</guimenu>
3226
 
                        <guimenuitem>Open Logfile</guimenuitem>
3227
 
                </menuchoice></term>
3228
 
                <listitem><para>
3229
 
                        <action>Displays a screen with the log of messages from the current tab.  Only works for
3230
 
                                <interface>Channel</interface>, <interface>Server Messages</interface>,
3231
 
                                and <interface>Query</interface> tabs.  Logging must be enabled in
3232
 
                                <menuchoice>
3233
 
                                        <guisubmenu>Settings</guisubmenu>
3234
 
                                        <guisubmenu>Configure Konversation</guisubmenu>
3235
 
                                        <guisubmenu>Behavior</guisubmenu>
3236
 
                                        <guisubmenu>Logging</guisubmenu>
3237
 
                                </menuchoice> on the main menu.
3238
 
                        </action>
3239
 
                </para></listitem>
3240
 
        </varlistentry>
3241
 
</variablelist>
3242
 
</para>
3243
 
</sect2>
3244
 
 
3245
 
<sect2>
3246
 
<title>The <guimenu>Help</guimenu> Menu</title>
3247
 
 
3248
 
<!-- Assuming you have a standard help menu (help, what's this, about -->
3249
 
<!-- &konversation;, about KDE) then the documentation is already written. -->
3250
 
<!-- The following entity is valid anywhere that a variablelist is -->
3251
 
<!-- valid.  -->
3252
 
 
3253
 
&help.menu.documentation;
3254
 
 
3255
 
</sect2>
3256
 
 
3257
 
</sect1>
3258
 
</chapter>
3259
 
 
3260
 
<!-- =================================================================== -->
3261
 
 
3262
 
<chapter id="faq">
3263
 
<title>Questions and Answers</title>
3264
 
 
3265
 
<!-- (OPTIONAL but recommended) This chapter should include all of the silly
3266
 
(and not-so-silly) newbie questions that fill up your mailbox. This chapter
3267
 
should be reserved for BRIEF questions and answers! If one question uses more
3268
 
than a page or so then it should probably be part of the
3269
 
"Using this Application" chapter instead. You should use links to
3270
 
cross-reference questions to the parts of your documentation that answer them.
3271
 
This is also a great place to provide pointers to other FAQ's if your users
3272
 
must do some complicated configuration on other programs in order for your
3273
 
application work. -->
3274
 
 
3275
 
&reporting.bugs;
3276
 
&updating.documentation;
3277
 
 
3278
 
<qandaset id="faqlist">
3279
 
 
3280
 
<qandaentry>
3281
 
<question>
3282
 
<para>When I start &konversation;, I'd like to connect to a server without joining any channels.   How do I do that?</para>
3283
 
</question>
3284
 
<answer>
3285
 
<para>In the <link linkend="serverlist-addnetwork">Edit Server</link> screen, leave the <guilabel>Channels</guilabel> frame empty.</para>
3286
 
</answer>
3287
 
</qandaentry>
3288
 
 
3289
 
<qandaentry>
3290
 
<question>
3291
 
<para>&konversation; won't connect to any servers.  What is wrong.?</para>
3292
 
</question>
3293
 
<answer>
3294
 
<para>There are several things that could be wrong.</para>
3295
 
<orderedlist>
3296
 
<listitem>
3297
 
<para>
3298
 
Make sure that you have entered the correct <guilabel>Server name</guilabel> and the correct <guilabel>Port</guilabel> in the <link linkend="serverlist-addserver">Add Server</link> screen.
3299
 
</para>
3300
 
</listitem>
3301
 
<listitem>
3302
 
<para>
3303
 
Check the output in the <link linkend="channel-screen-tour">Server Messages</link> screen for any error messages.  Did the server reject the connection because of a bad password?  Did the server reject the connection because it requires <acronym>IDENTD</acronym> and
3304
 
your computer did not respond to the <acronym>IDENT</acronym> request?  Did you check
3305
 
the SSL protocol box but the server does not support SSL?
3306
 
</para>
3307
 
</listitem>
3308
 
<listitem>
3309
 
<para>
3310
 
If you are behind a firewall, make sure the correct ports are enabled.  &konversation; needs the following ports enabled:
3311
 
</para>
3312
 
 
3313
 
<para>
3314
 
<itemizedlist>
3315
 
<listitem><para>Outgoing TCP 6667 (or the port of the server you connect to)</para></listitem>
3316
 
<listitem><para>Incoming TCP 113 (if the server requires IDENTD)</para></listitem>
3317
 
<!-- <listitem><para>TODO (Incoming port numbers?)</para></listitem> -->
3318
 
</itemizedlist>
3319
 
</para>
3320
 
 
3321
 
<para>For more information on &irc; connection problems, see <ulink url="http://www.irchelp.org/irchelp/networks/connectprob.html">irchelp.org</ulink>.
3322
 
</para>
3323
 
 
3324
 
</listitem>
3325
 
 
3326
 
</orderedlist>
3327
 
</answer>
3328
 
</qandaentry>
3329
 
 
3330
 
<qandaentry>
3331
 
<question>
3332
 
<para>When I go to
3333
 
<menuchoice>
3334
 
<guisubmenu>Window</guisubmenu>
3335
 
<guisubmenu>Channel List</guisubmenu>
3336
 
</menuchoice>, I cannot select it. Why is that?</para>
3337
 
</question>
3338
 
<answer>
3339
 
<para>
3340
 
The
3341
 
<menuchoice>
3342
 
<guisubmenu>Windows</guisubmenu>
3343
 
<guisubmenu>Channel List</guisubmenu>
3344
 
</menuchoice>  menu entry will be greyed-out if a non-channel tab, &eg; <guilabel>Watched Nicks Online</guilabel>, is currently being viewed.
3345
 
To make it selectable again go back to a channel tab or the server tab.
3346
 
</para>
3347
 
</answer>
3348
 
</qandaentry>
3349
 
 
3350
 
</qandaset>
3351
 
</chapter>
3352
 
 
3353
 
<chapter id="credits">
3354
 
 
3355
 
<!-- Include credits for the programmers, documentation writers, and
3356
 
contributors here. The license for your software should then be included below
3357
 
the credits with a reference to the appropriate license file included in the KDE
3358
 
distribution. -->
3359
 
 
3360
 
<title>Credits and License</title>
3361
 
 
3362
 
<para>
3363
 
&konversation;
3364
 
</para>
3365
 
<para>
3366
 
Program copyright 2002-2005 by the &konversation; team.
3367
 
</para>
3368
 
<para><ulink url="&konviwebsite;">&konviwebsite;</ulink>
3369
 
</para>
3370
 
<para>
3371
 
Contributors:
3372
 
<itemizedlist>
3373
 
<listitem><para>Dario Abatianni <email>eisfuchs@tigress.com</email></para></listitem>
3374
 
<listitem><para>Peter Simonsson <email>psn@linux.se</email></para></listitem>
3375
 
<listitem><para>Christian Muehlhaeuser <email>chris@chris.de</email></para></listitem>
3376
 
<listitem><para>John Tapsel <email>john@geola.geo.uk</email></para></listitem>
3377
 
<listitem><para>Ismail Donmez <email>ismail.donmez@boun.edu.tr</email></para></listitem>
3378
 
<listitem><para>Shintaro Matsuoka <email>shin@shoegazed.org</email></para></listitem>
3379
 
<listitem><para>Gary Cramblitt <email>garycramblitt@comcast.net</email></para></listitem>
3380
 
<listitem><para>Matthias Gierlings <email>gismore@users.sourceforge.net</email></para></listitem>
3381
 
<listitem><para>&Alex.Zepeda; <email>garbanzo@hooked.net</email></para></listitem>
3382
 
<listitem><para>Stanislav Karchebny <email>berkus@users.sourceforge.net</email></para></listitem>
3383
 
<listitem><para>Mickael Marchand <email>marchand@kde.org</email></para></listitem>
3384
 
</itemizedlist>
3385
 
</para>
3386
 
 
3387
 
<para>
3388
 
Thanks to:
3389
 
<itemizedlist>
3390
 
<listitem><para>Michael Goettsche <email>michael.goettsche@kdemail.net</email></para></listitem>
3391
 
<listitem><para>Benjamin Meyer <email>ben+konversation@kdemail.net</email></para></listitem>
3392
 
<listitem><para>Jacub Stachowski <email>qbast@go2.pl</email></para></listitem>
3393
 
<listitem><para>Sabastian Sariego <email>segfault@kde.cl</email></para></listitem>
3394
 
<listitem><para>Olivier Bedard <email>www.konversation.org hosting</email></para></listitem>
3395
 
<listitem><para>Frauke Oster <email>frauke@frsv.de</email></para></listitem>
3396
 
<listitem><para>Lucijan Busch <email>lucijan@kde.org</email></para></listitem>
3397
 
<listitem><para>Sascha Cunz <email>mail@sacu.de</email></para></listitem>
3398
 
<listitem><para>Steve Wollkind <email>steve@njord.org</email></para></listitem>
3399
 
<listitem><para>Thomas Nagy <email>thomas.nagy@eleve.emn.fr</email></para></listitem>
3400
 
<listitem><para>Tobias Olry <email>tobias.olry@web.de</email></para></listitem>
3401
 
<listitem><para>Ruud Nabben <email>r.nabben@gawab.com</email></para></listitem>
3402
 
</itemizedlist>
3403
 
</para>
3404
 
 
3405
 
<para>
3406
 
Documentation Copyright &copy; 2003-2005 Gary R. Cramblitt <email>garycramblitt@comcast.net</email>
3407
 
</para>
3408
 
 
3409
 
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
3410
 
 
3411
 
&underFDL;               <!-- FDL: do not remove -->
3412
 
 
3413
 
<!-- Determine which license your application is licensed under,
3414
 
     and delete all the remaining licenses below:
3415
 
 
3416
 
     (NOTE:  All documentation are licensed under the FDL,
3417
 
     regardless of what license the application uses) -->
3418
 
 
3419
 
&underGPL;               <!-- GPL License -->
3420
 
 
3421
 
</chapter>
3422
 
 
3423
 
<appendix id="installation">
3424
 
<title>Installation</title>
3425
 
 
3426
 
<!-- =================================================================== -->
3427
 
 
3428
 
<sect1 id="getting-kapp">
3429
 
<title>How to obtain &konversation;</title>
3430
 
 
3431
 
<!-- This first entity contains boiler plate for applications that are
3432
 
part of KDE CVS.  You should remove it if you are releasing your
3433
 
application -->
3434
 
 
3435
 
&install.intro.documentation;
3436
 
 
3437
 
<para>
3438
 
The latest versions of &konversation;, including source code and build instructions
3439
 
can also be obtained from the
3440
 
<ulink url="&konviwebsite;">&konviwebsite; website</ulink>.
3441
 
</para>
3442
 
 
3443
 
</sect1>
3444
 
 
3445
 
<!-- =================================================================== -->
3446
 
 
3447
 
<sect1 id="requirements">
3448
 
<title>Requirements</title>
3449
 
 
3450
 
<!--
3451
 
List any special requirements for your application here. This should include:
3452
 
.Libraries or other software that is not included in kdesupport,
3453
 
kdelibs, or kdebase.
3454
 
.Hardware requirements like amount of RAM, disk space, graphics card
3455
 
capabilities, screen resolution, special expansion cards, etc.
3456
 
.Operating systems the app will run on. If your app is designed only for a
3457
 
specific OS, (you wrote a graphical LILO configurator for example) put this
3458
 
information here.
3459
 
-->
3460
 
 
3461
 
<para>
3462
 
In order to successfully use &konversation;, you need &kde; 3.2 or later and a network connection.
3463
 
On earlier &kde; versions some features may be missing.
3464
 
If you will be running &konversation; from behind a firewall, see <link linkend="faq">Questions and Answers</link>.  If you wish to use SSL protocol, you may need OpenSSL.
3465
 
</para>
3466
 
 
3467
 
</sect1>
3468
 
</appendix>
3469
 
 
3470
 
&documentation.index;
3471
 
</book>
3472
 
 
3473
 
<!--
3474
 
Local Variables:
3475
 
mode: xml
3476
 
sgml-minimize-attributes:nil
3477
 
sgml-general-insert-case:lower
3478
 
sgml-indent-step:0
3479
 
sgml-indent-data:nil
3480
 
End:
3481
 
 
3482
 
vim:tabstop=2:shiftwidth=2:expandtab
3483
 
-->