Hex Artifact Content

Artifact 8d482010cf5f2fe6b4e29837fec468c3df250977:

Wiki page [Manual page] by schelte 2018-08-19 20:22:39.
0000: 44 20 32 30 31 38 2d 30 38 2d 31 39 54 32 30 3a  D 2018-08-19T20:
0010: 32 32 3a 33 39 2e 37 38 31 0a 4c 20 4d 61 6e 75  22:39.781.L Manu
0020: 61 6c 5c 73 70 61 67 65 0a 50 20 37 30 34 63 63  al\spage.P 704cc
0030: 37 39 35 65 30 33 63 30 61 36 37 33 31 64 34 63  795e03c0a6731d4c
0040: 63 32 66 36 39 30 39 39 37 31 37 34 32 63 36 35  c2f6909971742c65
0050: 39 39 30 0a 55 20 73 63 68 65 6c 74 65 0a 57 20  990.U schelte.W 
0060: 34 35 37 35 0a 3c 68 31 3e 54 63 6c 20 66 73 77  4575.<h1>Tcl fsw
0070: 61 74 63 68 20 65 78 74 65 6e 73 69 6f 6e 3c 2f  atch extension</
0080: 68 31 3e 0d 0a 0d 0a 3c 70 3e 66 73 77 61 74 63  h1>....<p>fswatc
0090: 68 20 2d 20 54 63 6c 20 6c 69 62 72 61 72 79 20  h - Tcl library 
00a0: 66 6f 72 20 66 69 6c 65 73 79 73 74 65 6d 20 6e  for filesystem n
00b0: 6f 74 69 66 69 63 61 74 69 6f 6e 73 0d 0a 0d 0a  otifications....
00c0: 3c 68 72 3e 0d 0a 0d 0a 3c 68 32 3e 53 79 6e 6f  <hr>....<h2>Syno
00d0: 70 73 69 73 3c 2f 68 32 3e 0d 0a 0d 0a 3c 70 3e  psis</h2>....<p>
00e0: 0d 0a 70 61 63 6b 61 67 65 20 72 65 71 75 69 72  ..package requir
00f0: 65 20 3c 62 3e 54 63 6c 20 38 2e 35 3c 2f 62 3e  e <b>Tcl 8.5</b>
0100: 3c 62 72 3e 0d 0a 70 61 63 6b 61 67 65 20 72 65  <br>..package re
0110: 71 75 69 72 65 20 3c 62 3e 66 73 77 61 74 63 68  quire <b>fswatch
0120: 20 32 2e 30 3c 2f 62 3e 3c 62 72 3e 0d 0a 3c 70   2.0</b><br>..<p
0130: 3e 0d 0a 5b 23 31 7c 3c 62 3e 66 73 77 61 74 63  >..[#1|<b>fswatc
0140: 68 3c 2f 62 3e 20 3c 62 3e 63 72 65 61 74 65 3c  h</b> <b>create<
0150: 2f 62 3e 20 3c 69 3e 63 61 6c 6c 62 61 63 6b 3c  /b> <i>callback<
0160: 2f 69 3e 5d 3c 62 72 3e 0d 0a 5b 23 32 7c 3c 62  /i>]<br>..[#2|<b
0170: 3e 66 73 77 61 74 63 68 3c 2f 62 3e 20 3c 62 3e  >fswatch</b> <b>
0180: 61 64 64 3c 2f 62 3e 20 3c 69 3e 63 68 61 6e 6e  add</b> <i>chann
0190: 65 6c 49 64 3c 2f 69 3e 20 3f 3c 62 3e 2d 72 65  elId</i> ?<b>-re
01a0: 70 6c 61 63 65 3c 2f 62 3e 3f 20 3c 69 3e 70 61  place</b>? <i>pa
01b0: 74 68 3c 2f 69 3e 20 3c 69 3e 66 6c 61 67 73 3c  th</i> <i>flags<
01c0: 2f 69 3e 5d 3c 62 72 3e 0d 0a 5b 23 33 7c 3c 62  /i>]<br>..[#3|<b
01d0: 3e 66 73 77 61 74 63 68 3c 2f 62 3e 20 3c 62 3e  >fswatch</b> <b>
01e0: 72 65 6d 6f 76 65 3c 2f 62 3e 20 3c 69 3e 63 68  remove</b> <i>ch
01f0: 61 6e 6e 65 6c 49 64 3c 2f 69 3e 20 3f 3c 69 3e  annelId</i> ?<i>
0200: 77 61 74 63 68 49 64 3c 2f 69 3e 20 3c 69 3e 2e  watchId</i> <i>.
0210: 2e 2e 3c 2f 69 3e 3f 5d 3c 62 72 3e 0d 0a 5b 23  ..</i>?]<br>..[#
0220: 34 7c 3c 62 3e 66 73 77 61 74 63 68 3c 2f 62 3e  4|<b>fswatch</b>
0230: 20 3c 62 3e 63 6c 6f 73 65 3c 2f 62 3e 20 3c 69   <b>close</b> <i
0240: 3e 63 68 61 6e 6e 65 6c 49 64 3c 2f 69 3e 5d 3c  >channelId</i>]<
0250: 62 72 3e 0d 0a 5b 23 35 7c 3c 62 3e 66 73 77 61  br>..[#5|<b>fswa
0260: 74 63 68 3c 2f 62 3e 20 3c 62 3e 69 6e 66 6f 3c  tch</b> <b>info<
0270: 2f 62 3e 20 3c 69 3e 63 68 61 6e 6e 65 6c 49 64  /b> <i>channelId
0280: 3c 2f 69 3e 20 3f 3c 69 3e 77 61 74 63 68 49 64  </i> ?<i>watchId
0290: 3c 2f 69 3e 20 2e 2e 2e 3f 5d 3c 62 72 3e 0d 0a  </i> ...?]<br>..
02a0: 0d 0a 3c 68 72 3e 0d 0a 0d 0a 3c 68 32 3e 44 65  ..<hr>....<h2>De
02b0: 73 63 72 69 70 74 69 6f 6e 3c 2f 68 32 3e 0d 0a  scription</h2>..
02c0: 0d 0a 54 68 65 20 3c 62 3e 66 73 77 61 74 63 68  ..The <b>fswatch
02d0: 3c 2f 62 3e 20 70 61 63 6b 61 67 65 20 70 72 6f  </b> package pro
02e0: 76 69 64 65 73 20 61 20 63 6f 6d 6d 61 6e 64 20  vides a command 
02f0: 74 6f 20 73 65 74 20 75 70 0d 0a 6e 6f 74 69 66  to set up..notif
0300: 69 63 61 74 69 6f 6e 73 20 61 62 6f 75 74 20 66  ications about f
0310: 69 6c 65 73 79 73 74 65 6d 20 65 76 65 6e 74 73  ilesystem events
0320: 2e 0d 0a 3c 64 6c 3e 0d 0a 3c 64 74 3e 3c 61 20  ...<dl>..<dt><a 
0330: 6e 61 6d 65 3d 22 31 22 3e 3c 2f 61 3e 3c 62 3e  name="1"></a><b>
0340: 66 73 77 61 74 63 68 3c 2f 62 3e 20 3c 62 3e 63  fswatch</b> <b>c
0350: 72 65 61 74 65 3c 2f 62 3e 20 3c 69 3e 63 61 6c  reate</b> <i>cal
0360: 6c 62 61 63 6b 3c 2f 69 3e 0d 0a 3c 64 64 3e 43  lback</i>..<dd>C
0370: 72 65 61 74 65 20 61 6e 20 66 73 77 61 74 63 68  reate an fswatch
0380: 20 63 68 61 6e 6e 65 6c 49 64 2e 20 54 68 65 20   channelId. The 
0390: 63 6f 6d 6d 61 6e 64 20 72 65 74 75 72 6e 73 20  command returns 
03a0: 61 20 63 68 61 6e 6e 65 6c 49 64 20 74 6f 20 62  a channelId to b
03b0: 65 20 75 73 65 64 20 69 6e 0d 0a 6f 74 68 65 72  e used in..other
03c0: 20 66 73 77 61 74 63 68 20 73 75 62 63 6f 6d 6d   fswatch subcomm
03d0: 61 6e 64 73 2e 0d 0a 57 68 65 6e 20 61 6e 79 20  ands...When any 
03e0: 77 61 74 63 68 20 77 69 74 68 69 6e 20 74 68 65  watch within the
03f0: 20 63 68 61 6e 6e 65 6c 49 64 20 66 69 72 65 73   channelId fires
0400: 2c 20 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 77  , the callback w
0410: 69 6c 6c 20 62 65 20 63 61 6c 6c 65 64 20 77 69  ill be called wi
0420: 74 68 0d 0a 6f 6e 65 20 61 64 64 69 74 69 6f 6e  th..one addition
0430: 61 6c 20 61 72 67 75 6d 65 6e 74 3a 20 41 20 64  al argument: A d
0440: 69 63 74 20 64 65 73 63 72 69 62 69 6e 67 20 74  ict describing t
0450: 68 65 20 65 76 65 6e 74 20 74 68 61 74 20 63 61  he event that ca
0460: 75 73 65 64 20 74 68 65 20 77 61 74 63 68 20 74  used the watch t
0470: 6f 0d 0a 66 69 72 65 2e 0d 0a 54 68 65 20 64 69  o..fire...The di
0480: 63 74 20 63 6f 6e 74 61 69 6e 73 20 74 68 65 20  ct contains the 
0490: 66 6f 6c 6c 6f 77 69 6e 67 20 69 74 65 6d 73 3a  following items:
04a0: 0d 0a 3c 64 6c 3e 0d 0a 3c 64 74 3e 3c 65 6d 3e  ..<dl>..<dt><em>
04b0: 63 68 61 6e 3c 2f 65 6d 3e 0d 0a 3c 64 64 3e 54  chan</em>..<dd>T
04c0: 68 65 20 63 68 61 6e 6e 65 6c 49 64 2e 0d 0a 3c  he channelId...<
04d0: 64 74 3e 3c 65 6d 3e 77 61 74 63 68 3c 2f 65 6d  dt><em>watch</em
04e0: 3e 0d 0a 3c 64 64 3e 54 68 65 20 77 61 74 63 68  >..<dd>The watch
04f0: 49 64 2e 0d 0a 3c 64 74 3e 3c 65 6d 3e 70 61 74  Id...<dt><em>pat
0500: 68 3c 2f 65 6d 3e 0d 0a 3c 64 64 3e 54 68 65 20  h</em>..<dd>The 
0510: 70 61 74 68 20 61 73 73 6f 63 69 61 74 65 64 20  path associated 
0520: 77 69 74 68 20 74 68 65 20 77 61 74 63 68 49 64  with the watchId
0530: 2e 0d 0a 3c 64 74 3e 3c 65 6d 3e 65 76 65 6e 74  ...<dt><em>event
0540: 3c 2f 65 6d 3e 0d 0a 3c 64 64 3e 54 68 65 20 74  </em>..<dd>The t
0550: 79 70 65 20 6f 66 20 65 76 65 6e 74 2e 20 53 65  ype of event. Se
0560: 65 20 3c 62 3e 65 76 65 6e 74 73 3c 2f 62 3e 20  e <b>events</b> 
0570: 62 65 6c 6f 77 2e 0d 0a 3c 64 74 3e 3c 65 6d 3e  below...<dt><em>
0580: 69 73 64 69 72 3c 2f 65 6d 3e 0d 0a 3c 64 64 3e  isdir</em>..<dd>
0590: 41 20 62 6f 6f 6c 65 61 6e 20 69 6e 64 69 63 61  A boolean indica
05a0: 74 69 6e 67 20 69 66 20 74 68 65 20 65 76 65 6e  ting if the even
05b0: 74 20 69 73 20 72 65 6c 61 74 65 64 20 74 6f 20  t is related to 
05c0: 61 20 64 69 72 65 63 6f 72 79 2e 0d 0a 3c 64 74  a direcory...<dt
05d0: 3e 3c 65 6d 3e 63 6f 6f 6b 69 65 3c 2f 65 6d 3e  ><em>cookie</em>
05e0: 0d 0a 3c 64 64 3e 41 6e 20 69 6e 74 65 67 65 72  ..<dd>An integer
05f0: 20 74 6f 20 74 69 65 20 72 65 6c 61 74 65 64 20   to tie related 
0600: 65 76 65 6e 74 73 20 74 6f 67 65 74 68 65 72 20  events together 
0610: 28 6f 6e 6c 79 20 66 6f 72 0d 0a 6d 6f 76 65 64  (only for..moved
0620: 66 72 6f 6d 20 61 6e 64 20 6d 6f 76 65 64 74 6f  from and movedto
0630: 20 65 76 65 6e 74 73 29 2e 0d 0a 3c 64 74 3e 3c   events)...<dt><
0640: 65 6d 3e 6e 61 6d 65 3c 2f 65 6d 3e 0d 0a 3c 64  em>name</em>..<d
0650: 64 3e 54 68 65 20 6e 61 6d 65 20 6f 66 20 74 68  d>The name of th
0660: 65 20 61 66 66 65 63 74 65 64 20 66 69 6c 65 20  e affected file 
0670: 6f 72 20 64 69 72 65 63 74 6f 72 79 20 28 69 66  or directory (if
0680: 20 61 70 70 6c 69 63 61 62 6c 65 29 2e 0d 0a 3c   applicable)...<
0690: 2f 64 6c 3e 0d 0a 3c 64 74 3e 3c 61 20 6e 61 6d  /dl>..<dt><a nam
06a0: 65 3d 22 32 22 3e 3c 2f 61 3e 3c 62 3e 66 73 77  e="2"></a><b>fsw
06b0: 61 74 63 68 3c 2f 62 3e 20 3c 62 3e 61 64 64 3c  atch</b> <b>add<
06c0: 2f 62 3e 20 3c 69 3e 63 68 61 6e 6e 65 6c 49 64  /b> <i>channelId
06d0: 3c 2f 69 3e 20 3f 3c 62 3e 2d 72 65 70 6c 61 63  </i> ?<b>-replac
06e0: 65 3c 2f 62 3e 3f 20 3c 69 3e 70 61 74 68 3c 2f  e</b>? <i>path</
06f0: 69 3e 20 3c 69 3e 66 6c 61 67 73 3c 2f 69 3e 0d  i> <i>flags</i>.
0700: 0a 3c 64 64 3e 41 64 64 20 61 20 74 61 72 67 65  .<dd>Add a targe
0710: 74 20 70 61 74 68 20 74 6f 20 61 6e 20 66 73 77  t path to an fsw
0720: 61 74 63 68 20 63 68 61 6e 6e 65 6c 49 64 2e 20  atch channelId. 
0730: 54 68 65 20 63 6f 6d 6d 61 6e 64 20 72 65 74 75  The command retu
0740: 72 6e 73 20 61 20 77 61 74 63 68 49 64 2e 20 54  rns a watchId. T
0750: 68 65 0d 0a 3c 69 3e 66 6c 61 67 73 3c 2f 69 3e  he..<i>flags</i>
0760: 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61 20 6c   argument is a l
0770: 69 73 74 20 73 70 65 63 69 66 79 69 6e 67 20 77  ist specifying w
0780: 68 69 63 68 20 65 76 65 6e 74 73 20 73 68 6f 75  hich events shou
0790: 6c 64 20 62 65 20 72 65 70 6f 72 74 65 64 2e 20  ld be reported. 
07a0: 53 65 65 0d 0a 3c 62 3e 65 76 65 6e 74 73 3c 2f  See..<b>events</
07b0: 62 3e 20 62 65 6c 6f 77 2e 0d 0a 49 66 20 74 68  b> below...If th
07c0: 65 20 70 61 74 68 20 77 61 73 20 61 6c 72 65 61  e path was alrea
07d0: 64 79 20 62 65 69 6e 67 20 77 61 74 63 68 65 64  dy being watched
07e0: 2c 20 74 68 65 20 73 70 65 63 69 66 69 65 64 20  , the specified 
07f0: 65 76 65 6e 74 73 20 61 72 65 20 61 64 64 65 64  events are added
0800: 20 74 6f 20 74 68 65 0d 0a 65 78 69 73 74 69 6e   to the..existin
0810: 67 20 6c 69 73 74 2c 20 75 6e 6c 65 73 73 20 74  g list, unless t
0820: 68 65 20 3c 62 3e 2d 72 65 70 6c 61 63 65 3c 2f  he <b>-replace</
0830: 62 3e 20 6f 70 74 69 6f 6e 20 69 73 20 70 72 65  b> option is pre
0840: 73 65 6e 74 2e 0d 0a 3c 64 74 3e 3c 61 20 6e 61  sent...<dt><a na
0850: 6d 65 3d 22 33 22 3e 3c 2f 61 3e 3c 62 3e 66 73  me="3"></a><b>fs
0860: 77 61 74 63 68 3c 2f 62 3e 20 3c 62 3e 72 65 6d  watch</b> <b>rem
0870: 6f 76 65 3c 2f 62 3e 20 3c 69 3e 63 68 61 6e 6e  ove</b> <i>chann
0880: 65 6c 49 64 3c 2f 69 3e 20 3f 3c 69 3e 77 61 74  elId</i> ?<i>wat
0890: 63 68 49 64 3c 2f 69 3e 20 3c 69 3e 2e 2e 2e 3c  chId</i> <i>...<
08a0: 2f 69 3e 3f 0d 0a 3c 64 64 3e 52 65 6d 6f 76 65  /i>?..<dd>Remove
08b0: 20 74 61 72 67 65 74 20 70 61 74 68 73 20 66 72   target paths fr
08c0: 6f 6d 20 61 6e 20 66 73 77 61 74 63 68 20 63 68  om an fswatch ch
08d0: 61 6e 6e 65 6c 49 64 2e 0d 0a 3c 64 74 3e 3c 61  annelId...<dt><a
08e0: 20 6e 61 6d 65 3d 22 34 22 3e 3c 2f 61 3e 3c 62   name="4"></a><b
08f0: 3e 66 73 77 61 74 63 68 3c 2f 62 3e 20 3c 62 3e  >fswatch</b> <b>
0900: 63 6c 6f 73 65 3c 2f 62 3e 20 3c 69 3e 63 68 61  close</b> <i>cha
0910: 6e 6e 65 6c 49 64 3c 2f 69 3e 0d 0a 3c 64 64 3e  nnelId</i>..<dd>
0920: 43 6c 6f 73 65 73 20 61 6e 20 66 73 77 61 74 63  Closes an fswatc
0930: 68 20 63 68 61 6e 6e 65 6c 49 64 2e 0d 0a 3c 64  h channelId...<d
0940: 74 3e 3c 61 20 6e 61 6d 65 3d 22 35 22 3e 3c 2f  t><a name="5"></
0950: 61 3e 3c 62 3e 66 73 77 61 74 63 68 3c 2f 62 3e  a><b>fswatch</b>
0960: 20 3c 62 3e 69 6e 66 6f 3c 2f 62 3e 20 3c 69 3e   <b>info</b> <i>
0970: 63 68 61 6e 6e 65 6c 49 64 3c 2f 69 3e 20 3f 3c  channelId</i> ?<
0980: 69 3e 77 61 74 63 68 49 64 3c 2f 69 3e 20 2e 2e  i>watchId</i> ..
0990: 2e 3f 0d 0a 3c 64 64 3e 52 65 74 75 72 6e 20 69  .?..<dd>Return i
09a0: 6e 66 6f 72 6d 61 74 69 6f 6e 20 61 62 6f 75 74  nformation about
09b0: 20 61 63 74 69 76 65 20 77 61 74 63 68 49 64 73   active watchIds
09c0: 20 61 73 20 61 20 64 69 63 74 2e 20 54 68 65 20   as a dict. The 
09d0: 64 69 63 74 27 73 20 6b 65 79 73 20 61 72 65 0d  dict's keys are.
09e0: 0a 74 68 65 20 72 65 71 75 65 73 74 65 64 20 77  .the requested w
09f0: 61 74 63 68 49 64 20 28 6f 72 20 61 6c 6c 20 77  atchId (or all w
0a00: 61 74 63 68 49 64 73 20 69 66 20 74 68 65 20 6f  atchIds if the o
0a10: 70 74 69 6f 6e 61 6c 20 61 72 67 75 6d 65 6e 74  ptional argument
0a20: 73 20 77 65 72 65 20 6f 6d 69 74 74 65 64 29 0d  s were omitted).
0a30: 0a 61 6e 64 20 74 68 65 20 76 61 6c 75 65 73 20  .and the values 
0a40: 61 20 6c 69 73 74 20 6f 66 20 70 61 74 68 20 61  a list of path a
0a50: 6e 64 20 65 76 65 6e 74 20 74 79 70 65 73 20 65  nd event types e
0a60: 61 63 68 2e 0d 0a 3c 2f 64 6c 3e 0d 0a 0d 0a 3c  ach...</dl>....<
0a70: 68 32 3e 45 76 65 6e 74 73 3c 2f 68 32 3e 0d 0a  h2>Events</h2>..
0a80: 0d 0a 54 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20  ..The following 
0a90: 65 76 65 6e 74 20 74 79 70 65 73 20 6d 61 79 20  event types may 
0aa0: 62 65 20 73 70 65 63 69 66 69 65 64 20 69 6e 20  be specified in 
0ab0: 74 68 65 20 3c 62 3e 61 64 64 3c 2f 62 3e 20 63  the <b>add</b> c
0ac0: 6f 6d 6d 61 6e 64 2c 20 61 6e 64 20 6d 61 79 0d  ommand, and may.
0ad0: 0a 61 6c 73 6f 20 62 65 20 72 65 70 6f 72 74 65  .also be reporte
0ae0: 64 20 74 6f 20 74 68 65 20 3c 69 3e 63 61 6c 6c  d to the <i>call
0af0: 62 61 63 6b 3c 2f 69 3e 2e 0d 0a 3c 64 6c 3e 0d  back</i>...<dl>.
0b00: 0a 3c 64 74 3e 3c 65 6d 3e 61 63 63 65 73 73 3c  .<dt><em>access<
0b10: 2f 65 6d 3e 0d 0a 3c 64 64 3e 46 69 6c 65 20 69  /em>..<dd>File i
0b20: 73 20 61 63 63 65 73 73 65 64 2e 0d 0a 3c 64 74  s accessed...<dt
0b30: 3e 3c 65 6d 3e 6d 6f 64 69 66 79 3c 2f 65 6d 3e  ><em>modify</em>
0b40: 0d 0a 3c 64 64 3e 46 69 6c 65 20 69 73 20 6d 6f  ..<dd>File is mo
0b50: 64 69 66 69 65 64 2e 0d 0a 3c 64 74 3e 3c 65 6d  dified...<dt><em
0b60: 3e 61 74 74 72 69 62 3c 2f 65 6d 3e 0d 0a 3c 64  >attrib</em>..<d
0b70: 64 3e 4d 65 74 61 64 61 74 61 20 63 68 61 6e 67  d>Metadata chang
0b80: 65 73 2e 0d 0a 3c 64 74 3e 3c 65 6d 3e 63 6c 6f  es...<dt><em>clo
0b90: 73 65 77 72 69 74 65 3c 2f 65 6d 3e 0d 0a 3c 64  sewrite</em>..<d
0ba0: 64 3e 46 69 6c 65 20 6f 70 65 6e 65 64 20 66 6f  d>File opened fo
0bb0: 72 20 77 72 69 74 69 6e 67 20 69 73 20 63 6c 6f  r writing is clo
0bc0: 73 65 64 2e 0d 0a 3c 64 74 3e 3c 65 6d 3e 63 6c  sed...<dt><em>cl
0bd0: 6f 73 65 6e 6f 77 72 69 74 65 3c 2f 65 6d 3e 0d  osenowrite</em>.
0be0: 0a 3c 64 64 3e 46 69 6c 65 20 6f 72 20 64 69 72  .<dd>File or dir
0bf0: 65 63 74 6f 72 79 20 6e 6f 74 20 6f 70 65 6e 65  ectory not opene
0c00: 64 20 66 6f 72 20 77 72 69 74 69 6e 67 20 69 73  d for writing is
0c10: 20 63 6c 6f 73 65 64 2e 0d 0a 3c 64 74 3e 3c 65   closed...<dt><e
0c20: 6d 3e 6f 70 65 6e 3c 2f 65 6d 3e 0d 0a 3c 64 64  m>open</em>..<dd
0c30: 3e 46 69 6c 65 20 6f 72 20 64 69 72 65 63 74 6f  >File or directo
0c40: 72 79 20 69 73 20 6f 70 65 6e 65 64 2e 0d 0a 3c  ry is opened...<
0c50: 64 74 3e 3c 65 6d 3e 6d 6f 76 65 64 66 72 6f 6d  dt><em>movedfrom
0c60: 3c 2f 65 6d 3e 0d 0a 3c 64 64 3e 47 65 6e 65 72  </em>..<dd>Gener
0c70: 61 74 65 64 20 66 6f 72 20 74 68 65 20 64 69 72  ated for the dir
0c80: 65 63 74 6f 72 79 20 63 6f 6e 74 61 69 6e 69 6e  ectory containin
0c90: 67 20 74 68 65 20 6f 6c 64 20 66 69 6c 65 6e 61  g the old filena
0ca0: 6d 65 0d 0a 77 68 65 6e 20 61 20 66 69 6c 65 20  me..when a file 
0cb0: 69 73 20 72 65 6e 61 6d 65 64 2e 0d 0a 3c 64 74  is renamed...<dt
0cc0: 3e 3c 65 6d 3e 6d 6f 76 65 64 74 6f 3c 2f 65 6d  ><em>movedto</em
0cd0: 3e 0d 0a 3c 64 64 3e 47 65 6e 65 72 61 74 65 64  >..<dd>Generated
0ce0: 20 66 6f 72 20 74 68 65 20 64 69 72 65 63 74 6f   for the directo
0cf0: 72 79 20 63 6f 6e 74 61 69 6e 69 6e 67 20 74 68  ry containing th
0d00: 65 20 6e 65 77 20 66 69 6c 65 6e 61 6d 65 0d 0a  e new filename..
0d10: 77 68 65 6e 20 61 20 66 69 6c 65 20 69 73 20 72  when a file is r
0d20: 65 6e 61 6d 65 64 2e 0d 0a 3c 64 74 3e 3c 65 6d  enamed...<dt><em
0d30: 3e 63 72 65 61 74 65 3c 2f 65 6d 3e 0d 0a 3c 64  >create</em>..<d
0d40: 64 3e 46 69 6c 65 2f 64 69 72 65 63 74 6f 72 79  d>File/directory
0d50: 20 63 72 65 61 74 65 64 20 69 6e 20 77 61 74 63   created in watc
0d60: 68 65 64 20 64 69 72 65 63 74 6f 72 79 2e 0d 0a  hed directory...
0d70: 3c 64 74 3e 3c 65 6d 3e 64 65 6c 65 74 65 3c 2f  <dt><em>delete</
0d80: 65 6d 3e 0d 0a 3c 64 64 3e 46 69 6c 65 2f 64 69  em>..<dd>File/di
0d90: 72 65 63 74 6f 72 79 20 64 65 6c 65 74 65 64 20  rectory deleted 
0da0: 66 72 6f 6d 20 77 61 74 63 68 65 64 20 64 69 72  from watched dir
0db0: 65 63 74 6f 72 79 2e 0d 0a 3c 64 74 3e 3c 65 6d  ectory...<dt><em
0dc0: 3e 64 65 6c 65 74 65 73 65 6c 66 3c 2f 65 6d 3e  >deleteself</em>
0dd0: 0d 0a 3c 64 64 3e 57 61 74 63 68 65 64 20 66 69  ..<dd>Watched fi
0de0: 6c 65 2f 64 69 72 65 63 74 6f 72 79 20 69 73 20  le/directory is 
0df0: 69 74 73 65 6c 66 20 64 65 6c 65 74 65 64 2e 0d  itself deleted..
0e00: 0a 3c 64 74 3e 3c 65 6d 3e 6d 6f 76 65 73 65 6c  .<dt><em>movesel
0e10: 66 3c 2f 65 6d 3e 0d 0a 3c 64 64 3e 57 61 74 63  f</em>..<dd>Watc
0e20: 68 65 64 20 66 69 6c 65 2f 64 69 72 65 63 74 6f  hed file/directo
0e30: 72 79 20 69 73 20 69 74 73 65 6c 66 20 6d 6f 76  ry is itself mov
0e40: 65 64 2e 0d 0a 3c 2f 64 6c 3e 0d 0a 41 20 66 65  ed...</dl>..A fe
0e50: 77 20 73 68 6f 72 74 68 61 6e 64 20 6e 61 6d 65  w shorthand name
0e60: 73 20 61 72 65 20 61 76 61 69 6c 61 62 6c 65 20  s are available 
0e70: 66 6f 72 20 73 6f 6d 65 20 63 6f 6d 62 69 6e 61  for some combina
0e80: 74 69 6f 6e 73 20 6f 66 20 65 76 65 6e 74 73 2e  tions of events.
0e90: 20 54 68 65 73 65 0d 0a 77 69 6c 6c 20 6e 65 76   These..will nev
0ea0: 65 72 20 61 70 70 65 61 72 20 69 6e 20 74 68 65  er appear in the
0eb0: 20 64 69 63 74 20 70 72 6f 76 69 64 65 64 20 74   dict provided t
0ec0: 6f 20 74 68 65 20 3c 69 3e 63 61 6c 6c 62 61 63  o the <i>callbac
0ed0: 6b 3c 2f 69 3e 2e 0d 0a 3c 64 6c 3e 0d 0a 3c 64  k</i>...<dl>..<d
0ee0: 74 3e 3c 65 6d 3e 63 6c 6f 73 65 3c 2f 65 6d 3e  t><em>close</em>
0ef0: 0d 0a 3c 64 64 3e 53 68 6f 72 74 68 61 6e 64 20  ..<dd>Shorthand 
0f00: 66 6f 72 20 7b 63 6c 6f 73 65 77 72 69 74 65 20  for {closewrite 
0f10: 63 6c 6f 73 65 6e 6f 77 72 69 74 65 7d 2e 0d 0a  closenowrite}...
0f20: 3c 64 74 3e 3c 65 6d 3e 6d 6f 76 65 3c 2f 65 6d  <dt><em>move</em
0f30: 3e 0d 0a 3c 64 64 3e 53 68 6f 72 74 68 61 6e 64  >..<dd>Shorthand
0f40: 20 66 6f 72 20 7b 6d 6f 76 65 64 66 72 6f 6d 20   for {movedfrom 
0f50: 6d 6f 76 65 64 74 6f 7d 2e 0d 0a 3c 64 74 3e 3c  movedto}...<dt><
0f60: 65 6d 3e 61 6c 6c 65 76 65 6e 74 73 3c 2f 65 6d  em>allevents</em
0f70: 3e 0d 0a 3c 64 64 3e 53 68 6f 72 74 68 61 6e 64  >..<dd>Shorthand
0f80: 20 66 6f 72 20 6d 6f 6e 69 74 6f 72 69 6e 67 20   for monitoring 
0f90: 61 6c 6c 20 77 61 74 63 68 61 62 6c 65 20 65 76  all watchable ev
0fa0: 65 6e 74 73 2e 0d 0a 3c 2f 64 6c 3e 0d 0a 53 6f  ents...</dl>..So
0fb0: 6d 65 20 61 64 64 69 74 69 6f 6e 61 6c 20 6e 61  me additional na
0fc0: 6d 65 73 20 6d 61 79 20 62 65 20 69 6e 63 6c 75  mes may be inclu
0fd0: 64 65 64 20 69 6e 20 74 68 65 20 3c 69 3e 66 6c  ded in the <i>fl
0fe0: 61 67 73 3c 2f 69 3e 20 61 72 67 75 6d 65 6e 74  ags</i> argument
0ff0: 20 74 6f 20 63 6f 6e 74 72 6f 6c 0d 0a 68 6f 77   to control..how
1000: 20 74 68 65 20 6f 74 68 65 72 20 65 76 65 6e 74   the other event
1010: 73 20 73 68 6f 75 6c 64 20 62 65 20 68 61 6e 64  s should be hand
1020: 6c 65 64 2e 0d 0a 3c 64 6c 3e 0d 0a 3c 64 74 3e  led...<dl>..<dt>
1030: 3c 65 6d 3e 6f 6e 65 73 68 6f 74 3c 2f 65 6d 3e  <em>oneshot</em>
1040: 0d 0a 3c 64 64 3e 4d 6f 6e 69 74 6f 72 20 74 68  ..<dd>Monitor th
1050: 65 20 66 69 6c 65 73 79 73 74 65 6d 20 6f 62 6a  e filesystem obj
1060: 65 63 74 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e  ect correspondin
1070: 67 20 74 6f 20 70 61 74 68 6e 61 6d 65 0d 0a 66  g to pathname..f
1080: 6f 72 20 6f 6e 65 20 65 76 65 6e 74 2c 20 74 68  or one event, th
1090: 65 6e 20 72 65 6d 6f 76 65 20 66 72 6f 6d 20 77  en remove from w
10a0: 61 74 63 68 20 6c 69 73 74 2e 0d 0a 3c 64 74 3e  atch list...<dt>
10b0: 3c 65 6d 3e 65 78 63 6c 75 6e 6c 69 6e 6b 3c 2f  <em>exclunlink</
10c0: 65 6d 3e 0d 0a 3c 64 64 3e 44 6f 6e 27 74 20 67  em>..<dd>Don't g
10d0: 65 6e 65 72 61 74 65 20 65 76 65 6e 74 73 20 66  enerate events f
10e0: 6f 72 20 63 68 69 6c 64 72 65 6e 20 61 66 74 65  or children afte
10f0: 72 20 74 68 65 79 20 68 61 76 65 20 62 65 65 6e  r they have been
1100: 0d 0a 75 6e 6c 69 6e 6b 65 64 20 66 72 6f 6d 20  ..unlinked from 
1110: 74 68 65 20 77 61 74 63 68 65 64 20 64 69 72 65  the watched dire
1120: 63 74 6f 72 79 2e 0d 0a 3c 2f 64 6c 3e 0d 0a 46  ctory...</dl>..F
1130: 69 6e 61 6c 6c 79 2c 20 74 68 65 20 64 69 63 74  inally, the dict
1140: 20 70 72 6f 76 69 64 65 64 20 74 6f 20 74 68 65   provided to the
1150: 20 3c 69 3e 63 61 6c 6c 62 61 63 6b 3c 2f 69 3e   <i>callback</i>
1160: 20 63 61 6e 20 72 65 70 6f 72 74 20 61 20 6e 75   can report a nu
1170: 6d 62 65 72 20 6f 66 0d 0a 73 70 65 63 69 61 6c  mber of..special
1180: 20 65 76 65 6e 74 73 2e 0d 0a 3c 64 6c 3e 0d 0a   events...<dl>..
1190: 3c 64 74 3e 3c 65 6d 3e 75 6e 6d 6f 75 6e 74 3c  <dt><em>unmount<
11a0: 2f 65 6d 3e 0d 0a 3c 64 64 3e 46 69 6c 65 73 79  /em>..<dd>Filesy
11b0: 73 74 65 6d 20 63 6f 6e 74 61 69 6e 69 6e 67 20  stem containing 
11c0: 77 61 74 63 68 65 64 20 6f 62 6a 65 63 74 20 69  watched object i
11d0: 73 20 75 6e 6d 6f 75 6e 74 65 64 2e 0d 0a 3c 64  s unmounted...<d
11e0: 74 3e 3c 65 6d 3e 71 6f 76 65 72 66 6c 6f 77 3c  t><em>qoverflow<
11f0: 2f 65 6d 3e 0d 0a 3c 64 64 3e 45 76 65 6e 74 20  /em>..<dd>Event 
1200: 71 75 65 75 65 20 6f 76 65 72 66 6c 6f 77 65 64  queue overflowed
1210: 0d 0a 3c 64 74 3e 3c 65 6d 3e 69 67 6e 6f 72 65  ..<dt><em>ignore
1220: 64 3c 2f 65 6d 3e 0d 0a 3c 64 64 3e 57 61 74 63  d</em>..<dd>Watc
1230: 68 20 69 73 20 72 65 6d 6f 76 65 64 2e 0d 0a 3c  h is removed...<
1240: 2f 64 6c 3e 0a 5a 20 31 35 32 61 33 62 62 30 65  /dl>.Z 152a3bb0e
1250: 30 31 66 36 62 65 61 61 38 37 36 65 33 32 34 36  01f6beaa876e3246
1260: 66 61 61 32 39 66 62 0a                          faa29fb.