Cache the document element: now that we have comments in dom,
[kdelibs.git] / kinit / README.autostart
blobbbfd036ecb9cc90729e87eda2720397b63869dd4
1 KDE SESSION AUTOSTART
2 =====================
4 KDE session startup occurs in the following sequence:
6    Window manager startup
7    Autostart phase 1
8    Session restoration
9    Autostart phase 2
11 Applications may be scheduled to be automatically run at KDE session startup
12 in either autostart phase 1 or phase 2. Autostart phase 1 is the original
13 autostart phase; phase 2 was introduced in KDE 3. To run in either phase, an
14 application's .desktop file must be located in a KDE autostart directory such
15 as $KDEDIR/share/autostart or $KDEHOME/share/autostart. The .desktop file can
16 contain the following optional entries to control its autostart:
18    X-KDE-autostart-condition = rcfile:group:entry:default
20          rcfile   = name of a config file (including path if necessary)
21          group    = name of a group within the config file
22          entry    = name of a boolean entry within the group
23          default  = true or false
25       Starts the application only if the specified boolean entry in the
26       specified config file has the value 'true'. If the specified entry is
27       missing from the config file, the application will only be started if
28       'default' is 'true'.
29       If the entry is not within a group, the group entry can be left empty.
31    X-KDE-autostart-after = desktop_name
33          desktop_name  = the name of another .desktop file excluding path and
34                          the .desktop suffix. E.g. panel.desktop would appear
35                          as 'X-KDE-autostart-after=panel'
36                       
37       Waits until the .desktop file specified by 'desktop_name' has been
38       autostarted. The entry is ignored if the specified application is not
39       scheduled in the same autostart phase as this .desktop file.
41    X-KDE-autostart-phase = phase
43          phase  = 1 or 2
45       Starts the application in the autostart phase specified by 'phase'.
46       If this entry is missing or 'phase' < 1, 'phase' defaults to 1. If
47       'phase' > 2 the application will not be autostarted since the specified
48       autostart phase will never be reached.
49       
51    Hidden = true
53       Disables autostarting the application.
56 KUniqueApplication and session restoration
57 ------------------------------------------
59 If KUniqueApplication applications are autostarted before they are restored
60 from the previous session, they will never see the session restoration command.
61 So if you need to autostart a KUniqueApplication which may also be restored
62 in session restoration, you should schedule it for autostart in phase 2.