fbs view 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 source
1 Fbs - Framebuffer Boot Splash toolkit
2 ================================================================================
5 Fbs is a rewrite of the old SliTaz Fbsplash tool for the SliTaz ARM and
6 Raspberry Pi flavor. SliTaz ARM use radically simple boot scripts so
7 the integration was very easy. Enabling/disabling fbsplash on boot and
8 managing themes can be done with the fbs utility.
10 In time or if someone give a hand on. It may be possible to have a
11 GTK or/and Ncurses frontend to handle themes.
14 Overview
15 --------
17 * Use Busybox fbsplash applet for image and progress bar
18 * Use Linux kernel options 'quiet' at boot time
19 * Enable FBSPLASH in /etc/rcS.conf confg file
20 * Tweak /etc/inittab to hide and log text messages
21 * The SliTaz theme can fit in very small screen since the image
22 goes top/left and have a black bg such as the Linux Framebuffer
25 Install & setup
26 ---------------
27 Fbs is packaged for SliTaz but should work on any GNU/Linux with some
28 modifications to the boot scripts, patches are welcome! To install the
29 fbs utility and default theme:
31 # make && make install
33 Boot splash is activated on some SliTaz ARM flavor but not on the i486
34 standard distibution so you need enable fbs to have a graphical boot:
36 # fbs on [theme]
38 All fbs configuration variable can be found in: /etc/rcS.conf. Thes are:
40 FBSPLASH="on"
41 FBTHEME="slitaz"
43 Testing
44 -------
45 Let test the environment, first make sure you have the Linux Framebuffer
46 device node with: 'ls /dev/fb0'. The Raspberry Pi use the Linux framebuffer
47 so Fbs will work out of the box.
49 Then press Ctrl+F2 to open a text mode session (back to X with Ctrl+F7)
50 and run as root the Fbs testsuite:
52 # fbs test
54 Theming
55 -------
56 Fbs provide a nifty theming mechanism designed to easily handle installed
57 themes as well has creating and sharing new themes. A theme consist in
58 a small and human readable configuration and in a gzip ppm image.
60 # fbs themes
61 # fbs set-theme [theme]
62 # fbs pack-theme [theme]
63 # fbs add-theme [theme]
65 Code example
66 ------------
67 #!/bin/sh
68 #
69 export fifo=/tmp/fbs.fifo
70 fbsplash -c -f ${fifo}
71 -s /usr/share/fbs/default/fbsplash.ppm \
72 -i /usrshare/fbs/default/fbsplash.cfg &
74 echo 25 > ${fifo}
75 sleep 1
76 echo 50 > ${fifo}
77 sleep 1
78 echo 75 > ${fifo}
79 sleep 1
80 echo "exit" > ${fifo}
82 ===============================================================================