Table of Contents

Themes documentation


Splashy theme handling abilities is superb! Splashy offers XML based themes that can be tested against a well known schema. This is one of the best features of Splashy. Changing a theme is a simple as:

  1. edit /etc/splashy/config.xml
  2. (optional) update initramfs initrd file

See more details below.

Theme Specifications

  cd /etc/splashy/themes
  ls default/
    theme.xml
    background.png

  cat default/theme.xml
    ...
    <name>default</name>
    ...

Getting themes

You will find Splashy themes inside the Splashy tarball1) in the themes/ directory.

Probably your distribution already provides packages with Splashy themes. Debian, for example, has a splashy-themes package.

If you wish to take a preview of themes, some of them are available for preview in the screenshots article.

Installing a theme

Installing a theme is pretty easy with Splashy. You can do it through Splashy's splashy_config command (recommended) or manually.

Installing themes through splashy_config

Once you have downloaded the theme tarball, run the following command:

splashy_config -i <path_to_tarball>

You must run that command as root super-user.

Installing themes manually

It is strongly recommended to use splashy_config rather than doing this manually. But if you are still interested in doing things on your own, just follow the these steps:

  1. Download a theme tarball
  2. See in /etc/splashy/config.xml what path is defined between the <themes> tags2)
  3. Extract the tarball in that path
  4. (optionally) update your initramfs image (update-initramfs -u on Debian/Ubuntu/Xandros) to update your initrd image

Notes: Splashy uses /etc/default/splashy to know whether it should be in initramfs or not. In the future, splashy_config will check this and run the proper command according to the distribution being used. It's safe to run update-initramfs -u anyway.

Setting the theme to use

Once you have installed a theme, if you like it, you might want splashy to use it.

Again, changing the theme is pretty easy with Splashy. You can do it through Splashy's splashy_config command (recommended) or manually.

Note: if you are using Splashy from initramfs, you will need to update your image. On Debian/Ubuntu this can be done by simply running: sudo update-initramfs -u

Setting themes through splashy_config

Setting a theme in Splashy can't get any easier:

Once the theme is installed, just run splashy_config -s <name> where name is the name of the theme3)

Setting themes manually

The manual way is safe in most cases, but it is still recommended to use splashy_config whenever possible rather than doing things on your own. Just follow the following steps:

  1. Edit /etc/splashy/config.xml
  2. Look for a line like this: <current_theme>default</current_theme>
  3. Change default (or whatever you have there) for the name of the theme you wish to use.

Creating a theme

Splashy also provides a tool for easily creating themes of your own:

 splashy_config -c

Once the above command is executed, splashy_config will prompt for the details about the theme you wish to create and create a new directory. This directory is the theme!

You can also see splashy_config's help4) for a non-interactive way of creating themes (for use with scripts, for example).

You are wellcome to pack this theme in a tarball5) and send it to us.

Getting new themes

You can get user contributed themes or upload your own online from here.

Contributing themes

You can send your own themes to us using the following email address (please reformat the address correctly):

splashy-users <AT~> lists.alioth.debian.org

Go back to main page

1) A .tar.gz file
2) The default path is /etc/splashy/themes
3) The name you should use corresponds to the name of the theme's directory in /etc/splashy/themes
4) splashy_config's help is accessible through splashy-config -h
5) To create a tarball run tar czf THEME_NAME.tar.gz THEME_DIRECTORY