← Back to branch summary

~ubuntu-branches/ubuntu/trusty/pyinotify/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/public/inotify-module.html

  • Committer: Bazaar Package Importer
  • Author(s): Hans Ulrich Niedermann
  • Date: 2006-04-02 02:35:31 UTC
  • Revision ID: james.westby@ubuntu.com-20060402023531-3fj27jbd4x9s4752
Tags: upstream-0.5.2
Import upstream version 0.5.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/public/inotify-module.html
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>inotify</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
 
8
</head>
 
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
10
      alink="#204080">
 
11
 
 
12
<!-- =========== START OF NAVBAR =========== -->
 
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
14
  <tr valign="center">
 
15
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar" align="right" width="100%">
 
19
      <table border="0" cellpadding="0" cellspacing="0">
 
20
      <tr><th class="navbar" align="center">
 
21
        <p class="nomargin">
 
22
          pyinotify
 
23
      </p></th></tr></table>
 
24
    </th>
 
25
  </tr>
 
26
</table>
 
27
<table width="100%" cellpadding="0" cellspacing="0">
 
28
  <tr valign="top">
 
29
    <td width="100%">
 
30
      <font size="-1"><b class="breadcrumbs">
 
31
        Module&nbsp;inotify
 
32
      </b></font></br>
 
33
    </td>
 
34
    <td><table cellpadding="0" cellspacing="0">
 
35
      <tr><td align="right"><font size="-2">[<a href="../private/inotify-module.html">show&nbsp;private</a>&nbsp;|&nbsp;hide&nbsp;private]</font></td></tr>
 
36
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="inotify-module.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
37
    </table></td>
 
38
</tr></table>
 
39
 
 
40
<!-- =========== START OF MODULE DESCRIPTION =========== -->
 
41
<h2 class="module">Module inotify</h2>
 
42
 
 
43
<p>Raw wrap of inotify.</p>
 
44
This module wrap:
 
45
<ol start="1">
 
46
  <li>
 
47
    3 system calls: inotify_init, inotify_add_watch, 
 
48
    inotify_rm_watch.
 
49
  </li>
 
50
  <li>
 
51
    3 variables (accessible via proc fs): max_queued_events, 
 
52
    max_user_instances, max_user_watches.
 
53
  </li>
 
54
</ol>
 
55
How-to manipulate the variables:
 
56
<ol start="1">
 
57
  <li>
 
58
    Get the int value: tmp_int = max_queued_events.value
 
59
  </li>
 
60
  <li>
 
61
    Update the value: max_queued_events.value = 42
 
62
  </li>
 
63
</ol>
 
64
<hr/>
 
65
<p><b>Author:</b> Sebastien Martini
 
66
</p>
 
67
 
 
68
<p><b>Contact:</b> sebastien.martini&#64;gmail.com
 
69
</p>
 
70
 
 
71
<p><b>License:</b> GPL 2
 
72
</p>
 
73
 
 
74
 
 
75
<!-- =========== START OF VARIABLE SUMMARY =========== -->
 
76
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
77
<tr bgcolor="#70b0f0" class="summary">
 
78
  <th colspan="2">Variable Summary</th></tr>
 
79
<tr><td align="right" valign="top" width="15%"><font size="-1">MaxQueuedEvents</font></td>
 
80
<td><b><a href="inotify-module.html#max_queued_events"><code>max_queued_events</code></a></b>: access it through its 'value' member.</td></tr>
 
81
<tr><td align="right" valign="top" width="15%"><font size="-1">MaxUserInstances</font></td>
 
82
<td><b><a href="inotify-module.html#max_user_instances"><code>max_user_instances</code></a></b>: access it through its 'value' member.</td></tr>
 
83
<tr><td align="right" valign="top" width="15%"><font size="-1">MaxUserWatches</font></td>
 
84
<td><b><a href="inotify-module.html#max_user_watches"><code>max_user_watches</code></a></b>: access it through its 'value' member.</td></tr>
 
85
</table><br />
 
86
 
 
87
 
 
88
<!-- =========== START OF VARIABLE DETAILS =========== -->
 
89
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
90
<tr bgcolor="#70b0f0" class="details">
 
91
  <th colspan="2">Variable Details</th></tr>
 
92
</table>
 
93
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
94
<a name="max_queued_events"></a>
 
95
<h3>max_queued_events</h3>
 
96
access it through its 'value' member.
 
97
<dl>
 
98
  <dt></dt>
 
99
  <dd>
 
100
    <dl>
 
101
      <dt><b>Type:</b></dt>
 
102
      <dd>
 
103
          MaxQueuedEvents
 
104
 
 
105
      </dd>
 
106
<span title="16384">      <dt><b>Value:</b></dt>
 
107
      <dd><table><tr><td>
 
108
<pre class="variable">
 
109
16384                                                                  </pre>
 
110
        </td></tr></table></dd>
 
111
</span>    </dl>
 
112
  </dd>
 
113
</dl></td></tr></table>
 
114
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
115
<a name="max_user_instances"></a>
 
116
<h3>max_user_instances</h3>
 
117
access it through its 'value' member.
 
118
<dl>
 
119
  <dt></dt>
 
120
  <dd>
 
121
    <dl>
 
122
      <dt><b>Type:</b></dt>
 
123
      <dd>
 
124
          MaxUserInstances
 
125
 
 
126
      </dd>
 
127
<span title="128">      <dt><b>Value:</b></dt>
 
128
      <dd><table><tr><td>
 
129
<pre class="variable">
 
130
128                                                                    </pre>
 
131
        </td></tr></table></dd>
 
132
</span>    </dl>
 
133
  </dd>
 
134
</dl></td></tr></table>
 
135
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
136
<a name="max_user_watches"></a>
 
137
<h3>max_user_watches</h3>
 
138
access it through its 'value' member.
 
139
<dl>
 
140
  <dt></dt>
 
141
  <dd>
 
142
    <dl>
 
143
      <dt><b>Type:</b></dt>
 
144
      <dd>
 
145
          MaxUserWatches
 
146
 
 
147
      </dd>
 
148
<span title="8192">      <dt><b>Value:</b></dt>
 
149
      <dd><table><tr><td>
 
150
<pre class="variable">
 
151
8192                                                                   </pre>
 
152
        </td></tr></table></dd>
 
153
</span>    </dl>
 
154
  </dd>
 
155
</dl></td></tr></table>
 
156
<br />
 
157
 
 
158
 
 
159
<!-- =========== START OF NAVBAR =========== -->
 
160
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
161
  <tr valign="center">
 
162
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
163
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
164
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
165
    <th class="navbar" align="right" width="100%">
 
166
      <table border="0" cellpadding="0" cellspacing="0">
 
167
      <tr><th class="navbar" align="center">
 
168
        <p class="nomargin">
 
169
          pyinotify
 
170
      </p></th></tr></table>
 
171
    </th>
 
172
  </tr>
 
173
</table>
 
174
 
 
175
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
176
  <tr>
 
177
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Wed Mar 29 03:46:07 2006</font></td>
 
178
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
179
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
180
  </tr>
 
181
</table>
 
182
</body>
 
183
</html>