manual/LDP_man-pages/original/man2/inotify_rm_watch.2

   1 .\" man2/inotify_rm_watch.2 - inotify_rm_watch man page
   2 .\"
   3 .\" Copyright (C) 2005 Robert Love
   4 .\"
   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, write to the Free
  22 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  23 .\" USA.
  24 .\"
  25 .\" 2005-07-19 Robert Love <rlove@rlove.org> - initial version
  26 .\" 2006-02-07 mtk, minor changes
  27 .\"
  28 .TH INOTIFY_RM_WATCH 2 2006-02-07 "Linux" "Linux Programmer's Manual"
  29 .SH NAME
  30 inotify_rm_watch \- remove an existing watch from an inotify instance
  31 .SH SYNOPSIS
  32 .B #include <sys/inotify.h>
  33 .sp
  34 .BI "int inotify_rm_watch(int " fd ", uint32_t " wd );
  35 .\" FIXME . The type of the second argument should probably be "int".
  36 .\" I submitted a patch to fix this.  See the LKML thread
  37 .\" "[patch] Fix type errors in inotify interfaces", 18 Nov 2008
  38 .\" Glibc bug filed: http://sources.redhat.com/bugzilla/show_bug.cgi?id=7040
  39 .SH DESCRIPTION
  40 .BR inotify_rm_watch ()
  41 removes the watch associated with the watch descriptor
  42 .I wd
  43 from the inotify instance associated with the file descriptor
  44 .IR fd .
  45
  46 Removing a watch causes an
  47 .B IN_IGNORED
  48 event to be generated for this watch descriptor.
  49 (See
  50 .BR inotify (7).)
  51 .SH "RETURN VALUE"
  52 On success,
  53 .BR inotify_rm_watch ()
  54 returns zero, or \-1 if an error occurred (in which case,
  55 .I errno
  56 is set appropriately).
  57 .SH ERRORS
  58 .TP
  59 .B EBADF
  60 .I fd
  61 is not a valid file descriptor.
  62 .TP
  63 .B EINVAL
  64 The watch descriptor
  65 .I wd
  66 is not valid; or
  67 .I fd
  68 is not an inotify file descriptor.
  69 .SH VERSIONS
  70 Inotify was merged into the 2.6.13 Linux kernel.
  71 .SH "CONFORMING TO"
  72 This system call is Linux-specific.
  73 .SH "SEE ALSO"
  74 .BR inotify_add_watch (2),
  75 .BR inotify_init (2),
  76 .BR inotify (7)