- Uniformly use .In for header file references.
[dragonfly.git] / lib / libc / sys / closefrom.2
CommitLineData
e5a3561f
HP
1.\"
2.\" Copyright (c) 2005 The DragonFly Project. All rights reserved.
3.\"
4.\" This code is derived from software contributed to The DragonFly Project
5.\" by Hiten Pandya <hmp@backplane.com>.
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.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\" notice, this list of conditions and the following disclaimer in
15.\" the documentation and/or other materials provided with the
16.\" distribution.
17.\" 3. Neither the name of The DragonFly Project nor the names of its
18.\" contributors may be used to endorse or promote products derived
19.\" from this software without specific, prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
44cb301e 34.\" $DragonFly: src/lib/libc/sys/closefrom.2,v 1.2 2006/05/26 19:39:37 swildner Exp $
e5a3561f
HP
35.\"
36.\" $OpenBSD: closefrom.2,v 1.2 2004/01/12 20:52:09 jmc Exp $
37.\"
38.\" Copyright (c) 2004 Ted Unangst. All rights reserved.
39.\"
40.\" Redistribution and use in source and binary forms, with or without
41.\" modification, are permitted provided that the following conditions
42.\" are met:
43.\" 1. Redistributions of source code must retain the above copyright
44.\" notice, this list of conditions and the following disclaimer.
45.\" 2. Redistributions in binary form must reproduce the above copyright
46.\" notice, this list of conditions and the following disclaimer in the
47.\" documentation and/or other materials provided with the distribution.
48.\"
49.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
50.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
53.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59.\" SUCH DAMAGE.
60.Dd April 10, 2004
61.Dt CLOSEFROM 2
62.Os
63.Sh NAME
64.Nm closefrom
65.Nd delete many descriptors
66.Sh SYNOPSIS
44cb301e 67.In unistd.h
e5a3561f
HP
68.Ft int
69.Fn closefrom "int fd"
70.Sh DESCRIPTION
71The
72.Fn closefrom
73system call deletes all descriptors numbered
74.Fa fd
75and higher from the per-process file descriptor table.
76It is effectively the same as calling
77.Xr close 2
78on each descriptor.
79.Sh IMPLEMENTATION NOTES
80The behaviour of the
81.Nm
82system call in
83.Dx
84is similar to that of
85.Tn SunOS
86except for error returned in the case of an abort.
87.Sh RETURN VALUES
88The value of 0 is returned in all cases, or
89.Er EINTR
90when an interrupt or abort is received.
91.Sh SEE ALSO
92.Xr close 2
93.Sh HISTORY
94The
95.Nm
96system call appeared in
97.Dx 1.2 .
98It was originally introduced in some version of
99.Tn "Sun Solaris" .
100.Sh AUTHORS
101This system call is written by
102.An Joerg Sonnenberger Aq joerg@bec.de .