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