bin/fvwm-root.1.in

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