diff options
-rw-r--r-- | jsmond.1 | 6 | ||||
-rw-r--r-- | jsmond.html | 491 |
2 files changed, 494 insertions, 3 deletions
@@ -2,7 +2,7 @@ . .TH JSMOND 1 "2020-05-16" "0.1.0" "Urchlay" .SH NAME -jsmond \- disable screensaver on joystick activity +jsmond \- deactivate screensaver on joystick activity . .nr rst2man-indent-level 0 . @@ -134,11 +134,11 @@ jsmond isn\(aqt portable. It only works on Linux, at least for now. .SH LICENSE .sp jsmond is released under the WTFPL: Do WTF you want with this. -.SH AUTHORS +.SH AUTHOR .sp jsmond was written by B. Watson <\fI\%yalhcru@gmail.com\fP>. .SH SEE ALSO .sp -sdl\-jstest(1), sdl2\-jstest(2) +jstest(1), jscal(1), sdl\-jstest(1), sdl2\-jstest(2) .\" Generated by docutils manpage writer. . diff --git a/jsmond.html b/jsmond.html new file mode 100644 index 0000000..c90e0bb --- /dev/null +++ b/jsmond.html @@ -0,0 +1,491 @@ +<?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>jsmond</title> +<meta name="date" content="2020-05-16" /> +<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="jsmond"> +<h1 class="title">jsmond</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-16</td></tr> +<tr><th class="docinfo-name">Version:</th> +<td>0.1.0</td></tr> +</tbody> +</table> +<!-- RST source for jsmond(1) man page. Convert with: --> +<!-- rst2man.py jsmond.rst > jsmond.1 --> +<div class="section" id="synopsis"> +<h1>SYNOPSIS</h1> +<p>jsmond [<strong>-c command</strong>] [<strong>-i seconds</strong>] [<strong>-d</strong>] [<strong>-x</strong>] [<strong>joydev [joydev ...]</strong>]</p> +</div> +<div class="section" id="description"> +<h1>DESCRIPTION</h1> +<p>jsmond lets you play games with your joysticks/gamepads without +xscreensaver activating due to lack of keyboard/mouse input.</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> seconds (60, 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 runs the <strong>xscreensaver-command -deactivate</strong> +(or whatever the <strong>-c</strong> argument is set to). The command will be run no +more than once every <em>interval</em> seconds.</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 +will be monitored (no search is done).</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">-c <var><command></var></span></kbd></td> +<td>Run <command> when activity was detected during the +last <em>interval</em>.</td></tr> +<tr><td class="option-group"> +<kbd><span class="option">-i <var><seconds></var></span></kbd></td> +<td>Interval to check for activity. Should be set a minute or +so less than your xscreensaver timeout. Setting this too low +will waste resources. Default: 60.</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> +<tr><td class="option-group"> +<kbd><span class="option">-x</span></kbd></td> +<td>Don't try to connect to X server (and don't exit until killed).</td></tr> +</tbody> +</table> +</div> +<div class="section" id="notes"> +<h1>NOTES</h1> +<p>A space is required between an option and its argument, as shown +above. Use e.g. <strong>-i 120</strong>, not <strong>-i120</strong>.</p> +<p>By default, jsmond searches for and monitors all the joysticks it can +find, up to MAX_STICKS (normally 16; see the <strong>--help</strong> output to find +the compiled-in default). You can override the search on the command +line by providing one or more <strong>joydev</strong> arguments, in which case only +those devices will be monitored.</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 at compile time (see the <strong>--help</strong> output to find the +compiled-in default).</p> +<p>Note that it's <em>not</em> an error to give nonexistent joystick device names. +jsmond will wait for devices to come into existence (e.g. as created +by <strong>udev</strong>).</p> +<p>jsmond should be started from your <strong>.xinitrc</strong> or whatever X startup +script your windowmanager or desktop environment uses. By default, it +will exit when the X server does.</p> +<p>If you can think of a use for jsmond outside of X, give it the -x argument +so it won't complain about not being able to connect to the X server. This +will also prevent it from exiting when the X server does. When using +-x, be careful not to spawn multiple instances of jsmond (although they +won't hurt anything, just waste resources).</p> +<p>There's no PID file. Just use "pkill jsmond".</p> +</div> +<div class="section" id="exit-status"> +<h1>EXIT STATUS</h1> +<p>Without the -d option, the exit status is 0 (success) if jsmond +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, jsmond 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>jsmond isn't portable. It only works on Linux, at least for now.</p> +<!-- EXAMPLES --> +<!-- ======== --> +</div> +<div class="section" id="license"> +<h1>LICENSE</h1> +<p>jsmond is released under the WTFPL: Do WTF you want with this.</p> +</div> +<div class="section" id="author"> +<h1>AUTHOR</h1> +<p>jsmond 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> |