summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFlorian Bruhin <git@the-compiler.org>2014-09-20 18:32:26 +0200
committerFlorian Bruhin <git@the-compiler.org>2014-09-20 18:32:26 +0200
commitdc4b6d89f5c642e576256d922120f4b56713a02a (patch)
treeb82379973a52867749ea02ca865b75cb7d1b45ba
parent4e261d9993590e6c3cbb925e2a28a40cceac28c7 (diff)
downloadjournalwatch-dc4b6d89f5c642e576256d922120f4b56713a02a.tar.gz
journalwatch-dc4b6d89f5c642e576256d922120f4b56713a02a.zip
Update README
-rw-r--r--README.txt27
1 files changed, 21 insertions, 6 deletions
diff --git a/README.txt b/README.txt
index f1c5f66..134ff7c 100644
--- a/README.txt
+++ b/README.txt
@@ -1,15 +1,30 @@
+journalwatch
+============
+
journalwatch is a tool which can find error messages in the systemd journal.
-It is similiar to tools like logwatch/logcheck except it's much more KISS and
-only works with the systemd journal. It works by defining patterns to match all
-log lines which are not interesting, and then prints all log lines not matching
-those patterns (or sends them by mail).
+It is similiar to tools like
+http://sourceforge.net/projects/logwatch/[logwatch] or
+http://logcheck.org/[logcheck] except it's much more KISS and
+only works with the systemd
+http://0pointer.de/blog/projects/journalctl.html[journal]. It works by defining
+patterns to match all log lines which are not interesting, and then prints all
+log lines not matching those patterns (or sends them by mail).
When you start it the first time, it'll write the default pattern and config to
-$XDG_CONFIG_HOME/.config/journalwatch ($XDG_CONFIG_HOME is your home if unset).
-Details on how to configure journalwatch are available in these files.
+`$XDG_CONFIG_HOME/.config/journalwatch` (`$XDG_CONFIG_HOME` is your home if
+unset). Details on how to configure journalwatch are available in these files.
+
+Dependencies
+------------
+- Python 3 (tested with 3.3 and 3.4, should work with >= 3.2)
+- `systemd` python module
+- A working `sendmail`/MTA (http://msmtp.sourceforge.net/[msmtp] is easy to set
+up)
+License
+-------
journalwatch is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by