aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorB. Watson <urchlay@slackware.uk>2025-05-08 04:21:44 -0400
committerB. Watson <urchlay@slackware.uk>2025-05-08 04:21:44 -0400
commit9872f6128c48ff39b5d7003765418b29e259bebb (patch)
treeef74b3f58a6c36ddd301ede892706447be382a81
parentfad6942c47674fc4a034fa29aa33ebd55e82546a (diff)
downloadmarsond-9872f6128c48ff39b5d7003765418b29e259bebb.tar.gz
mention udev rules in man page, add LIMITATIONS.
-rw-r--r--marsond.828
-rw-r--r--marsond.rst25
2 files changed, 52 insertions, 1 deletions
diff --git a/marsond.8 b/marsond.8
index be63471..ecd7145 100644
--- a/marsond.8
+++ b/marsond.8
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "MARSOND" 8 "2025-05-07" "0.3.0" "Urchlay's Stuff"
+.TH "MARSOND" 8 "2025-05-08" "0.3.0" "Urchlay's Stuff"
.SH NAME
marsond \- Fix Enter key timing on Marson/USBLink/MT606-1 PS/2-USB adaptors
.SH SYNOPSIS
@@ -72,6 +72,18 @@ does, with SDL 1 and 2 running under X (and SDL 1 on the console,
too). I don\(aqt use Wayland, so I haven\(aqt tested it there. If you do,
please contact me and let me know if it works for you.
.sp
+For normal use, \fBmarsond\fP will be started by a \fBudev\fP(7) rule
+when the adaptor is plugged in (including booting with the adaptor
+connected). The udev rule is found in:
+.INDENT 0.0
+.INDENT 3.5
+/etc/udev/rules.d/99\-marsond.rules
+.UNINDENT
+.UNINDENT
+.sp
+\&...which can be edited to change the options it\(aqs run with, if
+needed. The defaults work well on the author\(aqs system.
+.sp
\fBmarsond\fP must be run as root. At startup, it does these
things as root:
.INDENT 0.0
@@ -165,6 +177,20 @@ Group to run as, after dropping privileges. Default:
the primary group of the user it\(aqs running as. Normally
you won\(aqt have to set this.
.UNINDENT
+.SH LIMITATIONS
+.sp
+Only one MT\-606\-1 device is supported, out of the box. This shouldn\(aqt
+really be a problem (do you really need 2 keyboards?) but it\(aqs worth
+mentioning. If you really do own two of these adaptors and want to use
+them on the same PC, you could add a second udev rule (with \-k option
+for the daemon).
+.sp
+This isn\(aqt really a \fBmarsond\fP problem per se, but when Xorg detects
+a new keyboard, it resets your keyboard repeat rate (\fBxset r\fP)
+and custom keymap (\fBxmodmap\fP(1)). If you use a \(aqdesktop\(aq such
+as KDE, GNOME, or XFCE, it should re\-apply your settings. For a
+traditional window manager (WindowMaker, FVWM2, etc), this can be very
+annoying.
.\" EXIT STATUS
.
.\" ===========
diff --git a/marsond.rst b/marsond.rst
index 8f56ace..2a95b71 100644
--- a/marsond.rst
+++ b/marsond.rst
@@ -57,6 +57,15 @@ does, with SDL 1 and 2 running under X (and SDL 1 on the console,
too). I don't use Wayland, so I haven't tested it there. If you do,
please contact me and let me know if it works for you.
+For normal use, **marsond** will be started by a **udev**\(7) rule
+when the adaptor is plugged in (including booting with the adaptor
+connected). The udev rule is found in:
+
+ /etc/udev/rules.d/99-marsond.rules
+
+...which can be edited to change the options it's run with, if
+needed. The defaults work well on the author's system.
+
**marsond** must be run as root. At startup, it does these
things as root:
@@ -137,6 +146,22 @@ MARSOND_GROUP
the primary group of the user it's running as. Normally
you won't have to set this.
+LIMITATIONS
+===========
+
+Only one MT-606-1 device is supported, out of the box. This shouldn't
+really be a problem (do you really need 2 keyboards?) but it's worth
+mentioning. If you really do own two of these adaptors and want to use
+them on the same PC, you could add a second udev rule (with -k option
+for the daemon).
+
+This isn't really a **marsond** problem per se, but when Xorg detects
+a new keyboard, it resets your keyboard repeat rate (**xset r**)
+and custom keymap (**xmodmap**\(1)). If you use a 'desktop' such
+as KDE, GNOME, or XFCE, it should re-apply your settings. For a
+traditional window manager (WindowMaker, FVWM2, etc), this can be very
+annoying.
+
.. EXIT STATUS
.. ===========