111 lines
3.9 KiB
Groff
111 lines
3.9 KiB
Groff
.\" Copyright (c) 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" This code is derived from software contributed to Berkeley by
|
|
.\" Berkeley Software Design, Inc.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" @(#)revoke.2 8.1 (Berkeley) 6/4/93
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd June 4, 1993
|
|
.Dt REVOKE 2
|
|
.Os
|
|
.Sh NAME
|
|
.Nm revoke
|
|
.Nd revoke file access
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.Fd #include <unistd.h>
|
|
.Ft int
|
|
.Fn revoke "const char *path"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn revoke
|
|
function invalidates all current open file descriptors in the system
|
|
for the file named by
|
|
.Fa path .
|
|
Subsequent operations on any such descriptors
|
|
fail, with the exceptions that a
|
|
.Fn read
|
|
from a character device file which has been revoked
|
|
returns a count of zero (end of file),
|
|
and a
|
|
.Fn close
|
|
call will succeed.
|
|
If the file is a special file for a device which is open,
|
|
the device close function
|
|
is called as if all open references to the file had been closed.
|
|
.Pp
|
|
Access to a file may be revoked only by its owner or the super user.
|
|
The
|
|
.Fn revoke
|
|
function is currently supported only for block and character special
|
|
device files.
|
|
It is normally used to prepare a terminal device for a new login session,
|
|
preventing any access by a previous user of the terminal.
|
|
.Sh RETURN VALUES
|
|
A 0 value indicated that the call succeeded. A \-1 return value
|
|
indicates an error occurred and
|
|
.Va errno
|
|
is set to indicated the reason.
|
|
.Sh ERRORS
|
|
Access to the named file is revoked unless one of the following:
|
|
.Bl -tag -width Er
|
|
.It Bq Er ENOTDIR
|
|
A component of the path prefix is not a directory.
|
|
.It Bq Er ENAMETOOLONG
|
|
A component of a pathname exceeded 255 characters,
|
|
or an entire path name exceeded 1024 characters.
|
|
.It Bq Er ENOENT
|
|
The named file or a component of the path name does not exist.
|
|
.It Bq Er EACCES
|
|
Search permission is denied for a component of the path prefix.
|
|
.It Bq Er ELOOP
|
|
Too many symbolic links were encountered in translating the pathname.
|
|
.It Bq Er EFAULT
|
|
.Fa Path
|
|
points outside the process's allocated address space.
|
|
.It Bq Er EINVAL
|
|
The implementation does not support the
|
|
.Fn revoke
|
|
operation on the named file.
|
|
.It Bq Er EPERM
|
|
The caller is neither the owner of the file nor the super user.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr close 2
|
|
.Sh HISTORY
|
|
The
|
|
.Fn revoke
|
|
function was introduced in
|
|
.Bx 4.3 Reno .
|