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