aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README37
1 files changed, 29 insertions, 8 deletions
diff --git a/README b/README
index 948ed37..eeacaa1 100644
--- a/README
+++ b/README
@@ -26,7 +26,7 @@ Prerequisites
-------------
- Recent-ish Linux kernel. Anything from 4.x up should be fine.
-- Kernel headers.
+- glibc and kernel headers.
- uinput support in the kernel. Most distros should have this.
- gcc or clang.
- make.
@@ -44,14 +44,35 @@ If you want to build a static binary, you can't do it with glibc,
due to it needing libnss_compat at runtime (for the getpwnam() and
getgrnam() calls). You'll have to use something like musl-libc.
+After installation, or any time you edit the udev .rules file,
+run this:
+
+# udevadm control --reload
+
+If you're packaging this for a Linux distro, you can run the
+above command from your package system's post-install hook (e.g.
+doinst.sh on Slackware). See also the variables at the top of
+the Makefile.
+
Running the daemon
------------------
-Everyone seems to use a different init system these days. I only
-provide an rc.marsond script for Slackware's SysV init. Basically, you
-want to start up the daemon at boot, using whatever facility your OS
-provides (systemd, s6, openrc, etc). It must be started as root, and
-it will drop privileges after initialization and run as the 'nobody'
-user by default. See the man page for other options you might want
-to use.
+After "make install", it will run via udev when the device is plugged
+in. See /etc/udev/rules.s/99-marsond.rules to change the options,
+if needed. If it doesn't start automatically, check the vendor and
+product IDs in dmesg against the ones in the .rules file. If you have
+a different vendor/product ID that has the Enter key problem, please
+contact me so I can add them to the udev rule.
+
+When the device is unplugged, the daemon will exit.
+
+For testing purposes, you can start it manually. Usually when you do
+this, you'll want the -v and -f options (verbose, foreground).
+
+
+Contact
+-------
+
+Email: B. Watson, <urchlay@slackware.uk>
+IRC: Urchlay on irc.libera.chat