commit	81f73985c1753fb9e1ee756d3c4199440c6ef030	[log] [tgz]
author	Nathan Youngman <git@nathany.com>	Thu Jan 01 03:14:50 2015
committer	Nathan Youngman <git@nathany.com>	Thu Jan 01 03:14:50 2015
tree	f9e5da3daeaae6d494ef85b7ff99b429f560ed6b
parent	b60ebf7604dd4945d4d891f3c752f528b433d135 [diff]

tree: f9e5da3daeaae6d494ef85b7ff99b429f560ed6b

README.md

File system notifications for Go

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

Moving Notice

There is a fork being actively developed with a new API in preparation for the Go Standard Library: github.com/go-fsnotify/fsnotify

Example:

package main

import (
	"log"

	"github.com/howeyc/fsnotify"
)

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.