1= fvwm-root(1) 2 3== NAME 4 5fvwm-root - Sets the root window of the current X display to image 6 7== SYNOPSIS 8 9*fvwm-root* [**--retain-pixmap**|*-r*] [*--no-retain-pixmap*] 10[**--dummy**|*-d*] [*--no-dummy*] [*--dither*] [*--no-dither*] 11[*--color-limit* [_ncolors_] ] [*--no-color-limit*] 12[**--help**|**-h**|*-?*] [**--version**|*-V*] _image_file_ 13 14== DESCRIPTION 15 16_fvwm-root_ reads the image file specified in the command line and 17displays it in the root window. The supported image formats are _XBM_, 18_XPM_, _PNG_ and _SVG_ if appropriated libraries are compiled in. 19 20SVG rendering options (as described in the * ICONS AND IMAGES * section 21of the main fvwm documentation) can be utilized. 22 23== OPTIONS 24 25These command line options are recognized by fvwm-root: 26 27*--retain-pixmap* | *-r*:: 28 Causes fvwm-root to retain and publish the Pixmap with which the 29 background has been set (the ESETROOT_PMAP_ID and _XROOTPMAP_ID 30 properties are used). This is useful for applications which want to 31 use the root Pixmap on the background to simulate transparency (for 32 example, Eterm and Aterm use this method). This option should also be 33 used for the RootTransparent colorset option, refer to the COLORSETS 34 section of fvwm(1). If this option is not used, fvwm-root sets the 35 _XSETROOT_ID property to None, and some programs, like fvwm modules, 36 may use this to update their background if the background is 37 transparent (Transparent colorset). 38+ 39Note, a well behaved program, like fvwm, should listen to both 40_XSETROOT_ID and _XROOTPMAP_ID property changes and update itself 41correspondingly. However some programs listen only to one of them, so 42you should either use this option or not depending on what part is 43implemented by these programs. You should also use this option to get 44fast root-transparent menus in fvwm. 45 46*--no-retain-pixmap*:: 47 This is a default. May be useful to explicitly force the default even 48 if "--retain-pixmap" is specified earlier. 49*--dummy* | *-d*:: 50 Causes fvwm-root NOT to set the background, but to only free a memory 51 associated with the ESETROOT_PMAP_ID property (if any). In any case 52 the _XSETROOT_ID property is set to None. 53*--no-dummy*:: 54 This is a default. May be useful to explicitly force the default even 55 if "--dummy" is specified earlier. 56*--dither*:: 57 Causes fvwm-root to dither images for "smoother" rendition on displays 58 with color depth of 16 or lower. This the default with color depth 59 less or equal to 8. 60*--no-dither*:: 61 Causes fvwm-root NOT to dither images. This is the default with color 62 depth greater than 8. 63**--color-limit **__ncolors__:: 64 Causes fvwm-root to limit its color use to _ncolors_ (if specified). 65 This option is taken in account only with color depth less or equal to 66 8 (and a TrueColor or GrayScale visual). The default is to use the 67 same color limit as fvwm. So in normal situation this option is not 68 useful. However, if fvwm use a private colors map, as fvwm-root always 69 use the default colors map you should use this option for limiting 70 colors correctly. If _ncolors_ is not specified a default is used. 71*--no-color-limit*:: 72 Causes fvwm-root NOT to limit its color use. 73*--help*:: 74 Shows a short usage. 75*--version*:: 76 Shows a version number. 77 78== BUGS 79 80Repeated use of fvwm-root with different xpm pixmaps will use up slots 81in your color table pretty darn fast. 82 83== AUTHOR 84 85Rob Nation 86 87Rewritten and enhanced by fvwm-workers. 88