path: root/jsmond.1

.\" Man page generated from reStructuredText.
.
.TH JSMOND 1 "2020-05-17" "0.2.0" "Urchlay"
.SH NAME
jsmond \- deactivate screensaver on joystick activity
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" RST source for jsmond(1) man page. Convert with:
.
.\" rst2man.py jsmond.rst > jsmond.1
.
.SH SYNOPSIS
.sp
jsmond [\fB\-i interval\fP] [\fB\-k keycode\fP | \fB\-b button\fP] [\fB\-d dir\fP] [\fB\-j name\fP] [\fB\-D\fP] [\fBjoydev [joydev ...]\fP]
.SH DESCRIPTION
.sp
jsmond lets you play games with your joysticks/gamepads without
the screen saver activating due to lack of keyboard/mouse input.
.sp
Multiple joystick devices can be monitored. By default, jsmond
monitors up to 16 devices, named /dev/input/js0 through js15.
These devices don\(aqt have to actually exist: they can come and go
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 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
doesn\(aqt do the right thing for you. In this case, only these devices
will be monitored (no search is done).
.sp
jsmond should be started from your \fB\&.xinitrc\fP or whatever X startup
script your window manager or desktop environment uses. By default, it
will exit when the X server does. There\(aqs no PID file: use "pkill jsmond"
if you need to kill the daemon.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-\-help
Print usage summary
.TP
.BI \-i \ <millis>
Interval to check for activity, in milliseconds.
Default: 250.
.TP
.BI \-k \ <keycode>
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 \fIdoesn\(aqt\fP map to a keysym
in your usual keymapping (use "xmodmap \-pk" to find one).
.TP
.BI \-b \ <button>
Send a click of this button when activity is detected,
rather than a keystroke. Should be a button that
applications don\(aqt normally respond to (6 or higher).
.UNINDENT
.sp
These options are intended for developers and  \fIreally\fP shouldn\(aqt be
needed for normal use:
.INDENT 0.0
.TP
.BI \-d \ <dir>
Path to the directory containing joystick device nodes.
Default is "/dev/input".
.TP
.BI \-j \ <name>
Name of joystick device nodes, without any numeric
suffix. Default is "js".
.TP
.B \-D
Debug mode: run in foreground and print verbose messages.
.UNINDENT
.sp
A space is required between an option and its argument, as shown
above. Use e.g. \fB\-i 300\fP, not \fB\-i300\fP\&.
.SH NOTES
.sp
By default, jsmond searches for and monitors all the joysticks it can
find, up to MAX_STICKS (normally 16; see the \fB\-\-help\fP output to find
the compiled\-in default). You can override the search on the command
line by providing one or more \fBjoydev\fP arguments, in which case only
those devices will be monitored.
.sp
\fBjoydev\fP arguments can be either a path to a device node (e.g.
\fI/dev/input/js0\fP 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 \fB\-d\fP and \fB\-j\fP options. Note that (currently)
all the joystick devices have to be in the same directory for jsmond
to detect hotplug events!
.sp
Note that it\(aqs \fInot\fP an error to give nonexistent joystick device names.
jsmond will wait for devices to come into existence (e.g. as created
by \fBudev\fP).
.sp
If the screensaver is configured to lock the screen, and it has already
activated, pressing a joystick button/direction will just bring up the
password dialog, same as pressing a key or mouse button would.
.SH EXIT STATUS
.sp
Without the \-D option, the exit status is 0 (success) if jsmond
successfully forked into the background.
.sp
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.
.sp
With the \-D option, jsmond never exits until it\(aqs killed.
.SH BUGS
.sp
There\(aqs no way to distinguish between an invalid device name and a
device name that doesn\(aqt happen to exist yet because its device hasn\(aqt
been plugged in yet. Try to avoid typos, if you really have to use device
names (better to autodetect).
.sp
Normally once daemonized, jsmond is very robust. However, if something
does go wrong, there\(aqs no way to find out what. Probably there should
be a log file, or use syslog.
.sp
jsmond isn\(aqt portable. It only works on Linux, at least for now, for
three reasons:
.INDENT 0.0
.IP \(bu 2
It uses the Linux joystick API.
.IP \(bu 2
It uses inotify(7) to detect joystick hotplug events.
.IP \(bu 2
I haven\(aqt even looked at other OSes to see if it would be possible
to port the code.
.UNINDENT
.\" EXAMPLES
.
.\" ========
.
.SH LICENSE
.sp
jsmond is released under the WTFPL: Do WTF you want with this.
.SH AUTHOR
.sp
jsmond was written by B. Watson <\fI\%yalhcru@gmail.com\fP>.
.SH SEE ALSO
.sp
jstest(1), jscal(1), sdl\-jstest(1), sdl2\-jstest(2)
.\" Generated by docutils manpage writer.
.