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