File: iwatch.1

package info (click to toggle)
iwatch 0.2.2-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 148 kB
  • sloc: perl: 472; sh: 100; makefile: 41; xml: 28
file content (91 lines) | stat: -rw-r--r-- 3,073 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
.TH IWATCH 1
.SH NAME
iwatch \- a realtime filesystem monitor / monitor any changes in directories/files specified
.SH SYNOPSIS
.B iwatch
.RI [ options ]
.SH DESCRIPTION
This manual page documents briefly the
.B iwatch
command.  iWatch is a realtime filesystem monitoring program. It's a simple perl
script to monitor changes in specific directories/files and send email
notification immediately. It reads the dir/file list from xml config file
and needs inotify support in kernel (Linux Kernel >= 2.6.13).
.SH OPTIONS
Usage for daemon mode of iWatch:
.TP
.B "iwatch [-d] [-f <config file>] [-v] [-p <pid file>]"
.TP
In the daemon mode iWatch has the following options:
.TP
.B \-d
Execute the application as daemon. iWatch will run in foregroud 
without this option.
.TP
.B \-f <configfile.xml>
Specify alternative configuration file. Default is /etc/iwatch/iwatch.xml.
.TP
.B \-p <pidfile>
Specify an alternate pid file (default: /var/run/iwatch.pid)
.TP
.B \-v
Be verbose.
.TP
Usage for command line mode of iWatch:
.TP
.B "iwatch [-c command] [-e event[,event[,..]]] [-h|--help] [-m <email address>] [-r] [-s <on|off>] [-t <filter string>] [-v] [--version] [-x exception] [-X <regex string as exception>] <target>"
.TP
In the command line mode iWatch has the following options:
.TP
.B \-c <command>
You can specify a command to be executed if an event occurs. For details
about the string format take a look at /usr/share/doc/iwatch/README.gz.
.TP
.B \-C <charset>
Specify the charset (default is utf-8).
.TP
.B \-e <event[,event[,..]]>
Events list. For details about possible events take a look at /usr/share/doc/iwatch/README.gz.
.TP
.B \-h, \-\-help
Print help message.
.TP
.B \-m <emailaddress>
Contact point's email address. Without this option, iwatch will not send 
any email notification (obviously).
.TP
.B \-r
Recursivity of the watched directory.
.TP
.B \-s on|off
Enable or disable reports to the syslog (default is off/disabled).
.TP
.B \-t <filter>
Filter string (regex) to compare with the filename or directory name.
.TP
.B \-x <exception file or directory>
Specify the file or directory which should not be watched.
.TP
.B \-X <regex string as exception>
Specify a regex string as exception.
.SH USAGE EXAMPLES
.TP
.B % iwatch /tmp
Monitor changes in /tmp directory with default events.
.TP
.B % iwatch \-r \-e access,create \-m root@localhost \-x /etc/mail /etc
Monitor only access and create events in /etc directory recursively
with /etc/mail as exception and send email notification to cahya@localhost.
.TP
.B % iwatch \-r \-c "(w;ps -ef)|mail -s '%f was changed' root@localhost" /bin
Monitor /bin directory recursively and execute the command.
.TP
.B % iwatch \-r \-X '\.svn' ~/projects
Monitor ~/projects directory recursively, but exclude any .svn directories
inside. This can't be done with a normal '\-x' option since '\-x' can
only exclude the defined path.
.SH AUTHOR
iwatch was written by Cahya Wirawan <cahya@gmx.at>. 
.PP
This manual page was written by Michael Prokop <mika@debian.org>
for the Debian project (but may be used by others).