Subversion Repositories public

Rev

Rev 108 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
102 luk 1
.TH "incrontab" "1" "0.5.9" "Lukas Jelinek" "incron documentation"
57 luk 2
.SH "NAME"
3
incrontab \- table manipulator for inotify cron (incron)
4
.SH "SYNOPSIS"
69 luk 5
\fBincrontab\fR [\fB\-u\fR \fIuser\fR] [\fB\-f\fR \fIconfig\fR] \fIfile\fR
57 luk 6
 
69 luk 7
\fBincrontab\fR [\fB\-u\fR \fIuser\fR] [\fB\-f\fR \fIconfig\fR] [\fB\-l\fR | \fB\-r\fR | \fB\-e\fR | \fB\-t\fR | \fB\-d\fR]
57 luk 8
.SH "DESCRIPTION"
9
incrontab is a table manipulator for the inotify cron (incron) system. It creates, removes, modifies and lists user tables (\fIincrontab\fR(5)).
10
 
11
Each user (including system users even they haven't home directories) has an incron table which can't be manipulated directly (only root can effectively change these tables and is NOT recommended to do so).
12
 
13
All informational messages of this program are printed to the standard error output (stderr).
14
 
75 luk 15
If \fI/etc/incron.allow\fR exists only users listed here may use incron. Otherwise if \fI/etc/incron.deny\fR exists only users NOT listed here may use incron. If none of these files exists everyone is allowed to use incron. (\fBImportant note:\fR This behavior is insecure and will be probably changed to be compatible with the style used by ISC Cron.) Location of these files can be changed in the configuration.
57 luk 16
 
17
The first form of this command imports a file, validates it and stores to the table. "\-" can be used for loading from the standard input.
18
 
19
 
20
 
21
\fB\-u\fR (or \fB\-\-user\fR) option overrides the current (real) user to the given one. This option is intended for manipulation with system users' tables (such as apache, postfix, daemon etc.). It can be used only if the current user has root's effective rights.
22
 
23
\fB\-l\fR (or \fB\-\-list\fR) option causes the current table is printed to the standard output.
24
 
25
\fB\-r\fR (or \fB\-\-remove\fR) option causes the current table (if any) is permanently remove without any warning or confirmation. Use with caution!
26
 
108 luk 27
\fB\-e\fR (or \fB\-\-edit\fR) option causes executing an editor for editing the user table (see below for the information about editor selection). You can edit your incron table now. If the table is changed it stores the modified version.
67 luk 28
 
29
\fB\-t\fR (or \fB\-\-types\fR) option causes the list of supported event types (delimited by commas) is printed to the standard output. This feature is intended for front\-end applications to find out which event types was compiled in.
69 luk 30
 
75 luk 31
\fB\-d\fR (or \fB\-\-reload\fR) option causes reloading the current table by \fIincrond\fR(8). It is done through "touching" the table (writing into it without modifying it). This feature is intended e.g. for creating watches on newly created files (with already existing rules) or for rearming IN_ONESHOT watches.
32
 
69 luk 33
\fB\-f <FILE>\fR (or \fB\-\-config=<FILE>\fR) option specifies another location for the configuration file (/etc/incron.conf is used by default). This feature requires root privileges.
34
 
108 luk 35
There is a few complex algorithm how to determine which editor will be user for editing. If any of the following rule succeeds the appropriate editor is used:
69 luk 36
 
37
1. EDITOR environment variable
38
 
39
2. VISUAL environment variable
40
 
41
3. configuration value
42
 
43
4. etc/alternatives/editor
44
 
45
5. hard\-wired editor (\fIvim\fR by default)
46
 
47
It's not recommended to use graphical editors (such as gVim, KEdit etc.) due to possible problems with connecting to the X server.
57 luk 48
.SH "SEE ALSO"
75 luk 49
incrond(8), incrontab(5), incron.conf(5)
57 luk 50
.SH "AUTHOR"
102 luk 51
Lukas Jelinek <lukas@aiken.cz> (please report bugs to http://bts.aiken.cz or <bugs@aiken.cz>).
57 luk 52
.SH "COPYING"
53
This program is free software. It can be used, redistributed and/or modified under the terms of the GNU General Public License, version 2.