xref: /netbsd-src/lib/libc/sys/revoke.2 (revision ae9172d6cd9432a6a1a56760d86b32c57a66c39c)
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.\"
37.Dd June 4, 1993
38.Dt REVOKE 2
39.Os
40.Sh NAME
41.Nm revoke
42.Nd revoke file access
43.Sh SYNOPSIS
44.Ft int
45.Fn revoke "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 super user.
65The
66.Nm revoke
67function is currently supported only for block and character special
68device files.
69It is normally used to prepare a terminal device for a new login session,
70preventing any access by a previous user of the terminal.
71.Sh RETURN VALUES
72A 0 value indicated that the call succeeded.  A \-1 return value
73indicates an error occurred and
74.Va errno
75is set to indicated the reason.
76.Sh ERRORS
77Access to the named file is revoked unless one of the following:
78.Bl -tag -width Er
79.It Bq Er ENOTDIR
80A component of the path prefix is not a directory.
81.It Bq Er ENAMETOOLONG
82A component of a pathname exceeded 255 characters,
83or an entire path name exceeded 1024 characters.
84.It Bq Er ENOENT
85The named file or a component of the path name does not exist.
86.It Bq Er EACCES
87Search permission is denied for a component of the path prefix.
88.It Bq Er ELOOP
89Too many symbolic links were encountered in translating the pathname.
90.It Bq Er EFAULT
91.Fa Path
92points outside the process's allocated address space.
93.It Bq Er EINVAL
94The named file is neither a character special or block
95special file.
96.It Bq Er EPERM
97The caller is neither the owner of the file nor the super user.
98.El
99.Sh SEE ALSO
100.Xr close 2
101.Sh HISTORY
102The
103.Nm revoke
104function was introduced in
105.Bx 4.3 Reno .
106