docs/kdenetwork/ksirc/index.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
   3   <!ENTITY mirc "<application>mIrc</application>">
   4   <!ENTITY kappname "&ksirc;">
   5   <!ENTITY package "kdenetwork">
   6   <!ENTITY irc "<acronym>IRC</acronym>">
   7   <!ENTITY CTCP "<acronym>CTCP</acronym>">
   8   <!ENTITY % addindex "IGNORE">
   9   <!ENTITY % English "INCLUDE" > <!-- change language only here -->
  10 ]>
  11
  12 <book lang="&language;">
  13
  14 <bookinfo>
  15 <title>The &ksirc; Handbook</title>
  16 <authorgroup>
  17 <author>
  18 &Andrew.Stanley-Jones;
  19 &Andrew.Stanley-Jones.mail;
  20 </author>
  21 <author>
  22 &Philip.Rodrigues;
  23 &Philip.Rodrigues.mail;
  24 </author>
  25 <author>
  26 &Anne-Marie.Mahfouf;
  27 &Anne-Marie.Mahfouf.mail;
  28 </author>
  29 </authorgroup>
  30
  31 <copyright>
  32 <year>1997</year>
  33 <holder>Andrew Stanley-Jones</holder>
  34 </copyright>
  35
  36 <copyright>
  37 <year>2001</year><year>2002</year><year>2004</year>
  38 <holder>
  39 Philip Rodrigues
  40 </holder>
  41
  42 </copyright>
  43
  44 <copyright>
  45 <year>2005</year>
  46 <holder>
  47 Anne-Marie Mahfouf
  48 </holder>
  49
  50 </copyright>
  51
  52 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  53 <date>2005-05-10</date>
  54 <releaseinfo>1.3.12</releaseinfo>
  55
  56 <legalnotice>&FDLNotice;</legalnotice>
  57
  58 <abstract>
  59 <para>This documentation describes &ksirc; 1.2.1, the &kde; &irc;
  60 client.</para>
  61 </abstract>
  62
  63 <keywordset>
  64 <keyword>KDE</keyword>
  65 <keyword>KSirc</keyword>
  66 <keyword>irc</keyword>
  67 <keyword>Internet relay chat</keyword>
  68 </keywordset>
  69 </bookinfo>
  70
  71 <chapter id="introduction">
  72 <title>Introduction</title>
  73
  74 <para>&ksirc; is the default &kde; &irc; client. It supports scripting
  75 with <acronym>Perl</acronym> and has a lot of compatibility with &mirc;
  76 for general use.</para>
  77
  78 </chapter>
  79
  80 <chapter id="using-ksirc">
  81 <title>Using &ksirc;</title>
  82
  83 <sect1 id="irc-basics">
  84 <title>If you haven't used &irc; before...</title>
  85
  86 <para>Simply put, &irc; is a chat protocol, defined by official Internet
  87 standards, and capable of stealing many hours of your life. To use
  88 &irc;, you must connect to a server, and then join a channel (equivalent
  89 to a chat room).</para>
  90
  91 <para>To connect to a server, open &ksirc; and select
  92 <menuchoice><guimenu>Connections</guimenu><guimenuitem>New
  93 Server...</guimenuitem></menuchoice> or press <keycap>F2</keycap>. In the
  94 dialog box that is displayed, select a group from the leftmost drop-down
  95 box and then a server from the middle drop-down box. The port, shown on
  96 the right, will almost always be 6667. A new window will be displayed
  97 showing the messages sent by the server to the client. When these
  98 messages have finished scrolling past, you want to choose your
  99 channel. To display a list of available channels, type
 100 <userinput><command>/list</command></userinput>. To join a channel,
 101 type: <userinput><command>/join</command>
 102 <replaceable>#channelname</replaceable></userinput>. To leave a channel,
 103 just type <userinput><command>/part</command></userinput>.</para>
 104
 105 <para>That's the basics; for more detailed information, read
 106 on...</para>
 107
 108 </sect1>
 109
 110 <sect1 id="ksirc-basics">
 111 <title>&ksirc; Basics</title>
 112
 113 <sect2 id="servers">
 114 <title>Servers</title>
 115
 116 <para>&ksirc; allows you to connect to any number of
 117 servers. To connect to a server, select
 118 <menuchoice><guimenu>Connections</guimenu><guimenuitem>New
 119 Server</guimenuitem></menuchoice> or press <keycap>F2</keycap>.The
 120 <guilabel>Connect to Server</guilabel> Dialog appears, and you can select a
 121 <guilabel>Group</guilabel>, then a <guilabel>Server</guilabel>, and also
 122 a <guilabel>Port</guilabel> to connect to.</para>
 123
 124 <para>Just click <guilabel>Connect</guilabel> when you're done, and a
 125 new window for the server is displayed. You can keep track of the
 126 servers you're connected to in the &ksirc; <guilabel>Server
 127 Control</guilabel> window.</para>
 128
 129 <para>You can get help on most &irc; commands by typing <userinput>/help
 130 <replaceable>commandname</replaceable></userinput>.
 131  Typing <userinput>/help</userinput> on its own gives a list of available
 132 commands.</para>
 133 </sect2>
 134
 135 <sect2 id="channels">
 136 <title>Channels</title>
 137
 138 <para>You can connect to channels with the normal &irc; command
 139 <userinput><command>/join</command> <replaceable>#channelname</replaceable>
 140 </userinput>, by selecting
 141 <menuchoice><guimenu>Connections</guimenu><guimenuitem>Join
 142 Channel...</guimenuitem></menuchoice> or by pressing
 143 <keycap>F3</keycap>.</para>
 144
 145 <para>Channels you are connected to are shown in the <guilabel>Server
 146 Control</guilabel> window under the server to which the they belong. To
 147 leave a channel, you can <userinput>/part</userinput>, select
 148 <menuchoice><guimenu>Channel</guimenu><guimenuitem>Close</guimenuitem>
 149 </menuchoice> or press <keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo>.</para>
 150
 151 </sect2>
 152
 153 <sect2 id="channel-options">
 154 <title>Channel Options</title>
 155
 156 <para>The <guimenu>Channel</guimenu> menu, available in any channel
 157 window, contains some useful options:</para>
 158
 159 <variablelist>
 160
 161 <varlistentry>
 162 <term><menuchoice>
 163 <shortcut><keycombo>&Ctrl;<keycap>S</keycap>
 164 </keycombo></shortcut>
 165 <guimenuitem>Save to Logfile...</guimenuitem>
 166 </menuchoice></term>
 167 <listitem>
 168 <para><action>Saves the contents of the channel to a
 169 file.</action></para>
 170 </listitem>
 171 </varlistentry>
 172
 173 <varlistentry>
 174 <term><menuchoice>
 175 <guimenuitem>Time Stamp</guimenuitem>
 176 </menuchoice></term>
 177 <listitem>
 178 <para><action>If selected, prepends each thing said in the channel with the
 179 time it was said, in the form [HH:MM:SS]</action></para>
 180 </listitem>
 181 </varlistentry>
 182
 183 <varlistentry>
 184 <term><menuchoice> <shortcut><keycombo action="seq">&Alt;<keycap>C</keycap>
 185 <keycap>T</keycap></keycombo></shortcut>
 186 <guimenuitem>Ascii Table</guimenuitem>
 187 </menuchoice></term>
 188 <listitem>
 189 <para><action>Displays a table of Ascii characters</action>, from which you can
 190 choose any characters you require.</para></listitem>
 191 </varlistentry>
 192
 193 <varlistentry>
 194 <term><menuchoice><shortcut><keycombo action="seq">&Alt;<keycap>C</keycap>
 195 <keycap>P</keycap></keycombo></shortcut>
 196 <guimenuitem>Beep on Change</guimenuitem>
 197 </menuchoice></term>
 198 <listitem>
 199 <para><action>If selected, &ksirc; emits a beep every time something is said on
 200 a channel.</action></para></listitem>
 201 </varlistentry>
 202
 203
 204 </variablelist>
 205
 206 </sect2>
 207
 208 <sect2 id="user-options">
 209 <title>User Options</title>
 210
 211 <para>In a channel, the user list is displayed along the right hand
 212 side. Right-clicking a nickname in that list gives you a pop-up menu of
 213 options, most of which are self-explanatory. Those actions can be configured (changing the order, adding or removing some) in the Configure KSirc... dialog in the User Menu tab. The default actions are the following:</para>
 214
 215 <variablelist>
 216
 217 <varlistentry>
 218 <term><guimenuitem>Refresh Nicks</guimenuitem></term>
 219 <listitem>
 220 <para><action>Sends a message to the server to request the list of users in the
 221 channel.</action> This ensures that the list of nicknames is up-to-date.</para>
 222 </listitem>
 223 </varlistentry>
 224
 225 <varlistentry>
 226 <term><guimenuitem>Follow</guimenuitem></term>
 227 <listitem>
 228 <para><action>Highlights the user's nick in every message they send to
 229 the channel. This way, you can follow someone's thread of conversation
 230 in a busy channel. The user's nick color is picked at random.</action></para>
 231 </listitem>
 232 </varlistentry>
 233
 234 <varlistentry>
 235 <term><guimenuitem>unFollow</guimenuitem></term>
 236 <listitem>
 237 <para><action>Stops following the user.</action></para>
 238 </listitem>
 239 </varlistentry>
 240
 241 <varlistentry>
 242 <term><guimenuitem>Whois</guimenuitem></term>
 243 <listitem>
 244 <para><action>Sends a &CTCP; whois query to the user, which
 245 provides information about the user, such as his hostname and what
 246 server he is connected to.</action></para>
 247 </listitem>
 248 </varlistentry>
 249
 250 <varlistentry>
 251 <term><guimenuitem>Ping</guimenuitem></term>
 252 <listitem>
 253 <para><action>Sends a &CTCP; ping request to the user, to
 254 determine his echo time.</action></para>
 255 </listitem>
 256 </varlistentry>
 257
 258 <varlistentry>
 259 <term><guimenuitem>Version</guimenuitem></term>
 260 <listitem>
 261 <para><action>Sends a &CTCP; version request to the user, to
 262 determine what software he is using.</action></para>
 263 </listitem>
 264 </varlistentry>
 265
 266 <varlistentry>
 267 <term><guimenuitem>Abuse</guimenuitem></term>
 268 <listitem>
 269 <para><action>Abuses the user in one of various amusing
 270 ways.</action></para>
 271 </listitem>
 272 </varlistentry>
 273
 274 </variablelist>
 275
 276 <para>The following commands are only available if you are an operator
 277 on the channel:</para>
 278
 279 <variablelist>
 280 <varlistentry>
 281 <term><guimenuitem>Kick</guimenuitem></term>
 282 <listitem>
 283 <para><action>Removes the user off the channel.</action></para>
 284 </listitem>
 285 </varlistentry>
 286
 287 <varlistentry>
 288 <term><guimenuitem>Ban</guimenuitem></term>
 289 <listitem>
 290 <para><action>Bans the user from joining the channel.</action></para>
 291 </listitem>
 292 </varlistentry>
 293
 294 <varlistentry>
 295 <term><guimenuitem>unBan</guimenuitem></term>
 296 <listitem>
 297 <para><action>Removes the ban on the user joining the channel.</action></para>
 298 </listitem>
 299 </varlistentry>
 300
 301 <varlistentry>
 302 <term><guimenuitem>Op</guimenuitem></term>
 303 <listitem>
 304 <para><action>Gives the user operator privileges.</action></para>
 305 </listitem>
 306 </varlistentry>
 307
 308 <varlistentry>
 309 <term><guimenuitem>DeOp</guimenuitem></term>
 310 <listitem>
 311 <para><action>Removes operator privileges from the user.</action></para>
 312 </listitem>
 313 </varlistentry>
 314
 315 </variablelist>
 316
 317 </sect2>
 318 </sect1>
 319
 320 <sect1 id="autoconnecting">
 321 <title>Autoconnecting</title>
 322 <para>If you have a number of servers and/or channels which you
 323 connect to every time you use &ksirc;, then you can set up &ksirc; to
 324 automatically connect to them: In the <guilabel>Server
 325 Control</guilabel> window, select
 326 <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
 327 KSirc...</guimenuitem></menuchoice>, and in the dialog which appears,
 328 select the <guilabel>Auto Connect</guilabel> page. To add a channel on
 329 a new server, fill in the <guilabel>Server</guilabel> and
 330 <guilabel>Channel</guilabel> text boxes, and then click on
 331 <guibutton>Add</guibutton>. To add another channel on this server,
 332 select the server name in the tree view, enter the channel name in the
 333 <guilabel>Channel</guilabel> text box, and click on
 334 <guibutton>Update/Add</guibutton>. You can repeat this process as many
 335 times as you like to add several servers and channels for &ksirc; to
 336 connect to at startup.</para>
 337 </sect1>
 338
 339 </chapter>
 340
 341 <chapter id="ksirc-configuration">
 342 <title>&ksirc; Configuration</title>
 343
 344 <sect1 id="config-intro">
 345 <title>Introduction to Configuration</title>
 346 <para>The &ksirc; configuration dialog is available from
 347 <menuchoice><guimenu>Options</guimenu><guimenuitem>Preferences...</guimenuitem></menuchoice>
 348 in the &ksirc; <guilabel>Server Control</guilabel> window.
 349 </para>
 350 </sect1>
 351
 352 <sect1 id="look-and-feel">
 353 <title>The <guilabel>Look and Feel</guilabel> Tab</title>
 354 <sect2 id="windowmode">
 355 <title><guilabel>Window Mode</guilabel></title>
 356 <para>
 357 <variablelist>
 358
 359 <varlistentry>
 360 <term><guilabel>SDI Mode (old behavior)</guilabel></term>
 361 <listitem><para>Causes &ksirc; to use single document interface mode, in which
 362 each new channel or <command>/query</command> window has its own, separate
 363 window.</para></listitem>
 364 </varlistentry>
 365
 366 <varlistentry>
 367 <term><guilabel>Paged MDI mode (XChat)</guilabel></term>
 368 <listitem><para>Causes &ksirc; to use multiple document interface mode, in the
 369 style of <application>XChat</application>, in which each new channel or
 370 <command>/query</command> window has a tab in one main &ksirc; window. Each tab
 371 can be brought to the front by clicking its tab, and you can switch tabs using
 372 <keycombo>&Alt;<keysym>Left Arrow</keysym></keycombo> and
 373 <keycombo>&Alt;<keysym>Right Arrow</keysym></keycombo>.</para>
 374 </listitem>
 375 </varlistentry>
 376
 377 </variablelist>
 378
 379 </para>
 380 </sect2>
 381 <sect2 id="wallpaper-config">
 382 <title><guilabel>Wallpaper</guilabel></title>
 383 <para>
 384 In the <guilabel>Wallpaper</guilabel> section, you can change the image placed
 385 in the background of your &ksirc; windows. You can enter the name of the file
 386 to use in the text box, or browse for files using the button to the right of
 387 the textbox. Image files used must be in  &GIF;, <acronym>JPEG</acronym> or
 388 <acronym>PNG</acronym> format. A preview of the image is shown at the right of
 389 the dialog box.</para>
 390 <para>If you don't want a wallpaper, simply right-click in the path field and choose clear in the context menu. Or remove the wallpaper location to leave the field empty and click Apply. No wall paper will be set then.</para>
 391 </sect2>
 392
 393 </sect1>
 394
 395 <sect1 id="general-config">
 396 <title>The <guilabel>General</guilabel> Tab</title>
 397
 398 <sect2 id="general-global-config">
 399 <title><guilabel>Global Options</guilabel> </title>
 400 <para>
 401 <variablelist>
 402 <varlistentry>
 403 <term><guilabel>Dock in system tray</guilabel></term>
 404 <listitem><para>This allows KSirc to be docked in the system tray. By default this is not enabled. When KSirc is docked in the system tray, you are able to access several options by clicking on the KSirc icon. When you close KSirc window, the icon stays in the systray until you quit KSirc.</para></listitem>
 405 </varlistentry>
 406
 407 <varlistentry>
 408 <term><guilabel>Color picker popup</guilabel></term>
 409 <listitem><para>If selected, a popup window from which to select the color of
 410 your text is presented when you press
 411 <keycombo action="simul">&Ctrl;<keycap>K</keycap></keycombo>. If not, you have
 412 to type the color codes manually. See also <xref
 413 linkend="sectcolors"/>. This option is selected by default.</para></listitem>
 414 </varlistentry>
 415
 416 <varlistentry>
 417 <term><guilabel>Auto create window</guilabel></term> <listitem><para>If
 418 selected, &ksirc; will automatically create a new window for each user who
 419 sends a <command>/msg</command> command to you. If not selected, any text sent
 420 to you with <command>/msg</command> is displayed in the current window and you
 421 can use <command>/query <replaceable>username</replaceable></command> to create
 422 a window to chat to that user. It is selected by default.</para></listitem>
 423 </varlistentry>
 424
 425 <varlistentry>
 426 <term><guilabel>Auto-rejoin</guilabel></term>
 427 <listitem><para><action>Rejoins channels automatically if you are
 428 disconnected.</action></para></listitem>
 429 </varlistentry>
 430
 431 <varlistentry>
 432 <term><guilabel>Auto create on notice</guilabel></term>
 433 <listitem><para></para></listitem>
 434 </varlistentry>
 435
 436 <varlistentry>
 437 <term><guilabel>Announce away messages</guilabel></term>
 438 <listitem><para>If this is checked, you will see the messages when a user selects the away option. By default this option is not checked. It is checked by default.</para></listitem>
 439 </varlistentry>
 440
 441 <varlistentry id="nick-completion">
 442 <term><guilabel>Nick completion</guilabel></term> <listitem><para>
 443 If selected, switches nickname completion on. Nickname completion works as
 444 follows:
 445 <orderedlist>
 446
 447 <listitem><para>Type the first letters of a user's nickname.</para></listitem>
 448
 449 <listitem><para>Press <keysym>TAB</keysym>. The text you typed will be
 450 completed to match the username, including changes in capitalization if
 451 necessary. &eg; <userinput>phi&lt;TAB&gt;</userinput> becomes
 452 <computeroutput>PhilRod</computeroutput> if there is a user called
 453 <quote>PhilRod</quote> on the channel.</para></listitem>
 454
 455 <listitem><para>If more than one user's nickname on the channel matches the
 456 text you have typed, the first name in the list is chosen. Pressing
 457 <keysym>TAB</keysym> subsequent times displays the next nickname in the
 458 list. For example, if there are users <quote>PhilA</quote> and
 459 <quote>PhilRod</quote> on a channel, and you type
 460 <userinput>phi&lt;TAB&gt;</userinput>, the text will first be completed to
 461 <computeroutput>PhilA</computeroutput>, and if you press <keysym>TAB</keysym>
 462 again, it will change to <computeroutput>PhilRod</computeroutput>.</para>
 463 </listitem>
 464
 465 </orderedlist>
 466 </para>
 467 </listitem>
 468 </varlistentry>
 469
 470 <varlistentry>
 471 <term><guilabel>Use color nick list</guilabel></term>
 472 <listitem><para>If selected, it will use the colors set in the Colors tab of the Configure KSirc dialog for coloring the nicknames.</para></listitem>
 473 </varlistentry>
 474
 475 <varlistentry>
 476 <term><guilabel>Display topic in caption</guilabel></term>
 477 <listitem><para><action>Displays the topic of the current channel in the window
 478 caption.</action> If not selected, the topic is only displayed inside the
 479 window.</para></listitem>
 480 </varlistentry>
 481
 482 <varlistentry>
 483 <term><guilabel>Dock passive popups</guilabel></term>
 484 <listitem><para>This option is only available if Dock in system tray is checked. If it checked, the passive popups will be displayed docked to the system tray.</para></listitem>
 485 </varlistentry>
 486
 487 <varlistentry>
 488 <term><guilabel>One line text entry box</guilabel></term>
 489 <listitem><para>If this is not selected, the entry box where you write your text in each channel will expand on several lines depending of the text length. If this is selected, only one line will be used and that means you will not see the beginning of the text you are writing if it is longer than the line.</para></listitem>
 490 </varlistentry>
 491
 492 <varlistentry>
 493 <term><guilabel>History Length</guilabel></term>
 494 <listitem><para>Stores up to this many lines of chat from each window, allowing
 495 you to scroll upwards and see what has already been said.</para></listitem>
 496 </varlistentry>
 497
 498 <varlistentry>
 499 <term><guilabel>Auto save history</guilabel></term>
 500 <listitem><para>If this is selected, private message history is saved. When you open a private window the second time with the same user, you will see a log (the history) of your previous chat with him.</para></listitem>
 501 </varlistentry>
 502
 503 </variablelist>
 504 </para>
 505 </sect2>
 506
 507 <sect2 id="misc-general-config">
 508 <title><guilabel>Per Channel Options</guilabel> </title>
 509 <para>
 510
 511 <variablelist>
 512
 513 <varlistentry>
 514 <term><guilabel>Override existing channels options</guilabel></term>
 515 <listitem><para>If this is selected, the settings in this tab will override each channel options so these settings will be applied in each channel, independently of your channel settings in the Channel menu. This setting will only work until next time you open the configuration dialog and it will be reset unchecked then. This is because you probably don't want to override the existing channels options all the time.</para></listitem>
 516 </varlistentry>
 517
 518 <varlistentry>
 519 <term><guilabel>Time Stamp</guilabel></term> <listitem><para><action>Prepends
 520 each thing said in the channel with the time it was said,</action> in the form
 521 [HH:MM:SS].</para>
 522 </listitem>
 523 </varlistentry>
 524
 525 <varlistentry>
 526 <term><guilabel>Show topic</guilabel></term>
 527 <listitem><para>Displays the channel topic on top of each channel window.</para></listitem>
 528 </varlistentry>
 529
 530 <varlistentry>
 531 <term><guilabel>Beep on change</guilabel></term>
 532 <listitem><para>If selected, a system beep will be generated whenever a user on
 533 your <command>/notify</command> list signs onto the &irc; server you are
 534 on.</para></listitem>
 535 </varlistentry>
 536
 537 <varlistentry>
 538 <term><guilabel>Enable logging</guilabel></term>
 539 <listitem><para>Creates log files for each channel per day. These log files are stored in $KDEHOME/share/apps/ksirc/logs/ and the files look like: /$KDEHOME/share/apps/ksirc/logs/#channelname_year_month_day_servername.log</para></listitem>
 540 </varlistentry>
 541
 542 <varlistentry>
 543 <term><guilabel>Hide part/join messages</guilabel></term>
 544 <listitem><para></para></listitem>
 545 </varlistentry>
 546
 547 <varlistentry>
 548 <term><guilabel>Default encoding</guilabel></term>
 549 <listitem><para></para></listitem>
 550 </varlistentry>
 551
 552 </variablelist>
 553 </para>
 554 </sect2>
 555
 556
 557 </sect1>
 558
 559 <sect1 id="startup-tab">
 560 <title>The <guilabel>Startup</guilabel> Tab</title>
 561
 562 <para>
 563 Here you can configure &ksirc;'s startup settings.
 564 </para>
 565
 566 <sect2 id="server">
 567 <title><guilabel>Server</guilabel></title>
 568
 569 <para>
 570 x</para>
 571
 572 </sect2>
 573
 574 <sect2 id="name-settings">
 575 <title><guilabel>Name Settings</guilabel></title>
 576
 577 <para>
 578
 579 <variablelist>
 580
 581 <varlistentry>
 582 <term><guilabel>Nick Name</guilabel></term>
 583 <listitem><para>Set your &irc; nickname.</para></listitem>
 584 </varlistentry>
 585
 586 <varlistentry>
 587 <term><guilabel>Alternative Nick</guilabel></term>
 588 <listitem><para>Set the nickname to use if your first choice is already in use
 589 by another user.</para></listitem>
 590 </varlistentry>
 591
 592 <varlistentry>
 593 <term><guilabel>Real Name</guilabel></term>
 594 <listitem><para>Your real name, as returned by a <command>/whois</command>
 595 query on you.</para></listitem>
 596 </varlistentry>
 597
 598 <varlistentry>
 599 <term><guilabel>User ID</guilabel></term>
 600 <listitem><para>Your real name, as returned by a <command>/whois</command>
 601 query on you.</para></listitem>
 602 </varlistentry>
 603
 604 </variablelist>
 605 </para>
 606 </sect2>
 607
 608 <sect2 id="notify-list">
 609 <title><guilabel>Notify List</guilabel></title>
 610
 611 <para>
 612 Here you can enter a list of users who you want added to your
 613 <command>/notify</command> list at startup. You will be alerted when each of
 614 the users in the list is online.</para>
 615 </sect2>
 616
 617 </sect1>
 618
 619 <sect1 id="colors-tab">
 620 <title>The <guilabel>Colors</guilabel> Tab</title>
 621 <para>
 622 Here you can configure &ksirc;'s use of color.
 623 </para>
 624
 625 <sect2 id="chat-colors">
 626 <title><guilabel>Chat colors</guilabel> Configuration</title>
 627 <para>
 628 Here you can set colors for each of the types of text. Clicking the color
 629 button to the right of each text type's label will display a color selector box
 630 in which you can choose the color in which you want this type of text to be
 631 displayed.
 632 </para>
 633 </sect2>
 634
 635 <sect2 id="nick-colors">
 636 <title><guilabel>Nick Colors</guilabel></title>
 637 <para>
 638 <guilabel>Foreground:</guilabel> and <guilabel>Background:</guilabel> set the
 639 colors for the foreground and background of users' nicknames in chat
 640 windows. The <guilabel>Color for messages containing your nick:</guilabel>
 641 option sets the color for any message appearing in a channel which contains
 642 your nickname.</para>
 643 </sect2>
 644
 645 <sect2 id="color-codes">
 646 <title><guilabel>Color codes</guilabel></title>
 647 <para>
 648 Here you can set whether &ksirc; allows native color codes (see <xref
 649 linkend="sectcolors"/>) and also whether &mirc; color codes are allowed.</para>
 650 </sect2>
 651
 652 </sect1>
 653
 654 <!--<sect1 id="irc-colors-tab">
 655 <title>The <guilabel>IRC Colors</guilabel> Tab</title>
 656 <para>
 657 </para>
 658 </sect1>-->
 659
 660 <sect1 id="user-menu-tab">
 661 <title>The <guilabel>User Menu</guilabel> Tab</title>
 662 <para>This page allows configuration for the RMB (Right Mouse Button) menu for the nick list located on the right in each channel. When you right click on a nickname, some actions are defined by default. These are the actions listed on the left. You can change these actions order, delete some and add others.
 663 </para>
 664 </sect1>
 665
 666 <sect1 id="server-channel-tab">
 667 <title>The <guilabel>Server/Channel</guilabel> Tab</title>
 668 <para>Here are listed the servers and channels you join to using the New Server (<keycap>F2</keycap>) and New Channel (<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>) dialogs via the Channel menu.
 669 </para>
 670 <sect2 id="server-config">
 671 <title>Server</title>
 672 <para>You add there the servers you want to use. Write the server name in the field and click the Add Server to List button. If you want to delete a server from the list, you click on the server name and then on the Delete Server from List button.</para>
 673 </sect2>
 674 <sect2 id="channels-config">
 675 <title>Channels</title>
 676 <para>You add there the channels you want to connect to. Write the channel name in the field and click the Add Channel to List button. If you want to delete a channel from the list, you click on the channel name and then on the Delete Channel from List button.</para>
 677 </sect2>
 678 </sect1>
 679
 680 <sect1 id="auto-connect-tab">
 681 <title>The <guilabel>Auto Connect</guilabel> Tab</title>
 682 <para>
 683 </para>
 684 <sect2 id="auto-connect-setup">
 685 <title>Auto Connect Setup</title>
 686 <para>You set here the server and channels names that you want to connect directly when KSirc starts.</para>
 687 <para>You need to use the Auto Connect Setup dialog first to add new channels. You enter there the server name. The server port is set by default for most servers. If you are not sure, just leave it as it is. Usually servers don't ask for passwords so if you don't have a password, leave the Password field empty. Then add a channel name and click the Add button. The channel will be displayed in the Auto Connect List.</para>
 688 <para>
 689 If you want to add more channel for a same server, click on the server in the Auto Connect List and the server name will be displayed in the Auto Connect Setup dialog. Write the channel name in the Channel field and click on Update/Add.
 690 </para>
 691 <para>
 692 In order to remove a channel form the Auto Connect List, click on the channel name in the list and then click the Delete button.
 693 </para>
 694 </sect2>
 695 </sect1>
 696
 697 <sect1 id="fonts-tab">
 698 <title>The <guilabel>Fonts</guilabel> Tab</title>
 699 <para>
 700 You can change here the font for the main window. Select the font you want then click the Apply button to preview the change. Ok applies the changes and quits the dialog.
 701 </para>
 702 </sect1>
 703
 704 <!--<sect1 id="shortcuts-tab">
 705 <title>The <guilabel>Shortcuts</guilabel> Tab</title>
 706 <para>
 707 </para>
 708
 709 <sect2 id="global-shortcuts">
 710 <title>Global Shortcuts</title>
 711 <para></para>
 712
 713 </sect2>
 714 <sect2 id="shortcuts-selected-action">
 715 <title>Shortcut for Selected Action</title>
 716 <para></para>
 717 </sect2>
 718 </sect1>-->
 719
 720 </chapter>
 721
 722
 723 <chapter id="sectcolors">
 724 <title>&ksirc; Colors</title>
 725
 726 <para>&ksirc; follows the color scheme used by
 727 &mirc; and a slight modification for more
 728 powerful in house use.</para>
 729
 730 <screen>&lt;fg&gt; == foreground
 731 &lt;bg&gt; == background
 732 &lsqb;&rsqb; == optional
 733 </screen>
 734
 735 <sect1 id="mirccompatibility">
 736 <title>&mirc; compatibility</title>
 737
 738 <para>Format:</para>
 739 <itemizedlist>
 740 <listitem>
 741 <para><userinput>0x03&lt;fg&gt;&lsqb;,&lt;bg&gt;&rsqb;</userinput>
 742 sets the foreground and background</para>
 743 </listitem>
 744 <listitem>
 745 <para><userinput>0x03</userinput>
 746 resets to defaults for <emphasis>that</emphasis> line</para>
 747 </listitem>
 748 </itemizedlist>
 749 </sect1>
 750
 751 <sect1 id="ksircnative">
 752 <title>&ksirc; native</title>
 753
 754 <para>Format:</para>
 755
 756 <itemizedlist>
 757 <listitem>
 758 <para><userinput>&tilde;&lt;fg&gt;&lsqb;,&lt;bg&gt;&rsqb;</userinput>
 759 sets the foreground and background</para>
 760 </listitem>
 761 <listitem>
 762 <para><userinput>&tilde;c</userinput> resets to defaults</para>
 763 </listitem>
 764 <listitem>
 765 <para><userinput>&tilde;b</userinput> sets bold font</para>
 766 </listitem>
 767 <listitem>
 768 <para><userinput>&tilde;u</userinput> sets underline</para>
 769 </listitem>
 770 <listitem>
 771 <para><userinput>&tilde;i</userinput> sets italics</para>
 772 </listitem>
 773 <listitem>
 774 <para><userinput>&tilde;r</userinput> sets reverse video</para>
 775 </listitem>
 776 </itemizedlist>
 777
 778 <para>Why did I change &ksirc; to use &tilde; instead of 0x03
 779 (<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>)?
 780 Well, it's hard to use 0x03 in scripts and not all C functions seem to
 781 like it. <userinput>&tilde;<replaceable>letter</replaceable></userinput>
 782 also allows more commands while not stomping on &mirc;'s future changes.</para>
 783
 784 </sect1>
 785
 786 <sect1 id="colornumbers">
 787 <title>Color Numbers</title>
 788
 789 <orderedlist>
 790 <listitem>
 791 <para> white</para>
 792 </listitem>
 793 <listitem>
 794 <para> black</para>
 795 </listitem>
 796 <listitem>
 797 <para> blue</para>
 798 </listitem>
 799 <listitem>
 800 <para> green</para>
 801 </listitem>
 802 <listitem>
 803 <para> red</para>
 804 </listitem>
 805 <listitem>
 806 <para> brown</para>
 807 </listitem>
 808 <listitem>
 809 <para> purple</para>
 810 </listitem>
 811 <listitem>
 812 <para> orange</para>
 813 </listitem>
 814 <listitem>
 815 <para> yellow</para>
 816 </listitem>
 817 <listitem>
 818 <para> lightGreen</para>
 819 </listitem>
 820 <listitem>
 821 <para> cyan</para>
 822 </listitem>
 823 <listitem>
 824 <para> lightCyan</para>
 825 </listitem>
 826 <listitem>
 827 <para> lightBlue</para>
 828 </listitem>
 829 <listitem>
 830 <para> pink</para>
 831 </listitem>
 832 <listitem>
 833 <para> gray</para>
 834 </listitem>
 835 <listitem>
 836 <para> lightGray</para>
 837 </listitem>
 838 </orderedlist>
 839 </sect1>
 840
 841 <sect1 id="sendingboldunderlinereverseandcolor">
 842 <title>Sending Bold, Underline, Reverse, and Color</title>
 843
 844 <para>You can use the following key combinations to insert control codes
 845 in text:</para>
 846
 847 <itemizedlist>
 848 <listitem>
 849 <para><keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo> for
 850 bold text</para>
 851 </listitem>
 852 <listitem>
 853 <para><keycombo action="simul">&Ctrl;<keycap>U</keycap></keycombo> for
 854 underlined text</para>
 855 </listitem>
 856 <listitem>
 857 <para><keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo> for
 858 reverse text</para>
 859 </listitem>
 860 <listitem>
 861 <para><keycombo action="simul">&Ctrl;<keycap>K</keycap></keycombo> for
 862 colored text</para>
 863 </listitem>
 864 <listitem>
 865 <para><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> for
 866 plain text</para>
 867 </listitem>
 868 </itemizedlist>
 869
 870 </sect1>
 871
 872 <sect1 id="examplessetcolors">
 873 <title>Examples</title>
 874
 875 <para>To underline a single word in a sentence:</para>
 876
 877 <procedure>
 878 <step>
 879 <para>Type <keycombo
 880 action="simul">&Ctrl;<keycap>U</keycap></keycombo></para>
 881 </step>
 882 <step>
 883 <para>Type in the word</para>
 884 </step>
 885 <step>
 886 <para>Type <keycombo action="simul">&Ctrl;<keycap>U</keycap></keycombo>
 887 again</para>
 888 </step>
 889 </procedure>
 890
 891 <para>Only the text that is enclosed by the start and end codes will be
 892 affected. You can use this method with all of the other control
 893 codes.</para>
 894
 895 <para>The <keycombo action="simul">&Ctrl;<keycap>K</keycap></keycombo>
 896 control code is slightly different because it allows you to specify a
 897 color number. To color a single word in a sentence:</para>
 898
 899 <procedure>
 900 <step>
 901 <para>Type <keycombo
 902 action="simul">&Ctrl;<keycap>K</keycap></keycombo></para>
 903 </step>
 904 <step>
 905 <para>Type a number between 0 and 15</para>
 906 </step>
 907 <step>
 908 <para>Type the word</para>
 909 </step>
 910 <step>
 911 <para>Type <keycombo
 912 action="simul">&Ctrl;<keycap>K</keycap></keycombo> again</para>
 913 </step>
 914 </procedure>
 915
 916 <para>If you also want to change the background color of a word, you
 917 would need to type two numbers separated by a comma instead of just one
 918 number. The first number is the text color, the second number is the
 919 background color. The colors range from 0 to 15, the index is in the
 920 previous section.</para>
 921
 922 <para>You can enclose text in multiple control codes, so for example you
 923 could have a bold, underlined, and colored word.</para>
 924
 925 </sect1>
 926 </chapter>
 927
 928 <chapter id="filters">
 929 <title>Filters</title>
 930
 931 <sect1 id="filterrulesandhowtomakethem">
 932 <title>Filter Rules and How to Make them</title>
 933
 934 <para>If you just can't figure it out, wait. I want to build a nice
 935 <quote>filter builder</quote> where you can just click your way through
 936 it. Though, it might be a while.</para>
 937
 938 <para>The filter tries to find the <quote>match</quote> string then use
 939 the <quote>From</quote> and <quote>To</quote> as a substitution.  The
 940 match, from and to are all <application>Perl</application> regex
 941 expressions. Rules are evaluated in descending order.  The top rule is
 942 evaluated first, then the second from the top, &etc; All strings are
 943 evaluated as:</para>
 944
 945 <para><varname>$<replaceable>name</replaceable></varname> is expanded to
 946 the environment variable
 947 <varname><replaceable>name</replaceable></varname>.  This is done
 948 immediately when you insert the rule, and will not change after that
 949 time.  Therefore it's probably of limited value.</para>
 950
 951 <para><varname>$$<replaceable>name</replaceable></varname> is
 952 substituted with the <acronym>Perl</acronym>
 953 <varname>$<replaceable>name</replaceable></varname> variable during the
 954 match.  This can be substrings such as <varname>$1</varname>,
 955 <varname>$2</varname> in the substitution, or normal variables available
 956 under <application>sirc</application> (such as <varname>$nick</varname>,
 957 <varname>$channel</varname>, &etc;).</para>
 958
 959 <para><varname>&tilde;<replaceable>name</replaceable>&tilde;</varname>
 960 <emphasis>prepended once and only once</emphasis> to the line will send
 961 the line of text to the window called <replaceable>name</replaceable>.
 962 If the window does not exist it will go to the last window which had
 963 focus.  There are several special windows, all prefixed by a single
 964 <literal>!</literal>:</para>
 965
 966 <para><variablelist>
 967 <varlistentry>
 968 <term><varname>!default</varname></term>
 969 <listitem>
 970 <para>The current default window.  Guaranteed to exist.</para>
 971 </listitem>
 972 </varlistentry>
 973 <varlistentry>
 974 <term><varname>!all</varname></term>
 975 <listitem>
 976 <para>Send to every window.  This might not show up on all windows,
 977 depending on how the text is parsed.  For example, channel windows won't
 978 show a <command>/part</command> or <command>/quit</command> unless the nickname is on the channel.</para>
 979 </listitem>
 980 </varlistentry>
 981 <varlistentry>
 982 <term><varname>!discard</varname></term>
 983 <listitem>
 984 <para>discards the text.</para>
 985 </listitem>
 986 </varlistentry>
 987 </variablelist>
 988 </para>
 989
 990 <para>The rest of the expression is dealt with as normal
 991 <acronym>Perl</acronym> regex.  A
 992 good understanding of the <command>perlre</command> man page will
 993 definitely help, but a basic understanding of regex is most certainly
 994 required.</para>
 995
 996 </sect1>
 997
 998 <sect1 id="examplesfilters">
 999 <title>Examples:</title>
1000
1001 <orderedlist><listitem>
1002 <para>Want to convert all boren from boren to BoreN</para>
1003
1004 <screen>Match: .*
1005 From: boren
1006 To: BoreN</screen>
1007
1008 <para>Pretty straight forward, match anything, then substitute boren
1009 with BoreN.</para>
1010
1011 </listitem>
1012 <listitem>
1013 <para>You want to match everything with boren in it and send to the
1014 window called <quote>boren</quote></para>
1015
1016 <screen>Match: boren
1017 From: &circ;
1018 To: &tilde;boren&tilde;</screen>
1019
1020 <para>Looks for <quote>boren</quote> if found, substitutes the beginning
1021 of the string (&circ;) with &tilde;boren&tilde;.</para>
1022
1023 </listitem>
1024 <listitem>
1025
1026 <para>Though the previous example works, if the string already has
1027 <literal>&tilde;somewindow&tilde;</literal> on it, you'll now have two
1028 <literal>&tilde;boren&tilde;&tilde;somewindow&tilde;...</literal> So you
1029 can do this instead.</para>
1030
1031 <screen>Match: boren
1032 From: ^(?:&tilde;\S+&tilde;)
1033 To: &tilde;boren&tilde;</screen>
1034
1035 <para>Ok, the from line is a little bit more complicated.  It means: match
1036 0 or 1 copies of <literal>&tilde;\S+&tilde;</literal>.  Which is 1
1037 tilde, one or more non-whitespaces, and then another tilde.  The
1038 paranoid might do <literal>(*:&tilde;\S+&tilde;)</literal>, which means:
1039 match 0 or more channel directives in case prior rules are
1040 broken.</para>
1041
1042 </listitem>
1043
1044 <listitem>
1045 <para>Server kill messages tend to be long, ugly, annoying, &etc; A basic
1046 message on dalnet looks like:</para>
1047
1048 <screen>*** Notice -- Received KILL message for
1049 BOBO!ANDY@line82-basel.datacomm.ch from NickServ
1050 Path: empire.ny.us.dal.net[209.51.168.14]!trapdoor.ca.us.dal.net
1051 [206.86.127.252]!caris.ca.us.dal.net[208.1.222.221]
1052 !services.dal.net[2008.1.222.222]!services.dal.net
1053 (NickServ Enforcement)</screen>
1054
1055 <para>When you're <literal>+s</literal> you get tons of them; you don't
1056 want all of them flying across your screen.  I'm going to make 3 rules
1057 to deal with them one bit at a time.  You could do it in less rules, but
1058 it'll show you the basic rule structure, in nice steps, and how to use
1059 multiple rules to parse a message.  The first step is to remove the
1060 Path: portion of the message:</para>
1061
1062 <screen>Match: ^\*\*\*.* KILL message for.*
1063 From:  Path: \S+
1064 To: .</screen>
1065
1066
1067 <para>Match looks for the message starting with <literal>***</literal>,
1068 the <literal>*</literal>'s have to be quoted with <literal>\</literal>
1069 since by themselves they mean 0 or more of the prior character.
1070 <literal>.*</literal> means: match anything until you find <literal>
1071 KILL message for</literal>.  This allows us to avoid typing in
1072 <literal>-- Received...</literal> &etc; The trailing
1073 <literal>.*</literal> means: match anything to the end of the line. (not
1074 needed, I think)</para>
1075
1076 <para>The From line means: substitute " Path: " and any
1077 non-whitespace characters with the To.  To is a <literal>"."</literal>
1078 therefore the entire path turns into a single period.</para>
1079
1080 <para>The message now looks like:</para>
1081
1082 <screen>*** Notice -- Received KILL message for BOBO!ANDY@line82-basel.datacomm.ch
1083 from NickServ. (NickServ Enforcement)</screen>
1084
1085 <para>Notice the new <literal>"."</literal> after
1086 <literal>NickServ</literal>?</para>
1087 </listitem>
1088
1089 <listitem>
1090 <para>Ok, the message is a lot cleaner, but KILLs from nickserv aren't
1091 really that important, so let's forward them to the
1092 <literal>!discard</literal> window.</para>
1093
1094 <screen>Match: ^\*\*\*.*KILL message.*\(NickServ Enforcement\)
1095 From: ^(?:&tilde;\S+&tilde;)
1096 To:  &tilde;!discard&tilde;</screen>
1097
1098 <para>Match rule searches for the KILL message and makes sure it's from
1099 NickServ.  Notice the <literal>\(</literal> and <literal>\)</literal>
1100 are both used in regex, therefore we have to quote
1101 them.  This is very similar to what we said two examples before.</para>
1102
1103 </listitem>
1104 <listitem>
1105 <para>We've now filtered out all the nickserv kills, but the message is
1106 still pretty hard to read by simply glancing at it.  So let's reorder it
1107 to something like:</para>
1108
1109 <screen>*** [KILL] <replaceable>KILLER</replaceable>; killed <replaceable>KILLED</replaceable>; (<replaceable>REASON</replaceable>)</screen>
1110
1111 <screen>Match: \*\*\*.*KILL message
1112 From: \*\*\*.*for (.*?) from (.*?)\. \((.*?)\).*
1113 To: *** [KILL] $$2 killed $$1 ($$3)
1114 </screen>
1115
1116 <para>Ok, the match looks for
1117 <literal>***<replaceable>something</replaceable> KILL message</literal>.
1118 We can't use <literal>&circ;</literal> since we may have just appended
1119 <literal>&tilde;&lt;window&gt;&tilde;</literal>.</para>
1120
1121 <para>The from line gets a little more interesting. The <literal>"for
1122 (.*?) "</literal> looks for the word "for" then some text.
1123 <literal>.*?</literal> means: match zero or more of anything except
1124 newline, but isn't greedy. The rule is to stop when the first terminating condition is
1125 found, not the last. In other words it matches anything until a space is encountered.
1126 The surrounding <literal>()</literal> means: save the contents.  Each
1127 () saves the matched data in <literal>$&num;</literal> where
1128 <literal>&num;</literal> starts at 1 for the first substring, &etc;  In
1129 this case, <varname>$1</varname> gets the nick/user-info of the person
1130 killed. <varname>$2</varname> is then filled with the name of the
1131 killer. Between the <literal>()</literal> we have the reason for the
1132 kill. Here the <literal>(</literal> and <literal>\(</literal> get a
1133 little confusing.  Remember <literal>\(</literal> matches the actual
1134 character <literal>'('</literal>.</para>
1135
1136 </listitem>
1137 <listitem>
1138 <para>How to colorize your life.</para>
1139
1140 <para>Ok, you want to add some color to
1141 &ksirc;.  See the <link linkend="sectcolors">Colors section</link> for
1142 color info, but here's a filter rule to highlight the nickname between
1143 <literal>&lt;NICK&gt;</literal> on each line: </para>
1144
1145 <screen>Match: ^(?:&tilde;\S+&tilde;)&lt;\S+&gt;
1146 From: &lt;(\S+)&gt;
1147 To: &lt;&tilde;4$$1&tilde;c&gt;</screen>
1148
1149 <para>Takes the nickname and adds color &num;4 between the two
1150 <literal>&lt;&gt;</literal>. <literal>&tilde;c</literal> clears the color.</para>
1151
1152 </listitem>
1153 </orderedlist>
1154
1155 </sect1>
1156 </chapter>
1157
1158 <chapter id="keys">
1159 <title>Keys</title>
1160
1161 <para>This is a listing of the shortcut and command keys available
1162 under &ksirc;.</para>
1163
1164 <table>
1165 <title>Keybindings</title>
1166 <tgroup cols="2">
1167 <thead>
1168 <row>
1169 <entry>Keybinding</entry>
1170 <entry>Action</entry>
1171 </row>
1172 </thead>
1173
1174 <tbody>
1175
1176 <row>
1177 <entry><keycombo
1178 action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry>
1179 <entry>Open a new Channel/Query Window.</entry>
1180 </row>
1181
1182 <row>
1183 <entry><keycombo
1184 action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry>
1185 <entry>Quit</entry>
1186 </row>
1187
1188 <row>
1189 <entry><keycombo
1190 action="simul">&Ctrl;<keycap>Enter</keycap></keycombo></entry>
1191 <entry>Begin a message to the most recent person to send you a
1192 message.</entry>
1193 </row>
1194
1195 <row>
1196 <entry><keycombo
1197 action="simul">&Ctrl;&Shift;<keycap>Enter</keycap></keycombo></entry>
1198 <entry>Begin a message to the last-but-one person to send you a
1199 message.</entry>
1200 </row>
1201
1202 <row>
1203 <entry><keycombo
1204 action="simul">&Ctrl;<keycap>K</keycap></keycombo></entry>
1205 <entry>Start color code with a number. Text you type after this will be
1206 colored.</entry>
1207 </row>
1208
1209 <row>
1210 <entry><keycombo
1211 action="simul">&Ctrl;<keycap>U</keycap></keycombo></entry>
1212 <entry>Begin or end underlining text. Text after the first occurrence
1213 of this will be underlined until you type the shortcut again.</entry>
1214 </row>
1215
1216 <row>
1217 <entry><keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo></entry>
1218 <entry>Begin or end italic text. Text after the first occurrence
1219 of this will be italic until you type the shortcut again.</entry>
1220 </row>
1221
1222 <row>
1223 <entry><keycombo action="simul">&Ctrl;<keycap>B</keycap>
1224 </keycombo></entry>
1225 <entry>Begin or end bold text. Text after the first occurrence
1226 of this will be bold until you type the shortcut again.</entry>
1227 </row>
1228
1229 <row>
1230 <entry><keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo></entry>
1231 <entry>Begin or end reverse video text.  Text after the first occurrence
1232 of this will be reversed  until you type the shortcut again.</entry>
1233 </row>
1234
1235 <row>
1236 <entry><keycap>TAB</keycap></entry>
1237 <entry>Tries to complete the nickname of someone on the channel, based
1238 on the text you entered. You are probably familiar with this from your
1239 commandline shell, although it does not necessarily work in exactly the same
1240 way. See <xref linkend="nick-completion"/>.</entry>
1241 </row>
1242
1243 </tbody>
1244 </tgroup>
1245 </table>
1246
1247 </chapter>
1248
1249 <!-- annma: chapter title not good-->
1250 <chapter id="tips">
1251 <title>Tips</title>
1252
1253 <sect1 id="kde-channels">
1254 <title>Joining &kde; channels</title>
1255
1256 <para>
1257 &kde; &irc; channel are hosted on the Freenode network. Use the <guilabel>Server/Channel</guilabel> tab or the
1258 <guilabel>Auto Connect</guilabel> tab in <guilabel>Configure KSirc</guilabel> to add these channels. The network
1259 should be <userinput><systemitem class="domainname">irc.freenode.org</systemitem></userinput> on port <userinput>6667</userinput>. Below are listed the most
1260 important &kde; channels and their goals. Choose the channels you are
1261 interested in.
1262 </para>
1263
1264 <para>You can find some tips about asking questions on &kde; channels on
1265 the <ulink
1266 url="http://wiki.kde.org/tiki-index.php?page=Asking+Questions">&kde;
1267 community wiki</ulink>.
1268 </para>
1269
1270 <table>
1271   <title>KDE IRC channels</title>
1272   <tgroup cols="2">
1273     <thead>
1274       <row>
1275         <entry>Channel</entry>
1276         <entry>Target</entry>
1277       </row>
1278     </thead>
1279 <tbody>
1280  <row>
1281    <entry>#kde</entry>
1282    <entry>User help</entry>
1283  </row>
1284  <row>
1285    <entry>#kde-devel</entry>
1286    <entry>&kde; development</entry>
1287  </row>
1288  <row>
1289    <entry>#kdevelop</entry>
1290    <entry>KDevelop questions</entry>
1291  </row>
1292  <row>
1293    <entry>#kontact</entry>
1294    <entry><application>Kontact</application> (&kmail;, &korganizer;, &knotes;, ...)  related questions</entry>
1295  </row>
1296  <row>
1297    <entry>#amarok</entry>
1298    <entry>Community channel about <application>amaroK</application>: user questions, development</entry>
1299  </row>
1300  <row>
1301    <entry>#debian-kde</entry>
1302    <entry>Debian KDE related questions</entry>
1303  </row>
1304  <row>
1305    <entry>#kde-freebsd</entry>
1306    <entry>FreeBSD KDE related questions</entry>
1307  </row>
1308 </tbody>
1309 </tgroup>
1310 </table>
1311 </sect1>
1312
1313 <sect1 id="autoidentify">
1314 <title>Auto identify</title>
1315
1316 <para>If you intend to use &irc; on a regular basis you will probably
1317 want to register your nickname. This protects your nickname so that
1318 only you can use it. On DALnet, after you log on, you register your
1319 nickname using the command <userinput><command>/msg</command>
1320 nickserv register <replaceable>PASSWORD</replaceable></userinput>,
1321 where  <replaceable>PASSWORD</replaceable> is your password. You'll get a
1322 confirmation your nickname has been registered.
1323 </para>
1324
1325 <para>
1326 Then each time you log on to DALnet you get a message asking you to
1327 identify yourself. You will then need to type
1328 <userinput><command>/msg nickserv identify
1329 <replaceable>PASSWORD</replaceable></command></userinput>.
1330 </para>
1331
1332 <para>
1333 &ksirc; can identify you automatically when you log into any
1334 channel. You simply need to add the following Perl script in your home
1335 directory:
1336 </para>
1337
1338 <para>
1339 The following script will work on Freenode. This script should be
1340 saved as <filename>.sircrc.pl</filename> in your home
1341 directory. When you run &ksirc;, this script will automatically have
1342 you identified.
1343 </para>
1344
1345 <programlisting>
1346 sub hook_nick_notice {
1347 my $n = shift;
1348 my $m = shift;
1349
1350
1351 if($who =~ /NickServ/){
1352 if($m =~ /If this is your nickname/){
1353 $silent = 1;
1354 &amp;msg("nickserv", "identify <replaceable>XXXXXX</replaceable>");
1355 $silent = 0;
1356 }
1357 }
1358 }
1359 &amp;addhook("notice", "nick_notice");   # join on the "end of MOTD" numeric
1360 </programlisting>
1361 <para>
1362 Replace <replaceable>XXXXXX</replaceable> with your password.
1363 </para>
1364
1365 <para>
1366 The above script will work on other networks than Freenode where
1367 nickserv sends you the request "identify" but on some networks like
1368 Undernet you will need the following script:
1369 </para>
1370
1371 <programlisting>
1372 sub hook_connected {
1373 if($server =~ /undernet.org$/){
1374         &amp;msg("X\@channels.undernet.org", "login <replaceable>YOUR_NAME</replaceable> <replaceable>XXXX</replaceable>");
1375                 &amp;docommand("umode +x");
1376 }
1377 }
1378 &amp;addhook("255", "connected");   # join on the "end of MOTD" numeric
1379 </programlisting>
1380
1381 <para>
1382 Replace <replaceable>YOUR_NAME</replaceable> with your login name and
1383 <replaceable>XXXXXX</replaceable> with your password.
1384 </para>
1385
1386 <para>
1387   You can find more about SIRC programming on this page: <ulink
1388   url="http://www.iagora.com/~espel/sirc/PROGRAMMING">http://www.iagora.com/~espel/sirc/PROGRAMMING</ulink>
1389 </para>
1390 </sect1>
1391 </chapter>
1392 <!-- end annma -->
1393
1394 <chapter id="credits-and-license">
1395 <title>Credits and Licenses</title>
1396
1397 <para>&ksirc; copyright 1997-2002, the &ksirc; developers.</para>
1398
1399 <para>Portions of documentation copyright 1997, &Andrew.Stanley-Jones;</para>
1400
1401 <para>Documentation updated for &kde; 3.0 by &Philip.Rodrigues;
1402 &Philip.Rodrigues.mail;.</para>
1403
1404 <para><xref linkend="tips"/> was written by &Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail;.</para>
1405 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
1406
1407 &underFDL;
1408 &underGPL;
1409
1410 </chapter>
1411
1412 <appendix id="installation">
1413 <title>Installation</title>
1414
1415 <sect1 id="getting-ksirc">
1416 <title>Where to get &ksirc;</title>
1417
1418 &install.intro.documentation;
1419
1420 </sect1>
1421
1422
1423 <sect1 id="compilation">
1424 <title>Compilation and Installation</title>
1425
1426 &install.compile.documentation;
1427
1428 </sect1>
1429 </appendix>
1430
1431 &documentation.index;
1432
1433 </book>
1434
1435 <!--
1436 Local Variables:
1437 mode: sgml
1438 sgml-omittag: nil
1439 sgml-shorttag: t
1440 sgml-indent-step: nil
1441 End:
1442 -->
1443
1444
1445
1446