docs/kbuildsycoca5/man-kbuildsycoca5.8.docbook

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>&kde-frameworks;: KService</title>
0010 <author>
0011 <firstname>Darian</firstname>
0012 <surname>Lanx</surname>
0013 <contrib>Wrote the original documentation.</contrib>
0014 <affiliation>
0015 <address><email>content@openprojects.net</email></address>
0016 </affiliation>
0017 </author>
0018 <author>
0019 <firstname>Alex</firstname>
0020 <surname>Merry</surname>
0021 <contrib>Updated the documentation for &kf5-full;.</contrib>
0022 <affiliation>
0023 <address><email>alexmerry@kde.org</email></address>
0024 </affiliation>
0025 </author>
0026
0027 <date>2015-09-17</date>
0028 <releaseinfo>Frameworks 5.15</releaseinfo>
0029 <productname>KDE Frameworks</productname>
0030
0031 </refentryinfo>
0032
0033 <refmeta>
0034 <refentrytitle><command>kbuildsycoca5</command></refentrytitle>
0035 <manvolnum>8</manvolnum>
0036 </refmeta>
0037
0038 <refnamediv>
0039 <refname><command>kbuildsycoca5</command></refname>
0040 <refpurpose>Rebuilds the KService desktop file system configuration cache</refpurpose>
0041 </refnamediv>
0042
0043 <refsynopsisdiv>
0044 <title>Synopsis</title>
0045
0046 <cmdsynopsis>
0047 <command>kbuildsycoca5</command>
0048 <group choice="opt" rep="repeat"><replaceable class="option">OPTIONS</replaceable></group>
0049 </cmdsynopsis>
0050
0051 </refsynopsisdiv>
0052
0053
0054
0055 <refsect1>
0056 <title>Description</title>
0057
0058 <para>
0059 <command>kbuildsycoca5</command> builds binary cache of the data stored in
0060 <literal role="extension">.desktop</literal> and &MIME; type <literal
0061 role="extension">.xml</literal> files that the KService framework uses to find
0062 plugins, applications and other services.
0063 </para>
0064
0065 <para>
0066 The KService library uses this database to efficiently provide the information
0067 requested of it.
0068 </para>
0069
0070 <para>
0071 Users do not normally need to run this application directly; KService will run
0072 it if necessary, when any of the files whose data is cached are changed.
0073 </para>
0074 </refsect1>
0075
0076
0077
0078 <refsect1>
0079 <title>Options</title>
0080 <variablelist>
0081
0082 <varlistentry>
0083 <term><option>--global</option></term>
0084 <listitem>
0085 <para>Ignores any user-set files (in <varname>XDG_DATA_HOME</varname>). This is currently only supported on &UNIX; systems.</para>
0086 </listitem>
0087 </varlistentry>
0088
0089 <varlistentry>
0090 <term><option>--noincremental</option></term>
0091 <listitem>
0092 <para>Rather than using the existing cache and only updating the information that has changed or been added, start with an empty cache. Ignored if <option>--global</option> is set.</para>
0093 </listitem>
0094 </varlistentry>
0095
0096 <varlistentry>
0097 <term><option>--nosignal</option></term>
0098 <listitem>
0099 <para>Ordinarily, <command>kbuildsycoca5</command> sends a signal over &DBus; once the cache is updated to all the applications that use KService so that they are always working with the latest information. This option suppresses that behaviour.</para>
0100 </listitem>
0101 </varlistentry>
0102
0103 <varlistentry>
0104 <term><option>--menutest</option></term>
0105 <listitem>
0106 <para>Test the generation of the application menu database. Does not actually build the cache.</para>
0107 </listitem>
0108 </varlistentry>
0109
0110 <varlistentry>
0111 <term><option>--testmode</option></term>
0112 <listitem>
0113 <para>Use the QStandardPaths "test mode" to avoid interfering with user data. This is intended for use with unit tests.</para>
0114 </listitem>
0115 </varlistentry>
0116
0117 <varlistentry>
0118 <term><option>--track <replaceable>menu-id</replaceable></option></term>
0119 <listitem>
0120 <para>Track a menu ID for debugging.</para>
0121 </listitem>
0122 </varlistentry>
0123
0124 <varlistentry>
0125 <term><option>--author</option></term>
0126 <listitem>
0127 <para>
0128 Show author information.
0129 </para>
0130 </listitem>
0131 </varlistentry>
0132
0133 <varlistentry>
0134 <term><option>--license</option></term>
0135 <listitem>
0136 <para>
0137 Show license information.
0138 </para>
0139 </listitem>
0140 </varlistentry>
0141
0142 <varlistentry>
0143 <term><option>-h, --help</option></term>
0144 <listitem>
0145 <para>
0146 Show a brief help text.
0147 </para>
0148 </listitem>
0149 </varlistentry>
0150
0151 <varlistentry>
0152 <term><option>-v , --version</option></term>
0153 <listitem>
0154 <para>
0155 Show version information.
0156 </para>
0157 </listitem>
0158 </varlistentry>
0159
0160 </variablelist>
0161 </refsect1>
0162
0163
0164
0165 <refsect1>
0166 <title>Files</title>
0167 <variablelist>
0168 <varlistentry>
0169 <term><filename><varname>cachedir</varname>/ksycoca5_[lang]_[sha1-of-dirs]</filename></term>
0170 <listitem>
0171 <para>The KService cache generated by <command>kbuildsycoca5</command>. On &UNIX; systems, <varname>cachedir</varname>
0172 is typically <filename class="directory"><envar>XDG_CACHE_HOME</envar></filename>.</para>
0173 </listitem>
0174 </varlistentry>
0175 </variablelist>
0176 </refsect1>
0177
0178
0179
0180 <refsect1>
0181 <title>See Also</title>
0182 <para>
0183 <citerefentry><refentrytitle>kded5</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
0184 <citerefentry><refentrytitle>kdeinit5</refentrytitle><manvolnum>8</manvolnum></citerefentry>
0185 </para>
0186 </refsect1>
0187
0188
0189
0190 <refsect1>
0191 <title>Bugs</title>
0192 <para>Please use <ulink url="https://bugs.kde.org">&kde;'s bugtracker</ulink> to report bugs.</para>
0193 </refsect1>
0194
0195 </refentry>
0196
0197
0198