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