summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorTobias Klauser <tklauser@xenon.tklauser.home>2006-08-12 21:42:15 +0200
committerTobias Klauser <tklauser@xenon.tklauser.home>2006-08-12 21:42:15 +0200
commit0d7e4444ab8ab33b3f8d8b9313139ab19be3252a (patch)
tree6dece6269470b1089e2a71cff28d7f3894601843 /README
parent3c9d7963eec4c1a78583f70ba3a45b95e86064c9 (diff)
Add README and LICENSE files
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 21 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..5010178
--- /dev/null
+++ b/README
@@ -0,0 +1,21 @@
+ inotail - inotify enhanced tail
+o===============================o
+
+inotail is a drop-in replacement for the 'tail' program found in the base
+installation of every Linux/UNIX system. It makes use of the Inotify
+infrastructure in recent version of the Linux kernel to speed up tailing files
+in the follow mode (the '-f' option). Currently inotail is not fully compatible
+to neither POSIX or GNU tail but might be in the future.
+
+Requirements
+------------
+- Linux kernel 2.6.13 or higher with CONFIG_INOTIFY enabled
+- Future versions will require a version of the glibc shipping with inotify
+ support
+
+License
+-------
+inotail is licensed under the terms of the GNU General Public License Version 2.
+You can find the full text in the file LICENSE in the source tree of inotail.
+
+-- Tobias Klauser <tklauser@distanz.ch>