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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>File: README</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="fileHeader">
<h1>README</h1>
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Path:</strong></td>
<td>README
(<a href="http://cvs.pablotron.org/cgi-bin/viewcvs.cgi/fam-ruby/README">CVS</a>)
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
<td>Tue Dec 05 01:28:29 -0500 2006</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
FAM-Ruby 0.2.0 README
</p>
<h6>===============</h6>
<p>
This document was last updated on Tue Dec 05 00:45:30 2006. Please see the
file COPYING for licensing and warranty information. The latest version of
this library is available at the following URL: <a
href="http://www.pablotron.org/software/fam-ruby">www.pablotron.org/software/fam-ruby</a>/.
</p>
<p>
Introduction
</p>
<h6>======</h6>
<p>
FAM-Ruby is a Ruby interface to SGI’s File Alteration Monitor (<a
href="http://oss.sgi.com/projects/fam">oss.sgi.com/projects/fam</a>/). FAM
allows you to monitor files and directories for changes (file modification,
creation, and removal) — in an event-driven manner. FAM is available
on a variety of platforms, including Irix, Linux, and BSD variants (a patch
for systems that use dnotify is also available). As of version 0.2.0,
FAM-Ruby can also be used with Gamin (<a
href="http://www.gnome.org/~veillard/gamin">www.gnome.org/~veillard/gamin</a>/),
a GNOME library that is compatible with a subset of FAM. An RDoc-generated
API reference is available in doc/, and a brief description of each event
code is available in event_codes.txt.
</p>
<p>
System Requirements
</p>
<h6>=============</h6>
<ul>
<li>FAM, version 2.6.6.1 (or newer): <a
href="http://oss.sgi.com/projects/fam">oss.sgi.com/projects/fam</a>/
</li>
<li>Ruby, version 1.6.7 (or newer): <a
href="http://www.ruby-lang.org">www.ruby-lang.org</a>/
</li>
</ul>
<p>
If you don’t have FAM installed, you can use Gamin instead. Note that
the FAM-Ruby API changes slightly under Gamin; see "Using FAM-Ruby
With Gamin" below for additional information.
</p>
<p>
Installation
</p>
<h6>======</h6>
<p>
ruby ./extconf.rb # generate Makefile make && su -c "make
install" # compile and install library
</p>
<p>
Using FAM-Ruby With Gamin
</p>
<h6>===================</h6>
<p>
Gamin supports a subset of the FAM API, and it adds an additional method.
The API differences under Gamin are as follows:
</p>
<pre>
* Fam::Connection#debug_level= is not defined.
* Fam::Connection#suspend_monitor exists, but doesn't work
* Fam::Connection#resume_monitor exists, but doesn't work
* Fam::Connection#monitor_collection exists, but doesn't work
* Fam::Connection##no_exists is defined (as of Gamin 0.0.23).
</pre>
<p>
Comparing error values between FAM and Gamin will probably fail, since
Gamin defines the same error values (as FamErrlist), but as different
values.
</p>
<p>
A detailed list of differences between FAM and Gamin is available on the
Gamin page at <a
href="http://www.gnome.org/~veillard/gamin/differences.html">www.gnome.org/~veillard/gamin/differences.html</a>.
</p>
<p>
About the Author
</p>
<h6>==========</h6>
<p>
Paul Duncan <pabs@pablotron.org> <a
href="http://www.pablotron.org">www.pablotron.org</a>/
</p>
<p>
See the file AUTHORS for additional contributions.
</p>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
|
