notify

command
Version: v1.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 8, 2020 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Command notify listens on filesystem changes and forwards received mapping to user-defined handlers.

Usage

usage: notify [-c command] [-f script file] [path]...

The -c flag registers a command handler, which uses the syntax of package template. Notify passes struct to the template, splits produced string into command and args, and runs it using exec.Command(). Additionaly the path and event type values are accesible to the process via NOTIFY_PATH and NOTIFY_EVENT environment variables.

The struct being passed to the template is:

type Event struct {
    Path  string
    Event string
}

Values for the Event field are:

- create
- remove
- rename
- write

The -t flag registers a file handler, which works similary to the -c handler. The only difference the template is read from the given file instead of the command line.

The path argument tells notify which director or directories to listen on. By default notify listens recursively in current working directory.

If no handler is specified notify prints each event to os.Stdout.

Example usage

Executing event handler from command line:

 ~ $ notify -c 'echo "Hello from handler! (event={{.Event}}, path={{.Path}})"'
 2015/02/17 01:17:40 received notify.Create: "/Users/rjeczalik/notify.tmp"
 Hello from handler! (event=create, path=/Users/rjeczalik/notify.tmp)
...

Executing event handler from file:

~ $ cat > handler <<EOF
> echo "Hello from handler! (event={{.Event}}, path={{.Path}})"
> EOF

~ $ notify -f handler
2015/02/17 01:22:26 received notify.Create: "/Users/rjeczalik/notify.tmp"
Hello from handler! (event=create, path=/Users/rjeczalik/notify.tmp)
...

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL