run a program on X inactivity
extension to receive
inactivity events when a timeout is specified, running a specific program
after the elapsed time.
will also run the
program if it is sent a
signal, or if the
pointer sits in a corner of the screen for an amount of time. Signal and
corner locking are always enabled, whether
specified or not.
The options are as follows:
- Specify the size, in pixels, of the corner area. The default is 2
- Specify the number of seconds the pointer has to be in the given position
before running the program. The default is 2 seconds.
- This argument allows you to specify the server to connect to; see
- Set the position to one of none, northwest, northeast, southwest, or
southeast, respectively. If no position is specified, the default is
- Specify the full pathname of the program to run on any of the
aforementioned events. Arguments to the program may also be specified,
separated by whitespace. If
-program is not
specified, the default is xlock(1).
- Set the timeout to the specified number of seconds. If
-timeout is not specified,
xidle won't run any program on inactivity.
A few sets of application specific resources are supported and their values can
be overriden by the command line options:
- area (class
- Specify the size, in pixels, of the corner area; see the
- delay (class
- Specify the number of seconds to wait before running the program; see the
- position (class
- Set the position to one of: "no", "nw",
"ne", "sw", or "se"; see descriptions of the
- program (class
- Specify the full pathname of the program to run; see the
- timeout (class
- Set the timeout to the specified number of seconds; see the
xidle program resource class is
using the flying bats mode if no
activity is detected in 300 seconds or the pointer sits in the southwest
corner for more than 5 seconds:
$ xidle -delay 5 -sw -program "/usr/X11R6/bin/xlock -mode bat" \
program was written by
an xautolock replacement.
The maximum number of arguments for
the executable file, is currently set to 9.