xref: /openbsd/lib/libc/sys/closefrom.2 (revision 17df1aa7)
1.\"	$OpenBSD: closefrom.2,v 1.4 2007/05/31 19:19:32 jmc Exp $
2.\"
3.\" Copyright (c) 2004 Ted Unangst.  All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.Dd $Mdocdate: May 31 2007 $
26.Dt CLOSEFROM 2
27.Os
28.Sh NAME
29.Nm closefrom
30.Nd delete many descriptors
31.Sh SYNOPSIS
32.Fd #include <unistd.h>
33.Ft int
34.Fn closefrom "int fd"
35.Sh DESCRIPTION
36The
37.Fn closefrom
38call deletes all descriptors numbered
39.Fa fd
40and higher from the per-process file descriptor table.
41It is effectively the same as calling
42.Xr close 2
43on each descriptor.
44.Sh RETURN VALUES
45Upon successful completion, a value of 0 is returned.
46Otherwise, a value of \-1 is returned and the global integer variable
47.Va errno
48is set to indicate the error.
49.Sh ERRORS
50.Fn closefrom
51will fail if:
52.Bl -tag -width Er
53.It Bq Er EBADF
54.Fa fd
55is greater than all open file descriptors.
56.It Bq Er EINTR
57An interrupt was received.
58.El
59.Sh SEE ALSO
60.Xr close 2
61