aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--unsaver.html47
1 files changed, 23 insertions, 24 deletions
diff --git a/unsaver.html b/unsaver.html
index 04e1e92..878eb10 100644
--- a/unsaver.html
+++ b/unsaver.html
@@ -508,30 +508,29 @@ a single monitor, and may not work properly in multi-head environments.</p>
</div>
<div class="section" id="joystick-devices">
<h1>JOYSTICK DEVICES</h1>
-<p>It's recommended to let unsaver 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.</p>
-<p>If you do use them, the <em>joydev</em> arguments can be one of 3 things:</p>
-<blockquote>
-<ul class="simple">
-<li>The first argument can optionally be a directory, which must exist.
-The default is &quot;/dev/input&quot;. unsaver will look for joystick devices here.
-If there are no more <em>joydev</em> arguments, unsaver will monitor devices
-and detect hotplug events on devices js0 through js15 in this directory.</li>
-<li>One or more numbers. unsaver will prepend the directory and &quot;js&quot; to each number,
-and monitor that device. Hotplug events will be detected <em>only</em> for
-the specified devices. You could use this e.g. to not monitor your
-2nd joystick, because it sometimes drifts and reports false events.</li>
-<li>One or more device nodes (e.g. js0). Use relative paths here (relative
-to the directory argument or &quot;/dev/input&quot;). This option only exists
-for future-proofing (in case the js name changes someday). Hotplug
-events will be detected <em>only</em> for the specified devices.</li>
-</ul>
-</blockquote>
-<p>None of the joystick devices (whether autodetected, named, or numbered)
-has to actually exist when unsaver starts up, although their directory
-does have to exist. This means unsaver can detect hotplug events, but
-you have to be careful not to typo the device names.</p>
+<p>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.</p>
+<p>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.</p>
+<p>None of the joystick devices (whether autodetected or not) has to
+actually exist when unsaver starts up, although their directory does
+have to exist. This means unsaver can detect hotplug events, but you
+have to be careful not to typo the device names.</p>
+<p>If your system doesn't keep its joystick device nodes in /dev/input, and/or
+if they're not named &quot;js&lt;num&gt;&quot;, see ENVIRONMENT for a way to override
+the default names.</p>
+</div>
+<div class="section" id="environment">
+<h1>ENVIRONMENT</h1>
+<dl class="docutils">
+<dt>UNSAVER_JS_DIR Path to joystick device nodes. If your OS keeps them</dt>
+<dd>somewhere besides &quot;/dev/input&quot;, set this variable.</dd>
+<dt>UNSAVER_JS_NODE Base name for joystick device nodes. &quot;js&quot; by default.</dt>
+<dd><em>Don't</em> set this to &quot;event&quot;, unsaver doesn't speak the
+full Linux event protocol.</dd>
+</dl>
</div>
<div class="section" id="exit-status">
<h1>EXIT STATUS</h1>