control/message.sh: add

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

diff --git a/README b/README
index b229957f5f3a5a4bd043306f807e4ab82cfc06c3..5b30220060c95a9dd48f9dacd7dc43b041eec503 100644 (file)
--- 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.