Installation Note: Splashy does not yet works with DirectFB version 1.2 and up ====== Requirements ====== [[About|Splashy]] is usually distributed as a static binary. So, in most cases, it requires no more than just the [[http://www.gnu.org/software/libc|GNU standard C library (glibc)]]. Other requirements: * A video card * A kernel with framebuffers support (that's the default in almost all [[http://kernel.org|Linux]] distributions) * Linux users must use a 2.6 kernel Note that to enable the framebuffer on your kernel, you will need to add a parameter to the kernel arguments: **vga=791**. Read the framebuffer documentation of the kernel, or Splashy's README file, on how to use different resolutions. You will also need the keyword **splash** as an argument. This is respected by Splashy 0.2.x and up. ====== Binaries ====== ===== Debian ===== Splashy is currently in Debian unstable (aka Sid) repositories. Make sure that you have "vga=791 splash" as kernel parameters. You can add this to /boot/grub/menu.lst or /etc/lilo.conf. See the [[faq|FAQ]] section for more. Splashy's most recent (and testing) releases are stored in [[http://alioth.debian.org|Alioth]]. Use them if you want to be in the bleeding edge or if you want to test Splashy. This is the recommended installation method on Debian-based systems. Edit ///etc/apt/sources.list// and add * Debian Etch/Sid (testing/unstable) users: deb http://ftp.us.debian.org/debian unstable main Now run: apt-get update apt-get install splashy splashy-themes Now, whenever the system is updated, Splashy will be updated along with it. ==== Manual installation ==== Use this method if "the Debian-way" method failed. Using this installation method, Splashy will not be automatically updated with the rest of your system, so it is not recommended. To install the packages manually, go to the [[http://alioth.debian.org/project/showfiles.php?group_id=30657|download area]] (under //Files// section) and download the latest version's packages. Now, depending on the kind of packages you downloaded (*.deb or *.rpm) install it with //dpkg// or //rpm//: * [[http://www.debian.org|Debian]] (DEB) packages: //dpkg -i splashy*.deb splashy-themes*.deb// * [[http://www.rpm.org|RPM]] packages: //rpm -Uhv splashy*.rpm splashy-themes*.rpm// ==== Other information ==== Note that Splashy packages are compiled statically, so they should work for Debian as well as other Linux distributions ([[http://www.ubuntu.com|Ubuntu]], [[http://www.xandros.com|Xandros]], [[http://www.suse.com|SuSE]], [[http://www.redhat.com|RedHat]], etc). ====== Sources ====== There are two types of sources available: * Release tarballs * Development sources Release tarballs are the sources of the released versions. This sources are known to be stable and should work fine. Development sources are the sources on which the developers are working at this very moment and might not work well or not even compile, allthough they usually do. On the other hand, development sources are much more recent and usually have new features. Additionally, it is explained here how to compile Splashy in Sarge "the Debian way" since backporting libdirectfb is needed. ===== Release Sources ===== ==== Requirements ==== To compile Splashy yourself, apart from the libraries for libdirectfb, glib2 and the optional libjpeg and libpng, you'll also need their development packages (headers). ==== Downloading the sources ==== Go to the [[http://alioth.debian.org/project/showfiles.php?group_id=30657|download area]] (under //Files// section) and download the latest Splashy version's tarball (*.tar.gz or *.tar.bz2). ==== Compilation ==== To compile a tarball release, just extract it, enter the directory that will be created and run: ./configure --prefix=/ --libdir=/lib --sbindir=/sbin --sysconfdir=/etc --includedir=/usr/include --datarootdir=/usr/share --mandir=/usr/share/man make && make install ===== Development sources ===== ==== Requirements ==== To compile Splashy yourself you'll need the following additional applications: * autoconf 2.59 (or newer) * automake 1.9 (or newer) * libproc development files * libsysfs development files * libtool 1.5 (or newer) * make * pkg-config 0.14.0 (or newer) * [[http://directfb.org/|directfb]] 0.9.22 <= N <= 1.0.x (directfb 1.2 and up won't work) * [[http://gtk.org|glib2]] * [[http://packages.debian.org/unstable/libs/libmagic1|libmagic]] or file-devel * [[http://www.ijg.org|libjpeg]] and/or [[http://www.libpng.org/pub/png/libpng.html|libpng]] (optional) ==== Grabbing the sources ==== Run the following command: git clone git://git.debian.org/git/splashy/splashy.git And optionally: git clone git://git.debian.org/git/splashy/gsplashy.git git clone git://git.debian.org/git/splashy/splashy-themes.git **NOTE:** Developers should follow the [[developers]] instructions. ==== Compilation ==== Once you have downloaded/updated the sources, to compile Splashy just run: cd splashy ./autogen.sh --prefix=/ make && make install Optionally, to install all available Splashy themes: cp -r themes/* /etc/splashy/themes ==== Customizing Splashy ===== In order to install Splashy in your own custom distribution or variant of UNIX system, you would need to: - tell the system to start "/sbin/splashy boot" as early as possible - some "glue" to calculate the progressbar and update it using: splashy_update "progress NN" - you will need to exit Splashy at some point with: splashy_update exit In Linux you would need to pass "vga=NNN" and "splash" to your kernel as a parameter. vga= is needed by the Kernel to enable the framebuffer. "splash" tells Splashy that it should start at boot. In order for Splashy to know this, it will attempt to read from /proc/cmdline looking for the keyword "splash". This check should only happen on Linux, and not on any other UNIX system. ===== Compilation under Debian Sarge ===== To compile splashy under Debian Sarge you'll need to get libdirectfb 0.9.22 which is not available on Sarge. But backporting it from Sid is very simple. First grab sources : wget http://ftp.debian.org/debian/pool/main/d/directfb/directfb_0.9.25.1-3.diff.gz \ http://ftp.debian.org/debian/pool/main/d/directfb/directfb_0.9.25.1-3.dsc \ http://ftp.debian.org/debian/pool/main/d/directfb/directfb_0.9.25.1.orig.tar.gz dpkg-source -x directfb_0.9.25.1-3.dsc At this point, go into untared directory (directfb-0.9.22) and type : dpkg-checkbuilddeps It will show you the list of package needed to build (install them using aptitude). Finally, still in the same directory: dpkg-buildpackage -rfakeroot That's it, Sarge *.deb of libdirectfb 0.9.x. Just install them and [[installation|compile splashy as usual]]. ====== Uninstallation ====== The uninstallation of Splashy is rather simple. Just make sure to uninstall it in the adequate way depending on how you installed it. ===== From Debian package ===== If you installed Splashy from a Debian package, the process is a lot simpler: dpkg --purge splashy splashy-themes ===== From sources ===== If you compiled and installed Splashy from sources, enter Splashy's sources' directory adn run make uninstall ===== Manually ===== It is not recommended to remove it this way unless all other uninstallation methods failed. Removing Splashy manually is as easy as simply removing Splashy's binaries (//splashy//, //splashy_update//, //splashy_config// and //splashy_pgrep//) and init scripts from your system. The following command will remove all Splashy files, no matter what version of Splashy you are using: rm -f /sbin/splashy* /etc/{init,rc?}.d/[SK][0-9][0-9]splashy{Z,[0-9][0-9],-init} //[[start|Go back to main page]]//