add man page

[wall-notify/wall-notify.git] / README

diff --git a/README b/README
index 5b30220060c95a9dd48f9dacd7dc43b041eec503..4027cd9ef0a4000374c11fbc361d63850e06f66e 100644 (file)
--- a/README
+++ b/README
@@ -11,6 +11,9 @@ wall messages are either directly created by root with the `wall` command or
 sent by other programs like `reboot`, `shutdown` or other processes like NFS
 to warn users when the NFS server terminates.
 
+Optionally X11 can be used to automatically terminate wall-notify when the
+current X11 session terminates, i.e. when the user logs out. See below.
+
 wall-notify is licensed under GPL 3 (or later).
 
 
@@ -20,12 +23,19 @@ DEPENDENCIES
 - C89 compiler
 - libutempter or utmpx.h (utmpx.x requires a setgid utmp binary)
 
+- optional: X11 headers and library, necessary for X11 support
+
 
 INSTALLATION
 ------------
 
     ./configure && make && make check
 
+The libutempter is not available, the binary must be setgid utmp:
+
+    chgrp utmp src/wall-notify
+    chmod g+s src/wall-notify
+
 
 USAGE
 -----
@@ -52,9 +62,19 @@ in the message. For a simple wrapper script which removes those, see
 The shell is not used when running the program.
 
 
+If X11 support is compiled in then the '-X' option can be used to terminate
+wall-notify automatically when the X session quits. This is useful when
+wall-notify is started in `.xinitrc` and should quit when the X session ends,
+i.e the user logs out:
+
+    ./src/wall-notify -X cat
+
+
 BUGS
 ----
 
+Doesn't work on OpenBSD which has no support for utmpx.h.
+
 If you find any bugs not mentioned in this document please report them to
 <simon@ruderich.org> with wall-notify in the subject.