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