Initial commit

Author: cytopia

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 cytopia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,57 @@
+# watcherd
+
+watcherd will look for directory changes (added and deleted directories) under the specified path (`-p`) and will execute specified commands or shell scripts (`-a`, `-d`) depending on the event.
+Once all events have happened during one round (`-i`), a trigger command can be executed (`-t`).
+Note, the trigger command will only be execute when at least one add or delete command has succeeded with exit code 0.
+
+### Modes
+
+watcherd can either use the native [inotifywait](https://linux.die.net/man/1/inotifywait) implementation or if this is not available on your system use a custom bash implementation. The default is to use bash.
+
+### Examples
+
+Assuming `vhost-add.sh` will add nginx vhost config files and `vhost-del.sh` will remove nginx vhost config files, the following will then be able to create new nginx vhosts on-the-fly, simply by adding or deleting folders in your main www directory. The trigger command will simply force nginx to reload its configuration after directory changes occured.
+
+```shell
+watcherd -p /var/www -a vhost-add.sh -d vhost-del.sh -t "nginx -s stop"
+```
+
+### Usage
+
+```shell
+Usage: watcherd -p <path> -a <cmd> -d <cmd> [-t <cmd> -w <str> -i <int> -v]
+       watcherd --help
+       watcherd --version
+
+watcherd will look for directory changes (added and deleted directories) under
+the specified path (-p) and will execute specified commands or shell scripts
+(-a, -d) depending on the event. Once all events have happened during one round
+(-i), a trigger command can be executed (-t). Note, the trigger command will
+only be execute when at least one add or delete command has succeeded with exit
+code 0.
+
+Required arguments:
+  -p <path>     Path to directoy to watch for changes.
+  -a <cmd>      Command to execute when a directory was added.
+                The full path of the new dir will be appended as an argument to
+				this command.
+  -d <cmd>      Command to execute when a directory was deletd.
+                The full path of the new dir will be appended as an argument to
+				this command.
+
+Optional arguments:
+  -t <cmd>      Command to execute after all directories have been added or
+                deleted during one round.
+                No argument will be appended.
+  -w <str>      The directory watcher to use. Valid values are:
+                'inotify': Uses inotifywait to watch for directory changes.
+                'bash':    Uses a bash loop to watch for directory changes.
+                The default is to use 'bash' as the watcher.
+  -i <int>      When using the bash watcher, specify the interval in seconds
+                for how often to look for directory changes.
+  -v            Verbose output.
+
+Misc arguments:
+  --help        Show this help screen.
+  --version     Show version information.
+```