1UNCLUTTER-XFIXES(1)                                        UNCLUTTER-XFIXES(1)
2
3
4

NAME

6       unclutter-xfixes - rewrite of unclutter using the X11-Xfixes extension
7

SYNOPSIS

9       unclutter [--timeout seconds] [--jitter radius] [--exclude-root]
10       [--ignore-scrolling] [--ignore-buttons buttons] [--hide-on-touch]
11       [--fork|-b] [--help|-h] [--version|-v] [--start-hidden]
12
13       Compatibility arguments:
14
15       unclutter [--display|-d display] [--idle seconds] [--keystroke]
16       [--grab] [--noevents] [--reset] [--root] [--onescreen] [--not] name ...
17

DESCRIPTION

19       Hide the mouse cursor if it isn’t being used.
20
21       This version of unclutter is a rewrite of the original and uses the
22       x11-xfixes extension, which means that no fake windows or pointer
23       grabbing is needed. This should work better with window managers and
24       applications.
25

OPTIONS

27       --timeout seconds
28           Specifies the number of seconds after which the cursor should be
29           hidden if it was neither moved nor any button was pressed.
30           (Default: 5)
31
32       --jitter radius
33           Ignore cursor movements if the cursor hasn’t moved at least radius
34           pixels.
35
36       --exclude-root
37           Don’t hide the mouse cursor if it is idling over the root window
38           and not an actual window since in this case it isn’t obscuring
39           anything important, but rather just the desktop background.
40
41       --ignore-scrolling
42           Ignore mouse scroll events (buttons 4 and 5) so that scrolling
43           doesn’t unhide the cursor. This is a shortcut for --ignore-buttons
44           4,5. If you want to ignore horizontal scrolling as well, use
45           --ignore-buttons instead by specifying all buttons manually (e.g.
46           4,5,6,7).
47
48       --ignore-buttons
49           Defines the mouse buttons which do not unhide the cursor when
50           clicked. You can pass multiple button numbers by separating them
51           with ,.
52
53       --hide-on-touch
54           Hides the mouse cursor on touch events.
55
56       --start-hidden
57           Starts the cursor hidden.
58
59       --fork|-b
60           Fork unclutter to the background.
61
62       --help|-h
63           Display the usage and exit.
64
65       --version|-v
66           Display the version and exit.
67

TROUBLESHOOTING

69   --ignore-scrolling doesn’t work
70       This can happen, especially on trackpoints, if other button events,
71       e.g. for horizontal scrolling, are sent as well. You can try adding
72       some jitter, or verify by using xev -event button. If you want to
73       ignore horizontal scrolling as well, use --ignore-buttons instead of
74       --ignore-scrolling.
75

COMPATIBILITY

77       In order to be used as a drop-in replacement of unclutter,
78       unclutter-xfixes accepts all command line arguments of unclutter, but
79       ignores most of them.
80
81       --display|-d display
82           Specifies the X display to use. The same effect can be achieved by
83           setting the DISPLAY environment variable.
84
85       --idle seconds
86           This argument is mapped to --timeout.
87
88       --keystroke
89           This argument is ignored.
90
91       --grab
92           This argument is ignored.
93
94       --noevents
95           This argument is ignored.
96
97       --reset
98           This argument is ignored.
99
100       --root
101           This argument does the opposite of --exclude-root. Shouldn’t need
102           to be given, as this is the default behavior in unclutter-xfixes.
103
104       --onescreen
105           This argument restricts unclutter to the single screen specified in
106           --display or to the default screen of the display.
107
108       --not
109           This argument will result in all arguments that aren’t options or
110           option arguments, to be collected into a list that specifies
111           windows where the cursor shall not be removed. These will be the
112           windows where an element of the list matches, in a case insensitive
113           comparison, the starting characters of either the WM_NAME, or the
114           name or class of the WM_CLASS, properties of the window. (Note that
115           this argument can be given anywhere on the command line.)
116

AUTHOR

118       Ingo Bürk <ingo.buerk@airblader.de>
119           Author.
120
121
122
123                                  01/21/2023               UNCLUTTER-XFIXES(1)
Impressum