← Back to branch summary

~ubuntu-branches/ubuntu/utopic/kde-workspace/utopic-proposed

« back to all changes in this revision

Viewing changes to ksplash/README

  • Committer: Bazaar Package Importer
  • Author(s): Michał Zając
  • Date: 2011-07-09 08:31:15 UTC
  • Revision ID: james.westby@ubuntu.com-20110709083115-ohyxn6z93mily9fc
Tags: upstream-4.6.90
Import upstream version 4.6.90

Show diffs side-by-side

added added

removed removed

Lines of Context:
ksplash/README
 
1
KDE Splash:
 
2
===========
 
3
 
 
4
The 'kcm' directory contains the control module for configuring the splashscreen.
 
5
Other directories contain various splash implementations:
 
6
 
 
7
- 'none' is no splashscreen
 
8
- 'simple' is a very simple and fast splashscreen showing a plain progressbar
 
9
- 'ksplashx' is a more capable implementation. See its README.
 
10
 
 
11
(the KDE3 implementation 'ksplashml' has been removed to /tags/unmaintained)
 
12
 
 
13
 
 
14
Theme format:
 
15
=============
 
16
 
 
17
This is a description of what is shared between the implementations (as needed
 
18
by the configuration module and startkde code deciding which implementation to use).
 
19
Implementations may have their own additions.
 
20
 
 
21
Themes are stored in $KDEDIRS/share/apps/ksplash/Themes/ in a directory specifying
 
22
the name of the theme. The directory must contain file 'Theme.rc' describing
 
23
the theme and should contain file 'Preview.png' with a preview image. Other contents
 
24
are implementation-dependent.
 
25
 
 
26
 
 
27
Theme.rc format:
 
28
================
 
29
 
 
30
The format is the usual ini-style format, e.g.:
 
31
 
 
32
[KSplash Theme: Simple]
 
33
Name = Simple Splash Screen
 
34
Description = Very Simple Optimized Splash Screen
 
35
Version = 1.0
 
36
Author = Lubos Lunak <l.lunak@kde.org>
 
37
Engine = Simple
 
38
 
 
39
The group name is [KSplash Theme: <theme name>]. Name, Description, Version and Author
 
40
are shown in the configuration module. Engine selects which splash implementation
 
41
the theme is for (currently 'None', 'Simple' and 'KSplashX' ). There may be futher
 
42
implementation-dependent data in Theme.rc .
 
43
 
 
44
 
 
45
Startup states:
 
46
===============
 
47
 
 
48
These are ksplash states:
 
49
- initial - at the beginning
 
50
- kded - after kded is running (dbus is ready, etc.)
 
51
- confupdate - after kconf_update (settings updated after upgrade, etc.)
 
52
- kcminit - after configuration setup
 
53
- ksmserver - session manager is started
 
54
- wm - window manager is running
 
55
- desktop - desktop (plasma) is running
 
56
- ready - session is ready (not fully actually, still e.g. restoring applications, but splash goes away)
 
57
 
 
58
Note however that these states should not be relied on too much:
 
59
- they do not represent very accurately what is actually going on
 
60
- states may be removed (they'll take 0 time and directly go to another state)
 
61
- states may be added
 
62
- states may be reordered (waiting for a later state and then a sooner state means the sooner state will take 0 time)