fix tricky regression noticed by Vyacheslav Tokarev on Google Reader.
[kdelibs.git] / kded / README.kded
blobd2e003ad1effb564543062fbdeec4d1e402d361d
1 Welcome to this readme about KDED.
3 KDED stands for KDE Daemon which isn't very descriptive.
4 KDED runs in the background and performs a number of small tasks.
5 Some of these tasks are built in, others are started on demand.
7 Built in tasks
8 ==============
9 *) Checking for newly installed software and updating ksycoca when new
10 software is detected. Updating of ksycoca is done by the program kbuildsycoca
11 which gets started by kded. When kded is first started it always runs
12 kbuildsycoca to ensure that ksycoca is up to date.
14 *) Checking for newly installed update files. Applications can install
15 *.upd update files. These *.upd files are used to update configuration files 
16 of users, primarily when new versions of applications are installed with
17 (slightly) different configuration file formats. Updating of configuration
18 files is done by kconf_update. kded starts kconf_update when it detects a 
19 new update file. When kded is first started it always runs kconf_update to
20 ensure that it has not missed any update files. kconf_update keeps track
21 of which update files have been processed already in the config-file
22 kconf_updaterc. It only performs a certain update once.
24 *) Checking for hostname changes. It is a really bad idea to change the 
25 hostname of a running system and it usually only happens with incorrectly
26 configured dial-up connections. Never the less, kded will check for hostname
27 changes and if it detects one it will make the necassery changes to the
28 KDE environemnt and X-server to allow continued proper operation. The 
29 program kdontchangethehostname is executed to make the actual changes.
31 Configuration of built in tasks.
32 ================================
33 The built in tasks have some configuration options that can be changed by
34 editing the kdedrc configuration file. Changes need to be made with a text-
35 editor, there is no GUI available. All options are listed under the [General]
36 group:
38 HostnamePollInterval: This can be used to adjust the time interval at which
39 the hostname is checked for changes. The time is specified in milliseconds
40 and has a default of 5000 (5 seconds).
42 CheckSycoca: This option can be used to disable checking for new software.
43 ksycoca will still be built when kded starts up and when applications
44 explicitly request a rebuild of the ksycoca database. The user can 
45 also manually rebuild ksycoca by running the kbuildsycoca program.
46 The default value of this option is "true". Checking can be disabled by 
47 setting this option to "false".
49 CheckUpdates: This option can be used to disable checking for update files.
50 kconf_update will still be run when kded starts up.
51 The default value of this option is "true". Checking can be disabled by 
52 setting this option to "false".
54 CheckHostname: This option can be used to disable checking for hostname 
55 changes. The default value of this option is "true". Checking can be 
56 disabled by setting this option to "false".
58 Example kdedrc file with default values:
60 [General]
61 HostnamePollInterval=5000
62 CheckSycoca=true
63 CheckUpdates=true
64 CheckHostname=true
66 If FAM or DNOTIFY is not available, the filesystem will be polled at regular interval for any changes. Under the [DirWatch] group in the kdeglobals file
67 the following options are available to adjust the polling frequency:
69 PollInterval: This can be used to adjust the time interval at which the local
70 filesystem is checked for new software or update files. The time is specified
71 in milliseconds and has a default of 500 (0.5 seconds).
73 NFSPollInterval: This can be used to adjust the time interval at which remote
74 filesystems, such as NFS or Samba, are ebing checked for new software or 
75 update files. The time is specified in milliseconds and has a default of 5000
76 (5 seconds).
78 The above options are not used when FAM is used to watch for changes in the
79 filesystem, or when DNOTIFY is used. Specifying larger intervals may reduce 
80 the CPU load and/or network traffic. Shorter intervals are not recommended.
82 Please note that in previous versions of KDE these options where listed in 
83 the kderc file.
85 Example kdeglobals fragment:
87 [DirWatch]
88 PollInterval=500
89 NFSPollInterval=5000
91 KDED modules
92 ============
93 Some things can be greatly simplified if they can be coordinated from a 
94 central place. KDED has support for modules that will be demand-loaded 
95 whenever an application attempts to make DBus call to the module.
96 This can be useful for central administration tasks.
98 See kdelibs/kded/HOWTO.