1fvwm-root(1)                     Fvwm Modules                     fvwm-root(1)
2
3
4

NAME

6       fvwm-root - Sets the root window of the current X display to image
7
8

SYNOPSIS

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
14

DESCRIPTION

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
20       SVG  rendering  options  (as described in the  ICONS AND IMAGES section
21       of the main fvwm documentation) can be utilized.
22
23

OPTIONS

25       These 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
31              want to use the root Pixmap on the background to simulate trans‐
32              parency (for example, Eterm and Aterm  use  this  method).  This
33              option  should  also  be  used  for the RootTransparent colorset
34              option, refer to the COLORSETS  section  of  fvwm(1).   If  this
35              option  is not used, fvwm-root sets the _XSETROOT_ID property to
36              None, and some programs, like fvwm  modules,  may  use  this  to
37              update their background if the background is transparent (Trans‐
38              parent colorset).
39
40              Note, a well behaved program, like fvwm, should listen  to  both
41              _XSETROOT_ID  and  _XROOTPMAP_ID  property  changes  and  update
42              itself correspondingly.  However some programs  listen  only  to
43              one of them, so you should either use this option or not depend‐
44              ing on what part is implemented by these programs.   You  should
45              also use this option to get fast root-transparent menus in fvwm.
46
47       --no-retain-pixmap
48              This  is  a  default.  May  be  useful  to explicitely force the
49              default even if "--retain-pixmap" is specified earlier.
50
51       --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
56       --no-dummy
57              This is a default.  May  be  useful  to  explicitely  force  the
58              default even if "--dummy" is specified earlier.
59
60       --dither
61              Causes  fvwm-root  to  dither images for "smoother" rendition on
62              displays with color depth of 16 or lower. This the  defaut  with
63              color depth  less or equal to 8.
64
65       --no-dither
66              Causes  fvwm-root NOT to dither images. This is the default with
67              color depth greater than 8.
68
69       --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
79       --no-color-limit
80              Causes fvwm-root NOT to limit its color use.
81
82       --help Shows a short usage.
83
84       --version
85              Shows a version number.
86
87

COMPATIBILITY

89       In  the  past this utility was called xpmroot.  This name is still sup‐
90       ported as a symlink.
91
92

BUGS

94       Repeated use of fvwm-root with different xpm pixmaps will use up  slots
95       in your color table pretty darn fast.
96
97

AUTHOR

99       Rob Nation
100
101       Rewritten and enhanced by fvwm-workers.
102
103
104
1053rd Berkeley Distribution    09 May 2010 (2.5.30)                 fvwm-root(1)
Impressum