core/docs/libfbsplash

   1        libfbsplash and libfbsplashrender documentation
   2            -----------------------------------------------
   3
   4 Last update: 2007-08-09
   5
   6 This document is an introductory documentation for libfbsplash and
   7 libfbsplashrender.
   8
   9 1. Purpose
  10 ----------
  11
  12 Since 1.5, splashutils comes bundled with two libraries: libfbsplash
  13 and libfbsplashrender.  The libraries have two distinct purposes:
  14
  15 - lifbsplash: provides functions that can be useful for integrating
  16   fbsplash with the initscript system or for controlling the fbsplash
  17   daemon from third party applications,
  18
  19 - libfbsplashrender: provide functions to parse splash themes and
  20   to display the silent splash screen (either to a memory buffer,
  21   or directly on the screen).  One would use libfbsplashrender e.g.
  22   in software suspend applications (to provide a graphical interface
  23   while suspending/resuming the system).
  24
  25 2. Usage
  26 --------
  27
  28 In order to use libfbsplash, add "#include <fbsplash.h>" to your program
  29 and link it with "-lfbsplash".
  30
  31 In order to use libfbsplashredner, add "#include <fbsplash.h>" to your
  32 program and link it with "-lfbsplashrender".  If you link your program with
  33 libfbsplashrender, you will automatically gain access to all features
  34 provided by libfbsplash.
  35
  36 3. Documentation
  37 ----------------
  38
  39 If you want a complete reference for all functions provided by
  40 libfbsplash and libfbsplashrender, run `make doc` in the main
  41 splashutils directory (requires doxygen) or have a look at the code
  42 in libfbsplash.c and libfbsplashrender.c.
  43
  44 3. Additional information
  45 -------------------------
  46
  47 If you can't find an answer to your question in the splashutils
  48 documentation, feel free to mail me at spock@gentoo.org.
  49
  50 --
  51   Written by: Michal Januszewski <spock@gentoo.org>
  52