README.md
1Event Notify Test Runner
2========================
3
4A utility for running arbitrary commands when files change. Uses [kqueue(2)] or
5[inotify(7)] to avoid polling. `entr` was written to make rapid feedback and
6automated testing natural and completely ordinary.
7
8Source Installation - BSD, Mac OS, and Linux
9--------------------------------------------
10
11 ./configure
12 make test
13 make install
14
15To see available build options run `./configure -h`
16
17Docker and Windows Subsystem for Linux
18--------------------------------------
19
20Incomplete inotify support on WSL and Docker for Mac can cause `entr`
21to respond inconsistently. Since version 4.4, `entr` includes a workaround:
22Set the environment variable `ENTR_INOTIFY_WORKAROUND`.
23
24`entr` will confirm the workaround is enabled:
25
26```
27entr: broken inotify workaround enabled
28```
29
30Man Page Examples
31-----------------
32
33Rebuild a project if source files change, limiting output to the first 20 lines:
34
35 $ find src/ | entr sh -c 'make | head -n 20'
36
37Launch and auto-reload a node.js server:
38
39 $ ls *.js | entr -r node app.js
40
41Clear the screen and run a query after the SQL script is updated:
42
43 $ echo my.sql | entr -cp psql -f /_
44
45Rebuild project if a source file is modified or added to the src/ directory:
46
47 $ while sleep 0.1; do ls src/*.rb | entr -d make; done
48
49Auto-reload a web server, or terminate if the server exits
50
51 $ ls * | entr -rz ./httpd
52
53News
54----
55
56A release history as well as features in the upcoming release are covered in the
57[NEWS](NEWS) file.
58
59[kqueue(2)]: http://man.openbsd.org/kqueue.2
60[inotify(7)]: http://man.he.net/?section=all&topic=inotify
61