aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorB. Watson <yalhcru@gmail.com>2020-05-19 15:53:43 -0400
committerB. Watson <yalhcru@gmail.com>2020-05-19 15:53:43 -0400
commit0951ce5167226f5969698522890a34fd1c414c5c (patch)
treef1846388c73008546bfcbceb4825bf5a9ae4414e
parent7f81b16f333b034953c25be7148657552a7da783 (diff)
downloadunsaver-0951ce5167226f5969698522890a34fd1c414c5c.tar.gz
minor man page tweak
-rw-r--r--jsmond.112
-rw-r--r--jsmond.html14
-rw-r--r--jsmond.rst10
3 files changed, 21 insertions, 15 deletions
diff --git a/jsmond.1 b/jsmond.1
index 8b9513b..878839e 100644
--- a/jsmond.1
+++ b/jsmond.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH JSMOND 1 "2020-05-18" "0.2.0" "Urchlay"
+.TH JSMOND 1 "2020-05-19" "0.2.0" "Urchlay"
.SH NAME
jsmond \- deactivate screensaver on joystick activity
.
@@ -41,7 +41,8 @@ jsmond [\fB\-i interval[s|ms]\fP] [\fB\-m\fP | \fB\-k keycode\fP | \fB\-b button
.sp
jsmond lets you play games with your joysticks/gamepads without the screen
saver activating due to lack of keyboard/mouse input. It can also prevent
-the screensaver from activating when a fullscreen window is in use.
+the screensaver from activating when a fullscreen window is in use (e.g.
+while watching a movie).
.sp
Multiple joystick devices can be monitored. By default, jsmond
monitors up to 16 devices, named /dev/input/js0 through js15.
@@ -50,8 +51,8 @@ as joysticks are plugged in and unplugged.
.sp
Every \fIinterval\fP milliseconds (250, or whatever \fB\-i\fP is set to), jsmond
checks to see if there\(aqs been any activity on any of the devices it\(aqs
-monitoring. If so, it sends a fake mouse movement, keystroke, or mouse button click, which
-the screen saver will see as activity.
+monitoring. If so, it sends a fake mouse movement, keystroke, or mouse
+button click, which the screen saver will see as activity.
.sp
It\(aqs recommended to let jsmond find the joysticks itself. However,
you can pass one or more device names (or just numbers) if the default
@@ -119,7 +120,8 @@ needed for normal use:
.TP
.BI \-d \ <dir>
Path to the directory containing joystick device nodes.
-Default is "/dev/input".
+Default is "/dev/input". This directory is monitored with
+inotify(7) so jsmond will be aware of hotplug events.
.TP
.BI \-j \ <name>
Name of joystick device nodes, without any numeric
diff --git a/jsmond.html b/jsmond.html
index 2874b25..370edac 100644
--- a/jsmond.html
+++ b/jsmond.html
@@ -5,7 +5,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
<title>jsmond</title>
-<meta name="date" content="2020-05-18" />
+<meta name="date" content="2020-05-19" />
<style type="text/css">
/*
@@ -373,7 +373,7 @@ ul.auto-toc {
<tr class="manual-group field"><th class="docinfo-name">Manual group:</th><td class="field-body">Urchlay</td>
</tr>
<tr><th class="docinfo-name">Date:</th>
-<td>2020-05-18</td></tr>
+<td>2020-05-19</td></tr>
<tr><th class="docinfo-name">Version:</th>
<td>0.2.0</td></tr>
</tbody>
@@ -388,15 +388,16 @@ ul.auto-toc {
<h1>DESCRIPTION</h1>
<p>jsmond lets you play games with your joysticks/gamepads without the screen
saver activating due to lack of keyboard/mouse input. It can also prevent
-the screensaver from activating when a fullscreen window is in use.</p>
+the screensaver from activating when a fullscreen window is in use (e.g.
+while watching a movie).</p>
<p>Multiple joystick devices can be monitored. By default, jsmond
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.</p>
<p>Every <em>interval</em> milliseconds (250, or whatever <strong>-i</strong> is set to), jsmond
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.</p>
+monitoring. If so, it sends a fake mouse movement, keystroke, or mouse
+button click, which the screen saver will see as activity.</p>
<p>It's recommended to let jsmond find the joysticks itself. However,
you can pass one or more device names (or just numbers) if the default
doesn't do the right thing for you. In this case, only these devices
@@ -470,7 +471,8 @@ needed for normal use:</p>
<tr><td class="option-group">
<kbd><span class="option">-d <var>&lt;dir&gt;</var></span></kbd></td>
<td>Path to the directory containing joystick device nodes.
-Default is &quot;/dev/input&quot;.</td></tr>
+Default is &quot;/dev/input&quot;. This directory is monitored with
+inotify(7) so jsmond will be aware of hotplug events.</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-j <var>&lt;name&gt;</var></span></kbd></td>
<td>Name of joystick device nodes, without any numeric
diff --git a/jsmond.rst b/jsmond.rst
index 4c0a38d..95f62b9 100644
--- a/jsmond.rst
+++ b/jsmond.rst
@@ -27,7 +27,8 @@ DESCRIPTION
jsmond lets you play games with your joysticks/gamepads without the screen
saver activating due to lack of keyboard/mouse input. It can also prevent
-the screensaver from activating when a fullscreen window is in use.
+the screensaver from activating when a fullscreen window is in use (e.g.
+while watching a movie).
Multiple joystick devices can be monitored. By default, jsmond
monitors up to 16 devices, named /dev/input/js0 through js15.
@@ -36,8 +37,8 @@ as joysticks are plugged in and unplugged.
Every *interval* milliseconds (250, or whatever **-i** is set to), jsmond
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.
+monitoring. If so, it sends a fake mouse movement, keystroke, or mouse
+button click, which the screen saver will see as activity.
It's recommended to let jsmond find the joysticks itself. However,
you can pass one or more device names (or just numbers) if the default
@@ -94,7 +95,8 @@ These options are intended for developers and *really* shouldn't be
needed for normal use:
-d <dir> Path to the directory containing joystick device nodes.
- Default is "/dev/input".
+ Default is "/dev/input". This directory is monitored with
+ inotify(7) so jsmond will be aware of hotplug events.
-j <name> Name of joystick device nodes, without any numeric
suffix. Default is "js".