NAME

FvwmWallpaper - change your X wallpaper from within Fvwm

SYNOPSIS

FvwmStorage should be spawned by fvwm(1) for normal functionality.

Run this module from your StartFunction:

AddToFunc StartFunction
+ I Module FvwmWallpaper

Then you can send commands to FvwmWallpaper, e.g.:

Key Return A CM SendToModule FvwmWallpaper menu

DESCRIPTION

FvwmWallpaper is a fvwm module written in Perl. It lets you change your X wallpaper from within Fvwm. FvwmWallpaper tries to find the best way to display your picture and resizes it if necessary. Resized pictures are cached. FvwmWallpaper can display a menu with thumbnails where you can select your wallpaper. Thumbnails are cached too.

INSTALLATION

Copy FvwmWallpaper into your fvwm module directory, e.g.:

sudo cp FvwmWallpaper $(fvwm-config -m)/

INITIALIZATION

During initialization, FvwmWallpaper gets config info from fvwm’s module configuration database (see fvwm(1), section MODULE COMMANDS). Available options are discussed below.

USAGE

Run the module, supposedly from StartFunction in .fvwm2rc:

Module FvwmWallpaper

Then send commands to it:

SendToModule FvwmWallpaper command

Valid commands are:

menu

menu

Display a menu where you can select a wallpaper image

set

set image

Set image as new wallpaper. image can be any image supported by ImageMagick. See ImageMagick(1) for details.

show_vars

show_vars

dump settings

cache_dir

FvwmWallpaper: cache_dir directory

Directory to store pictures created by FvwmWallpaper. This are thumbnails for the menu and prescaled background images. You may remove the contents of this directory at any time as FvwmWallpaper will recreate it when it’s needed. Default is $FVWM_USERDIR/.cache/wallpaper

debug

debug value`

Turn on debug mode if value is 1, turn it off if value is 0

menu_name

FvwmWallpaper: menu_name name

Use name as name for the wallpaper menu

menu_title

FvwmWallpaper: menu_title title

Use title as title for the wallpaper menu

pics_dir

FvwmWallpaper: pics_dir directory

Directory where FvwmWallpaper looks for background images.

thumbnail_size

FvwmWallpaper: thumbnail_size ``size

Use size as size for thumbnails in the wallpaper menu

wallpaper_format

FvwmWallpaper: wallpaper_format format

Use format as file format for wallpapers. format can be any file extension supported by ImageMagick

thumbnail_format

FvwmWallpaper: thumbnail_format format

Use format as file format for thumbnails. format can be any file extension supported by ImageMagick

max_x_scale_factor

FvwmWallpaper: max_x_scale_factor number

FvwmWallpaper should not vertically scale images more than factor times

max_y_scale_factor

FvwmWallpaper: max_y_scale_factor number

FvwmWallpaper should not horizontally scale wallpaper images more than factor times

min_x_tile_factor

FvwmWallpaper: min_x_tile_factor number

FvwmWallpaper will use tile mode if the screen is vertically at least number times bigger than the wallpaper image

min_y_tile_factor

FvwmWallpaper: min_y_tile_factor number

FvwmWallpaper will use tile mode if the screen is horizontally at least number times bigger than the wallpaper image

STARTUP

At startup first module options are read. The syntax is:

*FvwmWallpaper: command

Where command is any valid FvwmWallpaper command as described above