Warning, /frameworks/kinit/docs/kdeinit5/man-kdeinit5.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>kdeinit5 User's Manual</title>
0010 <author>
0011 <firstname>Waldo</firstname>
0012 <surname>Bastian</surname>
0013 <affiliation>
0014 <address><email>bastian@kde.org</email></address>
0015 </affiliation>
0016 </author>
0017 
0018 <author>
0019 <firstname>Mario</firstname>
0020 <surname>Weilguni</surname>
0021 <affiliation>
0022 <address><email>mweilguni@sime.com</email></address>
0023 </affiliation>
0024 </author>
0025 
0026 <author>
0027 <firstname>Lubos</firstname>
0028 <surname>Lunak</surname>
0029 <affiliation>
0030 <address><email>l.lunak@kde.org</email></address>
0031 </affiliation>
0032 </author>
0033 
0034 <date>2013-12-18</date>
0035 <releaseinfo>Frameworks 5.0</releaseinfo>
0036 <productname>KDE Frameworks</productname>
0037 </refentryinfo>
0038 
0039 <refmeta>
0040 <refentrytitle><command>kdeinit5</command></refentrytitle>
0041 <manvolnum>8</manvolnum>
0042 </refmeta>
0043 
0044 <refnamediv>
0045 <refname><command>kdeinit5</command></refname>
0046 <refpurpose>Launcher for applications built with kdeinit support, and for KIO slaves.</refpurpose>
0047 </refnamediv>
0048 
0049 <refsynopsisdiv>
0050 <title>Synopsis</title>
0051 
0052 <cmdsynopsis>
0053 <command>kdeinit5</command>
0054 
0055 <arg choice="opt">--help</arg>
0056 <group>
0057 <arg>--no-fork</arg>
0058 <arg>--no-kded</arg>
0059 <arg>--suicide</arg>
0060 </group>
0061 <group>
0062 <arg>+programs</arg>
0063 <arg>programs</arg>
0064 </group>
0065 </cmdsynopsis>
0066 
0067 </refsynopsisdiv>
0068 
0069 <refsect1>
0070 <title>Description</title>
0071 
0072 <para>kdeinit5 is a process launcher somewhat similar to the
0073 famous <command>init</command> used for booting UNIX. It executes &kde;
0074 programs and kdeinit loadable modules (KLMs) starting them more efficiently.
0075 </para>
0076 
0077 <para>Using kdeinit5 to launch &kde; applications makes starting a typical
0078 &kde; application a couple times faster and reduces memory consumption by
0079 a substantial amount.</para>
0080 
0081 <para>kdeinit5 is linked against all libraries a standard &kde; application
0082 needs. With this technique, starting an application becomes much faster 
0083 because now only the application itself needs to be linked whereas otherwise
0084 both the application as well as all the libraries it uses need to be linked.
0085 </para>
0086 
0087 </refsect1>
0088 
0089 <refsect1>
0090 <title>Disadvantages</title>
0091 
0092 <para>
0093 The process name of applications started via kdeinit5
0094 is "kdeinit5". This problem can be corrected to a degree by changing the
0095 application name as shown by <command>ps</command>. However, applications
0096 like <command>killall</command> will only see kdeinit5
0097 as the process name. To workaround this, use <command>kdekillall</command>
0098 (from kdesdk/scripts) for applications started via kdeinit5.
0099 </para>
0100 
0101 </refsect1>
0102 
0103 <refsect1>
0104 <title>Options</title>
0105 
0106 <variablelist>
0107 
0108 <varlistentry>
0109 <term><option>--help</option></term>
0110 <listitem>
0111 <para>
0112 Show help about options
0113 </para>
0114 </listitem>
0115 </varlistentry>
0116 
0117 <varlistentry>
0118 <term><option>--no-fork</option></term>
0119 <listitem>
0120 <para>Do not fork, i.e. do not exit until all the executed programs ends</para>
0121 </listitem>
0122 </varlistentry>
0123 
0124 <varlistentry>
0125 <term><option>--no-kded</option></term>
0126 <listitem>
0127 <para>Do not start kded</para>
0128 </listitem>
0129 </varlistentry>
0130 
0131 <varlistentry>
0132 <term><option>--suicide</option></term>
0133 <listitem>
0134 <para>
0135 Terminate when no KDE applications are left running
0136 </para>
0137 </listitem>
0138 </varlistentry>
0139 
0140 <varlistentry>
0141 <term><option>+programs</option></term>
0142 <listitem>
0143 <para>
0144 runs the programs handling requests
0145 </para>
0146 </listitem>
0147 </varlistentry>
0148 
0149 <varlistentry>
0150 <term><option>programs</option></term>
0151 <listitem>
0152 <para>
0153 runs the programs without handling requests
0154 </para>
0155 </listitem>
0156 </varlistentry>
0157 
0158 </variablelist>
0159 
0160 </refsect1>
0161 
0162 <refsect1>
0163 <title>Usage</title>
0164 <para>
0165 A standard way to run this program is by simply specifying the following
0166 command at the prompt
0167 <userinput><command>kdeinit5</command> program</userinput> or
0168 <userinput><command>kdeinit5</command> +program
0169 </userinput>
0170 </para>
0171 
0172 </refsect1>
0173 
0174 <!--
0175 <refsect1>
0176 <title>Examples</title>
0177 <para>
0178 <userinput><command>kdeinit5</command> +kwrite</userinput>
0179 </para>
0180 </refsect1>
0181 -->
0182 
0183 <refsect1>
0184 <title>Files</title>
0185 
0186 <variablelist>
0187 <varlistentry>
0188 <term><filename>/tmp/kde-$USER/kdeinit5_$INSTANCE</filename></term>
0189 <listitem>
0190 <para>...</para>
0191 </listitem>
0192 </varlistentry>
0193 </variablelist>
0194 
0195 </refsect1>
0196 
0197 <refsect1>
0198 <title>Environment Variables</title>
0199 <variablelist>
0200 
0201 <varlistentry>
0202 <term>$<envar>HOME</envar></term>
0203 <listitem>
0204 <para>Specifies the home directory of the current user</para>
0205 </listitem>
0206 </varlistentry>
0207 
0208 <varlistentry>
0209 <term>$<envar>KDE_HOME_READONLY</envar></term>
0210 <listitem>
0211 <para>Specifies if the home directory of the current user is read only</para>
0212 </listitem>
0213 </varlistentry>
0214 
0215 <varlistentry>
0216 <term>$<envar>KDE_IS_PRELINKED</envar></term>
0217 <listitem>
0218 <para>If set, tells kdeinit5 that the &kde; programs are pre-linked.</para>
0219 <para>(Prelinking is a process that allows you to speed up the process of dynamic linking.)</para>
0220 </listitem>
0221 </varlistentry>
0222 
0223 <varlistentry>
0224 <term>$<envar>KDE_DISPLAY</envar></term>
0225 <listitem>
0226 <para>If set, tells kdeinit5 that it is running on a &kde; desktop.</para>
0227 </listitem>
0228 </varlistentry>
0229 
0230 </variablelist>
0231 
0232 </refsect1>
0233 
0234 <refsect1>
0235 <title>See Also</title>
0236 <para>kded5, kdekillall</para>
0237 </refsect1>
0238 
0239 <refsect1>
0240 <title>Bugs</title>
0241 <para>Please use <ulink url="http://bugs.kde.org">KDE's bugtracker</ulink> to report bugs.</para>
0242 </refsect1>
0243 
0244 </refentry>
0245 
0246 
0247