aboutsummaryrefslogtreecommitdiff
path: root/jsmond.rst
diff options
context:
space:
mode:
Diffstat (limited to 'jsmond.rst')
-rw-r--r--jsmond.rst34
1 files changed, 26 insertions, 8 deletions
diff --git a/jsmond.rst b/jsmond.rst
index bf9f9c8..89b47a6 100644
--- a/jsmond.rst
+++ b/jsmond.rst
@@ -20,7 +20,7 @@ deactivate screensaver on joystick activity
SYNOPSIS
========
-jsmond [**-i interval**] [**-m** | **-k keycode** | **-b button**] [**-d dir**] [**-j name**] [**-D**] [**joydev [joydev ...]**]
+jsmond [**-i interval[s|ms]**] [**-m** | **-k keycode** | **-b button**] [**-d dir**] [**-j name**] [**-D**] [**joydev [joydev ...]**]
DESCRIPTION
===========
@@ -53,8 +53,11 @@ OPTIONS
--help Print usage summary
--i <millis> Interval to check for activity, in milliseconds.
- Default: 250.
+-i <interval> Interval to check for activity. Can be given in seconds
+ with *s* suffix (e.g. **1s**), or milliseconds with *m*
+ (e.g. **200m**). If just a number is given, it's assumed
+ to be in seconds if it's under 100, otherwise it's treated
+ as milliseconds. Default: 250m.
-k <keycode> Send this keycode when activity is detected. Default
is to search the keymap for an unused code. If you set this
@@ -72,6 +75,18 @@ OPTIONS
10 pixels to the left and up, then warp the pointer back
to its starting point.
+-c <command> Run a command when activity is detected, rather than
+ sending a fake keystroke/click/motion. It's recommended
+ to set *interval* to at least 1 second, when using this
+ option.
+
+-x Same as **-c "xscreensaver-command -deactivate" -i 1s**.
+
+-f Disable screensaver if a full-screen window is detected.
+ This isn't likely to be 100% reliable.
+
+-F Same as **-f**, but also disables joystick monitoring entirely.
+
These options are intended for developers and *really* shouldn't be
needed for normal use:
@@ -89,11 +104,14 @@ above. Use e.g. **-i 300**, not **-i300**.
NOTES
=====
-By default, jsmond searches for and monitors all the joysticks it can
-find, up to MAX_STICKS (normally 16; see the **--help** output to find
-the compiled-in default). You can override the search on the command
-line by providing one or more **joydev** arguments, in which case only
-those devices will be monitored.
+jsmond was tested with xlock(1) and xscreensaver(1). All 3 modes
+(keycode, mouse click, and mouse motion) work with xscreensaver.
+xlock doesn't respond to mouse motion, so use the keycode or click
+modes with it.
+
+jsmond can monitor up to MAX_STICKS joysticks. This is a compile time
+constant, normally set to 16. See the **--help** output to find out
+the compiled-in default.
**joydev** arguments can be either a path to a device node (e.g.
*/dev/input/js0* or similar), or a number, which will have the default