lib/libc/sys/revoke.2

   1 .\" Copyright (c) 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Berkeley Software Design, Inc.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgement:
  17 .\"     This product includes software developed by the University of
  18 .\"     California, Berkeley and its contributors.
  19 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     @(#)revoke.2    8.1 (Berkeley) 6/4/93
  36 .\" $FreeBSD: src/lib/libc/sys/revoke.2,v 1.7.2.3 2001/12/14 18:34:01 ru Exp $
  37 .\"
  38 .Dd June 4, 1993
  39 .Dt REVOKE 2
  40 .Os
  41 .Sh NAME
  42 .Nm revoke
  43 .Nd revoke file access
  44 .Sh LIBRARY
  45 .Lb libc
  46 .Sh SYNOPSIS
  47 .In unistd.h
  48 .Ft int
  49 .Fn revoke "const char *path"
  50 .Sh DESCRIPTION
  51 The
  52 .Fn revoke
  53 function invalidates all current open file descriptors in the system
  54 for the file named by
  55 .Fa path .
  56 Subsequent operations on any such descriptors
  57 fail, with the exceptions that a
  58 .Fn read
  59 from a character device file which has been revoked
  60 returns a count of zero (end of file),
  61 and a
  62 .Fn close
  63 call will succeed.
  64 If the file is a special file for a device which is open,
  65 the device close function
  66 is called as if all open references to the file had been closed.
  67 .Pp
  68 Access to a file may be revoked only by its owner or the super user.
  69 The
  70 .Fn revoke
  71 function is currently supported only for block and character special
  72 device files.
  73 It is normally used to prepare a terminal device for a new login session,
  74 preventing any access by a previous user of the terminal.
  75 .Sh RETURN VALUES
  76 .Rv -std revoke
  77 .Sh ERRORS
  78 Access to the named file is revoked unless one of the following:
  79 .Bl -tag -width Er
  80 .It Bq Er ENOTDIR
  81 A component of the path prefix is not a directory.
  82 .It Bq Er ENAMETOOLONG
  83 A component of a pathname exceeded 255 characters,
  84 or an entire path name exceeded 1024 characters.
  85 .It Bq Er ENOENT
  86 The named file or a component of the path name does not exist.
  87 .It Bq Er EACCES
  88 Search permission is denied for a component of the path prefix.
  89 .It Bq Er ELOOP
  90 Too many symbolic links were encountered in translating the pathname.
  91 .It Bq Er EFAULT
  92 .Fa Path
  93 points outside the process's allocated address space.
  94 .It Bq Er EINVAL
  95 The implementation does not support the
  96 .Fn revoke
  97 operation on the named file.
  98 .It Bq Er EPERM
  99 The caller is neither the owner of the file nor the super user.
 100 .El
 101 .Sh SEE ALSO
 102 .Xr close 2
 103 .Sh HISTORY
 104 The
 105 .Fn revoke
 106 function was introduced in
 107 .Bx 4.3 Reno .