path: root/xdeadzone.1

.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "XDEADZONE" 1 "2024-02-04" "0.1" "Urchlay's Misc Stuff"
.SH NAME
xdeadzone \- keep the mouse pointer out of the dead zone, on mismatched multihead displays.
.\" RST source for xdeadzone(1) man page. Convert with:
.
.\" rst2man.py xdeadzone.rst > xdeadzone.1
.
.SH SYNOPSIS
.sp
xdeadzone [\fB\-b\fP | \fB\-w\fP ] [\fB\-n*] [\fP\-nw** | \fB\-ne\fP | \fB\-sw\fP | \fB\-se\fP ] \fIgeometry\fP
.sp
xdeadzone \fB\-\-help\fP | \fB\-\-version\fP
.SH DESCRIPTION
.sp
\fBxdeadzone\fP\(aqs job is to create a window of a specified size and
position, and prevent the mouse pointer from entering it.
.sp
The intended use for it is to keep the mouse out of the "dead zone"
of a multi\-head X display where the monitors don\(aqt all have the same
resolution.
.sp
It could also be useful for covering annoying parts of the screen,
e.g. advertisements in ad\-driven software like the Opera browser, or
Adobe Reader. Use absolute positioning (no \fB\-nw\fP, \fB\-ne\fP, \fB\-sw\fP,
\fB\-se\fP) for this, and either \fB\-b\fP or \fB\-w\fP to make the window
visible.
.sp
By default, \fBxdeadzone\fP doesn\(aqt display a visible window. It stays
on top of other windows, and is present on every virtual desktop.
If run with \fB\-b\fP or \fB\-w\fP, it\(aqll appear as a solid black or white
rectangle with no title bar or window frame... although if you\(aqre
using it to block the mouse from a dead zone, you won\(aqt be able to see
it anyway. If you want a titlebar (and a movable window), run with \fB\-n\fP\&.
.sp
\fBxdeadzone\fP has been tested with various window managers and desktop
environments, and works properly with at least: KDE (Plasma 5), XFCE
4, Fmwv2, WindowMaker, BlackBox, and FluxBox.
.sp
As a safety measure, \fBxdeadzone\fP will allow the mouse pointer into
its window if the control key and at least one modifier (left/right
alt, "win" keys) are held down while the mouse is moving. This
prevents e.g. an error in the geometry argument from locking out the
mouse from the wrong part of the screen.
.SH OPTIONS
.sp
Options can appear in any order on the command line.
.SS Required argument
.INDENT 0.0
.TP
.B \fBgeometry\fP
This is a standard X11 geometry specification. Its format is
<\fIwidth\fP>x<\fIheight\fP> for \fB\-nw\fP, \fB\-ne\fP, \fB\-sw\fP, \fB\-se\fP modes. For
absolute positioning,
it\(aqs <\fIwidth\fP>x<\fIheight\fP>[\fI+\-\fP]<\fIxpos\fP>[\fI+\-\fP]<\fIypos\fP>.
Negative xpos and ypos will be
treated as offsets from the right/bottom of the display.
.sp
Examples: \fB200x100\fP, \fB64x64\-0\-0\fP, \fB50x60+100+100\fP\&.
.UNINDENT
.SS Modes
.sp
One (and only one) mode option is allowed. If none is given,
absolute positioning is used.
.INDENT 0.0
.TP
.B \fB\-nw\fP
Place window at northwest (top left) corner of display.
.TP
.B \fB\-ne\fP
Place window at northeast (top right) corner of display.
.TP
.B \fB\-sw\fP
Place window at southwest (bottom left) corner of display.
.TP
.B \fB\-se\fP
Place window at southeast (bottom right) corner of display.
.UNINDENT
.SS Appearance options
.sp
These are optional, and control how \fBxdeadzone\fP\(aqs window will look
and behave. By default, the window is invisible (\fIInputOnly\fP in Xlib
terms).
.INDENT 0.0
.TP
.B \fB\-b\fP
Make window visible, display as a black rectangle.
.TP
.B \fB\-w\fP
Make window visible, display as a white rectangle.
.TP
.B \fB\-n\fP
Create window as a normal window, with titlebar and without
appearing on all desktops. Implies \fB\-w\fP, but can be followed
by \fB\-b\fP for a black rectangle.
In this mode, the window will have a titlebar (but no close button),
will be movable and resizable, and will not appear on all virtual
desktops. However, it will still be "always on top".
.UNINDENT
.SS Informational options
.INDENT 0.0
.TP
.B  \-\-help
Print built\-in help, then exit.
.TP
.B  \-\-version
Print the application name and version number, then exit.
.UNINDENT
.SH ENVIRONMENT
.INDENT 0.0
.TP
.B \fBDISPLAY\fP
As usual for X applications: the X server to connect to.
.UNINDENT
.SH EXIT STATUS
.sp
With \fB\-\-help\fP or \fB\-\-version\fP, exit status is 0 (success).
.sp
If there\(aqs an error in the arguments, exit status is non\-zero (failure).
.sp
In normal operation, \fBxdeadzone\fP never exits.
.SH EXAMPLES
.sp
You have a 1920x1080 LCD monitor on the left, and a 1280x1024
one on the right. This gives you a nice 3200x1080 X display... but the
mouse can "vanish", because X pretends the right\-hand monitor has
1080 vertical pixels. So there\(aqs a 1280x56 horizontal strip "below" the
bottom of the right\-hand monitor that doesn\(aqt get displayed. If the
mouse moves into this area, the pointer disappears, and it\(aqs not
obvious what happened to it.
.sp
To avoid losing the pointer, you can run this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
xdeadzone \-se 1280x56 &
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\&...from your ~/.xinitrc (or whatever you use to run commands at X startup).
.sp
If you instead have the same two monitors in a vertical arrangement,
with the 1280x1024 one on top, you\(aqll have a 640x1024 vertical strip
of \(aqdead zone\(aq beyond the right edge of the top monitor. To avoid
losing the mouse there:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
xdeadzone \-ne 640x1024 &
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If the dead zone were on the left of the top monitor, you\(aqd use \fB\-nw\fP instead
of \fB\-ne\fP\&.
.SH COPYRIGHT
.sp
WTFPL. Do WTF you want to with this.
.sp
See \fI\%http://www.wtfpl.net/txt/copying/\fP for details.
.SH AUTHORS
.sp
\fBxdeadzone\fP was written by B. Watson (\fI\%urchlay@slackware.uk\fP).
.SH SEE ALSO
.sp
\fBxrandr\fP(1)
.\" Generated by docutils manpage writer.
.