1UNCLUTTER(1X) UNCLUTTER(1X)
2
6 unclutter - remove idle cursor image from screen
7
9 unclutter [-display|-d display] [-idle seconds] [-keystroke] [-jitter
10 pixels] [-grab] [-noevents] [-reset] [-root] [-onescreen] [-not] name
11 ...
12
14 unclutter removes the cursor image from the screen so that it does not
15 obstruct the area you are looking at after it has not moved for a given
16 time. It does not do this if the cursor is in the root window or a
17 button is down. It tries to ignore jitter (small movements due to
18 noise) if you have a mouse that twitches.
19
21 -display
22 is followed by the display to open.
23 -idle is followed by the number of seconds between polls for idleness.
25 The default is 5.
26 -keystroke
28 tells unclutter not to use a timeout to determine when to remove
29 the cursor, but to instead wait until a key has been pressed
30 (released, really).
31 -jitter
33 is followed by the amount of movement of the pointer that is to
34 be ignored and considered as random noise. The default is 0.
35 -grab means use the original method of grabbing the pointer in order
37 to remove the cursor. This often doesn't interoperate too well
38 with some window managers.
39 -noevents
41 stops unclutter sending a pseudo EnterNotify event to the X
42 client whose cursor has been stolen. Sending the event helps
43 programs like emacs think that they have not lost the pointer
44 focus. This option is provided for backwards compatibility in
45 case some clients get upset.
46 -reset resets the timeout for idleness after the cursor is restored for
48 some reason (such as a window being pushed or popped) even
49 though the x y coordinates of the cursor have not changed. Nor‐
50 mally, the cursor would immediately be removed again.
51 -root means remove the cursor even if it is on the root background,
53 where in principle it should not be obscuring anything useful.
54 -onescreen
56 restricts unclutter to the single screen specified as display,
57 or the default screen for the display. Normally, unclutter will
58 unclutter all the screens on a display.
59 -not is followed by a list of window names where the cursor should
61 not be removed. The first few characters of the WM_NAME prop‐
62 erty on the window need to match one the listed names. This
63 argument must be the last on the command line.
64
66 The -keystroke option may not work (that is, the cursor will not disap‐
67 pear) with clients that request KeyRelease events. Games and Xt appli‐
68 cations using KeyUp in their translation tables are most likely to suf‐
69 fer from this problem. The most feasible solution is to extend unclut‐
70 ter to use the XTest extension to get all keyboard and mouse events,
71 though this of course requires XTest to be in the server too.
72 The -keystroke option does not distinguish modifier keys from keys
74 which actually generate characters. If desired this could be imple‐
75 mented in a simple way by using XLookupString to see if any characters
76 are returned.
77
79 The message
80 someone created a sub-window to my sub-window!
82 means that unclutter thinks a second unclutter is running, and tried to
84 steal the cursor by creating a sub-window to the sub-window already
85 used to steal the cursor. This situation quickly deteriorates into a
86 fight no one can win, so it is detected when possible and the program
87 gives up.
88
90 Mark M Martin. cetia 7feb1994. mmm@cetia.fr
91 UNCLUTTER(1X)