GNU Direvent

Table of Contents

Direvent

This edition of the GNU Direvent manual, last updated 4 July 2016, documents GNU Direvent Version 5.1.

GNU Direvent:   Section:   Chapter:FastBack: Top   Up: Top   FastForward: Overview   Contents: Table of ContentsIndex: Concept Index

1 Introduction

GNU direvent monitors events in file system directories. For each event that occurs in a set of pre-configured directories, the program calls an external program associated with it, supplying it the information about the event and the location within the file system where it took place.

GNU direvent provides an easy way to configure your system to react immediately if certain files undergo changes. This may be helpful, for example, to track changes in important configuration files.

Interfaces for tracking changes to file systems are highly system-specific. GNU direvent aims to provide a uniform and system-independent command-level interface. As of version 5.1 direvent works with modern Linux kernels (since v. 2.6.13) and BSD systems (FreeBSD, NetBSD, OpenBSD, Darwin).

GNU Direvent:   Section:   Chapter:FastBack: Intro   Up: Top   FastForward: Quick start   Contents: Table of ContentsIndex: Concept Index

2 Overview

GNU direvent monitors a set of directories on the file system and reacts when a file system event occurs in any of them. Directories and events to monitor are specified in the configuration file. When an event occurs, the program reacts by invoking an external command configured for that event.

File system events can be divided into two major groups. The system-dependent events are specific for each particular kernel interface. In the contrast, generic events don’t depend on the underlying system. They provide a higher level of abstraction and make it possible to port GNU direvent configurations between various systems and architectures.

The generic events are:

create

A file was created.

delete

A file was deleted;

write

A file was written to;

attrib

File attributes have changed. This includes changes in the file ownership, mode, link count, etc.

A watcher is a configuration entity that associates a set of directories with a set of events and instructs direvent to run a specified external command when any of these events occur in any of these directories. This external command (called a handler) can obtain information about the event that triggered it from the environment variables, or from its command line.

Watchers are defined in the configuration file, which direvent reads at startup. This file has a simple and easy to use syntax.

Three types of comments are allowed: inline comments, that begin with a ‘#’ or ‘//’ and extend to the end of line, and multi-line comments, which comprise everything enclosed between ‘/*’ and ‘*/’. Comments and empty lines are ignored. Whitespace characters are ignored as well, except as they serve to separate tokens.

A token is a string of consecutive characters from the following classes: alphanumeric characters, underscores, dots, asteriscs, slashes, semicolons, commercial at’s, and dashes.

Any other sequence of characters must be enclosed in double quotation marks in order to represent a single token.

Adjacent quoted strings are concatenated.

A configuration statement consists of a keyword and value separated by any amount of whitespace and is terminated with a semicolon. A block statement is a collection of statements enclosed in curly braces.

The following block statement declares a watcher:

watcher {
    path pathname [recursive [level]];
    file pattern-list;
    event  event-list;
    command command-line;
    user name;
    timeout number;
    environ env-spec;
    option string-list;
}

Each watcher statement instructs direvent to monitor events listed in event-list occurring in the directories specified by pathnames in path statements (any number of path statements can be given). When any such event is detected, the supplied command-line will be executed.

Each directory defined with the recursive keyword will be watched recursively. This means that for each subdirectory created in it, direvent will install a watcher similar to that of its parent directory. Optional level statement can be used to set up a cut-off nesting level, beyond which the recursive operation is disabled.

The rest of statements are optional. The file statement instructs GNU direvent to react only if the event concerned the file whose name matches one of the patterns given in its argument. The user statement can be used to execute the command-line as the user name (provided, of course, that direvent is started with root privileges). The timeout specifies the maximum amount of time (in seconds) the command is allowed to run. It defaults to 5. The environ statement modifies the command environment. Finally, the option statement supplies additional options. It can be used, for example, to divert the command’s output to syslog.

GNU Direvent:   Section:   Chapter:FastBack: Overview   Up: Top   FastForward: Invocation   Contents: Table of ContentsIndex: Concept Index

3 Quick Start

Let’s suppose you have a directory where users can upload their files and you want these files to be processed right after upload, in real time. Let this directory be /home/ftp/incoming and the program to process the upload be /usr/bin/upload. Let’s also suppose that this program expects name of the uploaded file as its argument.

To make direvent handle this task, you would need to create a watcher for the upload directory which would handle the ‘create’ event:

watcher {
    path /home/ftp/incoming;
    event create;
    # more statements follow...

On this event, the watcher is to invoke /usr/bin/upload with the name of the created file as an argument. To make it possible, the direvent configuration file provides macro variables, which can be used in the command argument at configuration time and which are expanded to the actual values before the command is executed. Macro variables are referred to using the same syntax as shell variables: a dollar sign followed by the variable name, optionally enclosed in curly braces. The ‘file’ variable is expanded to the name of the file for which the event is reported. This name is relative to the current working directory which, by the time the handler is executed, is set to the directory where the event occurred. Thus, the handler can be configured as:

    command "/usr/bin/upload $file";

To summarize, the watcher declaration is:

watcher {
    path /home/ftp/incoming;
    event create;
    command "/usr/bin/upload $file";
}    

Before invoking the handler, the following operations are performed:

  1. The current working directory is set to the directory where the event occurred.
  2. If the environ statement is present in the watcher, the environment is modified according to its rules. (see environment modification)
  3. The standard input is closed.
  4. If the ‘stdout’ option is supplied, the standard output is captured and redirected to the syslog. Otherwise it is closed.
  5. If the ‘stderr’ option is supplied, the standard error is captured and redirected to the syslog. Otherwise it is closed.
  6. File descriptors above 2 are closed.
  7. Macro variables are expanded. See macro expansion.
  8. If the ‘shell’ option is set, the handler is invoked via the shell, as /bin/sh -c "command".

    Otherwise, word splitting is performed on the resulting command line. The first word is treated as the pathname of the program, which is then invoked via the execve system call.

GNU Direvent:   Section:   Chapter:FastBack: Quick start   Up: Top   FastForward: Configuration   Contents: Table of ContentsIndex: Concept Index

4 Invocation

The invocation syntax is:

direvent  [options] [config]

where options are command line options discussed below and optional config supplies the configuration file to use instead of the default /etc/direvent.conf.

The options are:

-d
--debug

Increase debug level.

-F name
--facility=name

Set syslog facility.

-f
--foreground

Remain in foreground.

-I dir
--include=dir

Add dir to the beginning of the include search path (see include search path).

-l prio

While connected to a terminal, direvent outputs its diagnostics messages to stderr and, if configured, to syslog. This option limits the amount of information output to the standard error. The prio argument is one of the following priorities (in order of increasing severity): ‘debug’, ‘info’, ‘notice’, ‘warning’, ‘err’, ‘crit’, ‘alert’, ‘emerg’. When this option is given, only messages with the priority level equal to or greater than prio will be duplicated on the standard error.

-P file
--pidfile=file

Upon successful startup store the PID of the daemon process in file.

-T command
--self-test=command

Run in self-test mode. In this mode, direvent starts external command supplied as the argument to this option and continues running until the command exits. If command terminates normally, direvent exits with the code returned by it. If command terminates on signal, direvent exits with code ‘0’ if this signal was SIGHUP, and with code ‘2’ otherwise.

The command can include any command line options or arguments, provided that it is properly quoted. It is invoked as /bin/sh -c command in the environment of the parent direvent process.

This mode is used in direvent test suite. The idea is to configure the handler (see handler) so that it sends SIGHUP to command before exiting. To this effect, the special macro variable $self_test_pid is defined (see macro expansion) to the PID of the running command process. For example, consider configuration file test.conf, which contains the following:

watcher {
    path /tmp;
    command "/bin/kill -HUP $self_test_pid";
}    

Then, the following command can be used to check whether direvent correctly reacts on file creation in the watched directory:

$ direvent --foreground \
    --self-test 'touch /tmp/file && /usr/bin/sleep 20 && exit 1' \
    test.conf

The command will return ‘0’ if the handler was invoked, and ‘1’ if it was not.

-t
--lint

Check configuration file for errors and exit.

-u name
--user=name

Run as this user. This option overrides the user configuration statement (see user).

The following options are informative. They cause the program to display the requested piece of information and terminate:

-H
--config-help

Show configuration file summary.

-h
--help

Give a short usage summary.

--usage

Display available command line options.

-V
--version

Print program version.

GNU Direvent:   Section:   Chapter:FastBack: Invocation   Up: Top   FastForward: System dependencies   Contents: Table of ContentsIndex: Concept Index

5 Configuration

GNU Direvent:   Section:   Chapter:FastBack: Configuration   Up: Configuration   FastForward: System dependencies   Contents: Table of ContentsIndex: Concept Index

5.1 Configuration Syntax

The configuration file consists of statements and comments.

There are three classes of lexical tokens: keywords, values, and separators. Blanks, tabs, newlines and comments, collectively called white space are ignored except as they serve to separate tokens. Some white space is required to separate otherwise adjacent keywords and values.

GNU Direvent:   Section:   Chapter:FastBack: Configuration   Up: syntax   FastForward: System dependencies   Contents: Table of ContentsIndex: Concept Index

5.1.1 Comments

Comments may appear anywhere where white space may appear in the configuration file. There are two kinds of comments: single-line and multi-line comments. Single-line comments start with ‘#’ or ‘//’ and continue to the end of the line:

# This is a comment
// This too is a comment

Multi-line or C-style comments start with the two characters ‘/*’ (slash, star) and continue until the first occurrence of ‘*/’ (star, slash).

Multi-line comments cannot be nested. However, single-line comments may well appear within multi-line ones.

GNU Direvent:   Section:   Chapter:FastBack: Configuration   Up: syntax   FastForward: System dependencies   Contents: Table of ContentsIndex: Concept Index

5.1.2 Pragmatic Comments

Pragmatic comments are similar to usual single-line comments, except that they cause some changes in the way the configuration is parsed. Pragmatic comments begin with a ‘#’ sign and end with the next physical newline character.

#include <file>
#include "file"

Include the contents of the file file. If file is an absolute file name, the named file is included. An error message will be issued if it does not exist.

If file contains wildcard characters (‘*’, ‘[’, ‘]’ or ‘?’), it is interpreted as a shell globbing pattern and all files matching that pattern are included, in lexicographical order. If no matching files are found, the directive is replaced with an empty line.

Otherwise, the form with angle brackets searches for file in the include search path, while the second one looks for it in the current working directory first, and, if not found there, in the include search path. If the file is not found, an error message will be issued.

Include search path is formed by two directory sets: the user-defined search path, as defined by eventual -I (see include option) command line options, and the standard include search path, defined at compile time. The latter can be inspected using the --help option.

The order of directories is as follows. First, direvent scans any directories given with -I options, in the same order as given on the command line. If file is not found in any of them, the standard include search path is scanned. It is defined at the compile time and by default consists of two directories:

  • prefix/share/direvent/5.1/include
  • prefix/share/direvent/include

where prefix is the installation prefix. The default can be changed when configuring the package. To inspect the actual standard include search path at the runtime, run direvent --help, and look for the string ‘Include search path:’ in its output.

#include_once <file>
#include_once file

Same as #include, except that, if the file has already been included, it will not be included again.

#line num
#line num "file"

This line causes the parser to believe, for purposes of error diagnostics, that the line number of the next source line is given by num and the current input file is named by file. If the latter is absent, the remembered file name does not change.

# num "file"

This is a special form of #line statement, understood for compatibility with the C preprocessor.

GNU Direvent:   Section:   Chapter:FastBack: Configuration   Up: syntax   FastForward: System dependencies   Contents: Table of ContentsIndex: Concept Index

5.1.3 Statements

A simple statement consists of a keyword and value separated by any amount of whitespace. Simple statement is terminated with a semicolon (‘;’).

The following is a simple statement:

standalone yes;
pidfile /var/run/direvent.pid;

A keyword begins with a letter and may contain letters, decimal digits, underscores (‘_’) and dashes (‘-’). Examples of keywords are: ‘expression’, ‘output-file’.

A value can be one of the following:

number

A number is a sequence of decimal digits.

boolean

A boolean value is one of the following: ‘yes’, ‘true’, ‘t’ or ‘1’, meaning true, and ‘no’, ‘false’, ‘nil’, ‘0’ meaning false.

unquoted string

An unquoted string may contain letters, digits, and any of the following characters: ‘_’, ‘-’, ‘.’, ‘/’, ‘@’, ‘*’, ‘:’.

quoted string

A quoted string is any sequence of characters enclosed in double-quotes (‘"’). A backslash appearing within a quoted string introduces an escape sequence, which is replaced with a single character according to the following rules:

SequenceReplaced with
\aAudible bell character (ASCII 7)
\bBackspace character (ASCII 8)
\fForm-feed character (ASCII 12)
\nNewline character (ASCII 10)
\rCarriage return character (ASCII 13)
\tHorizontal tabulation character (ASCII 9)
\vVertical tabulation character (ASCII 11)
\\A single backslash (‘\’)
\"A double-quote.

Table 5.1: Backslash escapes

In addition, the sequence ‘\newline’ is removed from the string. This allows to split long strings over several physical lines, e.g.:

"a long string may be\
 split over several lines"

If the character following a backslash is not one of those specified above, the backslash is ignored and a warning is issued.

Two or more adjacent quoted strings are concatenated, which gives another way to split long strings over several lines to improve readability. The following fragment produces the same result as the example above:

"a long string may be"
" split over several lines"
Here-document

A here-document is a special construct that allows to introduce strings of text containing embedded newlines.

The <<word construct instructs the parser to read all the following lines up to the line containing only word, with possible trailing blanks. Any lines thus read are concatenated together into a single string. For example:

<<EOT
A multiline
string
EOT

The body of a here-document is interpreted the same way as a double-quoted string, unless word is preceded by a backslash (e.g. ‘<<\EOT’) or enclosed in double-quotes, in which case the text is read as is, without interpretation of escape sequences.

If word is prefixed with - (a dash), then all leading tab characters are stripped from input lines and the line containing word. Furthermore, if - is followed by a single space, all leading whitespace is stripped from them. This allows to indent here-documents in a natural fashion. For example:

<<- TEXT
    The leading whitespace will be
    ignored when reading these lines.
TEXT

It is important that the terminating delimiter be the only token on its line. The only exception to this rule is allowed if a here-document appears as the last element of a statement. In this case a semicolon can be placed on the same line with its terminating delimiter, as in:

help-text <<-EOT
        A sample help text.
EOT;
list

A list is a comma-separated list of values. Lists are enclosed in parentheses. The following example shows a statement whose value is a list of strings:

option (stdout,stderr);

In any case where a list is appropriate, a single value is allowed without being a member of a list: it is equivalent to a list with a single member. This means that, e.g.

option wait;

is equivalent to

option (wait);

A block statement introduces a logical group of statements. It consists of a keyword, followed by an optional value, and a sequence of statements enclosed in curly braces, as shown in the example below:

syslog {
  facility local0;
  tag "direvent";
}

The closing curly brace may be followed by a semicolon, although this is not required.

GNU Direvent:   Section:   Chapter:FastBack: Configuration   Up: Configuration   FastForward: System dependencies   Contents: Table of ContentsIndex: Concept Index

5.2 Macro Expansion

Arguments of some statements undergo macro expansion before use. During the macro expansion any occurrence of ‘$name’ is replaced by the value of the macro variable name. Variable names follow the usual convention: they begin with a letter and contain letters, digits and underscores. Curly braces around the name are optional. They are required only if the macro reference is followed by a character that is not to be interpreted as part of its name, as in ‘${command}string’.

The following macros are defined:

file

Name of the file that triggered the event.

genev_code

Generic (system-independent) event code. It is a bitwise OR of the event codes represented as a decimal number.

genev_name

Generic event name. If several generic events are reported simultaneously, the value of this variable is a list of event names separated by space characters. Each name corresponds to a bit in ‘$genev_code’.

self_test_pid

The PID of the external command started with the --self-test option (see self-test mode). If direvent is started without this option, this variable is not defined.

sysev_code

A system-dependent event code. It is a bitwise OR of the event codes represented as a decimal number.

sysev_name

A system-dependent event name. If several events are reported, the value of this variable is a list of event names separated by space characters. Each name corresponds to a bit in ‘sysev_code’. See System dependencies, for a list of system-dependent event names.

GNU Direvent:   Section:   Chapter:FastBack: Configuration   Up: Configuration   FastForward: System dependencies   Contents: Table of ContentsIndex: Concept Index

5.3 General Settings

Config: user name

Sets the user to run as. The name argument must be a name of an existing user.

Config: foreground bool

Run in foreground.

Config: pidfile file

Upon successful startup store the PID of the daemon process in file.

Config: debug number

Set debug level. Valid number values are ‘0’ (no debug) to ‘3’ (maximum verbosity).

GNU Direvent:   Section:   Chapter:FastBack: Configuration   Up: Configuration   FastForward: System dependencies   Contents: Table of ContentsIndex: Concept Index

5.4 Syslog

While connected to the terminal, direvent outputs its diagnostics and debugging messages to the standard error. After disconnecting from the controlling terminal it closes the first three file descriptors and directs all its output to the syslog. When running in foreground mode, its messages are sent both to the standard error and to the syslog.

The following configuration statement controls the syslog output:

syslog {
    facility string;
    tag string;
    print-priority bool;
}

The statements are:

Config: facility string

Set syslog facility. The argument is one of the following: ‘user’, ‘daemon’, ‘auth’ or ‘authpriv’, ‘mail’, ‘cron’, ‘local0’ through ‘local7’ (case-insensitive), or a facility number.

Config: tag string

Tag syslog messages with ‘string’. Normally the messages are tagged with the program name.

Config: print-priority bool

Prefix each message with its priority.

An example syslog statement:

syslog {
    facility local0;
    print-priority yes;
}

GNU Direvent:   Section:   Chapter:FastBack: Configuration   Up: Configuration   FastForward: System dependencies   Contents: Table of ContentsIndex: Concept Index

5.5 Watcher

The ‘watcher’ statement configures a single event watcher. A watcher can control several events in multiple pathnames. Any number of watcher statements is allowed in the configuration file, each one of them declaring a separate watcher.

watcher {
    path pathname [recursive [level]];
    file regexp-list;
    event event-list;
    command command-line;
    user name;
    timeout number;
    environ env-spec;
    option string-list;
}

The statements within a watcher block are:

Config: path pathname [recursive [number]]

Defines a pathname to watch. The pathname argument must be the name of an existing directory in the file system. The watcher will watch events occurring for all files within that directory. If the optional recursive clause is specified, this directory will be watched recursively, i.e. when any subdirectory is created in it, direvent will set up a watcher for files in this subdirectory. This new watcher will be an exact copy of the parent watcher, excepting for the pathnames. The optional number parameter defines a cut-off nesting level for recursive watching. If supplied, the recursive behaviour will apply only to the directories that are nested below that level.

Any number of path statements can appear in a watcher block. At least one path must be defined.

Config: file regexp-list

Selects which files are eligible for monitoring. The argument is a list of globbing patterns (in the sense of see fnmatch in fnmatch(3)) or extended regular expressions (see Extended regular expressions in GNU sed) one of which must match the file name in order for the watcher to act on it. A ‘!’ in front of a pattern or regular expression indicates negation. Such construct matches if the file name doesn’t match the pattern. Regular expressions must be surrounded by a pair of slashes, optionally followed by the following flags:

b

Use basic regular expressions.

i

Enable case-insensitive matching.

For example:

file ("*.cfg", "/.*\\.jpg/i");

In this statement, the first string (‘*.cfg’) is treated as a shell globbing pattern. The second one is a case-sensitive extended regular expression.

Config: event string-list

Configures the filesystem events to watch for in the directories declared by the path statements. The argument is a list of event names. Both generic and system-dependent event namess are allowed. Multiple event statements accumulate.

A missing event statement means “watch all events”.

For example:

event (open,delete);
Config: command string

Defines a command to execute on event. The string is a command line just as you would type it in sh. It may contain macro variables (see macro expansion), which will be expanded prior to execution.

For example:

command "/bin/prog -event $genev_name -file $file";

By default, the command is executed directly via execve system call. If ‘shell’ option is set, the command is executed via /bin/sh.

See handler environment, for a detailed discussion of how the command is executed.

Config: user string

Run command as this user.

Config: timeout number

Terminate the command if it runs longer than number seconds. The default is 5 seconds.

Config: option string-list

A list of additional options. The following options are defined:

shell

Invoke the handler command as /bin/sh -c "command".

wait

Wait for the program to terminate before handling next event from the event queue. Normally the program runs asynchronously.

stdout

Capture the standard output of the command and redirect it to the syslog with the ‘LOG_INFO’ priority.

stderr

Capture the standard error of the command and redirect it to the syslog with the ‘LOG_ERR’ priority.

Config: environ env-spec

Modify command environment. By default the command inherits the environment of direvent augmented with the following variables:

DIREVENT_SYSEV_CODE

The system-dependent event code (see the $sysev_code variable).

DIREVENT_SYSEV_NAME

The system-dependent event name or names (see the $sysev_name variable).

DIREVENT_GENEV_CODE

The generic event code (see the $genev_code variable).

DIREVENT_GENEV_NAME

The generic event name or names (see the $genev_name variable).

DIREVENT_FILE

The name of the affected file relative to the current working directory (see the $file variable).

The environ statement allows for trimming the environment. Its argument is a list of environment modification directives. Before applying, each directive undergoes macro expansion (see macro expansion). The following directives are available:

-’ (a single dash)

Clear the inherited environment, but retain the variables added by direvent itself. The removed environment variables can be selectively restored using the directives discussed below.

If used, this must be the first directive in the list.

--’ (double-dash)

Clear the entire environment, including the variables added by direvent.

If used, this must be the first directive in the list.

-name

Unset the variable name.

-name=val

Unset the environment variable name only if its value is val.

name

Restore the environment variable name. This directive is useful after ‘-’ or ‘--’ to retain some variables from the environment.

name=value

Define environment variable name to have given value.

name+=value

Retain variable name and append value to its existing value. If no such variable is present in the environment, it is created and value is assigned to it. However, if value begins with a punctuation character, this character is removed from it before the assignment. This is convenient for using this construct with environment variables like PATH, e.g.:

PATH+=:/sbin

In this example, if PATH exists, ‘:/sbin’ will be appended to it. Otherwise, it will be created and ‘/sbin’ will be assigned to it.

name=+value

Retain variable name and prepend value to its existing value. If no such variable is present in the environment, it is created and value is assigned to it. However, if value ends with a punctuation character, this character is removed from it before assignment.

GNU Direvent:   Section:   Chapter:FastBack: Configuration   Up: Top   FastForward: Reporting Bugs   Contents: Table of ContentsIndex: Concept Index

6 System Dependencies

Direvent relies on the event monitoring API provided by the kernel.

GNU Direvent:   Section:   Chapter:FastBack: System dependencies   Up: System dependencies   FastForward: Reporting Bugs   Contents: Table of ContentsIndex: Concept Index

6.1 GNU/Linux systems.

On GNU/Linux the program uses inotify. See monitoring file system events in inotify(7) man page.

The maximum number of watches a user process can have is controlled by the ‘fs.inotify.max_user_watches’ system variable. Normally it is set to 8192, which is quite enough for most purposes. However, if you monitor a big number or directories and/or are using recursive watchers, you may need to increase this number. In that case, use sysctl (see configure kernel parameters at runtime in sysctl(8) man page) to raise the limit, e.g.:

sysctl -w fs.inotify.max_user_watches=16384

Most GNU/Linux distributions provide the file /etc/sysctl.conf which can be used to set this variable on startup.

The following system-dependent events are defined on systems that use inotify:

ACCESS

A file was accessed.

ATTRIB

A file’s metadata changed.

CLOSE_WRITE

A writable file was closed.

CLOSE_NOWRITE

An unwritable file closed.

CREATE

A file was created.

DELETE

A file was deleted.

MODIFY

A file was modified.

MOVED_FROM

A file was moved into a monitored directory.

MOVED_TO

A file was moved out from a monitored directory.

OPEN

A file was opened.

GNU Direvent:   Section:   Chapter:FastBack: System dependencies   Up: System dependencies   FastForward: Reporting Bugs   Contents: Table of ContentsIndex: Concept Index

6.2 BSD systems

When compiled on BSD systems (including Darwin), direvent uses kqueue (see kernel event notification mechanism in kqueue(2) man page).

This interface needs an open file handle for each file in a monitored directory, which means that the number of watchers is limited by the maximum number of open files. Use ‘ulimit -n NUM’ in order to raise it to a higher number.

Since it operates on files, kqueue does not provide direct support for the ‘create’ generic event. Direvent works over this disadvantage by keeping track of the contents of each monitored directory and rescanning it each time a ‘WRITE’ system event is reported for it. It then generates the ‘open’ event for each file that appeared after the last scan. Such a rescan can consume considerable time if a directory has a very large number of files in it.

The following system-dependent events are available:

DELETE

The unlink() system call was called on the monitored file.

WRITE

A write occurred on the file.

EXTEND

The file was extended.

ATTRIB

The file attributes have changed.

LINK

The link count on the file changed.

RENAME

The file was renamed.

REVOKE

Access to the file was revoked via revoke() (see revoke file access in revoke(2) man page) or the underlying file system was unmounted.

GNU Direvent:   Section:   Chapter:FastBack: System dependencies   Up: System dependencies   FastForward: Reporting Bugs   Contents: Table of ContentsIndex: Concept Index

6.3 Darwin (Mac OS X)

Essentially the same as BSD. The main difference compared to Linux and BSD is that on Darwin the watchers are set after disconnecting from the controlling terminal, because Darwin lacks the rfork call and the event queue cannot be inherited by the child process.

GNU Direvent:   Section:   Chapter:FastBack: System dependencies   Up: Top   FastForward: Copying This Manual   Contents: Table of ContentsIndex: Concept Index

7 How to Report a Bug

Please, report bugs and suggestions to bug-direvent@gnu.org.ua.

You hit a bug if at least one of the conditions below is met:

If you think you’ve found a bug, please be sure to include maximum information available to reliably reproduce it, or at least to analyze it. The information needed is:

Any errors, typos or omissions found in this manual also qualify as bugs. Please report them, if you happen to find any.

GNU Direvent:   Section:   Chapter:FastBack: Reporting Bugs   Up: Top   FastForward: Concept Index   Contents: Table of ContentsIndex: Concept Index

Appendix A GNU Free Documentation License

Version 1.2, November 2002
Copyright © 2000, 2001, 2002, 2014 Free Software Foundation,
Inc.
59 Temple Place, Suite 330, Boston, MA  02111-1307, USA

Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
  1. PREAMBLE

    The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

    This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

    We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

  2. APPLICABILITY AND DEFINITIONS

    This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

    A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

    A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

    The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

    The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

    A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.

    Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

    The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.

    A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.

    The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

  3. VERBATIM COPYING

    You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

    You may also lend copies, under the same conditions stated above, and you may publicly display copies.

  4. COPYING IN QUANTITY

    If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

    If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

    If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

    It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

  5. MODIFICATIONS

    You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

    1. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
    2. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
    3. State on the Title page the name of the publisher of the Modified Version, as the publisher.
    4. Preserve all the copyright notices of the Document.
    5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
    6. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
    7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document’s license notice.
    8. Include an unaltered copy of this License.
    9. Preserve the section Entitled “History”, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled “History” in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
    10. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the “History” section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
    11. For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
    12. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
    13. Delete any section Entitled “Endorsements”. Such a section may not be included in the Modified Version.
    14. Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with any Invariant Section.
    15. Preserve any Warranty Disclaimers.

    If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.

    You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

    You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

    The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

  6. COMBINING DOCUMENTS

    You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

    The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

    In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”

  7. COLLECTIONS OF DOCUMENTS

    You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

    You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

  8. AGGREGATION WITH INDEPENDENT WORKS

    A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

    If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

  9. TRANSLATION

    Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

    If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

  10. TERMINATION

    You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

  11. FUTURE REVISIONS OF THIS LICENSE

    The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

    Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.

A.1 ADDENDUM: How to use this License for your documents

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:

  Copyright (C)  year  your name.
  Permission is granted to copy, distribute and/or modify this document
  under the terms of the GNU Free Documentation License, Version 1.2
  or any later version published by the Free Software Foundation;
  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
  Texts.  A copy of the license is included in the section entitled ``GNU
  Free Documentation License''.

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with...Texts.” line with this:

    with the Invariant Sections being list their titles, with
    the Front-Cover Texts being list, and with the Back-Cover Texts
    being list.

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.

GNU Direvent:   Section:   Chapter:FastBack: Copying This Manual   Up: Top     Contents: Table of ContentsIndex: Concept Index

Concept Index

This is a general index of all issues discussed in this manual

Jump to:   #   -  
A   B   C   D   E   F   G   H   I   K   L   M   N   O   P   Q   R   S   T   U   W  
Index Entry  Section
#
#include: Pragmatic Comments
#include_once: Pragmatic Comments
#line: Pragmatic Comments
-
--config-help: Invocation
--debug: Invocation
--facility: Invocation
--foreground: Invocation
--help: Invocation
--include: Invocation
--lint: Invocation
--pidfile: Invocation
--self-test: Invocation
--usage: Invocation
--user: Invocation
--version: Invocation
-d: Invocation
-F: Invocation
-f: Invocation
-H: Invocation
-h: Invocation
-I: Invocation
-l: Invocation
-P: Invocation
-T: Invocation
-t: Invocation
-u: Invocation
-V: Invocation
A
ACCESS, linux event: linux
ATTRIB, BSD: bsd
attrib, generic event: Overview
ATTRIB, linux event: linux
B
block statement: Statements
boolean value: Statements
BSD: bsd
C
CLOSE_NOWRITE, linux event: linux
CLOSE_WRITE, linux event: linux
command: watcher
Comments in a configuration file: Comments
comments, pragmatic: Pragmatic Comments
configuration file statements: Statements
create, generic event: Overview
CREATE, linux event: linux
D
Darwin: darwin
debug: general settings
DELETE, BSD: bsd
delete, generic event: Overview
DELETE, linux event: linux
DIREVENT_FILE, environment variable: watcher
DIREVENT_GENEV_CODE, environment variable: watcher
DIREVENT_GENEV_NAME, environment variable: watcher
DIREVENT_SYSEV_CODE, environment variable: watcher
DIREVENT_SYSEV_NAME, environment variable: watcher
E
environ: watcher
environment modification: watcher
environment, handler: watcher
escape sequence: Statements
event: watcher
events: Overview
events, generic: Overview
events, system-dependent, on BSD: bsd
events, system-dependent, on Darwin: bsd
events, system-dependent, on linux: linux
EXTEND, BSD: bsd
F
facility: syslog
facility, syslog: syslog
FDL, GNU Free Documentation License: Copying This Manual
file: watcher
file system events: Overview
file, macro variable: macro expansion
foreground: general settings
fs.inotify.max_user_watches: linux
G
generic events: Overview
genev_code, macro variable: macro expansion
genev_name, macro variable: macro expansion
GNU/Linux: linux
H
Handler environment variables: watcher
handler execution environment: Quick start
handler, defining: watcher
handler, introduced: Overview
here-document: Statements
I
include directories, preprocessor: Pragmatic Comments
include search path, preprocessor: Pragmatic Comments
inotify: linux
K
kqueue: bsd
L
LINK, BSD: bsd
linux kernel: linux
list: Statements
logging: syslog
M
Mac OS X: darwin
macro expansion: macro expansion
MODIFY, linux event: linux
MOVED_FROM, linux event: linux
MOVED_TO, linux event: linux
multi-line comments: Comments
N
number of open file descriptors: bsd
number of watches, linux: linux
O
OPEN, linux event: linux
option: watcher
P
path: watcher
pidfile: general settings
pragmatic comments: Pragmatic Comments
preprocessor include search path: Pragmatic Comments
print-priority: syslog
Q
quoted string: Statements
R
RENAME, BSD: bsd
S
self-test mode: Invocation
self_test_pid: macro expansion
shell, watcher option: watcher
simple statements: Statements
single-line comments: Comments
statement, block: Statements
statement, simple: Statements
statements, configuration file: Statements
stdout, watcher option: watcher
strerr, watcher option: watcher
string, quoted: Statements
string, unquoted: Statements
sysctl: linux
sysctl.conf: linux
sysev_code, macro variable: macro expansion
sysev_name, macro variable: macro expansion
syslog: syslog
syslog facility: syslog
syslog tag: syslog
system-dependent events on BSD: bsd
system-dependent events on Darwin: bsd
system-dependent events, linux: linux
T
tag: syslog
tag, syslog: syslog
timeout: watcher
U
user: general settings
user: watcher
W
wait, watcher option: watcher
watcher declaration: watcher
watcher declaration, summary: Overview
watcher, complete description: watcher
watcher, introduced: Overview
WRITE, BSD: bsd
write, generic event: Overview
Jump to:   #   -  
A   B   C   D   E   F   G   H   I   K   L   M   N   O   P   Q   R   S   T   U   W