summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md70
1 files changed, 70 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c28a27d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,70 @@
+journal-notify
+==============
+
+**Notify about journal log entries**
+
+This runs in background and produces notifications whenever systemd journal
+logs an entry. Notifications look like this:
+
+![Notification](screenshot.png)
+
+Requirements
+------------
+
+To compile and run `journal-notify` you need:
+
+* [libnotify](http://library.gnome.org/devel/notification-spec/)
+* [libsystemd](http://www.freedesktop.org/wiki/Software/systemd/)
+* [markdown](http://daringfireball.net/projects/markdown/) (HTML
+ documentation)
+* `gnome-icon-theme` (or whatever includes the icons you want to use)
+
+To use `journal-notify` you probably want `systemd-journald`.
+
+Some systems may require additional development packages for the libraries.
+Look for `libnotify-devel`, `libsystemd-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/journal-notify`,
+documentation can be found in `/usr/share/doc/journal-notify/`.
+
+Usage
+-----
+
+To use `journal-notify` you need access to the journal log files. Make sure
+you get the expexted log entries by running `journalctl`. Possibly you have
+to add yourself to group `systemd-journal` or similar.
+
+Just running `journal-notify` without parameter will show *all* log entries.
+Be warned: This can flood your disktop with notifications.
+
+`journal-notify` accepts some options:
+
+* *-e*: use extended regular expressions
+* *-h*: show help
+* *-i ICON*: icon to use
+* *-m MATCH*: This can be specified more than once. The option accepts matches
+ to systemd journal fields. (see `man 7 systemd.journal-fields`)
+* *-n*: no case sensitive regular expressions
+* *-r REGEX*: This add a regular expression match for the message field.
+
+The screenshot shown above resulted from this command:
+
+> journal-notify -m SYSLOG_IDENTIFIER=sshd -e -r "^(error:.\*|Accepted.\*)"
+-i security-high
+
+Additionally example desktop files are installed to
+`/usr/share/journal-notify/examples`. You should copy them to
+`~/.config/autostart/` to enable autostart or create your own desktop files
+there.
+