tree: b55860e7ad649324c5fa003701877405bf8df0d0 [path history] [tgz]
  1. .editorconfig
  2. .gitignore
  3. .travis.yml
  4. AUTHORS
  5. CHANGELOG.md
  6. CONTRIBUTING.md
  7. fen.go
  8. fsnotify.go
  9. inotify.go
  10. inotify_poller.go
  11. kqueue.go
  12. LICENSE
  13. open_mode_bsd.go
  14. open_mode_darwin.go
  15. README.md
  16. windows.go
vendor/github.com/fsnotify/fsnotify/README.md

File system notifications for Go

GoDoc Go Report Card

fsnotify utilizes golang.org/x/sys rather than syscall from the standard library. Ensure you have the latest version installed by running:

go get -u golang.org/x/sys/...

Cross platform: Windows, Linux, BSD and macOS.

AdapterOSStatus
inotifyLinux 2.6.27 or later, Android*Supported Build Status
kqueueBSD, macOS, iOS*Supported Build Status
ReadDirectoryChangesWWindowsSupported Build status
FSEventsmacOSPlanned
FENSolaris 11In Progress
fanotifyLinux 2.6.37+
USN JournalsWindowsMaybe
PollingAllMaybe

* Android and iOS are untested.

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

API stability

fsnotify is a fork of howeyc/fsnotify with a new API as of v1.0. The API is based on this design document.

All releases are tagged based on Semantic Versioning. Further API changes are planned, and will be tagged with a new major revision number.

Go 1.6 supports dependencies located in the vendor/ folder. Unless you are creating a library, it is recommended that you copy fsnotify into vendor/github.com/fsnotify/fsnotify within your project, and likewise for golang.org/x/sys.

Contributing

Please refer to CONTRIBUTING before opening an issue or pull request.

Example

See example_test.go.

Related Projects