XDECORATIONS(1)

NAME
xdecorations - manual page for xdecorations 0.1.9

DESCRIPTION
Some eye candy for the holidays, including lights, trees, snowmen, pumpkins, flying sleighs and witches, snow and autumn leaves.
This is along the lines of xsnow/xpenguins, and allows you to set themeable decorations on the desktop, you can choose ( at the moment ) Halloween, Xmas, Autumn or Weather themes or you can add your own.
You can set the speed of the various parts of the theme and their positions, either from the command line or from a config file, ( there is a documented default config file included ).
This works with a number of different WM's, but please see the INSTALL file for details on building/running and some work arounds.
Please see the INSTALL file for basic usage and the documented .rc config file.
Got to my webpage to see some short movies of XDecorations in action with config files.

MAIN OPTIONS
These are the application options.
-theme STRING
    Set theme name ( default 'Xmas' )
-delay INTEGER
    Set main delay
-configfile FILEPATH
    Set new config file ( using only one instance of this makes any sense )
-writeconfig FILEPATH
    Write out a new config file including currently loaded config file,defaults and command line options then exit Options after this are ignored
-noconfig
    Dont't load the default config file ( ~/.config/xdecorations.rc )
-usewindow/-no-usewindow
    Use a transparent window instead of the root window
-usebuffer/-no-usebuffer
    Use double buffering Using double buffering gives best graphical results but is slower The default is to use a transparent window with double buffering
-watchconfig/-no-watchconfig
    Monitor changes to last loaded config file and apply any changes in real time ( experimental be warned! )
-data FOLDERPATH
    Set path to folder containing pixmap data, default is PREFIX/share/XDecorations/pixmaps.

LAMPS OPTIONS
These are the options for controlling the lamps.
-lampset INTEGER
    The number of the lamp set to use ( 0=no lamps )
-lampy INTEGER
    Lamp Y position
-lampdelay INTEGER
    Delay for flashing lamps
-lampflash INTEGER
    Lamp flash type 0=flash, 1=inverted chase, 2=chase ,3=random, 4=cycle
-lampcycledelay INTEGER
    Delay before cycling to the next flash type

FLYERS OPTIONS
These are the options for controlling the flyers.
-flyer INTEGER
    Flying object set ( 0=disable flyers )
-maxflyers INTEGER
    Number of flying objects to use <100 If the number of flyers are > 0 then the image is chosen randomly from the available flyers If the number of flyers are < 0 then tthe image is chosen sequentially
-flyermaxy INTEGER
    Lowest point on screen for flying objects
-spread INTEGER
    Random delay for flying objects
-flydelay INTEGER
    Flying objects delay
-flystep INTEGER
    Amount to move flying objects
-flyanimdelay INTEGER
    Delay for animation of flying objects

TREES OPTIONS
These are the options for controlling the trees.
-tree INTEGER
    The number of the tree to use ( 0=no tree ) If no trees are shown star/treelights/tinsel are also disabled
-treex INTEGER
    Absolute X position of tree
-treey INTEGER
    Absolute Y position of tree
-showstar/-no-showstar
    Show star
-stardelay INTEGER
    Delay for star
-showtinsel/-no-showtinsel
    Show tinsel
-treelampset INTEGER
    Lampset to use on tree
-treelampdelay INTEGER
    Tree lamps delay
You can also use the terms left/centre/right on the command line with -treex to position the tree.
You can also use the terms top/centre/bottom ont the commandline with -treey to position the tree.
To use top, left etc in the config file substitute the following values, LEFT=-1000,CENTRE=-2000,RIGHT=-3000,TOP=-4000,BOTTOM=-5000

FIGURE OPTIONS
These are the options for controlling the figure.
-figure INTEGER
    The number of figure to use ( 0=no figure )
-figurex INTEGER
    Absolute X position of figure
-figurey INTEGER
    Absolute Y position of figure
-figuredelay INTEGER
    Delay for figure
You can also use the terms left/centre/right on the command line with -figurex to position the figure.
You can also use the terms top/centre/bottom ont the commandline with -figurey to position the figure.
To use top, left etc in the config file substitute the following values, LEFT=-1000,CENTRE=-2000,RIGHT=-3000,TOP=-4000,BOTTOM=-5000

FALLING OPTIONS
These are the options for controlling the falling objects.
-falling INTEGER
    The set number of the falling objects to use ( 0=no falling objects )
-falldelay INTEGER
    Delay for falling objects
-maxfalling INTEGER
    Maximum number of falling objects INTEGER<5000
-fallingspread INTEGER
    Random deleay between new falling objects appearing
-fallingspeed INTEGER
    Distance falling objects move in Y direction in one go
-minfallspeed INTEGER
    Min distance falling objects move in Y direction in one go ( MUST be less than fallingspeed )
-drift INTEGER
    Falling objects max X step
-fallinanimdelay INTEGER
    Delay for animation of falling objects

WIND OPTIONS
These are the options for controlling the wind.
-wind INTEGER
    Wind speed/direction ( +INTEGER wind>>> -INTEGER wind<<< 0 no wind )
-usegusts/-no-usegusts
    Use/don't use gusts of wind
-gustlen INTEGER
    Duration of gusts of wind
-gustdelay INTEGER
    Random delay between gusts of wind
-gustspeed INTEGER
    Speed of gusts of wind
-bsettleheight INTEGER
    Height of settled snow etc on bottom of desktop, 0 = Don't let snow settle
-wsettleheight INTEGER
    Height of settled snow etc on windows, 0 = Don't let snow settle
-settlerate INTEGER
    Rate at which settling occurs - lower the number slower but better Settled snow etc is swept clean at the end of a gust You should set drift > 1 for a more relalistic settle after being swept clean
-clearonmaxheight/-no-clearonmaxheight
    Clear the snow etc when it reaches the maximum height set by bsettleheight/wsettleheight
As some window managers include the decorations in the reported window size and some don't you may need to add an offset to where the snow etc starts to settle, KDE will need this xfce4wm may or may not need this. The bottom offset is to raise the start of settled snow etc from the bottom of the screen if you have a bottom panel.
-woffsety INTEGER
    Offset the settled layer on windows by INTEGER
-boffsety INTEGER
    Offset the settled layer froom the bottom by INTEGER

AUTHORS
K.D.Hedger.
keithdhedger@gmail.com
Bugs etc to the above email address.

SEE ALSO
Commented example configfile installed in $(pkgdatadir)/docs ( usually /usr/share/XDecorations/docs ).