syscons util remove use kbdcontrol & vidcontrol instead
[unix-history] / lib / libc / sys / shutdown.2
CommitLineData
15637ed4
RG
1.\" Copyright (c) 1983, 1991 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
14.\" This product includes software developed by the University of
15.\" California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\" may be used to endorse or promote products derived from this software
18.\" without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\" @(#)shutdown.2 6.4 (Berkeley) 3/10/91
33.\"
34.Dd March 10, 1991
35.Dt SHUTDOWN 2
36.Os BSD 4.2
37.Sh NAME
38.Nm shutdown
39.Nd shut down part of a full-duplex connection
40.Sh SYNOPSIS
41.Fd #include <sys/socket.h>
42.Ft int
43.Fn shutdown "int s" "int how"
44.Sh DESCRIPTION
45The
46.Fn shutdown
47call causes all or part of a full-duplex connection on
48the socket associated with
49.Fa s
50to be shut down.
51If
52.Fa how
53is 0, further receives will be disallowed.
54If
55.Fa how
56is 1, further sends will be disallowed.
57If
58.Fa how
59is 2, further sends and receives will be disallowed.
60.Sh DIAGNOSTICS
61A 0 is returned if the call succeeds, -1 if it fails.
62.Sh ERRORS
63The call succeeds unless:
64.Bl -tag -width ENOTCONNAA
65.It Bq Er EBADF
66.Fa S
67is not a valid descriptor.
68.It Bq Er ENOTSOCK
69.Fa S
70is a file, not a socket.
71.It Bq Er ENOTCONN
72The specified socket is not connected.
73.El
74.Sh SEE ALSO
75.Xr connect 2 ,
76.Xr socket 2
77.Sh HISTORY
78The
79.Nm
80function call appeared in
81.Bx 4.2 .