tde-packaging/ubuntu/maverick_automake/kdelibs/debian/man/kstartupconfig-kde3.1

.\" This file was generated by (a slightly modified) kdemangen.pl and edited by hand
.TH KSTARTUPCONFIG 1 "Jun 2006" "K Desktop Environment" "configuration options loader"
.SH NAME
kstartupconfig, kdostartupconfig
\- KDE configuration options loader
.SH SYNOPSIS
\fBkstartupconfig\fP [$TDEHOME]
.sp 1
\fBkdostartupconfig\fP
.SH DESCRIPTION
\fBkstartupconfig\fP loads configuration options for use in \fBstartkde\fP. It saves loading time as there is no need to launch programs linked to KDE libraries. \fBstartupconfig\fP uses a cache of some Kconfig options that are updated by \fBkdostartupconfig\fP. The cache is implemented as script file that is sourced and provides the options as shell variables.
.sp 1
The configuration options to load are stored in \fIstartupconfigkeys\fP as one option per line. They follow the format <file> <group> <key> <default>. A complete group is addressed as <file> [<group>]. The configuration options are processed in the specified order so the missing default values for groups can be specified as single options after the group option.
.sp 1
\fBkstartupconfig\fP stores every line from \fIstartupconfigkeys\fP in \fIstartupconfigfiles\fP followed by the paths of all files relevant to the option. Lines with non\-existent files start with '!' in case they are created later. The list of files is terminated by a line starting with '*'.
.sp 1
If the timestamps of all relevant files are older than the timestamp of \fIstartupconfigfile\fP there is no need to update anything. Otherwise \fBkdostartupconfig\fP is launched to create or update the necessary files.
.sp 1
\fBkdostartupconfig\fP writes values of the options to \fIstartupconfig\fP. \fIstartupconfig\fP is a shell script that sets the values to shell variables. The variables are named <file>_<group>_<key>.
.sp 1
\fBNotes:\fP
.IP "     \-"
the \fIkdeglobals\fP config file is not used as a dependency for other config files
.IP "     \-"
do not use frequently changed config files since the checking is timestamp\-based
.IP "     \-"
if \fBkconf_update\fP is used to update an option also touch the matching global config file to allow \fBkstartupconfig\fP to see changes
.SH OPTIONS
.TP
.B $TDEHOME
KDE home directory, if different to ~/.kde
.SS
.SH FILES
In case $TDEHOME is not set ~/.kde is assumed.
.TP
.I $TDEHOME/share/config/startupconfig
script, sourced to set shell variables with configuration options
.TP
.I $TDEHOME/share/config/startupconfigfiles
configuration options and files they belong to
.TP
.I $TDEHOME/share/config/startupconfigkeys
configuration options to load
.SH SEE ALSO
.BR kconf_update (1),\  startkde (1)
.SH AUTHORS
.nf
Lubos Lunak <l.lunak@kde.org>
.br

.br
.fi
Please use http://bugs.kde.org to report bugs, do not mail the author directly.
.PP
This manual page was written by Holger Hartmann <Holger_Hartmann@gmx.de> for the \fBDebian\fP Project (but may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.
.PP
On \fBDebian\fP systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL.