SPLASHY-CONFIG.XML(5) Splashy POSIX boot splash system SPLASHY-CONFIG.XML(5)NAME
Splashy - a user-mode, POSIX and LSB compliant, boot splashing system for UNIX.
SYNOPSIS
/etc/splashy/config.xml - Splashy's configuration file
DESCRIPTION
/etc/splashy/config.xml sets splashy's behaviour during boot, shutdown inter-runlevel and error. It is an XML file where all values are
enclosed in tags
A tag is anything enclosed between < and >. An opening tag has the form "<tag>" while a closing tag has its name preceded with a backslash
() character as in "< ag>"
Tags can be considered as folders. Each tag either contains tags or contains a value
The value of the final tag affects in the field defined by its parents tags
The following tag folders are supported:
<splashy>
This tag is mandatory. It contains all splashy's configuration values, listed below.
The following values are supported:
<themes>
Absolute path to the directory containing the installed splashy themes. Default: /etc/splashy/themes
<current_theme>
Name of the theme to use. It must be the name of a directory in <themes>'s value's directory. Default: default
<default_theme>
Full path to a theme to fall back to if the theme specified in <current_theme>'s value can't be found. Default:
/etc/splashy/themes/default
<pid> Full path to the PID file splashy will use to store its PID so that other processes can know if it is running. Default:
/var/run/splashy.pid
Comments can be introduced by enclsing them between <!-- and -->. Blank lines are also ignored
EXAMPLES
The following is a complete and valid splashy configuration file:
<splashy>
<!-- themes directory: conventional path /etc/splashy/themes -->
<themes>/etc/splashy/themes</themes>
<!-- current theme could be relative the themes defined above or full path -->
<current_theme>default</current_theme>
<!-- full path to theme to fall back in case of problems. DO NOT CHANGE -->
<default_theme>/etc/splashy/themes/default</default_theme>
<!-- this defaults should be ok -->
<pid>/var/run/splashy.pid</pid>
</splashy>
NOTES
Values are refered by their tag name prefixed with all of its parent tag's names. For example: "/splashy/pid"
FILES
/etc/splashy/config.xml
Main configuration. Defines how splashy should be setup
/etc/splashy/themes/
Location where splashy themes are stored
SEE ALSO splashy(1), splashy_config(1), splashy_config(1), splashy-theme.xml(5)AUTHORS
Jacobo Vilella <jacobo221@gmail.com>
perl v5.12.1 2010-07-05 SPLASHY-CONFIG.XML(5)
Check Out this Related Man Page
SPLASHY_CONFIG(1) Splashy POSIX boot splash system SPLASHY_CONFIG(1)NAME
Splashy - a user-mode, POSIX and LSB compliant, boot splashing system for UNIX.
SYNOPSIS
splashy_config [-h, --help] [-s, --set-theme THEME] [-i, --install-theme THEME.tar.gz] [-r, --remove-theme THEME][--info] [-c,
--create-theme [args...]]
DESCRIPTION
Splashy displays an image and a progress bar at boot time. splashy_config is used to change Splashy configuration options.
OPTIONS -h, --help
Print helps and exits
-s, --set-theme THEME
Changes current theme to THEME
-i, --install-theme THEME.tar.gz
Adds THEME to Splashy theme directory
-r, --remove-theme THEME
Removes THEME from theme directory
--info Prints all relevant information from the main Splashy config file
-c, --create-theme [args...]
Create a theme in an interactive mode if no arguments, else see the extra arguments section below
Extra arguments
--name NAME
Set the NAME of the new Splashy theme
--version VERSION
Set the VERSION of the new Splashy theme
--description DESC
Set the DESC of the new Splashy theme
--urls URLs Set the related URLs for this theme
--author AUTHOR
Set the AUTHOR(s) of the new Splashy theme
--boot-image PATH
Upload the boot image located at the specified PATH
--shutdown-image PATH
Upload the shutdown image located at the specified PATH
--error-image PATH
Upload the error image located at the specified PATH
--resume-image PATH
Upload the resume image located at the specified PATH
--suspend-image PATH
Upload the suspend image located at the specified PATH
--background-width WIDTH
Set the WIDTH of the background
--background-height HEIGHT
Set the HEIGHT of the background
--progressbar-x X-POSITION
Set the X-POSITION of the progress bar (percentage if the background height and width are not set, else pixel units)
--progressbar-y Y-POSITION
Set the Y-POSITION of the progress bar (percentage if the background height and width are not set, else pixel units)
--progressbar-width WIDTH
Set the WIDTH of the progress bar (percentage if the background height and width are not set, else pixel units)
--progressbar-height HEIGHT
Set the HEIGHT of the progress bar (percentage if the background height and width are not set, else pixel units)
--progressbar-red RED
Set the RED channel of the progress bar (0->255)
--progressbar-green GREEN
Set the GREEN channel of the progress bar (0->255)
--progressbar-blue BLUE
Set the BLUE channel of the progress bar (0->255)
--progressbar-alpha ALPHA
Set the ALPHA channel of the progress bar (0->255)
--progressbar-border-show yes|no
Set a border around the progressbar
--progressbar-border-red RED
Set the RED channel of the border around the progressbar (0->255)
--progressbar-border-green GREEN
Set the GREEN channel of the border around the progressbar (0->255)
--progressbar-border-blue BLUE
Set the BLUE channel of the border around the progressbar (0->255)
--progressbar-border-alpha ALPHA
Set the ALPHA channel of the border around the progressbar (0->255)
--progressbar-background-red RED
Set the RED channel of the background of the progressbar (0->255)
--progressbar-background-green GREEN
Set the GREEN channel of the background of the progressbar (0->255)
--progressbar-background-blue BLUE
Set the BLUE channel of the background of the progressbar (0->255)
--progressbar-background-alpha ALPHA
Set the ALPHA channel of the background of the progressbar (0->255)
--textbox-show yes|no
Set a text box
--textbox-x X-POS
Set the X-POS of the text box (percentage if the background height and width are not set, else pixel units)
--textbox-y Y-POS
Set the Y-POS of the text box (percentage if the background height and width are not set, else pixel units)
--textbox-width WIDTH
Set the WIDTH of the text box (percentage if the background height and width are not set, else pixel units)
--textbox-height HEIGHT
Set the HEIGHT of the text area (percentage if the background height and width are not set, else pixel units)
--textbox-red RED
Set the RED channel of the text area (0->255)
--textbox-green GREEN
Set the GREEN channel of the text area (0->255)
--textbox-blue BLUE
Set the BLUE channel of the text area (0->255)
--textbox-alpha ALPHA
Set the ALPHA channel of the text area (0->255)
--textbox-border-show yes|no
Set a border around the text area
--textbox-border-red RED
Set the RED channel of the border of the text area (0->255)
--textbox-border-green GREEN
Set the GREEN channel of the border of the text area (0->255)
--textbox-border-blue BLUE
Set the BLUE channel of the border of the text area (0->255)
--textbox-border-alpha ALPHA
Set the ALPHA channel of the border of the text area (0->255)
--text-font-file FILE
Upload the FONT file
--text-font-height HEIGHT
Set the HEIGHT of the text area font
--text-font-red RED
Set the RED channel of the text area font (0->255)
--text-font-green GREEN
Set the GREEN channel of the text area font (0->255)
--text-font-blue BLUE
Set the BLUE channel of the text area font (0->255)
--text-font-alpha ALPHA
Set the ALPHA channel of the text area font (0->255)
--autoverbose yes|no
Set if Splashy turn into verbose mode when an error appears at boot
--progressbar-visibility-boot yes|no
Set if Splashy shows a progress bar on boot
--progressbar-visibility-shutdown yes|no
Set if Splashy shows a progress bar on shutdown
--progressbar-visibility-resume yes|no
Set if Splashy shows a progress bar on resume
--progressbar-visibility-suspend yes|no
Set if Splashy shows a progress bar on suspend
--progressbar-direction-boot forward|backward
Set if the progress bar goes forward or backward on boot
--progressbar-direction-shutdown forward|backward
Set if the progress bar goes forward or backward on shutdown
--progressbar-direction-resume forward|backward
Set if the progress bar goes forward or backward on resume
--progressbar-direction-suspend forward|backward
Set if the progress bar goes forward or backward on suspend
--fadein yes|no
Set if Splashy appears smoothly
--fadeout yes|no
Set if Splashy disappears smoothly
EXAMPLES
"/usr/bin/splashy_config --info"
Shows all the themes currently installed.
FILES
/etc/splashy/config.xml
Main configuration. defines how splashy should be setup.
/etc/splashy/themes/default/theme.xml
Default theme. defines how the images displayed by splashy should be setup, their location and other theme-related variables.
SEE ALSO splashy(1), splashy_update(1), splashy-config.xml(5), splashy-theme.xml(5)AUTHORS
Vincent Amouret <vincent.amouret@gmail.com> Luis Mondesi <lemsx1@gmail.com>
perl v5.12.1 2010-07-05 SPLASHY_CONFIG(1)