WebSVN - public - Blame - Rev 45 - /incron/trunk/README

Rev	Author	Line No.	Line
45	luk	1
		2
		3
		4
		5
		6	2. Requirements
		7	3. How to use
		8	4. Bugs, suggestions
		9	5. Licensing
		10	6. Documentation
		11
		12
		13
		14
		15
		16
		17	This program is the "inotify cron" system. It consist of a daemon and
		18	a table manipulator. You can use it a similar way as the regular cron.
		19	The difference is that the inotify cron handles filesystem events
		20	rather than time periods.
		21
		22
		23	* Linux kernel 2.6.13 or later (with inotify compiled in)
		24	* inotify headers (inotify.h, inotify-syscalls.h) installed in
		25	<INCLUDE_DIR>/sys. The most common place is /usr/include/sys.
		26	* GCC 4.x compiler (probably works also with GCC 3.4, possibly with
		27	older versions too)
		28
		29
		30
		31	Because this version is very early it does not contain a standard
		32	portable build mechanism. There is only a Makefile which must be
		33	modified manually. On many Linux systems you need not to change
		34	anything.
		35
		36
		37	check the PREFIX and other common variables. If done you can
		38	now build the files ('make').
		39
		40
		41	installer creates a special user called 'incron' which manages
		42	the incron tables.
		43
		44
		45
		46	The incron daemon (incrond) must be run under root (typically from
		47	runlevel script etc.). It loads the current user tables and hooks
		48	them for later changes.
		49
		50
		51	since it SUIDs. For manipulation with the tables use basically
		52	the same syntax as for the crontab program. You can import a table,
		53	remove and edit the current table.
		54
		55
		56	<path> <mask> <command>
		57
		58
		59
		60
		61	<mask> is a symbolic (see inotify.h; use commas for separating
		62	symbols) or numeric mask for events
		63	<command> is an application or script to run on the events
		64
		65
		66
		67
		68	$@ - the watched filesystem path (see above)
		69	$# - the event-related file name
		70
		71
		72	an argument every time a file is changed in /var/mail. One of
		73	the solutions follows:
		74
		75
		76
		77
		78
		79	THIS PROGRAM IS AN ALPHA VERSION. IT PROBABLY CONTAINS BUGS AND
		80	THEREFORE IT IS NOT INTENDED FOR PRODUCTION USE.
		81
		82
		83	please use the bug tracking system at http://bts.aiken.cz.
		84
		85
		86
		87	This program is free software; you can redistribute it and/or
		88	modify it under the terms of the GNU General Public License,
		89	version 2 (see LICENSE-GPL).
		90
		91
		92	Please look into the source files for detailed information.
		93

Subversion Repositories public

(root)/incron/trunk/README - Rev 45