wallpaper

Package: WA2L/WinTools 1.2.08
Section: General Commands (1)
Updated: 08 February 2020
Index Return to Main Contents

 

NAME

wallpaper - generate and set a dynamic wallpaper

 

SYNOPSIS

WA2LWinTools/bin/wallpaper [ -h | -i | -u | -V | -l | -r ]

 

AVAILABILITY

WA2L/WinTools

 

DESCRIPTION

create and set a dynamic wallpaper based on a HTML file.

In the configuration file etc/wallpaper.cfg the credentials of the wallpaper to be set can be defined.

Hint: The wallpaper.cfg file can be found in the etc/ folder after an initial start of the wallpaper command. The configuration file will not be overwritten when a new version of the WA2L/WinTools package is installed.

See also wallpaper.cfg(4) for more information.

Because the desktop wallpaper is generated from a HTML page, many HTML features can be used to create a specific wallpaper. This includes for example transparent images, as it can be seen in the wallpaper.html file that is distributed with WA2L/WinTools.

 

Adjust wallpaper background color

When you use multiple monitors connected to the system they often don't have the same resolution. To produce the impression, that the image always fits the screen (on the small notebook monitor and the large extra monitor, for example) set the desktop background color identical to the wallpaper background color using the WALLPAPER_BGCOLOR=RED,GREEN,BLUE setting.

 

Customize the appearance of wallpapers

To customize the appearance of all wallpapers based on lib/wallpaper.js and lib/wallpaper.css, add the changes in the etc/wallpaper.css.cfg file:

   1 /*
   2  *
   3  * etc/wallpaper.css.cfg - Dynamic desktop wallpaper: Default Wallpaper (CSS) \
          user configuration for lib/wallpaper.css
   4  *
   5  * [00] 11.08.2015 CWa  Initial Version
   7  *
   8  */
   9 
  10 body
  11         {
  12         }
  13
  14 p.today
  15         {
  16         }
  :

Wallpapers based on lib/wallpaper.js and lib/wallpaper.css load first the lib/wallpaper.css file, then the etc/wallpaper.css.cfg file and finally the wallpaper HTML file specific style settings are applied.

Therefore only the changes to the lib/wallpaper.css have to be defined in etc/wallpaper.css.cfg or in the <style></style> section and not the entire CSS definition has to be specified.

 

Schedule regular wallpaper updates

To schedule the wallpaper command to automatically change the wallpaper in a regular interval: set the WALLPAPER_INTERVAL=<minutes> setting in the configuration file etc/wallpaper.cfg

 

OPTIONS

-h
usage message.

-i
install the wallpaper to 'Startup' in the Windows™ Start Menu.

-u
uninstall the wallpaper from 'Startup' in the Windows™ Start Menu.

-V
print program version.

-l
list schedule. This option lists the next automatic update of the wallpaper if the WALLPAPER_INTERVAL=<minutes> setting in wallpaper.cfg(4) is set to a value higher then 0.

-r
remove schedule of wallpaper from system.

 

ENVIRONMENT

%COMPUTERNAME%
name of the local computer. This variable is used to resolve the hostname if you use a host dependent configuration file.

%DOMAINNAME%
domain where the local computer is part of. This variable is used to resolve the domainname if you use a domain dependent configuration file.

 

EXIT STATUS

0
no error.

4
usage message displayed.

5
version message displayed.

 

FILES

etc/wallpaper.cfg
configuration file of wallpaper , see wallpaper.cfg(4) for more information.

etc/wallpaper.domainname.cfg
user domain dependent configuration file of wallpaper. This file has preference over etc/wallpaper.cfg. See wallpaper.cfg(4) for more information.

etc/wallpaper.hostname.cfg
host dependent configuration file of wallpaper. This file has preference over etc/wallpaper.domainname.cfg. See wallpaper.cfg(4) for more information.

var/wallpaper/
directory holding all HTML wallpaper files.

var/wallpaper/wallpaper.html
default wallpaper.

var/wallpaper/wallpaper.png
image for default wallpaper.

var/wallpaper/gallery/
default directory for image files shown in gallery wallpapers (full.html, gallery). To include other or more directories, use the WALLPAPER_GALLERY="filelist" setting in etc/wallpaper.cfg.

lib/wallpaper.css
CSS sheet for default wallpaper (not to be changed).

etc/wallpaper.css.cfg
configuration to the CSS sheet file lib/wallpaper.css. Add your customization to this file to protect your customization from overwriting when you upgrade the WA2L/WinTools package.

lib/wallpaper.js
java script file for default wallpaper (not to be changed).

Add customization/settings, to the file etc/wallpaper.js.cfg and not to the file lib/wallpaper.js due to the fact that on upgrades of the WA2L/WinTools package, your changes will be lost.

lib/cites.js
cites java script file for default wallpaper (not to be changed).

Add own cites to the file etc/wallpaper.js.cfg and not to the file lib/cites.js due to the fact that on upgrades of the WA2L/WinTools package, your changes will be lost.

lib/webcams.js
webcams java script file for default wallpaper (not to be changed).

To update the lib/webcams.js file independent from a WA2L/WinTools upgrade, use the WebcamsDownload(1m) command.

etc/wallpaper.js.cfg
configuration to the java script files lib/wallpaper.js and lib/cites.js. Add your customization to this file to protect your customization from overwriting when you upgrade the WA2L/WinTools package.

lib/webcamstest.html
test file for the definitions in the lib/webcams.js file.

var/cache/wallpaper/wallpaper.bmp
generated wallpaper image out of a defined HTML file. This file is set as desktop wallpaper and re-generated by subsequent calls of wallpaper.

var/cache/wallpaper/wallpaper.flag
if multiple wallpapers are specified in the WALLPAPER_HTML setting in the wallpaper.cfg file, this flag-file contains the index number of the last wallpaper chosen out of the specified list.

var/cache/wallpaper/wallpaper.js
dynamic system settings (as monitor count and monitor resolutions) and some settings made in etc/wallpaper.cfg made available as JavaScript variables in the HTML definition of lib/wallpaper.js based wallpapers.

 

EXAMPLES

-

 

SEE ALSO

wintoolsintro(1), config(1m), webcamsdownload(1m), wallpaper.cfg(4), wallpaperpack(1m), wscheduler(1)

 

NOTES

The wallpapers wallpaper.html, blank.html, full.html, gallery.html, porthole.html, rega.html, shark.html, sharkfin.html, webcams.html, whale.html and window.html are distributed with the WA2L/WinTools package.

When you add your own wallpapers to the var/wallpaper/ directory you should choose other names then the ones listed above, otherwise your changes will be lost on an upgrade of WA2L/WinTools.

HTML-, JavaScript- and CSS-files used to create own wallpapers should be written in DOS file format (not UNIX).

A handy, fast and simple web browser to debug wallpapers and to see JavaScript output using 'View Source', that is written to the document using document.write(text); is SlimBoat. See: http://www.slimboat.com for more information about SlimBoat Web Browser, fast & full-featured web browser for Windows, Linux & Mac.

For an online calculator from Hex to RGB values, see: http://www.exadium.com/tools/rgb-to-hex-colour-converter/ or http://www.farbtabelle.at/farben-umrechnen/ .

 

BUGS

If you run wallpaper within a DropBox folder you must define the WALLPAPER_TMPDIR setting in the etc/wallpaper.cfg setting outside of DropBox folders ( e.g: WALLPAPER_TMPDIR=%TMP% ).

 

AUTHOR

wallpaper was developed by Christian Walther. Send suggestions and bug reports to wa2l@users.sourceforge.net .

 

COPYRIGHT

Copyright © 2020 Christian Walther

This is free software; see WA2LWinTools/man/COPYING for copying conditions. There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


 

Index

NAME
SYNOPSIS
AVAILABILITY
DESCRIPTION
Adjust wallpaper background color
Customize the appearance of wallpapers
Schedule regular wallpaper updates
OPTIONS
ENVIRONMENT
EXIT STATUS
FILES
EXAMPLES
SEE ALSO
NOTES
BUGS
AUTHOR
COPYRIGHT

This document was created by man2html using the manual pages.
Time: 16:33:15 GMT, September 14, 2024