php-doc-en/reference/inotify/constants.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="inotify.constants" xmlns="http://docbook.org/ns/docbook">
  &reftitle.constants;
  &extension.constants;
  <variablelist xml:id="inotify.constants.events">
   <title>Inotify constants usable with <function>inotify_add_watch</function> and/or returned by <function>inotify_read</function></title>
   <varlistentry xml:id="constant.in-access">
    <term>
     <constant>IN_ACCESS</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      File was accessed (read) (*)
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-modify">
    <term>
     <constant>IN_MODIFY</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      File was modified (*)
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-attrib">
    <term>
     <constant>IN_ATTRIB</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Metadata changed (e.g. permissions, mtime, etc.) (*)
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-close-write">
    <term>
     <constant>IN_CLOSE_WRITE</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      File opened for writing was closed (*)
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-close-nowrite">
    <term>
     <constant>IN_CLOSE_NOWRITE</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      File not opened for writing was closed (*)
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-open">
    <term>
     <constant>IN_OPEN</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      File was opened (*)
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-moved-to">
    <term>
     <constant>IN_MOVED_TO</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      File moved into watched directory (*)
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-moved-from">
    <term>
     <constant>IN_MOVED_FROM</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      File moved out of watched directory (*)
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-create">
    <term>
     <constant>IN_CREATE</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      File or directory created in watched directory (*)
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-delete">
    <term>
     <constant>IN_DELETE</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      File or directory deleted in watched directory (*)
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-delete-self">
    <term>
     <constant>IN_DELETE_SELF</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Watched file or directory was deleted
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-move-self">
    <term>
     <constant>IN_MOVE_SELF</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Watch file or directory was moved
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-close">
    <term>
     <constant>IN_CLOSE</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Equals to IN_CLOSE_WRITE | IN_CLOSE_NOWRITE
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-move">
    <term>
     <constant>IN_MOVE</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Equals to IN_MOVED_FROM | IN_MOVED_TO
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-all-events">
    <term>
     <constant>IN_ALL_EVENTS</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Bitmask of all the above constants
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-unmount">
    <term>
     <constant>IN_UNMOUNT</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      File system containing watched object was unmounted
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-q-overflow">
    <term>
     <constant>IN_Q_OVERFLOW</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Event queue overflowed (wd is -1 for this event)
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-ignored">
    <term>
     <constant>IN_IGNORED</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Watch was removed (explicitly by <function>inotify_rm_watch</function>
      or because file was removed or filesystem unmounted
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-isdir">
    <term>
     <constant>IN_ISDIR</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Subject of this event is a directory
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-onlydir">
    <term>
     <constant>IN_ONLYDIR</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Only watch pathname if it is a directory (Since Linux 2.6.15)
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-dont-follow">
    <term>
     <constant>IN_DONT_FOLLOW</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Do not dereference pathname if it is a symlink (Since Linux 2.6.15)
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-mask-add">
    <term>
     <constant>IN_MASK_ADD</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Add events to watch mask for this pathname if it already exists
      (instead of replacing mask).
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.in-oneshot">
    <term>
     <constant>IN_ONESHOT</constant>
      (<type>int</type>)
    </term>
    <listitem>
     <simpara>
      Monitor pathname for one event, then remove from watch list.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
  <note>
   <simpara>
    The events marked with an asterisk (*) above can occur for files in watched
    directories.
   </simpara>
  </note>
</appendix>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->