add man page

[wall-notify/wall-notify.git] / man / wall-notify.txt

diff --git a/man/wall-notify.txt b/man/wall-notify.txt
new file mode 100644 (file)
index 0000000..e059204
--- /dev/null
+++ b/man/wall-notify.txt
@@ -0,0 +1,57 @@
+wall-notify(1)
+==============
+
+NAME
+----
+
+wall-notify - receive wall messages and pass them to a notification program
+
+
+SYNOPSIS
+--------
+
+*wall-notify* ['-X'] ['-m'] 'cmd' ['args']..
+
+
+DESCRIPTION
+-----------
+
+*wall-notify* receives *wall* messages and passes them to the notification
+program 'cmd' and its arguments via stdin. For each received message a new
+instance of 'cmd' is created.
+
+
+OPTIONS
+-------
+
+*-X*::
+    Quit when the current X session terminates. By default *wall-notify* keeps
+    running. This option is intended for `~/.xinitrc` to prevent stale
+    *wall-notify* processes when the user logs out. Requires a running X
+    server.
+
+*-m*::
+    Receive messages from all users. Works similar to *mesg y*. By default
+    only messages from root are allowed. Be careful when using this option, it
+    might be abused by local users to send fake messages.
+
+
+AUTHORS
+-------
+
+Written by Simon Ruderich <simon@ruderich.org>.
+
+
+COPYRIGHT
+---------
+
+Copyright \(C) 2014  Simon Ruderich. Free software licensed under GPL version
+3 or later.
+
+
+SEE ALSO
+--------
+
+manlink:wall[1], manlink:utmp[5], manlink:shtudown[1]
+
+// vim: ft=asciidoc