fbs diff README @ rev 0

Initial commit with the README
author Christophe Lincoln <pankso@slitaz.org>
date Fri Apr 18 21:21:01 2014 +0200 (2014-04-18)
parents
children b01ae7eabae8
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Fri Apr 18 21:21:01 2014 +0200
     1.3 @@ -0,0 +1,82 @@
     1.4 +Fbs - Framebuffer Boot Splash toolkit
     1.5 +================================================================================
     1.6 +
     1.7 +
     1.8 +Fbs is a rewrite of the old SliTaz Fbsplash tool for the SliTaz ARM and
     1.9 +Raspberry Pi flavor. SliTaz ARM use radically simple boot scripts so
    1.10 +the integration was very easy. Enabling/disabling fbsplash on boot and
    1.11 +managing themes can be done with the fbs utility.
    1.12 +
    1.13 +In time or if someone give a hand on. It may be possible to have a
    1.14 +GTK or/and Ncurses frontend to handle themes.
    1.15 +
    1.16 +
    1.17 +Overview
    1.18 +--------
    1.19 +
    1.20 + * Use Busybox fbsplash applet for image and progress bar
    1.21 + * Use Linux kernel options 'quiet' at boot time
    1.22 + * Enable FBSPLASH in /etc/rcS.conf confg file
    1.23 + * Tweak /etc/inittab to hide and log text messages
    1.24 + * The SliTaz theme can fit in very small screen since the image
    1.25 +   goes top/left and have a black bg such as the Linux Framebuffer
    1.26 +
    1.27 +
    1.28 +Install & setup
    1.29 +---------------
    1.30 +Fbs is packaged for SliTaz but should work on any GNU/Linux with some
    1.31 +modifications to the boot scripts, patches are welcome! To install the
    1.32 +fbs utility and default theme: 
    1.33 +
    1.34 +# make && make install
    1.35 +
    1.36 +Boot splash is activated on some SliTaz ARM flavor but not on the i486
    1.37 +standard distibution so you need enable fbs to have a graphical boot:
    1.38 +
    1.39 +# fbs on [theme]
    1.40 +
    1.41 +All fbs configuration variable can be found in: /etc/rcS.conf. Thes are:
    1.42 +
    1.43 +FBSPLASH="on"
    1.44 +FBTHEME="slitaz"
    1.45 +
    1.46 +Testing
    1.47 +-------
    1.48 +Let test the environment, first make sure you have the Linux Framebuffer
    1.49 +device node with: 'ls /dev/fb0'. The Raspberry Pi use the Linux framebuffer
    1.50 +so Fbs will work out of the box.
    1.51 +
    1.52 +Then press Ctrl+F2 to open a text mode session (back to X with Ctrl+F7)
    1.53 +and run as root the Fbs testsuite:
    1.54 +
    1.55 +# fbs test
    1.56 +
    1.57 +Theming
    1.58 +-------
    1.59 +Fbs provide a nifty theming mechanism designed to easily handle installed
    1.60 +themes as well has creating and sharing new themes. A theme consist in
    1.61 +a small and human readable configuration and in a gzip ppm image.
    1.62 +
    1.63 +# fbs themes
    1.64 +# fbs set-theme [theme]
    1.65 +# fbs pack-theme [theme]
    1.66 +# fbs add-theme [theme]
    1.67 +
    1.68 +Code example
    1.69 +------------
    1.70 +#!/bin/sh
    1.71 +#
    1.72 +export fifo=/tmp/fbs.fifo
    1.73 +fbsplash -c -f ${fifo}
    1.74 +	-s /usr/share/fbs/default/fbsplash.ppm \
    1.75 +	-i /usrshare/fbs/default/fbsplash.cfg &
    1.76 + 
    1.77 +echo 25 > ${fifo}
    1.78 +sleep 1
    1.79 +echo 50 > ${fifo}
    1.80 +sleep 1
    1.81 +echo 75 > ${fifo}
    1.82 +sleep 1
    1.83 +echo "exit" > ${fifo}
    1.84 + 
    1.85 +===============================================================================