From f6690f23148f7bf1445dc6435742fccff0cb1b3e Mon Sep 17 00:00:00 2001 From: "B. Watson" Date: Sat, 16 May 2020 05:55:13 -0400 Subject: initial commit --- jsmond.1 | 119 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 119 insertions(+) create mode 100644 jsmond.1 (limited to 'jsmond.1') diff --git a/jsmond.1 b/jsmond.1 new file mode 100644 index 0000000..df25a5e --- /dev/null +++ b/jsmond.1 @@ -0,0 +1,119 @@ +.\" Man page generated from reStructuredText. +. +.TH JSMOND 1 "2020-05-15" "0.1.0" "Urchlay" +.SH NAME +jsmond \- disable 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\-c command\fP] [\fB\-i seconds\fP] [\fB\-d\fP] [\fB\-x\fP] [\fBjoydev [joydev ...]\fP] +.SH DESCRIPTION +.sp +jsmond lets you play games with your joysticks/gamepads without +xscreensaver activating due to lack of keyboard/mouse input. +.sp +Up to 16 joystick devices can be monitored. By default, jsmond searches +for these and monitors all the joysticks it finds. You can override +this on the command line by providing one or more \fBjoydev\fP arguments, +in which case no autodetection will be done. +.sp +Every \fIinterval\fP seconds (60, 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 runs the \fBxscreensaver\-command \-deactivate\fP, +or whatever the \fB\-c\fP argument is set to. +.sp +The command will be run no more than once every \fIinterval\fP seconds. +.sp +jsmond should be started from your \fB\&.xinitrc\fP or whatever X startup +script your windowmanager or desktop environment uses. By default, it +will exit when the X server does. +.sp +If you can think of a use for jsmond outside of X, give it the \-x argument +so it won\(aqt 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\(aqt hurt anything, just waste resources). +.SH OPTIONS +.INDENT 0.0 +.TP +.B \-\-help +Print usage summary +.TP +.BI \-c \ +Run when activity was detected during the +last \fIinterval\fP\&. +.TP +.BI \-i \ +Interval to check for activity. Should be set lower +than your xscreensaver timeout. Setting this too low +will waste resources. Default: 60. +.TP +.B \-d +Debug mode: print verbose messages and don\(aqt fork() +into the background. +.TP +.B \-x +Don\(aqt try to connect to X server. +.UNINDENT +.SH EXIT STATUS +.sp +Without the \-d option, the exit status is 0 (success) if jsmond +successfully opened at least one joystick and forked into the background. +.sp +A non\-zero exit status means no joysticks were found, 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 +jsmond only searches for joysticks when it\(aqs started. If USB joysticks are +plugged in while jsmond is running, it won\(aqt detect them. This includes +unplugging the device and plugging it back in: jsmond won\(aqt complain, +but it\(aqll never report activity on that device again. +.sp +jsmond isn\(aqt portable. It only works on Linux, at least for now. +.\" EXAMPLES +. +.\" ======== +. +.SH LICENSE +.sp +jsmond is released under the WTFPL: Do WTF you want with this. +.SH AUTHORS +.sp +jsmond was written by B. Watson <\fI\%yalhcru@gmail.com\fP>. +.SH SEE ALSO +.sp +sdl\-jstest(1), sdl2\-jstest(2) +.\" Generated by docutils manpage writer. +. -- cgit v1.2.3