Warning, /plasma/systemsettings/doc/index.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003   <!ENTITY % addindex "IGNORE">
0004   <!ENTITY % English "INCLUDE">
0005 ]>
0006 <book id="systemsettings" lang="&language;">
0007 
0008 <bookinfo>
0009 <title>The &systemsettings; Handbook</title>
0010 
0011 <authorgroup>
0012 <author>
0013 &Richard.Johnson;
0014 &Richard.Johnson.mail;
0015 </author>
0016 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0017 </authorgroup>
0018 
0019 <copyright>
0020 <year>2007</year>
0021 <holder>&Richard.Johnson;</holder>
0022 </copyright>
0023 <legalnotice>&FDLNotice;</legalnotice>
0024 
0025 <date>2021-04-11</date>
0026 <releaseinfo>Plasma 5.20</releaseinfo>
0027 
0028 <abstract>
0029 <para>
0030 This documentation describes system configuration and administration center for your desktop.
0031 </para>
0032 </abstract>
0033 
0034 <keywordset>
0035 <keyword>KDE</keyword>
0036 <keyword>System</keyword>
0037 <keyword>Settings</keyword>
0038 <keyword>configuration</keyword>
0039 <keyword>administration</keyword>
0040 <keyword>config</keyword>
0041 <keyword>admin</keyword>
0042 </keywordset>
0043 
0044 </bookinfo>
0045 
0046 <chapter id="introduction">
0047 <title>Introduction</title>
0048 
0049 <para>
0050 The &systemsettings; provides the user with a centralized and convenient way to configure all of the settings for your desktop.
0051 </para>
0052 
0053 <para>
0054 &systemsettings; is made up of multiple modules. Each module is a separate application, however the &systemsettings; organizes all of these applications into a single location.
0055 </para>
0056 
0057 <tip>
0058 <para>
0059 Each &systemsettings; module can be executed individually
0060 </para>
0061 <para>
0062 See section entitled <link linkend="run-modules-individually">Running
0063 individual &systemsettings; modules</link> for more information.
0064 </para>
0065 </tip>
0066 
0067 <para>
0068 &systemsettings; groups all of the configuration modules into several categories:
0069 <itemizedlist>
0070 <listitem><para><link linkend="appearance">Appearance</link></para></listitem>
0071 <listitem><para><link linkend="workspace">Workspace</link></para></listitem>
0072 <listitem><para><link linkend="personalization">Personalization</link></para></listitem>
0073 <listitem><para><link linkend="network">Network</link></para></listitem>
0074 <listitem><para><link linkend="hardware">Hardware</link></para></listitem>
0075 <listitem><para><link linkend="system_administration">System Administration</link></para></listitem>
0076 </itemizedlist>
0077 </para>
0078 
0079 <para>
0080 The modules that make up &systemsettings; fall under one of the above categories, making it easier to locate the correct configuration module.
0081 </para>
0082 
0083 </chapter>
0084 
0085 <chapter id="using-kapp">
0086 <title>Using &systemsettings;</title>
0087 
0088 <para>
0089 This section details the use of &systemsettings; itself. For information on each individual module, please see <link linkend="modules">&systemsettings; Modules</link>.
0090 </para>
0091 
0092 <sect1 id="starting">
0093 <title>Starting &systemsettings;</title>
0094 
0095 <para>
0096 The &systemsettings; can be started in one of three ways:
0097 </para>
0098 
0099 <orderedlist>
0100 <listitem>
0101 <para>
0102 By selecting <menuchoice><guimenu>Settings</guimenu><guimenuitem>System Settings</guimenuitem></menuchoice> from the <guilabel>Application Menu</guilabel>.
0103 </para>
0104 </listitem>
0105 <listitem>
0106 <para>
0107   By pressing <keycombo>&Alt;<keycap>F2</keycap></keycombo> or <keycombo>&Alt;<keycap>Space</keycap></keycombo>. This will bring up the &krunner; dialog. Type <command>systemsettings</command>, and press &Enter;.
0108 </para>
0109 </listitem>
0110 <listitem>
0111 <para>
0112 Type <command>systemsettings &amp;</command> at any command prompt.
0113 </para>
0114 </listitem>
0115 </orderedlist>
0116 
0117 <para>
0118 All three of these methods are equivalent, and produce the same result.
0119 </para>
0120 </sect1>
0121 
0122 <sect1 id="screen">
0123 <title>The &systemsettings; Screen</title>
0124 
0125 <para>
0126 When you start &systemsettings;, you are presented with a window, which is divided into two functional parts.
0127 </para>
0128 
0129 <para>
0130 Across the top is a toolbar. The toolbar provides the user with the ability to go back into the main view from within a module using <guibutton>All Settings</guibutton>.
0131 You can also find a <guimenu>Help</guimenu> menu as well as a <guibutton>Configure</guibutton> button which provides you a dialog with alternate view settings.
0132 </para>
0133 <para>To search for something within all of the modules, start to type keywords into the search field at the right of the toolbar in the <guibutton>All Settings</guibutton> view. When you start typing, a list of matching topics will popup. Select one and only the groups with settings for this  keyword are enabled, the other are greyed out.</para>
0134 <para>When the icon window has the focus, you can type the first letter of 
0135 any module or module group name to select it. Typing this letter again the 
0136 selection moves to the next match.
0137 </para>
0138 <para>
0139 Underneath the toolbar is an icon view of the individual modules or module groups that 
0140 make up &systemsettings; grouped by different categories. By default, 
0141 if your mouse stays a few seconds over an icon, a tooltip 
0142 appears, either explaining the purpose of the module or showing the modules in this group.
0143 </para>
0144 </sect1>
0145 
0146 <sect1 id="general">
0147 <title>&systemsettings; Categories and Modules</title>
0148 <para>A brief overview of all categories and their modules:</para>
0149 
0150 <variablelist>
0151 <varlistentry id="appearance" >
0152 <term>Appearance</term>
0153 <listitem>
0154 <para><itemizedlist>
0155 <listitem><para>
0156 Global Theme
0157 </para></listitem>
0158 <listitem><para>
0159 Plasma Style
0160 </para></listitem>
0161 <listitem><para>
0162 Application Style (Application Style, Window Decorations)
0163 </para></listitem>
0164 <listitem><para>
0165 Colors
0166 </para></listitem>
0167 <listitem><para>
0168 Font (Fonts, Font Management)
0169 </para></listitem>
0170 <listitem><para>
0171 Icons
0172 </para></listitem>
0173 <listitem><para>
0174 Cursors
0175 </para></listitem>
0176 </itemizedlist></para>
0177 </listitem>
0178 </varlistentry>
0179 
0180 <varlistentry id="workspace" >
0181 <term>Workspace</term>
0182 <listitem>
0183 <para><itemizedlist>
0184 <listitem><para>
0185 Workspace Behavior (General Behavior, Desktop Effects, Screen Edges, Touch Screen, Screen Locking, Virtual Desktops, Activities)
0186 </para></listitem>
0187 <listitem><para>
0188 Window Management (Window Behavior, Task Switcher, KWin Scripts, Window Rules)
0189 </para></listitem>
0190 <listitem><para>
0191 Shortcuts (Shortcuts, Custom Shortcuts)
0192 </para></listitem>
0193 <listitem><para>
0194 Startup and Shutdown (Login Screen (SDDM), Autostart, Background Services, Desktop Session, Splash Screen)
0195 </para></listitem>
0196 <listitem><para>
0197 Search (File Search, Krunner, Web Search Keywords)
0198 </para></listitem>
0199 </itemizedlist></para>
0200 </listitem>
0201 </varlistentry>
0202 
0203 <varlistentry id="personalization" >
0204 <term>Personalization</term>
0205 <listitem>
0206 <para><itemizedlist>
0207 <listitem><para>
0208 Notifications
0209 </para></listitem>
0210 <listitem><para>
0211 Users
0212 </para></listitem>
0213 <listitem><para>
0214 Regional Settings (Language, Formats, Spell Check, Date &amp; Time)
0215 </para></listitem>
0216 <listitem><para>
0217 Accessibility
0218 </para></listitem>
0219 <listitem><para>
0220 Applications (Default Applications, File Associations, Locations, Launch Feedback)
0221 </para></listitem>
0222 <listitem><para>
0223 KDE Wallet
0224 </para></listitem>
0225 <listitem><para>
0226 Online Accounts
0227 </para></listitem>
0228 <listitem><para>
0229 User Feedback
0230 </para></listitem>
0231 </itemizedlist></para>
0232 </listitem>
0233 </varlistentry>
0234 
0235 <varlistentry id="network" >
0236 <term>Network</term>
0237 <listitem>
0238 <para><itemizedlist>
0239 <listitem><para>
0240 Settings (Proxy, Connection Preferences, SSL Preferences, Cache, Cookies, Browser Identification, Windows Shares)
0241 </para></listitem>
0242 </itemizedlist></para>
0243 </listitem>
0244 </varlistentry>
0245 
0246 <varlistentry id="hardware" >
0247 <term>Hardware</term>
0248 <listitem>
0249 <para><itemizedlist>
0250 <listitem><para>
0251 Input Devices (Keyboard, Mouse, Game Controller, Graphic Tablet, Touchpad)
0252 </para></listitem>
0253 <listitem><para>
0254 Display and Monitor (Display Configuration, Compositor, Gamma, Night Color)
0255 </para></listitem>
0256 <listitem><para>
0257 Audio
0258 </para></listitem>
0259 <listitem><para>
0260 Multimedia (Audio CDs, CDDB Retrieval)
0261 </para></listitem>
0262 <listitem><para>
0263 Power Management (Energy Saving, Activity Settings, Advanced Settings)
0264 </para></listitem>
0265 <listitem><para>
0266 Bluetooth
0267 </para></listitem>
0268 <listitem><para>
0269 Removable Storage (Device Actions, Digital Camera, Removable Devices)
0270 </para></listitem>
0271 </itemizedlist></para>
0272 </listitem>
0273 </varlistentry>
0274 
0275 <varlistentry id="system_administration" >
0276 <term>System Administration</term>
0277 <listitem>
0278 <para><itemizedlist>
0279 <listitem><para>
0280 System Information
0281 </para></listitem>
0282 </itemizedlist></para>
0283 </listitem>
0284 </varlistentry>
0285 
0286 </variablelist>
0287 
0288 <tip><para>Use the search field at the top right in <guibutton>All Settings</guibutton> view to find all matching modules for a given keyword.
0289 Start typing a keyword opens a list of keywords and only the matching modules are enabled.</para></tip>
0290 </sect1>
0291 <sect1 id="exiting">
0292 <title>Exiting the &systemsettings;</title>
0293 
0294 <para>
0295 &systemsettings; can be exited in one of two ways:
0296 </para>
0297 
0298 <orderedlist>
0299 <listitem>
0300 <para>
0301 Press <keycombo>&Ctrl;<keycap>Q</keycap></keycombo> on the keyboard.
0302 </para>
0303 </listitem>
0304 <listitem>
0305 <para>
0306 Click on the <guibutton>Close</guibutton> button located in the toolbar.
0307 </para>
0308 </listitem>
0309 </orderedlist>
0310 </sect1>
0311 
0312 <sect1 id="configuring">
0313 <title>Configuring &systemsettings;</title>
0314 
0315 <para>
0316 The <guiicon>Configure</guiicon> icon in the toolbar allows you to change some &systemsettings; parameters.
0317 You can change from <guilabel>Icon View</guilabel> (default view) to <guilabel>Sidebar View</guilabel>.
0318 In <guilabel>Sidebar View</guilabel> mode, the welcome page shows the frequently used modules
0319 for quick access.
0320 </para>
0321 
0322 <para>
0323 You can also turn off the detailed tooltips by unchecking <guilabel>Show detailed tooltips</guilabel>. 
0324 You will then get only normal tooltips and not the content of a module group.
0325 </para>
0326 
0327 </sect1>
0328 
0329 <sect1 id="run-modules-individually">
0330 <title>Running Individual &systemsettings; Modules</title>
0331 
0332 <para>
0333 Individual modules can be run without running &systemsettings; using the command <command>kcmshell5</command> from the command line. Type <command>kcmshell5 --list</command> to see a list of the available &systemsettings; modules.
0334 </para>
0335 <para>
0336 Additionally you can start KRunner and start type keywords. When you start typing, a list of matching modules prefixed with &systemsettings; will popup.
0337 </para>
0338 </sect1>
0339 </chapter>
0340 
0341 <chapter id="modules">
0342 <title>The &systemsettings; Modules</title>
0343 
0344 <para>
0345 In order to make it as easy as possible, the &systemsettings; has organized options into six categories. Under each category, there are icons grouped together under subcategories. Each icon is called a module. When you double click on a module icon, you will be presented with the options of the module in the main window.
0346 </para>
0347 
0348 <para>
0349 Each module will have some or all of the following buttons:
0350 </para>
0351 
0352 <variablelist>
0353 <varlistentry>
0354 <term>Help</term>
0355 <listitem>
0356 <para>
0357 This button will provide help specific to the current module. Clicking the button will open &khelpcenter; in a new window providing detailed information on the module.
0358 </para>
0359 </listitem>
0360 </varlistentry>
0361 
0362 <varlistentry>
0363 <term>Defaults</term>
0364 <listitem>
0365 <para>
0366 Clicking this button will restore this module to its default values. You must click <guibutton>Apply</guibutton> to save the options.
0367 </para>
0368 </listitem>
0369 </varlistentry>
0370 
0371 <varlistentry>
0372 <term>Reset</term>
0373 <listitem>
0374 <para>
0375 This button will <quote>Reset</quote> the module to the previous settings.
0376 </para>
0377 </listitem>
0378 </varlistentry>
0379 
0380 <varlistentry>
0381 <term>Apply</term>
0382 <listitem>
0383 <para>
0384 Clicking this button will save all changes. If you have changed anything, clicking <guibutton>Apply</guibutton> will cause the changes to take effect.
0385 </para>
0386 </listitem>
0387 </varlistentry>
0388 </variablelist>
0389 
0390 <note>
0391 <para>
0392 You must either <quote>Reset</quote> or <quote>Apply</quote> the changes before changing to another module.
0393 </para>
0394 <para>
0395 If you try to change without saving or resetting your options, you will be asked if you want to save your changes, or discard them.
0396 </para>
0397 </note>
0398 
0399 </chapter>
0400 
0401 <chapter id="credits">
0402 
0403 <title>Credits and License</title>
0404 
0405 <para>
0406 &systemsettings;
0407 </para>
0408 <para>
0409 Program copyright 2007 Benjamin C. Meyer.
0410 </para>
0411 <para>
0412 Program copyright 2009 Ben Cooksley.
0413 </para>
0414 <para>
0415 Contributors:
0416 <itemizedlist>
0417 <listitem>
0418 <para>
0419 Will Stephenson <email>wstepheson@kde.org</email>
0420 </para>
0421 </listitem>
0422 <listitem>
0423 <para>Michael D. Stemle, Jr. <email>manchicken@notsosoft.net</email>
0424 </para>
0425 </listitem>
0426 <listitem>
0427 <para>
0428 Matthias Kretz <email>kretz@kde.org</email>
0429 </para>
0430 </listitem>
0431 <listitem>
0432 <para>
0433 &Daniel.Molkentin; &Daniel.Molkentin.mail;
0434 </para>
0435 </listitem>
0436 <listitem>
0437 <para>
0438 &Matthias.Elter; &Matthias.Elter.mail;
0439 </para>
0440 </listitem>
0441 <listitem>
0442 <para>
0443 Frans Englich <email>englich@kde.org</email>
0444 </para>
0445 </listitem>
0446 <listitem>
0447 <para>
0448 Michael Jansen <email>kde@michael-jansen.biz</email>
0449 </para>
0450 </listitem>
0451 </itemizedlist>
0452 </para>
0453 
0454 <para>
0455 Documentation Copyright &copy; 2008 &Richard.Johnson; &Richard.Johnson.mail;
0456 </para>
0457 
0458 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0459 
0460 &underFDL;
0461 &underGPL;
0462 </chapter>
0463 
0464 &documentation.index;
0465 </book>
0466 
0467 <!--
0468 Local Variables:
0469 mode: xml
0470 sgml-minimize-attributes:nil
0471 sgml-general-insert-case:lower
0472 sgml-indent-step:0
0473 sgml-indent-data:nil
0474 End:
0475 
0476 vim:tabstop=2:shiftwidth=2:expandtab
0477 kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
0478 -->