diff options
author | Christian Hesse <mail@eworm.de> | 2013-07-17 20:49:10 +0200 |
---|---|---|
committer | Christian Hesse <mail@eworm.de> | 2013-07-17 20:49:10 +0200 |
commit | 951812d96ad6cf321a1d22142a7f807997ea9611 (patch) | |
tree | b4ea42ecf613e36d6e7ef54b35ee270e767279e4 | |
parent | 4b61f37332894cea36cf1ff54bdbe050b4fa3f89 (diff) | |
download | netlink-notify-951812d96ad6cf321a1d22142a7f807997ea9611.tar.gz netlink-notify-951812d96ad6cf321a1d22142a7f807997ea9611.tar.zst |
add documentation
-rw-r--r-- | README.md | 59 |
1 files changed, 58 insertions, 1 deletions
@@ -1,4 +1,61 @@ netlink-notify ============== -Notify about netlink changes
\ No newline at end of file +**Notify about netlink changes** + +This runs in background and produces notifications whenever a netlink event +is received. Notifications look like this: + +A device is down: + +![Device down](screenshot-down.png) + +A device is up: + +![Device up](screenshot-up.png) + +A device received an IP address: + +![Device received IP address](screenshot-ip.png) + +A device received an IPv6 address: + +![Device received IPv6 address](screenshot-ipv6.png) + +A device disappeared: + +![Device disappeared](screenshot-away.png) + +Requirements +------------ + +To compile and run `netlink-notify` you need: + +* [libnotify](http://library.gnome.org/devel/notification-spec/) +* [linux](http://www.kernel.org/) +* [markdown](http://daringfireball.net/projects/markdown/) (HTML documentation) + +Some systems may require additional development packages for the libraries. +Look for `libnotify-devel` or similar. + +Build and install +----------------- + +Building and installing is very easy. Just run: + +> make + +followed by: + +> make install + +This will place an executable at `/usr/bin/netlink-notify`, +documentation can be found in `/usr/share/doc/netlink-notify/`. +Additionally a desktop file is installed to `/etc/xdg/autostart/`, this +automatically starts the program when logged in to a desktop environment. + +Usage +----- + +Just run `netlink-notify` after installation or re-login to desktop +environment for autostart. |