diff options
Diffstat (limited to 'unsaver.html')
| -rw-r--r-- | unsaver.html | 559 |
1 files changed, 559 insertions, 0 deletions
diff --git a/unsaver.html b/unsaver.html new file mode 100644 index 0000000..7d3ce80 --- /dev/null +++ b/unsaver.html @@ -0,0 +1,559 @@ +<?xml version="1.0" encoding="utf-8" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" /> +<title>unsaver</title> +<meta name="date" content="2020-05-19" /> +<style type="text/css"> + +/* +:Author: David Goodger (goodger@python.org) +:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $ +:Copyright: This stylesheet has been placed in the public domain. + +Default cascading style sheet for the HTML output of Docutils. + +See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to +customize this style sheet. +*/ + +/* used to remove borders from tables and images */ +.borderless, table.borderless td, table.borderless th { + border: 0 } + +table.borderless td, table.borderless th { + /* Override padding for "table.docutils td" with "! important". + The right padding separates the table cells. */ + padding: 0 0.5em 0 0 ! important } + +.first { + /* Override more specific margin styles with "! important". */ + margin-top: 0 ! important } + +.last, .with-subtitle { + margin-bottom: 0 ! important } + +.hidden { + display: none } + +.subscript { + vertical-align: sub; + font-size: smaller } + +.superscript { + vertical-align: super; + font-size: smaller } + +a.toc-backref { + text-decoration: none ; + color: black } + +blockquote.epigraph { + margin: 2em 5em ; } + +dl.docutils dd { + margin-bottom: 0.5em } + +object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] { + overflow: hidden; +} + +/* Uncomment (and remove this text!) to get bold-faced definition list terms +dl.docutils dt { + font-weight: bold } +*/ + +div.abstract { + margin: 2em 5em } + +div.abstract p.topic-title { + font-weight: bold ; + text-align: center } + +div.admonition, div.attention, div.caution, div.danger, div.error, +div.hint, div.important, div.note, div.tip, div.warning { + margin: 2em ; + border: medium outset ; + padding: 1em } + +div.admonition p.admonition-title, div.hint p.admonition-title, +div.important p.admonition-title, div.note p.admonition-title, +div.tip p.admonition-title { + font-weight: bold ; + font-family: sans-serif } + +div.attention p.admonition-title, div.caution p.admonition-title, +div.danger p.admonition-title, div.error p.admonition-title, +div.warning p.admonition-title, .code .error { + color: red ; + font-weight: bold ; + font-family: sans-serif } + +/* Uncomment (and remove this text!) to get reduced vertical space in + compound paragraphs. +div.compound .compound-first, div.compound .compound-middle { + margin-bottom: 0.5em } + +div.compound .compound-last, div.compound .compound-middle { + margin-top: 0.5em } +*/ + +div.dedication { + margin: 2em 5em ; + text-align: center ; + font-style: italic } + +div.dedication p.topic-title { + font-weight: bold ; + font-style: normal } + +div.figure { + margin-left: 2em ; + margin-right: 2em } + +div.footer, div.header { + clear: both; + font-size: smaller } + +div.line-block { + display: block ; + margin-top: 1em ; + margin-bottom: 1em } + +div.line-block div.line-block { + margin-top: 0 ; + margin-bottom: 0 ; + margin-left: 1.5em } + +div.sidebar { + margin: 0 0 0.5em 1em ; + border: medium outset ; + padding: 1em ; + background-color: #ffffee ; + width: 40% ; + float: right ; + clear: right } + +div.sidebar p.rubric { + font-family: sans-serif ; + font-size: medium } + +div.system-messages { + margin: 5em } + +div.system-messages h1 { + color: red } + +div.system-message { + border: medium outset ; + padding: 1em } + +div.system-message p.system-message-title { + color: red ; + font-weight: bold } + +div.topic { + margin: 2em } + +h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, +h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { + margin-top: 0.4em } + +h1.title { + text-align: center } + +h2.subtitle { + text-align: center } + +hr.docutils { + width: 75% } + +img.align-left, .figure.align-left, object.align-left, table.align-left { + clear: left ; + float: left ; + margin-right: 1em } + +img.align-right, .figure.align-right, object.align-right, table.align-right { + clear: right ; + float: right ; + margin-left: 1em } + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left } + +.align-center { + clear: both ; + text-align: center } + +.align-right { + text-align: right } + +/* reset inner alignment in figures */ +div.align-right { + text-align: inherit } + +/* div.align-center * { */ +/* text-align: left } */ + +.align-top { + vertical-align: top } + +.align-middle { + vertical-align: middle } + +.align-bottom { + vertical-align: bottom } + +ol.simple, ul.simple { + margin-bottom: 1em } + +ol.arabic { + list-style: decimal } + +ol.loweralpha { + list-style: lower-alpha } + +ol.upperalpha { + list-style: upper-alpha } + +ol.lowerroman { + list-style: lower-roman } + +ol.upperroman { + list-style: upper-roman } + +p.attribution { + text-align: right ; + margin-left: 50% } + +p.caption { + font-style: italic } + +p.credits { + font-style: italic ; + font-size: smaller } + +p.label { + white-space: nowrap } + +p.rubric { + font-weight: bold ; + font-size: larger ; + color: maroon ; + text-align: center } + +p.sidebar-title { + font-family: sans-serif ; + font-weight: bold ; + font-size: larger } + +p.sidebar-subtitle { + font-family: sans-serif ; + font-weight: bold } + +p.topic-title { + font-weight: bold } + +pre.address { + margin-bottom: 0 ; + margin-top: 0 ; + font: inherit } + +pre.literal-block, pre.doctest-block, pre.math, pre.code { + margin-left: 2em ; + margin-right: 2em } + +pre.code .ln { color: grey; } /* line numbers */ +pre.code, code { background-color: #eeeeee } +pre.code .comment, code .comment { color: #5C6576 } +pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold } +pre.code .literal.string, code .literal.string { color: #0C5404 } +pre.code .name.builtin, code .name.builtin { color: #352B84 } +pre.code .deleted, code .deleted { background-color: #DEB0A1} +pre.code .inserted, code .inserted { background-color: #A3D289} + +span.classifier { + font-family: sans-serif ; + font-style: oblique } + +span.classifier-delimiter { + font-family: sans-serif ; + font-weight: bold } + +span.interpreted { + font-family: sans-serif } + +span.option { + white-space: nowrap } + +span.pre { + white-space: pre } + +span.problematic { + color: red } + +span.section-subtitle { + /* font-size relative to parent (h1..h6 element) */ + font-size: 80% } + +table.citation { + border-left: solid 1px gray; + margin-left: 1px } + +table.docinfo { + margin: 2em 4em } + +table.docutils { + margin-top: 0.5em ; + margin-bottom: 0.5em } + +table.footnote { + border-left: solid 1px black; + margin-left: 1px } + +table.docutils td, table.docutils th, +table.docinfo td, table.docinfo th { + padding-left: 0.5em ; + padding-right: 0.5em ; + vertical-align: top } + +table.docutils th.field-name, table.docinfo th.docinfo-name { + font-weight: bold ; + text-align: left ; + white-space: nowrap ; + padding-left: 0 } + +/* "booktabs" style (no vertical lines) */ +table.docutils.booktabs { + border: 0px; + border-top: 2px solid; + border-bottom: 2px solid; + border-collapse: collapse; +} +table.docutils.booktabs * { + border: 0px; +} +table.docutils.booktabs th { + border-bottom: thin solid; + text-align: left; +} + +h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, +h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { + font-size: 100% } + +ul.auto-toc { + list-style-type: none } + +</style> +</head> +<body> +<div class="document" id="unsaver"> +<h1 class="title">unsaver</h1> +<h2 class="subtitle" id="deactivate-screensaver-on-joystick-activity">deactivate screensaver on joystick activity</h2> +<table class="docinfo" frame="void" rules="none"> +<col class="docinfo-name" /> +<col class="docinfo-content" /> +<tbody valign="top"> +<tr class="manual-section field"><th class="docinfo-name">Manual section:</th><td class="field-body">1</td> +</tr> +<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-19</td></tr> +<tr><th class="docinfo-name">Version:</th> +<td>0.3.0</td></tr> +</tbody> +</table> +<!-- RST source for unsaver(1) man page. Convert with: --> +<!-- rst2man.py unsaver.rst > unsaver.1 --> +<div class="section" id="synopsis"> +<h1>SYNOPSIS</h1> +<p>unsaver [<strong>-i interval[s|ms]</strong>] [<strong>-m</strong> | <strong>-k keycode</strong> | <strong>-b button</strong> | <strong>-c command</strong> | <strong>-x</strong> ] [<strong>-d dir</strong>] [<strong>-j name</strong>] [<strong>-f</strong>] [<strong>-F</strong>] [<strong>-D</strong>] [<strong>joydev [joydev ...]</strong>]</p> +</div> +<div class="section" id="description"> +<h1>DESCRIPTION</h1> +<p>unsaver 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 (e.g. +while watching a movie).</p> +<p>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.</p> +<p>Every <em>interval</em> milliseconds (250, or whatever <strong>-i</strong> 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.</p> +<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. In this case, only these devices +will be monitored (no search is done).</p> +<p>unsaver should be started from your <strong>.xinitrc</strong> or whatever X startup +script your window manager or desktop environment uses. By default, it +will exit when the X server does. There's no PID file: use "pkill unsaver" +if you need to kill the daemon.</p> +</div> +<div class="section" id="options"> +<h1>OPTIONS</h1> +<table class="docutils option-list" frame="void" rules="none"> +<col class="option" /> +<col class="description" /> +<tbody valign="top"> +<tr><td class="option-group"> +<kbd><span class="option">--help</span></kbd></td> +<td>Print usage summary</td></tr> +<tr><td class="option-group"> +<kbd><span class="option">-i <var><interval></var></span></kbd></td> +<td>Interval to check for activity. Can be given in seconds +with <em>s</em> suffix (e.g. <strong>1s</strong>), or milliseconds with <em>m</em> +(e.g. <strong>200m</strong>). 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.</td></tr> +<tr><td class="option-group"> +<kbd><span class="option">-k <var><keycode></var></span></kbd></td> +<td>Send this keycode when activity is detected. Default +is to search the keymap for an unused code. If you set this +manually, it should be a keycode that <em>doesn't</em> map to a keysym +in your usual keymapping (use "xmodmap -pk" to find one).</td></tr> +<tr><td class="option-group"> +<kbd><span class="option">-b <var><button></var></span></kbd></td> +<td>Send a click of this button when activity is detected, +rather than a keystroke. Should be a button that +applications don't normally respond to (6 or higher), +but in some environments, the window manager responds to +all the 'extra' buttons as though they were button 1.</td></tr> +<tr><td class="option-group"> +<kbd><span class="option">-m</span></kbd></td> +<td>Send mouse movements rather than a keystroke. This will +move the pointer 10 pixels to the right and down, then +10 pixels to the left and up, then warp the pointer back +to its starting point.</td></tr> +<tr><td class="option-group"> +<kbd><span class="option">-c <var><command></var></span></kbd></td> +<td>Run a command when activity is detected, rather than +sending a fake keystroke/click/motion. It's recommended +to set <em>interval</em> to at least 1 second when using this +option, to avoid excess process-spawning overhead.</td></tr> +<tr><td class="option-group"> +<kbd><span class="option">-x</span></kbd></td> +<td>Same as <strong>-c "xscreensaver-command -deactivate" -i 1s</strong>.</td></tr> +<tr><td class="option-group"> +<kbd><span class="option">-f</span></kbd></td> +<td>Deactivate screensaver if a fullscreen window is detected. +This isn't likely to be 100% reliable yet.</td></tr> +<tr><td class="option-group"> +<kbd><span class="option">-F</span></kbd></td> +<td>Same as <strong>-f</strong>, but also disables joystick monitoring entirely. +Note that <strong>-j</strong>, <strong>-d</strong>, and <strong>joydev</strong> are ignored +with this option.</td></tr> +</tbody> +</table> +<p>These options are intended for developers and <em>really</em> shouldn't be +needed for normal use:</p> +<table class="docutils option-list" frame="void" rules="none"> +<col class="option" /> +<col class="description" /> +<tbody valign="top"> +<tr><td class="option-group"> +<kbd><span class="option">-d <var><dir></var></span></kbd></td> +<td>Path to the directory containing joystick device nodes. +Default is "/dev/input". This directory is monitored with +inotify(7) so unsaver will be aware of hotplug events.</td></tr> +<tr><td class="option-group"> +<kbd><span class="option">-j <var><name></var></span></kbd></td> +<td>Name of joystick device nodes, without any numeric +suffix. Default is "js".</td></tr> +<tr><td class="option-group"> +<kbd><span class="option">-D</span></kbd></td> +<td>Debug mode: run in foreground and print verbose messages.</td></tr> +</tbody> +</table> +<p>A space is required between an option and its argument, as shown +above. Use e.g. <strong>-i 300</strong>, not <strong>-i300</strong>.</p> +</div> +<div class="section" id="notes"> +<h1>NOTES</h1> +<p>unsaver 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.</p> +<p>unsaver can monitor up to MAX_STICKS joysticks. This is a compile time +constant, normally set to 16. See the <strong>--help</strong> output to find out +the compiled-in default.</p> +<p><strong>joydev</strong> arguments can be either a path to a device node (e.g. +<em>/dev/input/js0</em> or similar), or a number, which will have the default +device basename prepended to it. This is normally "/dev/input/js", but +can be changed via the <strong>-d</strong> and <strong>-j</strong> options. Note that (currently) +all the joystick devices have to be in the same directory for unsaver +to detect hotplug events!</p> +<p>Note that it's <em>not</em> an error to give nonexistent joystick device names. +unsaver will wait for devices to come into existence (e.g. as created +by <strong>udev</strong>).</p> +<p>If the screensaver is configured to lock the screen, and it has already +done so, pressing a joystick button/direction will just bring up the +password dialog, same as pressing a key or mouse button would.</p> +<p>unsaver depends on the XTest extension being present in the X server. If +you get a "X server doesn't support XTest extension" error, see your X +server documentation to find out how to enable XTest.</p> +<p>The fullscreen window monitoring has only been tested on a system with +a single monitor, and may not work properly in multi-head environments.</p> +</div> +<div class="section" id="exit-status"> +<h1>EXIT STATUS</h1> +<p>Without the -D option, the exit status is 0 (success) if unsaver +successfully forked into the background.</p> +<p>A non-zero exit status means an error in the command line arguments, +or else fork() failed. No daemon will be running in this case.</p> +<p>With the -D option, unsaver never exits until it's killed.</p> +</div> +<div class="section" id="bugs"> +<h1>BUGS</h1> +<p>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 +been plugged in yet. Try to avoid typos, if you really have to use device +names (better to autodetect).</p> +<p>Normally once daemonized, unsaver is very robust. However, if something +does go wrong, there's no way to find out what. Probably there should +be a log file, or use syslog (or is that overkill?).</p> +<p>It should be (but currently isn't) possible to at least work in +mouse-motion mode even without the XTest extension, via XWarpPointer().</p> +<p>unsaver isn't portable. It only works on Linux, at least for now, for +three reasons:</p> +<ul class="simple"> +<li>It uses the Linux joystick API.</li> +<li>It uses inotify(7) to detect joystick hotplug events.</li> +<li>I haven't even looked at other OSes to see if it would be possible +to port the code.</li> +</ul> +<!-- EXAMPLES --> +<!-- ======== --> +</div> +<div class="section" id="license"> +<h1>LICENSE</h1> +<p>unsaver is released under the WTFPL: Do WTF you want with this.</p> +</div> +<div class="section" id="author"> +<h1>AUTHOR</h1> +<p>unsaver was written by B. Watson <<a class="reference external" href="mailto:yalhcru@gmail.com">yalhcru@gmail.com</a>>.</p> +</div> +<div class="section" id="see-also"> +<h1>SEE ALSO</h1> +<p>jstest(1), jscal(1), sdl-jstest(1), sdl2-jstest(2)</p> +</div> +</div> +</body> +</html> |