core/docs/daemon

   1 1. Introduction
   2 ---------------
   3 Since 1.1.9, splashutils can be run in two different operating modes. The
   4 first one is the standard 'call-do_stuff-exit' way known from all previous
   5 versions of splashutils. The second one is the so-called splash daemon mode.
   6
   7 Using the first mode to manage the silent splash screen is inefficient
   8 and should be considered deprecated.
   9
  10
  11 2. Starting the splash daemon
  12 -----------------------------
  13 The splash daemon can be started with:
  14   # splash_util -d -t <theme>
  15
  16 Upon startup, the daemon will parse the config file, open a communications
  17 FIFO (SPLASH_FIFO, default: /lib/splash/cache/.splash) and go into background,
  18 detaching from the current console. It will also start a thread that
  19 will monitor the silent tty for keypresses. This thread will then switch
  20 the screen to verbose mode if a F2 keypress is detected. If an event device
  21 (more info below) is monitored for keypresses, it will be possible to use
  22 F2 to switch back and forth between the silent and verbose modes.
  23
  24
  25 3. Communicating with the splash daemon
  26 ---------------------------------------
  27 All communications with the splash daemon are performed via the splash
  28 FIFO. Currently, the following commands are recognized:
  29
  30  - set theme <theme>
  31    Sets the current theme to <theme>. This can also be used to force the
  32    splash daemon to re-read the config file for the currently used theme.
  33
  34  - set mode <silent|verbose>
  35    Sets the splash mode to either verbose or silent. A tty switch is
  36    performed and, if necessary, the screen is redrawn.
  37
  38  - set tty <silent|verbose> <tty>
  39    Sets the silent or verbose tty to <tty>. <tty> is a number in the range
  40    1 - MAX_NR_CONSOLES.
  41
  42  - set effects [fadein fadeout]
  43    Set the special effects that the splash daemon will use.  If used without
  44    any optional parameters, this command will disable the use of all special
  45    effects.
  46
  47  - set event dev <evdev>
  48    Sets the event device to <evdev> (such as /dev/input/event0). If the
  49    kernel was configured with CONFIG_INPUT_EVDEV='y' or if the evdev.ko
  50    module is loaded, the splash daemon will use the event interface to
  51    detect F2 keypresses, allowing switching back and forth between silent
  52    and verbose modes.
  53
  54  - set message <text>
  55    Sets the main system message to <text>. This command only does anything
  56    when splashutils was built with CONFIG_TTF defined.
  57
  58  - set gpm
  59    Makes the splash daemon a GPM client for the silent tty. This provides
  60    a good way to prevent the mouse cursor from messing the silent splash.
  61
  62  - paint rect <x0> <y0> <x1> <y1>
  63    Paints the specified part of the background buffer on the screen.
  64
  65  - paint
  66    Updates the image on screen. Equivalent to 'splash_util -c paint ...'
  67
  68  - repaint
  69    Repaints the whole screen.
  70
  71  - progress <num>
  72    Sets the progress to <num>, where <num> has to be in the range 0 - 65535.
  73
  74  - update_svc <service> <state>
  75    Updates the service <service> state to <state>. <state> can be one
  76    of the following:
  77       svc_inactive_start
  78       svc_inactive_stop
  79       svc_start
  80       svc_stop
  81       svc_started
  82       svc_stopped
  83       svc_start_failed
  84       svc_stop_failed
  85
  86  - log <text>
  87    Add a line of text to the fbsplash message log. If 'text' is longer than
  88    log_cols, it is automatically truncated.
  89
  90  - exit [staysilent]
  91    Causes the splash daemon to exit.
  92
  93    If the 'staysilent' option is provided, the daemon won't try to
  94    automatically switch the screen to the verbose tty.
  95
  96
  97 4. Exporting the background buffer to a file (EXPERIMENTAL)
  98 -----------------------------------------------------------
  99
 100 The splash daemon provides an option (-e) to export its background buffer
 101 to a file (by mmaping it). When the background buffer is exported to a file,
 102 the 'set notify' command can be used to run programs whenever the screen is
 103 being (re)painted. These programs can draw additional objects in the
 104 background buffer, thus providing support for features not present in the
 105 core splash daemon (such as support for some exotic file formats).
 106
 107 Special care has to be taken not to truncate the file with the background
 108 buffer. Failure to keep the size unchagned might result in unexpected
 109 behaviour of the splash daemon.
 110
 111 --
 112 Written by Michal Januszewski <spock@gentoo.org>.
 113