chbg-1.1(1)

NAME
chbg - root background image changer & manager for X

SYNOPSIS
chbg [ OPTIONS.. ] [IMAGE FILES]

DESCRIPTION
chbg is a simple program for managing & changing desktop pictures that can also be used as a xscreensaver(1) client.

OPTIONS

-v  prints version number and exit.

-h  prints help message and exit.

-setup
    starts setup window.

-notooltips
    disable tooltips inside configuration windows

-scenario filename
    fetch parameters from specified file.

-mode type
    set picture rendering mode from following types : tile, mirror, center, maximize, smart, centertile, inttile, symtile, intmirror, symmirror.
     (default : smart)

-effect n
    effect type for changing pictures [0-29].
     0 : random effect.
     1 : no effect. (default)
     2-29 : various picture changing effects.

-bg "#rrggbb"
    set default background color 1. (default : #000000)

-bg2 "#rrggbb"
    set default background color 2. (default : #ffffff)

-rand_colors
    randomize background colors.

-shader n
    set background color shading efect type [0-529].
     0 : no shading. (default)
     1 : random shading style.
     2-529 : various shading types.

-interval n.n
    time between picture changes in minutes.
     (default : 5)

-max_grow n.n
    maximal growing ratio of picture in smart mode.
     (default : 1.0)

-max_size percentage
    maximal size of picture in % of screen size used in smart mode, acceptable value 10-100.
     (default : 90)

-randomize
    randomize picture order.

-screensaver
    act as screensaver.

-xscreensaver
    act as xscreensaver client.

-speed n
    speed ratio for picture changing efects. smaller value means faster change.
     (default : 100)

-blank
    show blank screen, when can't load picture.

-cycle_blank
    when pictures not present cycle with blanking screen. (optionaly with shading)

-R  recurse through directory and search pictures. See also options -pattern and -min_psize.

-pattern pattern
    wildcard pattern for picture selection in recursion through directories. When you want to use more patterns, use more -pattern options.
     (effects only when used with -R option)

-inwindow
    run in own window not on root.

-windowid id
    run in existing window.

-run
    start run after setup window is popped up.
     (effects only when used with -setup option)

-min_psize nr
    minimal size of picture when recursing through directory. This option allows you to exclude small pictures or posible thumbnails.
     (effects only when used with -R option)

-deffects list
    list of disabled picture changing effects when randomizing. This option allows you to omit some picture changing effects, which you don't like or which doesn't suits your needs. Usable, when you wan't reject some of slow effects when faster changing is required.

-dshaders list
    list of disabled background shading effects when randomizing. This option allows you to omit some picture changing effects, which you don't like or which doesn't suits your needs.

-notooltips
    disable showing of tooltips with descriptions for setup controls.

-friter nr
    set number of iterations in fractal based shading effects.

-rect_size nr
    set size of used rectangle in any of picture changing effects.

-grad_dir dir
    directory where is located GIMP gradients directory on your system. As default are scaned directories /usr/share/gimp/gradients, /usr/share/gimp-1.1/gradients, /opt/share/gimp/gradients, /opt/share/gimp-1.1/gradients, /usr/local/share/gimp/gradients. /usr/local/share/gimp-1.1/gradients.
     When on your system are GIMP gradients somewhere elsewhere, use this option to force chbg to load GIMP gradients from your directory. When ChBg can't find gradient, it will automaticaly disable all gradient shading features.

-use_grad
    Enable using of GIMP gradients for coloring background shading effects.

-grad nr
    Set gradient number to use for coloring background shading effects. 0 means random.

-remember
    Allow remembering of last shown picture. This is very usable when you maintain very long list of pictures and next time when you run chbg with same scenario file you want to continue from that point where you left chbg last time.
     WARNING: this feature requires to have saved scenarion and that scenario must be writable by user.

-enlightenment
    If you are running Enlightenment window manager on your desktop, you may want to use its functions to manage desktop background images. When you enable this option, chbg will try to use its capabilities. This works only with enlightenment 0.16 and above using eesh program.

-once
    This option have only effect, when is used from commandline and pavuk will run without GUI environment. When this option is used, pavuk will run only one cycle of background changing and after that it will exit. This is usable if you want to change background once per session (for example from .xinitrc or .xsession startup scripts or Gnome/KDE session managers).

-thumb type
    You can use this option when you just want to use directly one of chbg's thumbnail previews. As type use one of all/dir/page .

FILES
chbgrc.sample
    Sample configuration file.

BUGS
See file BUGS in chbg source distribution.

AUTHOR
Programm - Stefan Ondrejicka <ondrej@idata.sk>
Manual page - Mikko Kilponen <mikil@uni.kaapeli.net>

SEE ALSO
X(1), xscreensaver(1), xscreensaver-command(1).