tree: 43c72aefbbc2a7ebcc15ed9ea6c2b101c28d720d [path history] [tgz]
  1. .gitignore
  2. .travis.yml
  3. AUTHORS
  4. CHANGELOG.md
  5. CONTRIBUTING.md
  6. example_test.go
  7. fsnotify.go
  8. inotify.go
  9. integration_test.go
  10. kqueue.go
  11. LICENSE
  12. open_mode_bsd.go
  13. open_mode_darwin.go
  14. README.md
  15. windows.go
vendor/src/github.com/go-fsnotify/fsnotify/README.md

File system notifications for Go

Coverage GoDoc

Cross platform: Windows, Linux, BSD and OS X.

AdapterOSStatus
inotifyLinux, Android*Supported
kqueueBSD, OS X, iOS*Supported
ReadDirectoryChangesWWindowsSupported
FSEventsOS XPlanned
FENSolaris 11Planned
fanotifyLinux 2.6.37+
PollingAllMaybe
Plan 9

* Android and iOS are untested.

Please see the documentation for usage. Consult the Wiki for the FAQ and further information.

API stability

Two major versions of fsnotify exist.

fsnotify.v1 provides a new API based on this design document. You can import v1 with:

import "gopkg.in/fsnotify.v1"

* Refer to the package as fsnotify (without the .v1 suffix).

fsnotify.v0 is API-compatible with howeyc/fsnotify. Bugfixes may be backported, but I recommend upgrading to v1.

import "gopkg.in/fsnotify.v0"

Further API changes are planned, but a new major revision will be tagged, so you can depend on the v1 API.

Contributing

A future version of Go will have fsnotify in the standard library, therefore fsnotify carries the same LICENSE as Go. Contributors retain their copyright, so we need you to fill out a short form before we can accept your contribution: Google Individual Contributor License Agreement.

Please read CONTRIBUTING before opening a pull request.

Example

See example_test.go.