runtime/doc/kcontrol/index.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
   3 "dtd/kdex.dtd" [
   4 <!ENTITY % addindex "IGNORE">
   5 <!ENTITY % English "INCLUDE" > <!-- change language only here -->
   6 ]>
   7
   8 <book lang="&language;">
   9 <bookinfo>
  10 <title>The &kcontrolcenter;</title>
  11
  12 <authorgroup>
  13 <author>&Mike.McBride; &Mike.McBride.mail;</author>
  14 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  15 </authorgroup>
  16
  17 <legalnotice>&FDLNotice;</legalnotice>
  18
  19 <date>2005-03-05</date>
  20 <releaseinfo>3.4.0</releaseinfo>
  21
  22 <abstract>
  23 <para>This documentation describes &kde;'s control center.</para>
  24 </abstract>
  25
  26 <keywordset>
  27 <keyword>KDE</keyword>
  28 <keyword>kcontrol</keyword>
  29 <keyword>configuration</keyword>
  30 <keyword>settings</keyword>
  31 <keyword>module</keyword>
  32 </keywordset>
  33
  34 </bookinfo>
  35
  36 <chapter id="introduction">
  37 <title>The &kcontrolcenter;</title>
  38
  39 <para>
  40 The &kcontrolcenter; (from now on referred to simply as <quote>the
  41 control center</quote>) provides you with a centralized and convenient
  42 way to configure all of your &kde; settings.
  43 </para>
  44
  45 <para>
  46 The control center is made up of multiple modules.  Each module is a
  47 separate application, but the control center organizes all of these
  48 programs into a convenient location.
  49 </para>
  50
  51 <tip>
  52 <para>
  53 Each control center module can be executed individually
  54 </para>
  55
  56 <para>
  57 See section entitled <link linkend="control-center-run-indiv">Running
  58 individual control center modules</link> for more information.
  59 </para>
  60 </tip>
  61
  62 <para>
  63 The control center groups the configuration modules into categories, so
  64 they are easy to locate.  Within each category, the control center shows
  65 all the modules in a list, so it is easier to find the right
  66 configuration module.
  67 </para>
  68 </chapter>
  69
  70 <chapter id="control-center">
  71 <title>Using the &kcontrolcenter;</title>
  72
  73 <para>
  74 This next section details the use of the control center itself.  For
  75 information on individual modules, please see <link linkend="module">Control
  76 Center Modules</link>
  77 </para>
  78
  79 <sect1 id="control-center-starting">
  80 <title>Starting the &kcontrol;</title>
  81
  82 <para>The &kcontrolcenter; can be started in 3 ways:
  83 </para>
  84
  85 <orderedlist>
  86 <listitem>
  87 <para>
  88 By selecting <menuchoice><guimenu>K Button</guimenu><guimenuitem>Control
  89 Center</guimenuitem></menuchoice> from the &kde; Panel.
  90 </para>
  91 </listitem>
  92 <listitem>
  93 <para>
  94 By pressing <keycombo
  95 action="simul">&Alt;<keycap>F2</keycap></keycombo>.
  96 </para>
  97
  98 <para>
  99 This will bring up a dialog box.  Type
 100 <userinput><command>kcontrol</command></userinput>, and click
 101 <guibutton>Run</guibutton>.
 102 </para>
 103 </listitem>
 104
 105 <listitem>
 106 <para>
 107 You can type <command>kcontrol &amp;</command> at any command prompt.
 108 </para>
 109 </listitem>
 110 </orderedlist>
 111
 112 <para>
 113 All three of these methods are equivalent, and produce the same result.
 114 </para>
 115
 116 </sect1>
 117
 118 <sect1 id="control-center-screen">
 119 <title>The &kcontrolcenter; Screen</title>
 120
 121 <para>
 122 When you start the control center, you are presented with a window,
 123 which can be divided into 3 functional parts.
 124 </para>
 125
 126 <screenshot>
 127 <screeninfo>Screenshot</screeninfo>
 128 <mediaobject>
 129 <imageobject> <imagedata fileref="screenshot.png" format="PNG"/>
 130 </imageobject>
 131 <textobject> <phrase>Screenshot</phrase> </textobject>
 132 <caption>
 133 <para>The &kde; Control Center Screen</para>
 134 </caption>
 135 </mediaobject>
 136 </screenshot>
 137
 138 <para>
 139 Across the top is a menubar.  The menubar will provide you with quick
 140 access to most of &kcontrolcenter;'s features.  The menus are detailed in
 141 <link linkend="control-center-menus">The &kde; Control Center
 142 Menus</link>.
 143 </para>
 144
 145 <para>
 146 Along the left hand side, is a icon tree.  Here you can choose which
 147 module to configure.
 148 </para>
 149
 150 <para>
 151 The main panel shows you some system information.
 152 </para>
 153
 154 <para>
 155 In this example, we are running &kde; 3.4.0, we started &kcontrolcenter;
 156 as user <systemitem class="username">newkde</systemitem>, the computer is
 157 named <systemitem class="systemname">turtle</systemitem>, it is a
 158 &Linux; system running the 2.6 kernel, on a i686 processor.
 159 </para>
 160
 161 </sect1>
 162
 163 <sect1 id="control-center-menus">
 164 <title>The &kcontrol; Menus</title>
 165
 166 <para>
 167 This next section gives you a brief description of what each menu item
 168 does.
 169 </para>
 170
 171 <sect2 id="control-center-menu-file">
 172 <title><guimenu>File</guimenu> Menu</title>
 173
 174 <para>
 175 The <guimenu>File</guimenu> menu has a single entry.
 176 </para>
 177
 178 <variablelist>
 179
 180 <varlistentry>
 181 <term><menuchoice>
 182 <shortcut>
 183 <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
 184 </shortcut>
 185 <guimenu>File</guimenu>
 186 <guimenuitem>Quit</guimenuitem>
 187 </menuchoice></term>
 188 <listitem>
 189 <para>
 190 <action>Closes the control center.</action>
 191 </para>
 192 </listitem>
 193 </varlistentry>
 194 </variablelist>
 195
 196 </sect2>
 197
 198 <sect2 id="control-center-menu-view">
 199 <title><guimenu>View</guimenu> Menu</title>
 200
 201 <para>
 202 These options determine how the module selection looks and behaves.
 203 </para>
 204
 205 <variablelist>
 206 <varlistentry>
 207 <term><menuchoice><guimenu>View</guimenu> <guimenuitem>Mode</guimenuitem>
 208 </menuchoice></term>
 209
 210 <listitem>
 211 <para>
 212 Determines whether to use <guimenuitem>Tree</guimenuitem> view,
 213 or <guimenuitem>Icon</guimenuitem> view for your modules.
 214 </para>
 215
 216 <para>
 217 With <guimenuitem>Tree</guimenuitem> view, each submenu appears as an
 218 indented list.
 219 </para>
 220
 221 <para>
 222 With <guimenuitem>Icon</guimenuitem> view, when you click on a category,
 223 the categories disappear and are replaced with the module list.  You
 224 then use the <guiicon>Back</guiicon> button to return to the categories.
 225 </para>
 226 </listitem>
 227 </varlistentry>
 228
 229 <varlistentry>
 230 <term><menuchoice>
 231 <guimenu>View</guimenu><guisubmenu>Icon size</guisubmenu>
 232 </menuchoice></term>
 233
 234 <listitem>
 235 <para>
 236 Using this option, you can choose
 237 <guimenuitem>Small</guimenuitem>, <guimenuitem>Medium</guimenuitem>, or
 238 <guimenuitem>Large</guimenuitem> icons to select your modules.
 239 </para>
 240
 241 <note><para>
 242 This menu item only controls the icon size if you are in
 243 <guimenuitem>Icon View</guimenuitem>.  If you choose
 244 <guimenuitem>Tree View</guimenuitem>, the <guimenuitem>Small</guimenuitem>
 245 icon size will be used, no matter what size was previously selected in
 246 <guimenuitem>Icon View</guimenuitem>.
 247 </para>
 248 </note>
 249 </listitem>
 250
 251 </varlistentry>
 252 </variablelist>
 253 </sect2>
 254
 255 <sect2 id="control-center-menu-settings">
 256 <title><guimenu>Settings</guimenu> Menu</title>
 257
 258 <para>
 259  The <guimenu>Settings</guimenu> menu has a single entry,
 260 <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice>. From here you can map keyboard shortcuts to the
 261 other menu options.
 262 </para>
 263
 264 </sect2>
 265
 266 <sect2 id="control-center-menu-help">
 267 <title><guimenu>Help</guimenu> Menu</title>
 268
 269 &help.menu.documentation;
 270
 271 </sect2>
 272
 273 </sect1>
 274
 275 <sect1 id="control-center-exiting">
 276 <title>Exiting The &kde; Control Center</title>
 277
 278 <para>
 279 You can exit the control center one of three ways:
 280 </para>
 281
 282 <itemizedlist>
 283 <listitem>
 284 <para>
 285 Select <menuchoice><guimenu>File</guimenu>
 286 <guimenuitem>Quit</guimenuitem></menuchoice> from the menu bar.
 287 </para>
 288 </listitem>
 289
 290 <listitem>
 291 <para>Type <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
 292 on the keyboard.
 293 </para>
 294 </listitem>
 295
 296 <listitem>
 297 <para>
 298 Click on the <guiicon>Close</guiicon> button on the frame surrounding
 299 the control center.
 300 </para>
 301 </listitem>
 302 </itemizedlist>
 303
 304 </sect1>
 305
 306 <sect1 id="control-center-run-indiv">
 307 <title>Running Individual Modules</title>
 308
 309 <para>
 310 You can run individual modules without running kcontrol using the command <command>kcmshell</command> from &konsole;. Type <userinput> <command>kcmshell</command><option> --list</option></userinput> to see a list of the available &kcontrolcenter; modules. You can also access individual &kcontrol; modules through adding the <guilabel>Preferences</guilabel> button to either &kicker; or the &kmenu; through their respective configuration dialogs.
 311 </para>
 312
 313 </sect1>
 314
 315 </chapter>
 316
 317 <!--*****************************************************************-->
 318
 319 <chapter id="module">
 320 <title>The &kcontrol; Modules</title>
 321
 322 <para>
 323 In order to make it as easy as possible, the &kcontrol; has organized
 324 similar options into groups.  Each group is called a module.  When you
 325 click on the name of a module in the left window, you will be presented
 326 with the options of the module on the right.
 327 </para>
 328
 329 <para>
 330 Each module will have some or all of the following buttons:
 331 </para>
 332
 333 <variablelist>
 334
 335 <varlistentry>
 336 <term>Help</term>
 337 <listitem>
 338 <para>
 339 This button will give you help specific to the current module.  The
 340 button will show you a short summary help page in the left window.  At
 341 the bottom of that window, you can click on a link to get more detailed
 342 help.
 343 </para>
 344 </listitem>
 345 </varlistentry>
 346
 347 <varlistentry>
 348 <term><guilabel>Defaults</guilabel></term>
 349 <listitem>
 350 <para>
 351 This button will restore this module to its default values.  You must
 352 click <guibutton>OK</guibutton> to save the options.
 353 </para>
 354 </listitem>
 355 </varlistentry>
 356
 357 <varlistentry>
 358 <term><guibutton>Apply</guibutton></term>
 359 <listitem>
 360 <para>
 361 Clicking this button will save all changes to &kde;.  If you have
 362 changed anything, clicking <guibutton>Apply</guibutton> will cause the
 363 changes to take effect.
 364 </para>
 365 </listitem>
 366 </varlistentry>
 367
 368 <varlistentry>
 369 <term><guibutton>Reset</guibutton></term>
 370 <listitem>
 371 <para>
 372 This button will <quote>Reset</quote> the module to the previous settings.
 373 </para>
 374 </listitem>
 375 </varlistentry>
 376
 377 </variablelist>
 378
 379 <note>
 380 <para>
 381 You must save the options of the current module using
 382 <guibutton>Apply</guibutton> before you can change to a different
 383 module.
 384 </para>
 385 <para>
 386 If you try to change without saving your options, you will be asked if
 387 you want to save your changes, or discard them.
 388 </para>
 389 </note>
 390 </chapter>
 391 <!--
 392       Commented until fixed arrangement is made
 393 <sect1 id="module-intro">
 394 <title>Navigating Modules</title>
 395
 396 <para>
 397 This is a list of the <emphasis>standard</emphasis> configuration
 398 modules (sorted by category) provided by the <application
 399 role="package">KDE base</application> package. Please note that there
 400 may be many more modules on your system if you have installed additional
 401 software.
 402 </para>
 403
 404 <variablelist>
 405 <varlistentry>
 406 <term>File Browsing</term>
 407 <listitem>
 408 <para>
 409 <link linkend="file-assoc">File Associations</link>,
 410 <link linkend="file-manager">File Manager</link>,
 411 </para>
 412 </listitem>
 413 </varlistentry>
 414
 415 <varlistentry>
 416 <term>Look and Feel</term>
 417 <listitem>
 418 <para>
 419 <link linkend="background">Background</link>,
 420 <!- - <link linkend="borders">Borders</link>,- ->
 421 <link linkend="color">Colors</link>,
 422 <link linkend="desktop">Desktop</link>,
 423 <link linkend="fonts">Fonts</link>,
 424 <link linkend="icons">Icons</link>,
 425 <!- -  <link linkend="iconstyle">Icon Style</link>, - ->
 426 <link linkend="key-bindings">Key Bindings</link>,
 427 <link linkend="launch-feedback">Launch feedback</link>,
 428 <link linkend="panel">Panel</link>,
 429 <link linkend="screensaver">Screensaver</link>,
 430 <link linkend="style">Style</link>,
 431 <link linkend="sys-notify">System Notifications</link>,
 432 <link linkend="taskbar">Taskbar</link>,
 433 <link linkend="theme-manager">Theme Manager</link>,
 434 <!- - <link linkend="numbername">Virtual Desktops</link>,- ->
 435 <link linkend="window-behavior">Window Behavior</link>,
 436 <link linkend="window-deco">Window Decoration</link>.
 437 </para>
 438 </listitem>
 439 </varlistentry>
 440
 441 <varlistentry>
 442 <term>Network</term>
 443 <listitem>
 444 <para>
 445 <link linkend="e-mail">E-Mail</link>,
 446 <link linkend="lan-browsing">LAN Browsing</link>,
 447 <link linkend="timeouts">Preferences</link>, <!- - FIXME - ->
 448 <link linkend="socks">SOCKS</link>,
 449 <link linkend="talk">Talk Configuration</link>
 450 <link linkend="windows-shares">Windows Shares</link>
 451 </para>
 452 </listitem>
 453 </varlistentry>
 454
 455 <varlistentry>
 456 <term>Peripherals</term>
 457 <listitem>
 458 <para>
 459 <link linkend="kbd">Keyboard</link>,
 460 <link linkend="mouse">Mouse</link>
 461 </para>
 462 </listitem>
 463 </varlistentry>
 464
 465 <varlistentry>
 466 <term>Personalization</term>
 467 <listitem>
 468 <para>
 469 <link linkend="accessibility">Accessibility</link>,
 470 <link linkend="locale">Country &amp; Language</link>,
 471 <link linkend="crypto">Crypto</link>,
 472 <!- - <link linkend="kblayout">Keyboard Layout</link>, - ->
 473 <link linkend="passwords">Passwords</link>
 474 <link linkend="spell-checking">Spell Checking</link>.
 475 </para>
 476 </listitem>
 477 </varlistentry>
 478
 479 <varlistentry>
 480 <term>Power Control</term>
 481 <listitem>
 482 <para>
 483 <link linkend="battery-monitor">Battery Monitor</link>,
 484 <link linkend="energy">Energy</link>,
 485 <link linkend="powerctrl">Laptop Power Control</link>,
 486 <link linkend="lowbatcrit">Low Battery Critical</link>,
 487 <link linkend="lowbatwarn">Low Battery Warning</link>
 488 </para>
 489 </listitem>
 490 </varlistentry>
 491
 492 <varlistentry>
 493 <term>Sound</term>
 494 <listitem>
 495 <para>
 496 <link linkend="midi">Midi</link>,
 497 <link linkend="mixer">Mixer</link>,
 498 <link linkend="sndserver">Sound Server</link>,
 499 <link linkend="bell">System Bell</link>
 500 </para>
 501 </listitem>
 502 </varlistentry>
 503
 504 <varlistentry>
 505 <term>System</term>
 506 <listitem>
 507 <para>
 508 <link linkend="datetime">Date and Time</link>,
 509 <link linkend="konsole">&konsole;</link>,
 510 <link linkend="login-manager">Login Manager</link>,
 511 <link linkend="print-manager">Printing Manager</link>,
 512 <link linkend="sessions">Session Manager</link>,
 513 </para>
 514 </listitem>
 515 </varlistentry>
 516
 517 <varlistentry>
 518 <term>Web Browsing</term>
 519 <listitem>
 520 <para>
 521 <link linkend="cookie">Cookies</link>,
 522 <link linkend="ebrowse">Enhanced Browsing</link>,
 523 <link linkend="konq-browsing">Konqueror Browser</link>,
 524 <link linkend="nsplugins">Netscape Plugins</link>,
 525 <link linkend="proxies">Proxies &amp; Cache</link>,
 526 <link linkend="stylesheets">Stylesheets</link>,
 527 <link linkend="user-agent">User Agent</link>,
 528 </para>
 529 </listitem>
 530 </varlistentry>
 531
 532 </variablelist>
 533 </sect1>
 534 </chapter>
 535 -->
 536
 537 <!-- commenting this section out until I figure out what to do with it :)
 538 <chapter id="laptop">
 539 <title>Laptop Modules Notes</title>
 540
 541 <para>
 542 In order to use the laptop modules, you must have the kernel
 543 <acronym>APM</acronym> package installed in your kernel.  Useful information
 544
 545 on
 546 how to do this can be found at
 547 <ulink url="http://www.cs.utexas.edu/users/kharker/linux-laptop/apm.html">
 548 http://www.cs.utexas.edu/users/kharker/linux-laptop/apm.html</ulink> and
 549 in the Battery Powered Linux mini-HOWTO at <ulink
 550 url="http://metalab.unc.edu/LDP/HOWTO/mini/Battery-Powered.html">
 551 http://metalab.unc.edu/LDP/HOWTO/mini/Battery-Powered.html</ulink>.
 552 </para>
 553
 554 <para>
 555 If you want the <guimenuitem>suspend</guimenuitem> and
 556 <guimenuitem>standby</guimenuitem> menu commands to work then you should
 557 install the &Linux; <application>apmd</application> package (version 2.4
 558 or later). If you want to use them from non-root accounts you must mark
 559 the <application>apm</application> command <quote>set uid root</quote>.
 560 </para>
 561
 562 <para>
 563 To do this, log on as <systemitem class="username">root</systemitem> and
 564 enter:
 565 </para>
 566
 567 <screen>
 568 <prompt>%</prompt><userinput><command>chown</command> <option>root
 569 /usr/bin/apm</option>;<command>chmod</command> <option>+s
 570 /usr/bin/apm</option></userinput>
 571 </screen>
 572
 573 <warning>
 574 <para>
 575 By doing this you will allow any user of your system to put it into suspend
 576 or
 577 standby states - if you are the only user, this should not be a problem.
 578 </para>
 579
 580 <para>
 581 Also note that any program which has <systemitem
 582 class="username">root</systemitem> access, can be a potential security
 583 problem.  You should carefully determine if there are any security
 584 concerns <emphasis>before</emphasis> giving any program <systemitem
 585 class="username">root</systemitem> permissions.
 586 </para>
 587 </warning>
 588 </chapter>
 589 -->
 590
 591 <chapter id="credits">
 592 <title>Credits and License</title>
 593
 594 <para>&kcontrol;</para>
 595 <para>Program copyright 1997-2001 The &kcontrolcenter; Developers</para>
 596 <para>Contributors:</para>
 597
 598 <itemizedlist>
 599 <listitem><para>Matthias Hoelzer-Kluepfel
 600 <email>hoelzer@kde.org</email></para></listitem>
 601 <listitem><para>Matthias Elter
 602 <email>elter@kde.org</email></para></listitem>
 603 </itemizedlist>
 604
 605 <para>Documentation <trademark class="copyright">copyright 2000 Michael
 606 McBride</trademark> <email>mpmcbride7@yahoo.com</email></para>
 607
 608 <para>Contributors:</para>
 609
 610 <itemizedlist>
 611 <listitem><para>Paul Campbell <email>paul@taniwha.com</email></para></listitem>
 612 <listitem><para>Helge Deller <email>deller@kde.org</email></para></listitem>
 613 <listitem><para>Mark Donohoe </para></listitem>
 614 <listitem><para>Pat Dowler </para></listitem>
 615 <listitem><para>Duncan Haldane <email>duncan@kde.org</email></para></listitem>
 616 <listitem><para>Steffen Hansen <email>stefh@mip.ou.dk</email>.</para></listitem>
 617 <listitem><para>Matthias Hoelzer-Kluepfel <email>hoelzer@kde.org</email></para></listitem>
 618 <listitem><para>Martin Jones <email>mjones@kde.org</email></para></listitem>
 619 <listitem><para>Jost Schenck <email>jost@schenck.de</email></para></listitem>
 620 <listitem><para>Jonathan Singer <email>jsinger@leeta.net</email></para></listitem>
 621 <listitem><para>Thomas Tanghus <email>tanghus@earthling.net</email></para></listitem>
 622 <listitem><para>Krishna Tateneni <email>tateneni@pluto.njcc.com></email></para></listitem>
 623 <listitem><para>Ellis Whitehead <email>ewhitehe@uni-freiburg.de</email></para></listitem>
 624
 625 </itemizedlist>
 626 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 627
 628 &underFDL;
 629 &underGPL;
 630 </chapter>
 631
 632 </book>
 633
 634 <!--
 635 Local Variables:
 636 mode: sgml
 637 End:
 638 -->
 639