xref: /dragonfly/lib/libc/sys/revoke.2 (revision c89a6c1b)
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.\" $FreeBSD: src/lib/libc/sys/revoke.2,v 1.7.2.3 2001/12/14 18:34:01 ru Exp $
37.\" $DragonFly: src/lib/libc/sys/revoke.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
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 LIBRARY
46.Lb libc
47.Sh SYNOPSIS
48.In unistd.h
49.Ft int
50.Fn revoke "const char *path"
51.Sh DESCRIPTION
52The
53.Fn revoke
54function invalidates all current open file descriptors in the system
55for the file named by
56.Fa path .
57Subsequent operations on any such descriptors
58fail, with the exceptions that a
59.Fn read
60from a character device file which has been revoked
61returns a count of zero (end of file),
62and a
63.Fn close
64call will succeed.
65If the file is a special file for a device which is open,
66the device close function
67is called as if all open references to the file had been closed.
68.Pp
69Access to a file may be revoked only by its owner or the super user.
70The
71.Fn revoke
72function is currently supported only for block and character special
73device files.
74It is normally used to prepare a terminal device for a new login session,
75preventing any access by a previous user of the terminal.
76.Sh RETURN VALUES
77.Rv -std revoke
78.Sh ERRORS
79Access to the named file is revoked unless one of the following:
80.Bl -tag -width Er
81.It Bq Er ENOTDIR
82A component of the path prefix is not a directory.
83.It Bq Er ENAMETOOLONG
84A component of a pathname exceeded 255 characters,
85or an entire path name exceeded 1024 characters.
86.It Bq Er ENOENT
87The named file or a component of the path name does not exist.
88.It Bq Er EACCES
89Search permission is denied for a component of the path prefix.
90.It Bq Er ELOOP
91Too many symbolic links were encountered in translating the pathname.
92.It Bq Er EFAULT
93.Fa Path
94points outside the process's allocated address space.
95.It Bq Er EINVAL
96The implementation does not support the
97.Fn revoke
98operation on the named 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.Fn revoke
107function was introduced in
108.Bx 4.3 Reno .
109