1fvwm-root(1) Fvwm Modules fvwm-root(1)
2
6 fvwm-root - Sets the root window of the current X display to image
7
10 fvwm-root [--retain-pixmap|-r] [--no-retain-pixmap] [--dummy|-d] [--no-
11 dummy] [--dither] [--no-dither] [--color-limit [ncolors] ] [--no-color-
12 limit] [--help|-h|-?] [--version|-V] image_file
13
16 fvwm-root reads the image file specified in the command line and dis‐
17 plays it in the root window. The supported image formats are XBM, XPM,
18 PNG and SVG if appropriated libraries are compiled in.
19 SVG rendering options (as described in the ICONS AND IMAGES section
21 of the main fvwm documentation) can be utilized.
22
25 These command line options are recognized by fvwm-root:
26 --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
31 want to use the root Pixmap on the background to simulate trans‐
32 parency (for example, Eterm and Aterm use this method). This op‐
33 tion should also be used for the RootTransparent colorset op‐
34 tion, refer to the COLORSETS section of fvwm(1). If this option
35 is not used, fvwm-root sets the _XSETROOT_ID property to None,
36 and some programs, like fvwm modules, may use this to update
37 their background if the background is transparent (Transparent
38 colorset).
39 Note, a well behaved program, like fvwm, should listen to both
41 _XSETROOT_ID and _XROOTPMAP_ID property changes and update it‐
42 self correspondingly. However some programs listen only to one
43 of them, so you should either use this option or not depending
44 on what part is implemented by these programs. You should also
45 use this option to get fast root-transparent menus in fvwm.
46 --no-retain-pixmap
48 This is a default. May be useful to explicitly force the default
49 even if "--retain-pixmap" is specified earlier.
50 --dummy | -d
52 Causes fvwm-root NOT to set the background, but to only free a
53 memory associated with the ESETROOT_PMAP_ID property (if any).
54 In any case the _XSETROOT_ID property is set to None.
55 --no-dummy
57 This is a default. May be useful to explicitly force the default
58 even if "--dummy" is specified earlier.
59 --dither
61 Causes fvwm-root to dither images for "smoother" rendition on
62 displays with color depth of 16 or lower. This the default with
63 color depth less or equal to 8.
64 --no-dither
66 Causes fvwm-root NOT to dither images. This is the default with
67 color depth greater than 8.
68 --color-limit ncolors
70 Causes fvwm-root to limit its color use to ncolors (if speci‐
71 fied). This option is taken in account only with color depth
72 less or equal to 8 (and a TrueColor or GrayScale visual). The
73 default is to use the same color limit as fvwm. So in normal
74 situation this option is not useful. However, if fvwm use a pri‐
75 vate colors map, as fvwm-root always use the default colors map
76 you should use this option for limiting colors correctly. If
77 ncolors is not specified a default is used.
78 --no-color-limit
80 Causes fvwm-root NOT to limit its color use.
81 --help Shows a short usage.
83 --version
85 Shows a version number.
86
89 In the past this utility was called xpmroot. This name is still sup‐
90 ported as a symlink.
91
94 Repeated use of fvwm-root with different xpm pixmaps will use up slots
95 in your color table pretty darn fast.
96
99 Rob Nation
100 Rewritten and enhanced by fvwm-workers.
1023rd Berkeley Distribution 19 October 2022 (2.7.0) fvwm-root(1)