original/man2/inotify_add_watch.2

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