core/README

   1
   2 splashutils -- userspace utilities for the framebuffer splash screen
   3 --------------------------------------------------------------------
   4
   5 This package provides a set of programs and scripts that can be used
   6 to provide a visually attractive environment during system boot-up,
   7 reboot and shutdown.
   8
   9 For installation instructions, have a look at the INSTALL file.
  10
  11 Here's a short description of provided programs, scripts and documents:
  12
  13 1. Programs
  14
  15    fbsplashd
  16    ---------
  17    The framebuffer splash daemon.
  18
  19    splash_util
  20    -----------
  21    A simple utility for various splash-related tasks not suitable for
  22    fbsplashd.
  23
  24    fbcondecor_helper
  25    -----------------
  26    A simple and small program run directly by the kernel to:
  27     - initialize the silent mode during early stages of the boot-up process,
  28         - provide the kernel with background images and theme configuration
  29           for the framebuffer console decorations.
  30
  31    This program is only of any use if the kernel has been patched with
  32    the 'fbcondecor' patch. The patch can be downloaded from the splashutils
  33    webpage.
  34
  35    fbcondecor_ctl
  36    --------------
  37    A program to control the framebuffer console decorations.
  38
  39    For technical documentation on the kernel<->userspace fbcondecor interface
  40    please refer to <kernel sources>/Documentation/fb/fbcondecor.txt.
  41
  42 2. Scripts
  43
  44    bootsplash2fbsplash
  45    -------------------
  46    Converts bootsplash theme files to a format acceptable by splashutils.
  47    Might not always work correctly and some manual adjustment of the
  48    resulting config files might be necessary.
  49
  50    splash_geninitramfs
  51    -------------------
  52    Generates initramfs images with data necessary to initialize verbose
  53    and silent splash during early boot-up.
  54
  55    splash_resize
  56    -------------
  57    Automatically generates theme config files for new resolutions. Might
  58    not always work correctly and some manual adjustment of the resulting
  59    config files might be necessary.
  60
  61    splash_manager
  62    --------------
  63    Performs various splash-related tasks in a user-friendly way. It
  64    allows the user to easily set and test themes, take screenshots
  65    of silent and verbose splash screens, and to replay recorded boot
  66    sequences.
  67
  68 3. Documentation
  69
  70    docs/bootsplash_compatibility
  71    -----------------------------
  72    A few notes about this package's compatibility with bootsplash.
  73
  74    docs/daemon
  75    -----------
  76    Description of the splash daemon communication protocol. Probably only
  77    useful to people developing support scripts for different Linux
  78    distributions.
  79
  80    docs/early_bootup
  81    -----------------
  82    A short explanation of the early-userspace concept and some info
  83    about creation and usage of splash initramfs images.
  84
  85    docs/kernel_parameters
  86    ----------------------
  87    A list of recognized kernel parameters.
  88
  89    docs/quickstart
  90    ---------------
  91    A very simplified intro to splashutils for people who REALLY don't have
  92    time to have a look at the rest of the documentation.
  93
  94    docs/theme_format
  95    -----------------
  96    Theme format specification. Useful for theme developers.
  97
  98 Any comments, suggestions and bug-reports are appreciated.
  99
 100 Project homepage:
 101   http://dev.gentoo.org/~spock/projects/fbsplash/
 102
 103 --
 104   Michal Januszewski <spock@gentoo.org>
 105