aboutsummaryrefslogtreecommitdiff
path: root/unsaver.rst
diff options
context:
space:
mode:
authorB. Watson <yalhcru@gmail.com>2020-05-20 03:03:46 -0400
committerB. Watson <yalhcru@gmail.com>2020-05-20 03:03:46 -0400
commitb06b668dd6a020d19bcafca8e9dff8b2486019f8 (patch)
treee9568561b7d5e0ffdba8ccaeca828af56b5315f3 /unsaver.rst
parent276db2c9c227043358ec83cf37116a907f975fcb (diff)
downloadunsaver-b06b668dd6a020d19bcafca8e9dff8b2486019f8.tar.gz
nitpickery
Diffstat (limited to 'unsaver.rst')
-rw-r--r--unsaver.rst49
1 files changed, 30 insertions, 19 deletions
diff --git a/unsaver.rst b/unsaver.rst
index b66e2ad..734d828 100644
--- a/unsaver.rst
+++ b/unsaver.rst
@@ -20,7 +20,7 @@ deactivate screensaver on joystick activity
SYNOPSIS
========
-unsaver [**-i interval[s|ms]**] [**-m** | **-k keycode** | **-b button** | **-c command** | **-x** ] [**-j** | **-f**] [**-d**] [**joydev [joydev ...]**]
+unsaver [**-i interval[s|ms]**] [**-m** | **-k keycode** | **-b button** | **-c command** | **-x** ] [**-j** | **-f**] [**-d**] [**joystick [joystick ...]**]
DESCRIPTION
===========
@@ -36,19 +36,26 @@ will exit when the X server does. There's no PID file: use "pkill unsaver"
if you need to kill the daemon.
Every *interval* milliseconds (250, or whatever **-i** is set to), unsaver
-checks to see if there's been any activity on any of the devices it's
-monitoring. If so, it sends a fake mouse movement, keystroke, or mouse
-button click, which the screen saver will see as activity.
+checks to see if there's been any activity on any of the josticks, or
+if a fullscreen window exists. If so, it deactivates the screensaver
+by sending a keystroke, clicking a mouse button, moving the mouse,
+or executing a command (see "Monitoring Options", below).
-Multiple joystick devices can be monitored. By default, unsaver
-monitors up to 16 devices, named /dev/input/js0 through js15.
-These devices don't have to actually exist: they can come and go
-as joysticks are plugged in and unplugged. See JOYSTICK DEVICES
-if the defaults don't work for you.
+Multiple joystick devices can be monitored. By default, unsaver monitors
+up to 16 joysticks. These devices don't have to actually exist: they
+can come and go as joysticks are plugged in and unplugged. See JOYSTICK
+DEVICES if the defaults don't work for you.
OPTIONS
=======
+With no options, the default interval is 250ms, the deactivation mode
+is to send an otherwise-unused keycode, and both joystick and fullscreen
+monitoring is enabled.
+
+A space is required between an option and its argument, as shown
+above. Use e.g. **-i 300**, not **-i300**.
+
General options
---------------
@@ -70,7 +77,7 @@ Monitoring options
-f Only detect fullscreen windows; don't monitor joysticks.
**-j** and **-f** are mutually exclusive. Note that
- **joydevs** are ignored with **-f**.
+ **joysticks** are ignored with **-f**.
Deactivation mode options
-------------------------
@@ -100,9 +107,6 @@ Only one of **-k**/**-b**/**-m**/**-c**/**-x** is accepted.
-x Same as **-c "xscreensaver-command -deactivate" -i 1s**.
-A space is required between an option and its argument, as shown
-above. Use e.g. **-i 300**, not **-i300**.
-
NOTES
=====
@@ -134,6 +138,10 @@ It's recommended to let unsaver find the joysticks itself. However, you
can pass one or more joystick numbers if the default doesn't do the right
thing for you. Remember that the first joystick is numbered 0, not 1.
+One reason to manually set the joystick list might be that your 2nd
+joystick is rarely used, and your cat likes to play with it. To monitor
+only one device, you can say **unsaver 0**.
+
When you manually set the list of devices, unsaver will only detect
hotplug events on the devices you gave it. If you plug in more joysticks,
they won't be monitored.
@@ -150,10 +158,12 @@ the default names.
ENVIRONMENT
===========
-UNSAVER_JS_DIR Path to joystick device nodes. If your OS keeps them
+UNSAVER_JS_DIR
+ Path to joystick device nodes. If your OS keeps them
somewhere besides "/dev/input", set this variable.
-UNSAVER_JS_NODE Base name for joystick device nodes. "js" by default.
+UNSAVER_JS_NODE
+ Base name for joystick device nodes. "js" by default.
*Don't* set this to "event", unsaver doesn't speak the
full Linux event protocol.
@@ -171,10 +181,10 @@ With the -d option, unsaver never exits until it's killed.
BUGS
====
-There's no way to distinguish between an invalid device name and a
-device name that doesn't happen to exist yet because its device hasn't
+There's no way to distinguish between an invalid device number and a
+device number that doesn't happen to exist yet because its device hasn't
been plugged in yet. Try to avoid typos, if you really have to use device
-names (better to autodetect).
+numbers (it's better to autodetect).
Normally once daemonized, unsaver is very robust. However, if something
does go wrong, there's no way to find out what. Probably there should
@@ -213,4 +223,5 @@ unsaver was written by B. Watson <yalhcru@gmail.com>.
SEE ALSO
========
-jstest(1), jscal(1), sdl-jstest(1), sdl2-jstest(2)
+jstest(1), jscal(1), sdl-jstest(1), sdl2-jstest(2), xscreensaver(1),
+xautolock(1), xlock(1), xset(1)