1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
|
<?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-20" />
<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-20</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>-j</strong> | <strong>-f</strong>] [<strong>-d</strong>] [<strong>joystick [joystick ...]</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 also prevents
the screensaver from activating when a fullscreen window is in use (e.g.
while watching a movie).</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>
<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 josticks, or
if a fullscreen window exists. If so, it deactivates the screensaver
by sending a keystroke, clicking a mouse button, moving the mouse,
or executing a command (see "Monitoring Options", below).</p>
<p>Multiple joystick devices can be monitored. By default, unsaver monitors
up to 16 joysticks. These devices don't have to actually exist: they
can come and go as joysticks are plugged in and unplugged. See JOYSTICK
DEVICES if the defaults don't work for you.</p>
</div>
<div class="section" id="options">
<h1>OPTIONS</h1>
<p>With no options, the default interval is 250ms, the deactivation mode
is to send an otherwise-unused keycode, and both joystick and fullscreen
monitoring is enabled.</p>
<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 class="section" id="general-options">
<h2>General options</h2>
<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 and exit.</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>
</div>
<div class="section" id="monitoring-options">
<h2>Monitoring options</h2>
<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">-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">-j</span></kbd></td>
<td>Only monitor joysticks; don't try to detect fullscreen windows.
<strong>-j</strong> and <strong>-f</strong> are mutually exclusive.</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-f</span></kbd></td>
<td>Only detect fullscreen windows; don't monitor joysticks.
<strong>-j</strong> and <strong>-f</strong> are mutually exclusive. Note that
<strong>joysticks</strong> are ignored with <strong>-f</strong>.</td></tr>
</tbody>
</table>
</div>
<div class="section" id="deactivation-mode-options">
<h2>Deactivation mode options</h2>
<p>Only one of <strong>-k</strong>/<strong>-b</strong>/<strong>-m</strong>/<strong>-c</strong>/<strong>-x</strong> is accepted.</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">-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>
</tbody>
</table>
</div>
</div>
<div class="section" id="notes">
<h1>NOTES</h1>
<p>unsaver was tested with xlock(1), xscreensaver(1), and the built-in
Xorg screensaver (see xset(1)). All 4 modes (keycode, mouse click, mouse
motion, command execution) work with xscreensaver. xlock doesn't have a
disable command nor respond to mouse motion, so use the keycode or click
modes with it. The "xset s" screen-blanker works with keycodes, mouse
clicks, and mouse motion. I didn't test with gnome-screensaver, sorry.</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>If the screensaver is configured to lock the screen, and it has already
done so, unsaver can't magically type your password for you.</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="joystick-devices">
<h1>JOYSTICK DEVICES</h1>
<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>One reason to manually set the joystick list might be that your 2nd
joystick is rarely used, and your cat likes to play with it. To monitor
only one device, you can say <strong>unsaver 0</strong>.</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 "js<num>", 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</dt>
<dd>Path to joystick device nodes. If your OS keeps them
somewhere besides "/dev/input", set this variable.</dd>
<dt>UNSAVER_JS_NODE</dt>
<dd>Base name for joystick device nodes. "js" by default.
<em>Don't</em> set this to "event", unsaver doesn't speak the
full Linux event protocol.</dd>
</dl>
</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 number and a
device number 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
numbers (it's 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>I <em>really</em> need to use the XKB extension rather than the old & deprecated
Xlib keyboard API. This mainly affects the default "find an unused
keycode" mode.</p>
<p>unsaver isn't portable. It only works on Linux, at least for now, for
three reasons:</p>
<blockquote>
<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>
</blockquote>
<!-- 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), xscreensaver(1),
xautolock(1), xlock(1), xset(1)</p>
</div>
</div>
</body>
</html>
|
