original/man2/inotify_add_watch.2

   1 .\" man2/inotify_add_watch.2 - inotify_add_watch man page
   2 .\"
   3 .\" Copyright (C) 2005 Robert Love
   4 .\" and Copyright, 2006 Michael Kerrisk
   5 .\"
   6 .\" This is free documentation; you can redistribute it and/or
   7 .\" modify it under the terms of the GNU General Public License as
   8 .\" published by the Free Software Foundation; either version 2 of
   9 .\" the License, or (at your option) any later version.
  10 .\"
  11 .\" The GNU General Public License's references to "object code"
  12 .\" and "executables" are to be interpreted as the output of any
  13 .\" document formatting or typesetting system, including
  14 .\" intermediate and printed output.
  15 .\"
  16 .\" This manual is distributed in the hope that it will be useful,
  17 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 .\" GNU General Public License for more details.
  20 .\"
  21 .\" You should have received a copy of the GNU General Public
  22 .\" License along with this manual; if not, write to the Free
  23 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  24 .\" USA.
  25 .\"
  26 .\" 2005-07-19 Robert Love <rlove@rlove.org> - initial version
  27 .\" 2006-02-07 mtk, various changes
  28 .\"
  29 .TH INOTIFY_ADD_WATCH 2 2006-02-07 "Linux" "Linux Programmer's Manual"
  30 .SH NAME
  31 inotify_add_watch \- add a watch to an initialized inotify instance
  32 .SH SYNOPSIS
  33 .B #include <sys/inotify.h>
  34 .sp
  35 .BI "int inotify_add_watch(int " fd ", const char *" pathname ", uint32_t " mask );
  36 .SH DESCRIPTION
  37 .BR inotify_add_watch ()
  38 adds a new watch, or modifies an existing watch,
  39 for the file whose location is specified in
  40 .IR pathname ;
  41 the caller must have read permission for this file.
  42 The
  43 .I fd
  44 argument is a file descriptor referring to the
  45 inotify instance whose watch list is to be modified.
  46 The events to be monitored for
  47 .I pathname
  48 are specified in the
  49 .I mask
  50 bit-mask argument.
  51 See
  52 .BR inotify (7)
  53 for a description of the bits that can be set in
  54 .IR mask .
  55
  56 A successful call to
  57 .BR inotify_add_watch ()
  58 returns the unique watch descriptor associated with
  59 .I pathname
  60 for this inotify instance.
  61 If
  62 .I pathname
  63 was not previously being watched by this inotify instance,
  64 then the watch descriptor is newly allocated.
  65 If
  66 .I pathname
  67 was already being watched, then the descriptor
  68 for the existing watch is returned.
  69
  70 The watch descriptor is returned by later
  71 .BR read (2)s
  72 from the inotify file descriptor.
  73 These reads fetch
  74 .I inotify_event
  75 structures (see
  76 .BR inotify (7))
  77 indicating file system events;
  78 the watch descriptor inside this structure identifies
  79 the object for which the event occurred.
  80 .SH "RETURN VALUE"
  81 On success,
  82 .BR inotify_add_watch ()
  83 returns a nonnegative watch descriptor.
  84 On error \-1 is returned and
  85 .I errno
  86 is set appropriately.
  87 .SH ERRORS
  88 .TP
  89 .B EACCES
  90 Read access to the given file is not permitted.
  91 .TP
  92 .B EBADF
  93 The given file descriptor is not valid.
  94 .TP
  95 .B EFAULT
  96 .I pathname
  97 points outside of the process's accessible address space.
  98 .TP
  99 .B EINVAL
 100 The given event mask contains no valid events; or
 101 .I fd
 102 is not an inotify file descriptor.
 103 .TP
 104 .B ENOMEM
 105 Insufficient kernel memory was available.
 106 .TP
 107 .B ENOSPC
 108 The user limit on the total number of inotify watches was reached or the
 109 kernel failed to allocate a needed resource.
 110 .SH VERSIONS
 111 Inotify was merged into the 2.6.13 Linux kernel.
 112 .SH "CONFORMING TO"
 113 This system call is Linux-specific.
 114 .SH "SEE ALSO"
 115 .BR inotify_init (2),
 116 .BR inotify_rm_watch (2),
 117 .BR inotify (7)