xsri(1) - f14

1XSRI(1)                     General Commands Manual                    XSRI(1)
2
3
4

NAME

6       xsri - set the root window background in X
7

SYNOPSIS

9       xsri [OPTION]...
10

DESCRIPTION

12       Allows the display of text, patterns, and images in the root window, so
13       users can customize the XDM-style login  screen  and/or  the  normal  X
14       background.
15
16       The image displayed by xsri is composed of three layers:
17
18       1)     A background color or gradient
19
20       2)     An optional tiled image
21
22       3)     An optional “emblem” image
23
24
25

OPTIONS

27   Mode Selection Options
28       --set  Set  the  background,  by the standard method used for setting a
29              users background (_XROOTPMAP_ID, ESETROOT_PMAP_I  point  to  the
30              pixmap ID, pixmap ID is owned by a persistant X connection which
31              must be killed with XKillClient). This is the default mode.
32
33
34       --run  Maintains the background while running, but  does  not  set  it.
35              This mode may take less memory than SET, since xsri can use mul‐
36              tiple windows to display the image,  and  will  work  better  on
37              Pseudo-color  displays.  On  exit,  the background will be in an
38              undefined state.
39
40
41       --test The image is displayed in a window which is half the  width  and
42              height of the screen.
43
44
45
46   Background Color and Gradient Options
47       --color=COLOR1
48              Set the background color.
49
50
51       --color2=COLOR2
52              If set, the background will be a gradient.
53
54
55       --hgradient
56              Draw  a horizontal gradient from COLOR1 at the left to COLOR2 at
57              the right. (Default if --color2 is given.)
58
59
60       --vgradient
61              Draw a vertical gradient from COLOR1 at the top to COLOR2 at the
62              bottom. (Default if --color2 is given.)
63
64
65
66   Tiled Image Options
67       --tile=IMAGE
68              The image to tile.
69
70
71       --tile-alpha={0-255}
72              The alpha value of the tile (255 == fully opaque, default)
73
74
75
76   Emblem Options
77       --emblem=IMAGE
78              Set the emblem image to IMAGE.
79
80
81       --emblem-alpha={0-255}
82              Set the alpha value of the emblem. The default is 255 ( == fully
83              opaque).
84
85
86       --emboss
87              Emboss the emblem on the background.
88
89
90       --geometry=[WIDTHxHEIGHT][+X+Y]
91              Set the location or size of the emblem.  Either  the  width  and
92              height or the location may be omitted.
93
94
95       --center-x
96              Center the emblem in the X direction.
97
98
99       --center-y
100              Center the emblem in the Y direction.
101
102
103       --scale-width[=PERCENT]
104              Scale  the emblem horizontally to a fraction of the width of the
105              screen. 100% is the default.
106
107
108       --scale-height[=PERCENT]
109              Scale the emblem vertically to a fraction of the height  of  the
110              screen. 100% is the default.
111
112
113       --avoid=WIDTHxHEIGHT[+X+Y]
114              Shrink  the  width  and/or  height of the emblem as necessary to
115              avoid the given rectangle. If X and Y  are  not  specified,  the
116              rectangle is centered. (Implies --keep-aspect.)
117
118
119       --keep-aspect
120              The  width  or  height of the emblem will be shrunk as needed to
121              maintain the aspect ratio.
122
123
124

PLACEMENT AND SCALING

126       The placement and scaling item algorithm, specified exactly:
127
128       Set w and h to width and height of the image.
129
130       If --geometry=WxH was specifed, set  w  to  W,  h  to  H.  If  --scale-
131       width=PERCENT  was specified, set w to (PERCENT/100) * screen_width. If
132       --scale-height=PERCENT  was  specified,  set  h  to   (PERCENT/100)   *
133       screen_height.
134
135       Define  the  horizontal gravity point to be at center if --center-x was
136       specified; otherwise, at right if --geometry=-X was  specified;  other‐
137       wise at left.
138
139       Define  the  vertical  gravity  point to be at center if --center-y was
140       specified; otherwise, at bottom if --geometry=-Y was specified;  other‐
141       wise at top.
142
143       If  --center-x, was specified, set x to center the image on the screen;
144       otherwise, if the position was specified via geometry, use that; other‐
145       wise set x = 0.
146
147       If  --center-y, was specified, set y to center the image on the screen;
148       otherwise, if the position was specified via geometry, use that; other‐
149       wise set y = 0.
150
151       If  --keep-aspect or --avoid was specified, then if the aspect ratio is
152       narrower than that of the image, shrink the height to make  the  aspect
153       ratio  match;  if  the  aspect  ratio  is wider than that of the image,
154       shrink the height to make the apsect ratio match, keeping  the  gravity
155       point at the same location.
156
157       If  --avoid  was  specified, shrink the image, keeping the aspect ratio
158       the same and the gravity point in the same place  to  avoid  the  given
159       rectangle. If this isn't possible, do not display the emblem.
160
161

AUTHOR

163       Owen Taylor <otaylor@redhat.com>
164
165

COPYRIGHT

167       Copyright © 2001, Red Hat, Inc.  xsri is distributed under the terms of
168       the GNU General Public License.  See the included file “COPYING”.
169
170