README

   1 README
   2 ======
   3
   4 wall-notify is a simple program which receives all messages written by wall
   5 and passes them to a notification program via stdin. It's designed for
   6 simplistic desktop environments (like tiling window managers) or GNU
   7 Screen/Tmux sessions to notify the user about important messages like reboots.
   8 It was inspired by KDE's knotify.
   9
  10 wall messages are either directly created by root with the `wall` command or
  11 sent by other programs like `reboot`, `shutdown` or other processes like NFS
  12 to warn users when the NFS server terminates.
  13
  14 wall-notify is licensed under GPL 3 (or later).
  15
  16
  17 DEPENDENCIES
  18 ------------
  19
  20 - C89 compiler
  21 - libutempter or utmpx.h (utmpx.x requires a setgid utmp binary)
  22
  23
  24 INSTALLATION
  25 ------------
  26
  27     ./configure && make && make check
  28
  29
  30 USAGE
  31 -----
  32
  33 To dump all wall messages to stdout use:
  34
  35     ./src/wall-notify cat
  36
  37 All arguments passed to `wall-notify` are used when execing the process, e.g.
  38 to replace all spaces with underlines use:
  39
  40     ./src/wall-notify sed 's/ /_/g'
  41
  42 To display the messages with `xmessage` use:
  43
  44     ./src/wall-notify xmessage -file -
  45
  46 However this will display '^M' (carriage-return) and other control characters
  47 in the message. For a simple wrapper script which removes those, see
  48 `contrib/message-helper`:
  49
  50     ./src/wall-notify contrib/message.sh xmessage -file -
  51
  52 The shell is not used when running the program.
  53
  54
  55 BUGS
  56 ----
  57
  58 If you find any bugs not mentioned in this document please report them to
  59 <simon@ruderich.org> with wall-notify in the subject.
  60
  61
  62 AUTHORS
  63 -------
  64
  65 Written by Simon Ruderich <simon@ruderich.org>.
  66
  67
  68 LICENSE
  69 -------
  70
  71 wall-notify is licensed under GPL version 3 or later.
  72
  73 Copyright (C) 2014  Simon Ruderich
  74
  75 This program is free software: you can redistribute it and/or modify
  76 it under the terms of the GNU General Public License as published by
  77 the Free Software Foundation, either version 3 of the License, or
  78 (at your option) any later version.
  79
  80 This program is distributed in the hope that it will be useful,
  81 but WITHOUT ANY WARRANTY; without even the implied warranty of
  82 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  83 GNU General Public License for more details.
  84
  85 You should have received a copy of the GNU General Public License
  86 along with this program.  If not, see <http://www.gnu.org/licenses/>.