wrlib: return NULL if XImage could not be taken, for consistency
[wmaker-crm.git] / doc / wmsetbg.1x
blobc626d62e28b4faa7789aee129a8ddbaf7aa81314
1 .\" Hey, Emacs!  This is an -*- nroff -*- source file.
2 .TH wmsetbg 1x "January 1999"
3 .SH NAME
4 wmsetbg \- sets the background on the X11 display
5 .SH SYNOPSIS
6 .B wmsetbg
7 [\-display] [{\-v|\-\-version}] [{\-h|\-\-help}] [{\-S|\-\-smooth}]
8 [{\-X|\-\-xinerama}] [{\-b|\-\-back\-color} \fIcolor\fP]
9 [{\-t|\-\-tile}|{\-e|\-\-center}|{\-s|\-\-scale}|{\-a|\-\-maxscale}|{\-f|\-\-fillscale} \fIimage\fP]
10 [{\-d|\-\-dither}|{\-m|\-\-match}] [\-u|\-\-update\-wmaker]
11 [{\-D|\-\-update\-domain} \fIdomain\fP] [{\-c|\-\-colors} \fIcpc\fP]
12 [{\-p|\-\-parse} \fItexture\fP] [{\-w|\-\-workspace} \fIworkspace\fP]
13 .SH DESCRIPTION
14 .B wmsetbg
15 reads the specified
16 .I image
17 (XPM, PNG, jpeg, Tiff, raw PPM) 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 .B \-a|\-\-maxscale
24 scales the specified \fIimage\fP preserving its aspect ratio
25 .TP
26 .B \-b|\-\-back\-color
27 the specified \fIcolor\fP is used as the background color for the
28 \fItexture\fP.  Window Maker temporarely sets the background to this
29 color while loading and processing the texture.  You can specify colors
30 using their X11 names or as an RGB tiplet (either as "rgb:RR/GG/BB" or
31 "#RRGGBB") (reference to appropriate manpage should be here).  In the
32 later case \fIcolor\fB is a quoted string.
33 .TP
34 .B \-e|\-\-center
35 centers the specified \fIimage\fP
36 .TP
37 .B \-t|\-\-tile
38 tiles the specified \fIimage\fP
39 .TP
40 .B \-s|\-\-scale
41 scales the specified \fIimage\fP (default)
42 .TP
43 .B \-f|\-\-fillscale
44 scales the specified \fIimage\fP to fill screen while preserving aspect ratio
45 .TP
46 .B \-d|\-\-dither
47 dithers colors
48 .TP
49 .B \-S|\-\-smooth
50 smooth scaled image
51 .TP
52 .B \-X|\-\-xinerama
53 stretch image across Xinerama heads
54 .TP
55 .B \-m|\-\-match
56 matches colors
57 .TP
58 .B \-u|\-\-update\-wmaker
59 updates the Window Maker defaults database
60 .TP
61 .B \-D|\-\-update\-domain
62 updates the specified \fIdomain\fP database
63 .TP
64 .B \-c|\-\-colors
65 colors per channel to use
66 .TP
67 .B \-p|\-\-parse
68 parses the specified \fItexture\fP as a \fIproplist style texture\fP
69 .TP
70 .B \-w|\-\-workspace
71 update background only for the specified \fIworkspace\fP
72 .TP
73 .B \-h|\-\-help
74 print a help message
75 .TP
76 .B \-v|\-\-version
77 print version number
78 .SH SEE ALSO
79 .BR wmaker (1x)
80 .SH AUTHOR
81 This man page was written by Marcelo Magallon <mmagallo@debian.org>.
82 .PP
83 Window Maker was written by Alfredo K. Kojima <kojima@windowmaker.info>.
84 wmsetbg was written by Dan Pascu <dan@windowmaker.info>