aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorB. Watson <urchlay@slackware.uk>2025-05-06 15:19:59 -0400
committerB. Watson <urchlay@slackware.uk>2025-05-06 15:19:59 -0400
commit9df059293d7743fbc1d51685faf45c384adbda85 (patch)
tree52cec11f7b985f4717aac87cf3fc9073bc2a4597
parentf0377a641080105502bcd77d059ec698c25f8769 (diff)
downloadmarsond-9df059293d7743fbc1d51685faf45c384adbda85.tar.gz
update man page.
-rw-r--r--marsond.19
-rw-r--r--marsond.rst9
2 files changed, 16 insertions, 2 deletions
diff --git a/marsond.1 b/marsond.1
index 667e38f..f0a84bd 100644
--- a/marsond.1
+++ b/marsond.1
@@ -71,6 +71,11 @@ This should work with everything that uses the keyboard. It definitely
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
+\fBmarsond\fP must be run as root. After grabbing the keyboard
+and creating the virtual keyboard device, it will drop
+privileges and run as the \fInobody\fP user by default (but
+see \fBENVIRONMENT\fP if you need a different user).
.SH OPTIONS
.sp
Options can be "bundled": \fB\-vf\fP is the same as \fB\-v\fP \fB\-f\fP\&.
@@ -130,7 +135,9 @@ After initialization, \fBmarsond\fP will drop privileges by
setting its user ID to this user\(aqs. Default: \fInobody\fP
.TP
.B MARSOND_GROUP
-Group to run as, after dropping privileges. Default: \fInogroup\fP
+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
.\" EXIT STATUS
.
diff --git a/marsond.rst b/marsond.rst
index 2df75bb..8b798c3 100644
--- a/marsond.rst
+++ b/marsond.rst
@@ -57,6 +57,11 @@ 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.
+**marsond** must be run as root. After grabbing the keyboard
+and creating the virtual keyboard device, it will drop
+privileges and run as the *nobody* user by default (but
+see **ENVIRONMENT** if you need a different user).
+
OPTIONS
=======
@@ -106,7 +111,9 @@ MARSOND_USER
setting its user ID to this user's. Default: *nobody*
MARSOND_GROUP
- Group to run as, after dropping privileges. Default: *nogroup*
+ Group to run as, after dropping privileges. Default:
+ the primary group of the user it's running as. Normally
+ you won't have to set this.
.. EXIT STATUS
.. ===========