workspace/doc/kcontrol/screensaver/index.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE article 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 <article lang="&language;">
   9 <articleinfo>
  10
  11 <authorgroup>
  12 <author>&Mike.McBride; &Mike.McBride.mail;</author>
  13 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  14 </authorgroup>
  15
  16 <date>2005-02-20</date>
  17 <releaseinfo>3.4</releaseinfo>
  18
  19 <keywordset>
  20 <keyword>KDE</keyword>
  21 <keyword>KControl</keyword>
  22 <keyword>screensaver</keyword>
  23 <keyword>screen saver</keyword>
  24 </keywordset>
  25 </articleinfo>
  26
  27 <sect1 id="screensaver">
  28
  29 <title>Screen Saver</title>
  30
  31 <para>Using this module, you can choose your screen saver, determine
  32 how much time must pass before the screen saver is activated, and add
  33 or remove password protection to your screen saver.</para>
  34
  35 <sect2 id="ss-choose">
  36 <title>Choosing the screen saver, and configuring its options</title>
  37
  38 <para>In the <guilabel>Settings</guilabel> box is a check box
  39 labeled <guilabel>Start screen saver automatically</guilabel>.  This
  40 box must have a mark in it, or &kde; will not launch any screen saver
  41 and it will not allow you to adjust the settings of your screen
  42 saver.</para>
  43
  44 <para>Along the left side is a list of all available screen savers.  You can
  45 select a screen saver by simply clicking on its name.  Once
  46 you have selected a screen saver, you will see a small preview on the
  47 monitor on the right.</para>
  48
  49 <note><para>The preview monitor will often show the screen saver
  50 larger than it is when the screen saver is activated.  This is done on
  51 purpose, since many of the details of the screen savers would be
  52 unintelligible if actually scaled down to such a small
  53 size.</para></note>
  54
  55 <para>Each screen saver has a different set of setup options.  By
  56 clicking on <guilabel>Setup...</guilabel>, a dialog box will appear with
  57 all available options.  As you adjust the options, the preview box in
  58 the dialog box will show you what effect you will achieve with the
  59 current settings.</para>
  60
  61 <para>When you are done setting up your screen saver, click
  62 <guibutton>OK</guibutton>.</para> <para>Clicking <guibutton>Cancel</guibutton>
  63 will erase any changes you made in this dialog box, and return you to the
  64 screen saver module.</para>
  65
  66 <para>Clicking the <guibutton>About</guibutton> button will give you
  67 the Copyright and Author information if you are interested.</para>
  68
  69 <para>When you think you have all the options set the way you want,
  70 simply click on <guibutton>Test</guibutton> to immediately start the
  71 screen saver <emphasis>exactly</emphasis> as it will appear.</para>
  72
  73 </sect2>
  74
  75 <sect2 id="ss-options">
  76 <title>Setting the time, priority and passwords for screen
  77 savers.</title>
  78
  79 <para>Below the screensaver list is a check box to have the screen saver <guilabel>Start automatically</guilabel> check box, and a spin box which determines the period of inactivity before the screen saver should be started.  You can enter any postive number of minutes in this box.</para>
  80
  81 <para>Below that is a check box labeled <guilabel>Require password to
  82 stop screen saver</guilabel>.  If it is checked, when you click a key
  83 or click a mouse button to end the screen saver and return to your
  84 work, you must enter a password.  The password used is the same
  85 password you used to login to your machine.  If there is no mark in
  86 the check box, no password is required to return to your
  87 desktop.</para>
  88
  89 <para>Enable the check box <guilabel>Make aware of
  90 power management</guilabel> if you don't want the screensaver to start
  91 while you watch TV or movies on your monitor.</para>
  92
  93 </sect2>
  94
  95 <sect2 id="ss-other"><title>Using a non-&kde; screen saver</title>
  96
  97 <para>&kde; does not prevent another screen saver from working.  To use a
  98 different screen saver, such as <application>xscreensaver</application>, simply
  99 disable the &kde; Screen Saver, and set up your other screen saver program
 100 normally.  </para>
 101
 102 </sect2>
 103
 104 <sect2 id="screensaver-remove">
 105 <title>Removing and restoring a screen saver from your system</title>
 106
 107 <para>If you want to remove a screen saver from the list in this
 108 Control Center Module, you will need to rename a file on your
 109 system.</para>
 110
 111 <caution><para>Working as a <systemitem
 112 class="username">root</systemitem> user is a potentially dangerous
 113 situation.  While unlikely, it is entirely possible to do permanent
 114 damage to your system while working as
 115 <emphasis>root</emphasis>.</para>
 116
 117 <para>Be very careful following the next set of
 118 directions</para></caution>
 119
 120 <para>To delete a screen saver, type the following commands:</para>
 121
 122 <screen>
 123 <prompt>bash$</prompt> <command>cd
 124 $KDEDIR/share/applnk/System/ScreenSavers</command>
 125 <prompt>bash$</prompt> <command>ls</command>
 126 </screen>
 127
 128 <para>This will give you a list of files.  You will notice
 129 similarities between some of the file names and that of the screen saver you
 130 want to remove.  Simply rename the file of similarly named desktop
 131 file to a name which does not end in
 132 <emphasis>desktop</emphasis>.</para>
 133
 134 <para>Example:</para>
 135 <screen>
 136 <prompt>bash$</prompt> <command>cd
 137 $KDEDIR/share/applnk/System/ScreenSavers</command>
 138 <prompt>bash$</prompt> <command>mv KSpace.desktop KSpace.backup</command>
 139 </screen>
 140
 141 <para>Will remove Space (GL) from the list</para>
 142
 143 <note><para>You must close the &kcontrolcenter; entirely and restart it before
 144 the changes will be seen.</para></note>
 145
 146 <para>To restore the disabled screen saver, simply rename the file back to its
 147 original name:</para>
 148
 149 <screen>
 150 <prompt>bash$</prompt> <command>cd
 151 $KDEDIR/share/applnk/System/ScreenSavers</command>
 152 <prompt>bash$</prompt> <command>mv KSpace.backup KSpace.desktop</command>
 153 </screen>
 154
 155 <para>Restart the &kcontrolcenter;, and the screen saver is back in the
 156 list.</para>
 157
 158 </sect2>
 159
 160 <sect2 id="grace">
 161 <title>Advanced Settings: Grace period</title>
 162
 163 <para>There is a five second grace period after the screen saver
 164 begins before a  password is required even if <guilabel>Require
 165 password</guilabel> is checked.</para>
 166 <para>Locking the desktop manually, by clicking the lock icon
 167 in the &kde; panel, causes the password protection to engage immediately with
 168 no grace period.</para>
 169 <para>To alter the grace period setting, you need to manually edit the
 170 configuration file.  To do so:</para>
 171 <para>
 172 <prompt>$</prompt> <command>cd <filename>~/.kde/share/config</filename>
 173 </command>
 174 </para>
 175 <para>Now, using a text editor (the example uses &kate;, the &kde; text editor),
 176 load the <filename>kdesktoprc</filename>.</para>
 177 <para>
 178 <prompt>$</prompt> <command>kate <filename>kdesktoprc</filename>
 179 </command>
 180 </para>
 181 <para>Search through the file for the section labeled
 182 <emphasis>[Screensaver]</emphasis>.</para>
 183 <para>Look through all lines in the section for an entry entitled
 184 <emphasis>LockGrace</emphasis>.</para>
 185 <para>If the entry exists, you can edit the value of the entry.  </para>
 186 <screen>[Screensaver]
 187 LockGrace=3000</screen>
 188 <para>The value of the entity represents the duration of the grace period
 189 in milliseconds. An entry of 3000, would change the grace period to 3 seconds.
 190 You can set the value of the entry to any number between zero (no grace period)
 191 and 300000 (5 minutes).
 192 </para>
 193 <para>If the entry does not exist, simply add the entry to the end of the
 194 section.</para>
 195
 196 <para>Any changes to the configuration entry take effect
 197 immediately.</para>
 198
 199 </sect2>
 200
 201 </sect1>
 202
 203 </article>