Warning, /frameworks/kded/docs/kded5/man-kded5.8.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003   <!ENTITY % English "INCLUDE"><!-- change language only here -->
0004 ]>
0005 
0006 <refentry lang="&language;">
0007 
0008 <refentryinfo>
0009 <title>kded5 User's Manual</title>
0010 <author>
0011 <firstname>David</firstname>
0012 <surname>Faure</surname>
0013 <contrib>Maintainer</contrib>
0014 <affiliation>
0015 <address><email>faure@kde.org</email></address>
0016 </affiliation>
0017 </author>
0018 
0019 <author>
0020 <firstname>Waldo</firstname>
0021 <surname>Bastian</surname>
0022 <contrib>Original author</contrib>
0023 <affiliation>
0024 <address><email>bastian@kde.org</email></address>
0025 </affiliation>
0026 </author>
0027 
0028 <date>2014-03-22</date>
0029 <releaseinfo>Frameworks 5.0</releaseinfo>
0030 <productname>KDE Frameworks</productname>
0031 
0032 </refentryinfo>
0033 
0034 <refmeta>
0035 <refentrytitle><command>kded5</command></refentrytitle>
0036 <manvolnum>8</manvolnum>
0037 </refmeta>
0038 
0039 <refnamediv>
0040 <refname><command>kded5</command></refname>
0041 <refpurpose>&kde; daemon - triggers Sycoca database updates when needed.</refpurpose>
0042 </refnamediv>
0043 
0044 <refsynopsisdiv>
0045 <title>Synopsis</title>
0046 
0047 <cmdsynopsis>
0048 <command>kded5</command>
0049 <arg choice="opt">--check</arg>
0050 </cmdsynopsis>
0051 </refsynopsisdiv>
0052 
0053 <refsect1>
0054 <title>Description</title>
0055 
0056 <para><command>kded5</command> consolidates several small services in one process. These are mostly &DBus; services provided by KDED modules, but it also manages sycoca (a binary cache of servicetypes, &MIME; types and services used by KService) and KConfig update scripts as needed.</para>
0057 
0058 <para>For sycoca, it monitors the directories containing .desktop files. When a file is added/removed, it waits 5 seconds (in case of a series of updates), and then launches <command>kbuildsycoca5</command> to update the sycoca.</para>
0059 
0060 <para>For KConfig, it checks newly-installed update files, &ie; the *.upd files used to update configuration files of users when the configuration file formats changes, and runs the KConfig update utility to perform the updates.</para>
0061 
0062 <para>Those tasks are also run when <command>kded5</command> is started to ensure that the user configuration is up to date.</para>
0063 
0064 <para>You do not normally need to run <command>kded5</command> directly; &plasma; desktop sessions run it automatically, and it is started on demand when an application attempts to use a &DBus; interface provided by it or one of its modules.</para>
0065 
0066 </refsect1>
0067 
0068 
0069 
0070 <refsect1>
0071 <title>Options</title>
0072 
0073 <variablelist>
0074 <varlistentry>
0075 <term><option>--check</option></term>
0076 <listitem>
0077 <para>Check the sycoca database, updating it if necessary, and exit.
0078 </para>
0079 </listitem>
0080 </varlistentry>
0081 </variablelist>
0082 </refsect1>
0083 
0084 
0085 
0086 <refsect1>
0087 <title>Configuration</title>
0088 
0089 <para><command>kded5</command> can be configured with the <filename>kded5rc</filename> ini-style configuration file. On &UNIX; systems, this can be found at <filename><varname>$XDG_CONFIG_HOME</varname>/kded5rc</filename>; if <varname>$XDG_CONFIG_HOME</varname> is not set, this defaults to <filename>~/.config/kded5rc</filename>.</para>
0090 
0091 <para>Configuration file entries are read on-demand, so changes can be made while <command>kded5</command> is running. However, all the current configuration options only really affect the startup behaviour of <command>kded5</command>.</para>
0092 
0093 <para>The <option>[General]</option> section has the following options:
0094 <variablelist>
0095 <varlistentry>
0096 <term><option>CheckSycoca</option></term>
0097 <listitem><para>Whether to update sycoca at startup (default: <constant>true</constant>).</para>
0098 </listitem>
0099 </varlistentry>
0100 <varlistentry>
0101 <term><option>CheckUpdates</option></term>
0102 <listitem><para>Whether to perform outstanding KConfig updates at startup (default: <constant>true</constant>).</para>
0103 </listitem>
0104 </varlistentry>
0105 <varlistentry>
0106 <term><option>CheckFileStamps</option></term>
0107 <listitem><para>Whether to check file timestamps when performing the initial sycoca update (default: <constant>true</constant>). See the documentation for <command>kbuildsycoca5</command> for more details.</para>
0108 </listitem>
0109 </varlistentry>
0110 <varlistentry>
0111 <term><option>DelayedCheck</option></term>
0112 <listitem><para>Whether to delay the initial sycoca update until about a minute after starting (default: <constant>false</constant>).</para>
0113 </listitem>
0114 </varlistentry>
0115 </variablelist>
0116 </para>
0117 
0118 <para>Each module also has a <option>[Module-<replaceable>name</replaceable>]</option> section in <filename>kded5rc</filename>, where <replaceable>name</replaceable> is the name of the module's desktop file without the <filename>.desktop</filename> extension. This contains an <option>autoload</option> option that specifies whether the module should be automatically loaded when <command>kded5</command> is started (default: <constant>false</constant>). Note that this setting can also be changed via <command>kded5</command>'s &DBus; interface.</para>
0119 </refsect1>
0120 
0121 
0122 
0123 <refsect1>
0124 <title>See Also</title>
0125 <para>
0126 <citerefentry><refentrytitle>kbuildsycoca5</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
0127 <citerefentry><refentrytitle>kdeinit5</refentrytitle><manvolnum>8</manvolnum></citerefentry>
0128 </para>
0129 </refsect1>
0130 
0131 
0132 
0133 <refsect1>
0134 <title>Bugs</title>
0135 <para>Please use <ulink url="https://bugs.kde.org">&kde;'s bugtracker</ulink> to report bugs.</para>
0136 </refsect1>
0137 
0138 </refentry>