update readme on v0 branch
3 files changed
tree: e1484d0bf001312975e6f1b72e42e00c46e58855
  1. .gitignore
  2. AUTHORS
  3. CHANGELOG.md
  4. CONTRIBUTING.md
  5. LICENSE
  6. README.md
  7. example_test.go
  8. fsnotify.go
  9. fsnotify_bsd.go
  10. fsnotify_linux.go
  11. fsnotify_open_bsd.go
  12. fsnotify_open_darwin.go
  13. fsnotify_symlink_test.go
  14. fsnotify_test.go
  15. fsnotify_windows.go
README.md

File system notifications for Go

GoDoc

This branch contains fsnotify.v0 which is API-compatible with howeyc/fsnotify. Bugfixes may be backported, but I recommend upgrading.

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

Example:

package main

import (
	"log"

	"gopkg.in/fsnotify.v0"
)

func main() {
	watcher, err := fsnotify.NewWatcher()
	if err != nil {
		log.Fatal(err)
	}

	done := make(chan bool)

	// Process events
	go func() {
		for {
			select {
			case ev := <-watcher.Event:
				log.Println("event:", ev)
			case err := <-watcher.Error:
				log.Println("error:", err)
			}
		}
	}()

	err = watcher.Watch("testDir")
	if err != nil {
		log.Fatal(err)
	}

	<-done

	/* ... do stuff ... */
	watcher.Close()
}

For each event:

  • Name
  • IsCreate()
  • IsDelete()
  • IsModify()
  • IsRename()

FAQ

When a file is moved to another directory is it still being watched?

No (it shouldn't be, unless you are watching where it was moved to).

When I watch a directory, are all subdirectories watched as well?

No, you must add watches for any directory you want to watch (a recursive watcher is in the works #56).

Do I have to watch the Error and Event channels in a separate goroutine?

As of now, yes. Looking into making this single-thread friendly (see #7)

Why am I receiving multiple events for the same file on OS X?

Spotlight indexing on OS X can result in multiple events (see #62). A temporary workaround is to add your folder(s) to the Spotlight Privacy settings until we have a native FSEvents implementation (see #54).

How many files can be watched at once?

There are OS-specific limits as to how many watches can be created:

  • Linux: /proc/sys/fs/inotify/max_user_watches contains the limit, reaching this limit results in a “no space left on device” error.
  • BSD / OSX: sysctl variables “kern.maxfiles” and “kern.maxfilesperproc”, reaching these limits results in a “too many open files” error.