OLD/bootsplash.txt

   1 TITLE:          Installing a bootsplash screen with progress bar
   2 LFS VERSION:    3.3+
   3 AUTHOR:         Bryan Gale <bryan@2dz.co.uk>
   4
   5 SYNOPIS:
   6         How to beautify the boot process with splash screen, progress bar and
   7         animation. Will also give you a pretty background on text consoles
   8
   9 HINT:
  10
  11 Required Packages
  12 -----------------
  13
  14 The SuSE bootsplash kernel patch (versions available for 2.4.18 and 2.4.20
  15 kernels):
  16         ftp://ftp.suse.com/pub/people/stepan/bootsplash/kernel/
  17         bootsplash-3.0.7-2.4.18-vanilla.diff
  18
  19 Or
  20         ftp://ftp.suse.com/pub/people/stepan/bootsplash/kernel/
  21         bootsplash-3.0.7-2.4.20-vanilla.diff
  22
  23 The splashutils package:
  24         ftp://ftp.suse.com/pub/people/stepan/bootsplash/rpm-sources/bootsplash/
  25         splashutils.tar.bz2
  26
  27 The frame-buffer mng player:
  28         ftp://ftp.suse.com/pub/people/stepan/bootsplash/rpm-sources/bootsplash/
  29         fbmngplay-0.5a.tar.bz2
  30
  31 Some helper scripts:
  32         ftp://ftp.suse.com/pub/people/stepan/bootsplash/rpm-sources/bootsplash/
  33         scripts.tar.bz2
  34
  35 A sample theme:
  36         ftp://ftp.suse.com/pub/people/stepan/bootsplash/themes/
  37         Theme-Linux.tar.bz2
  38
  39 This hint will assume these have been downloaded to /tmp
  40
  41 You should also have installed libmng and libjpeg and as described in the Beyond
  42 Linux From Scratch book
  43
  44
  45 Installing the kernel patch
  46 ---------------------------
  47
  48 Change to the directory containing your kernel sources, and apply the patch. You
  49 will then need to configure your kernel
  50
  51         cd /usr/src/linux &&
  52         patch -p1 < /tmp/bootsplash-3.0.7-2.4.*-vanilla.diff &&
  53         make menuconfig
  54
  55 You should enable the following options. Make sure they are compiled into the
  56 kernel, and not as modules
  57
  58         Code maturity level options  --->
  59                 Prompt for development and/or incomplete code/drivers
  60         Block devices  ---> RAM disk support
  61         Block devices  ---> Initial RAM disk (initrd) support
  62         Console drivers  ---> Video mode selection support
  63         Console drivers  ---> Frame-buffer support --->
  64                 Support for frame buffer devices
  65                 VESA VGA graphics console
  66                 Use splash screen instead of boot logo
  67
  68 Now compile and install the kernel
  69
  70         make dep &&
  71         make bzImage &&
  72         make modules &&
  73         make modules_install &&
  74         cp arch/i386/boot/bzImage /boot/lfskernel
  75
  76
  77 Installing user space stuff
  78 ---------------------------
  79
  80 Unpack splashutils.tar.bz2, compile and copy the required binaries to /sbin
  81
  82         cd /tmp &&
  83         tar xvjf splashutils.tar.bz2 &&
  84         cd splashutils &&
  85         make &&
  86         cp splash fbresolution /sbin &&
  87         cd ..
  88
  89 The two binaries we need are splash and fbresolution, so the rest can be
  90 deleted. We also need one script from the scripts.tar.bz2 package
  91
  92         tar xvjf scripts.tar.bz2 &&
  93         cd scripts &&
  94         chmod +x bootanim &&
  95         cp bootanim /sbin &&
  96         cd ..
  97
  98 The rest of the scripts are largely distro specific, so they can be deleted. The
  99 one we save, bootanim, is used by splash to start and stop animations. The mng
 100 player will also neeed to be installed to actually play the animations
 101
 102         tar xvjf fbmngplay-0.5a.tar.bz2 &&
 103         cd fbmngplay &&
 104         make
 105
 106 You may get compile errors, but hopefully the fbmngplay binary will be there
 107
 108         cp fbmngplay /sbin
 109
 110 If you do experence build errors they probably occured while building
 111 fbmngplay.static. If you want a static version of fbmngplay, see the note at the
 112 end of this hint
 113
 114
 115 Installing a bootsplash theme
 116 -----------------------------
 117
 118 We need to create a directory for our themes
 119
 120         mkdir -p /etc/bootsplash/themes
 121
 122 Move the sample theme (or any other theme from http://www.bootsplash.og) to this
 123 directory, and un-tar it
 124
 125         cd /etc/bootsplash/themes &&
 126         tar xvjf /tmp/Theme-Linux.tar.bz2
 127
 128 The programs installed earlier will search for the theme in
 129 /etc/bootsplash/themes/current, so we need to create a symlink
 130
 131         ln -s Linux current
 132
 133 When you want to use a different theme you should delete this symlink and create
 134 another one to your new un-tarred theme
 135
 136         rm current &&
 137         ln -s MYNEWTHEME current
 138
 139
 140 Updating Lilo and rebooting
 141 ---------------------------
 142
 143 You will need to edit /etc/lilo.conf. Under the entry for your linux kernel add
 144 the line
 145
 146         vga=791
 147
 148 This is so linux boots into a screen resolution that matches the size of the
 149 bootsplash screen. You will also need to add
 150
 151         initrd=/boot/initrd
 152
 153 To boot into silent mode (i.e. boot messages hidden), you will need also to add
 154
 155         append="splash=silent"
 156
 157 Not all themes have a silent mode, so this will not always apply.
 158
 159 The following will need to be done now, and everytime you want to change theme.
 160 Use splash to create a ram disk image of the bootsplash screen
 161
 162         splash -s -f \
 163         /etc/bootsplash/themes/current/config/bootsplash-1024x768.cfg > \
 164         /boot/initrd
 165
 166 Now update the mbr and reboot, and you should see your new splash screen
 167
 168         lilo &&
 169         shutdown -r now
 170
 171
 172 Utilising the progress bar
 173 --------------------------
 174
 175 If your theme is enabled with a progress bar, you will need to make some changes
 176 to your bootscripts to get it to work. The progress bar can be contolled by
 177 echoing commands to /proc/splash. For a tidy way to use this, you should add the
 178 following code to your /etc/rc.d/init.d/functions script
 179
 180         progressbar()
 181         {
 182
 183                 if [ $# != 1 ]
 184                 then
 185                         echo "Usage: progressbar {progress}"
 186                         exit 1
 187                 fi
 188
 189                 echo "show $(( 65534 * $1 / 100 ))" > /proc/splash
 190
 191         }
 192
 193 Now edit your bootscripts in /etc/rc.d/rcsysinit.d and (by default)
 194 /etc/rc.d/rc3.d to use this function. In general, before each instance of
 195 loadproc, you should add
 196
 197         progressbar XXX
 198
 199 Where XXX is boot progress out of 100. The LFS book explains the order in
 200 which the scripts will be run, and it will take some trial and error to get a
 201 smooth running progress bar. Remeber not to use this function before /proc
 202 has been mounted
 203
 204
 205 Utilising animation
 206 -------------------
 207
 208 The splash program handles animation, examining the
 209 /etc/bootsplash/themes/current/config/animations.cfg file, if your theme has
 210 one. Again, a function should be added to /etc/rc.d/init.d/functions file
 211
 212         animate()
 213         {
 214
 215                 if [ $# = 0 ]
 216                 then
 217                         echo "Usage: animate {hook}"
 218                         exit 1
 219                 fi
 220
 221                 splash "$*"
 222
 223         }
 224
 225 To use it place the following line in your bootscripts wherever an animation
 226 should be played
 227
 228         animate HOOK
 229
 230 To determine values for HOOK, you need to look at
 231 /etc/bootsplash/themes/current/config/animations.cfg. The file takes the format
 232
 233         HOOK:command
 234         HOOK:command
 235
 236 This is from the Redmond theme at http://www.bootsplash.org
 237
 238         fsck start:bootanim start bounce.mng
 239         master:bootanim stop
 240         shutdown: bootanim start bounce.mng
 241
 242 The command bootanim is the script we installed earlier, which handles the
 243 animations, and uses the fbmngplay command to actually play the things. To see
 244 a full list of paramemters, simply run bootanim. In this example we should add
 245 the following to the bootscript where fsck is run
 246
 247         animate fsck start
 248
 249 You should place the line
 250
 251         animate master
 252
 253 just before the bootscripts finish, as this will stop all animations.
 254
 255 The line
 256
 257         animate shutdown
 258
 259 should be placed somewhere in the shutdown scripts. Look in
 260 /etc/rc.d/rc6.d to see what will be run, and insert the line somewhere
 261 before the killproc-ing begins.
 262
 263 There is consistency between theme about these hooks, so once you have them in
 264 place, they should not need changing. No harm should come from trying to play a
 265 non existent animation.
 266
 267
 268 Miscellaneous
 269 -------------
 270
 271 Using splash, you can add or change a background on any of your terminals
 272
 273         splash -n -s -u 1 \
 274         /etc/bootsplash/themes/tty2-theme/config/bootsplash-1024x768.cfg
 275
 276         splash -n -s -u 2 \
 277         /etc/bootsplash/themes/tty3-theme/config/bootsplash-1024x768.cfg
 278
 279         splash -n -s -u 3 \
 280         /etc/bootsplash/themes/tty4-theme/config/bootsplash-1024x768.cfg
 281
 282         splash -n -s -u 4 \
 283         /etc/bootsplash/themes/tty5-theme/config/bootsplash-1024x768.cfg
 284
 285         splash -n -s -u 5 \
 286         /etc/bootsplash/themes/tty6-theme/config/bootsplash-1024x768.cfg
 287
 288 You can remove the background with
 289
 290         splash -s -n -u CONSOLENUMBER
 291
 292 You can retrun to silent mode using
 293
 294         echo "silent" > /proc/splash
 295
 296 This may be useful for creating a shutdown screen
 297
 298 Verbose mode can be triggered with F2 or
 299
 300         echo "verbose" > /proc/splash
 301
 302 You may want to place this in the print_status function of
 303 /etc/rc.d/init.d/functions, inside the failure case, or use it when your hard
 304 drive is being scanned for errors. You may also want to insert it somewhere
 305 into your bootscripts if silent mode doesn't automatically give way to verbose
 306 when your system finishes booting.
 307
 308 If you want to boot into a resolution other than 1024x768, simply follow the
 309 instructions as usual, but replace each mention of bootsplash-1024x768.cfg with
 310 bootsplash-XRESxYRES.cfg (you will of course need to make sure this file exists
 311 within your theme). You will also need to change the vga=791 line in lilo.conf
 312 appropriately. Here's a table I borrowed from the Gentoo forums:
 313
 314 Colors-----640x480-----800x600-----1024x768-----1280x1024
 315
 316 256----------769---------771----------773----------775
 317 32000--------784---------787----------790----------793
 318 65000--------785---------788----------791----------794
 319 16.7 Mill.---786---------789----------792----------795
 320
 321
 322 Compiling a static fbmngplay
 323 ----------------------------
 324
 325 If you keep /usr on a different partition to /, then you will need to use the
 326 static version of fbmngplay. This is so it does not depend on any libraries that
 327 are on a partition that may not have yet been mounted. To rid yourself of the
 328 compile error, edit the line in /tmp/fbmngplay/Makefile
 329
 330         LIBSS    = $(LIBDIR)/libmng-mini.a $(LIBDIR)/libz.a -lm
 331
 332 To
 333
 334         LIBSS    = $(LIBDIR)/libmng.a $(LIBDIR)/libjpeg.a $(LIBDIR)/libz.a -lm
 335
 336 Then copy /tmp/fbmngplay/fbmngplay.static to /sbin/fbmngplay
 337
 338 The splash command does not have any such dependencies problems, as it links
 339 only to glibc.
 340
 341 (Thanks to Dagmar d'Surreal for this bit)
 342
 343 Sources
 344 -------
 345
 346 http://www.bootsplash.org
 347 http://forums.gentoo.org/viewtopic.php?t=26494 (Thanks to kachaffeous)
 348 The blfs-support mailing list
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358