From fa9e9a0dfb0d6fc556679f3e4a27321e4d1bbfab Mon Sep 17 00:00:00 2001 From: Albert S Date: Wed, 22 Oct 2014 00:30:53 +0200 Subject: [PATCH] Updated README --- README | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/README b/README index 8ca3932..bdae64e 100644 --- a/README +++ b/README @@ -1,11 +1,12 @@ What is adhocify? ================= -adhocify is a very simple and useful tool. - -adhocify uses inotify to watch for file system events. Those events are -specified by the user. Once an event occurs, it launches a script supplied -by the user, passing the path of the file the event occurred on as an argument. +adhocify uses inotify to watch for file system events. +Once an event occurs a script will be launched. +It can pass the path of the file the event occured on to this script. +Requirements +============ +adhocify only runs on Linux. You need a kernel and libc with inotify support. How do I use adhocify? ====================== @@ -16,6 +17,19 @@ Examples: ------------------------------------------ Watches for IN_CLOSE_WRITE events in /tmp/, launches script /home/core/myscript.sh +/adhocify -w /tmp/ /home/core/myscript.sh {} +------------------------------------------ +Same as above, but also passes the file an event occured on to that script. (argv[1]). + + +./adhocify -w /tmp/ /bin/echo the file {} was written to +--------------------------------------------------------- +Running +echo "Test" > /tmp/test + +Will print in the shell adhocify was launched in: +the file /tmp/test was written to + ./adhocify -w /tmp/ -w /var/run /home/core/myscript.sh ------------------------------------------------------ Same as above, but also watches /var/run @@ -34,5 +48,4 @@ Watches for IN_OPEN events in /tmp/, launches script /home/core/myscript.sh ... ignores *.txt files .... -