X-Git-Url: https://ruderich.org/simon/gitweb/?a=blobdiff_plain;f=README;h=f6eb3de5b1e95dc932158ab99bc58aa16ec511d5;hb=3553a29a54f7755debfa189db830c4b8de51826f;hp=b229957f5f3a5a4bd043306f807e4ab82cfc06c3;hpb=75df966ec9fc32e2b6dbf16d34cf6105e04a4573;p=wall-notify%2Fwall-notify.git

diff --git a/README b/README
index b229957..f6eb3de 100644
--- a/README
+++ b/README
@@ -32,16 +32,22 @@ USAGE
 
 To dump all wall messages to stdout use:
 
-    ./wall-notify cat
+    ./src/wall-notify cat
 
 All arguments passed to `wall-notify` are used when execing the process, e.g.
 to replace all spaces with underlines use:
 
-    ./wall-notify sed 's/ /_/g'
+    ./src/wall-notify sed 's/ /_/g'
 
 To display the messages with `xmessage` use:
 
-    ./wall-notify xmessage -file -
+    ./src/wall-notify xmessage -file -
+
+However this will display '^M' (carriage-return) and other control characters
+in the message. For a simple wrapper script which removes those, see
+`contrib/message-helper`:
+
+    ./src/wall-notify contrib/message.sh xmessage -file -
 
 The shell is not used when running the program.
 
@@ -49,6 +55,8 @@ The shell is not used when running the program.
 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.