1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
<?xml version="1.0" encoding="UTF-8" ?>
<!-- $Id$ -->
<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"../docbook-xml/docbookx.dtd"
[
<!ENTITY % myents SYSTEM "../fvwm.ent" >
%myents;
]>
<section id='CursorStyle'>
<title>CursorStyle</title>
<cmdsynopsis>
<command>CursorStyle</command
><arg choice='plain'
><replaceable>context</replaceable
></arg
><arg choice='opt'
><group choice='plain'
><arg choice='plain'
><replaceable>num</replaceable
></arg
><arg choice='plain'
><replaceable>name</replaceable
></arg
><arg choice='plain'>None</arg
><arg choice='plain'>Tiny</arg
><arg choice='plain'
><replaceable>file</replaceable
><arg choice='opt'
><arg choice='plain'
><replaceable>x</replaceable
></arg
><arg choice='plain'
><replaceable>y</replaceable
></arg
></arg
></arg
></group
><arg choice='opt'
><arg choice='plain'
><replaceable>fg</replaceable
></arg>
<arg choice='plain'
><replaceable>bg</replaceable
></arg
></arg
></arg>
</cmdsynopsis>
<para>Defines a new cursor for the specified context. Note that this
command can not control the shapes an applications uses, for
example, to indicate that it is busy. The various contexts are:</para>
<variablelist>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="POSITION"/> (top_left_corner)</term>
<listitem><para>used when initially placing windows</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="TITLE"/> (top_left_arrow)</term>
<listitem><para>used in a window title-bar</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="DEFAULT"/> (top_left_arrow)</term>
<listitem><para>used in windows that do not set their cursor</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="SYS"/> (hand2)</term>
<listitem><para>used in one of the title-bar buttons</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="MOVE"/> (fleur)</term>
<listitem><para>used when moving or resizing windows</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="RESIZE"/> (sizing)</term>
<listitem><para>used when moving or resizing windows</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="WAIT"/> (watch)</term>
<listitem><para>used during certain fvwm commands (see <fvwmref cmd="BusyCursor"/> for details)</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="MENU"/> (top_left_arrow)</term>
<listitem><para>used in menus</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="SELECT"/> (crosshair)</term>
<listitem><para>used when the user is required to select a window</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="DESTROY"/> (pirate)</term>
<listitem><para>used for <fvwmref cmd="Destroy"/>, <fvwmref cmd="Close"/>, and <fvwmref cmd="Delete"/> commands</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="TOP"/> (top_side)</term>
<listitem><para>used in the top side-bar of a window</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="RIGHT"/> (right_side)</term>
<listitem><para>used in the right side-bar of a window</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="BOTTOM"/> (bottom_side)</term>
<listitem><para>used in the bottom side-bar of a window</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="LEFT"/> (left_side)</term>
<listitem><para>used in the left side-bar of a window</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="TOP_LEFT"/> (top_left_corner)</term>
<listitem><para>used in the top left corner of a window</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="TOP_RIGHT"/> (top_right_corner)</term>
<listitem><para>used in the top right corner of a window</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="BOTTOM_LEFT"/> (bottom_left_corner)</term>
<listitem><para>used in the bottom left corner of a window</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="BOTTOM_RIGHT"/> (bottom_right_corner)</term>
<listitem><para>used in the bottom right corner of a window</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="TOP_EDGE"/> (top_side)</term>
<listitem><para>used at the top edge of the screen</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="RIGHT_EDGE"/> (right_side)</term>
<listitem><para>used at the right edge of the screen</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="BOTTOM_EDGE"/> (bottom_side)</term>
<listitem><para>used at the bottom edge of the screen</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="LEFT_EDGE"/> (left_side)</term>
<listitem><para>used at the left edge of the screen</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="ROOT"/> (left_ptr)</term>
<listitem><para>used as the root cursor</para></listitem>
</varlistentry>
<varlistentry>
<term><fvwmopt cmd="CursorStyle" opt="STROKE"/> (plus)</term>
<listitem><para>used during a <fvwmref cmd="StrokeFunc"/> command.</para></listitem>
</varlistentry>
</variablelist>
<para>
The defaults are shown in parentheses above. If you ever want to
restore the default cursor for a specific context you can omit the
second argument.
</para>
<para>
The second argument is either the numeric value of the cursor as
defined in the include file <filename>X11/cursorfont.h</filename>
or its name (without the XC_ prefix). Alternatively, the xpm file
name may be specified. The name can also be
<fvwmopt cmd="CursorStyle" opt="None"/>
(no cursor) or
<fvwmopt cmd="CursorStyle" opt="Tiny"/>
(a single pixel as the cursor).</para>
<programlisting>
# make the kill cursor be XC_gumby (both forms work):
CursorStyle DESTROY 56
CursorStyle DESTROY gumby
</programlisting>
<para>
Alternatively, the cursor can be loaded from an (XPM, PNG or SVG) image
<replaceable>file</replaceable>. If fvwm is compiled with Xcursor support,
full ARGB is used, and (possibly animated) cursor files made with the
<command>xcursorgen</command> program can be loaded. Otherwise the cursor
is converted to monochrome.
</para>
<para>
The optional <replaceable>x</replaceable> and <replaceable>y</replaceable>
arguments (following a <replaceable>file</replaceable> argument) specifies
the hot-spot coordinate with 0 0 as the top left corner of the image.
Coordinates within the image boundary are valid and overrides any hot-spot
defined in the (XPM/Xcursor) image file. An invalid or undefined hot-spot
is placed in the center of the image.</para>
<programlisting>
CursorStyle ROOT cursor_image.png 0 0
</programlisting>
<para>The optional
<replaceable>fg</replaceable> and <replaceable>bg</replaceable>
arguments specify the foreground and background colors for the
cursor, defaulting to black and white (reverse video compared
to the actual bitmap). These colors are only used with monochrome
cursors. Otherwise they are silently ignored.</para>
<programlisting>
CursorStyle ROOT nice_arrow.xpm yellow black
</programlisting>
</section>
|
