doc/wmsetbg.1x

   1 .\" Hey, Emacs!  This is an -*- nroff -*- source file.
   2 .TH wmsetbg 1x "April 2015"
   3 .SH NAME
   4 wmsetbg \- sets the background on the X11 display
   5 .SH SYNOPSIS
   6 .B wmsetbg
   7 .RI [ \-display " display]"
   8 .RI [ \-\-update-domain " domain|" \-\-update-wmaker ]
   9 .RI [ options ]
  10 .RI [ image ]
  11 .SH DESCRIPTION
  12 .B wmsetbg
  13 reads the specified
  14 .I image
  15 (in any format supported by the
  16 .I WRaster
  17 library) and puts it on the root window. It can
  18 either scale the image or tile it to make it fit the root
  19 window. Window Maker uses this command internally to set the root
  20 window image on start up.
  21 .SH OPTIONS
  22 .TP
  23 .BR \-\-back\-color | \-b " \fIcolor\fP"
  24 the specified \fIcolor\fP is used as the background color for the
  25 \fItexture\fP.  Window Maker temporary sets the background to this
  26 color while loading and processing the texture.  You can specify colors
  27 using their X11 names or as an RGB triplet (either as "rgb:RR/GG/BB" or
  28 "#RRGGBB") (reference to appropriate manpage should be here).  In the
  29 later case \fIcolor\fB is a quoted string.
  30 .TP
  31 .BR \-\-center | \-e
  32 centers the \fIimage\fP in the screen
  33 .TP
  34 .BR \-\-colors | \-c " \fIcount\fP"
  35 limit the number of colors per channel to use for the image
  36 .TP
  37 .BR \-display " \fIdisplay\fP"
  38 connect to the X \fIdisplay\fP
  39 .TP
  40 .BR \-\-dither | \-d
  41 enable color dithering on \fIimage\fP
  42 .TP
  43 .BR \-\-fillscale | \-f
  44 scales the specified \fIimage\fP to fill screen while preserving aspect ratio
  45 .TP
  46 .BR \-\-help | \-h
  47 print a help message with the list of options
  48 .TP
  49 .BR \-\-match | \-m
  50 use the best-matching-color algorithm when converting image to indexed color palette
  51 .TP
  52 .BR \-\-maxscale | \-a
  53 scales the specified \fIimage\fP to fit inside the screen preserving its aspect ratio
  54 .TP
  55 .BR \-\-parse | \-p " \fItexture\fP"
  56 parses the specified \fItexture\fP as a \fIproplist style texture\fP
  57 .TP
  58 .BR \-\-scale | \-s
  59 scales the specified \fIimage\fP to fill the screen (default)
  60 .TP
  61 .BR \-\-smooth | \-S
  62 use a smooth scaling algorithm when resizing \fIimage\fP
  63 .TP
  64 .BR \-\-tile | \-t
  65 tiles the specified \fIimage\fP
  66 .TP
  67 .BR \-\-update\-domain | \-D " \fIdomain\fP"
  68 updates the specified \fIdomain\fP database
  69 .TP
  70 .BR \-\-update\-wmaker | \-u
  71 updates the Window Maker defaults database
  72 .TP
  73 .BR \-\-version | \-v
  74 print the version of Window Maker from which the program comes
  75 .TP
  76 .BR \-\-workspace | \-w " \fIworkspace\fP"
  77 update background only for the specified \fIworkspace\fP
  78 .TP
  79 .BR \-\-xinerama | \-X
  80 stretch image across Xinerama heads
  81 .SH "INDEXED COLOR SCREENS"
  82 If your screen is not in a \fBTrue Color\fP configuration (generally sold as 16,777,216 colors) but
  83 in a indexed color mode (256 colors, 16 colors, ... which are based on a \fBColorMap\fP) then Window
  84 Maker may need to process the image to convert it to a limited number of colors before using it for
  85 a background image.
  86
  87 There are two options to choose what algorithm you want to use:
  88 .TP
  89 .BR \-\-match " or " \-m
  90 Search for the closest matching color from the current colormap;
  91 this is the fastest algorithm but may lead to less good-looking result.
  92 .TP
  93 .BR \-\-dither " or " \-d
  94 Use a more complex algorithm which modify surrounding pixels to get a closer-looking color on average;
  95 this is slower but provides better looking images.
  96 .LP
  97 If none is specified, then it is Window Maker's configuration choice that will be used.
  98
  99 You can also use the option \fB\-\-colors\fP to reduce the total number of colors from the \fIimage\fP
 100 before the algorithm is applied.
 101 The value specified with the option defines the number of possible values for each primary color
 102 (red, green and blue), for example \fI8\fP would reduce the image to use only 8*8*8=512 colors before
 103 applying the conversion algorithm.
 104 .SH SEE ALSO
 105 .BR wmaker (1x)
 106 .SH AUTHOR
 107 This man page was written by Marcelo Magallon <mmagallo@debian.org>.
 108 .PP
 109 Window Maker was written by Alfredo K. Kojima <kojima@windowmaker.info>.
 110 wmsetbg was written by Dan Pascu <dan@windowmaker.info>