xref: /minix3/lib/libc/sys/shutdown.2 (revision 2fe8fb192fe7e8720e3e7a77f928da545e872a6a)
1*2fe8fb19SBen Gras.\"	$NetBSD: shutdown.2,v 1.17 2004/05/13 10:20:58 wiz Exp $
2*2fe8fb19SBen Gras.\"
3*2fe8fb19SBen Gras.\" Copyright (c) 1983, 1991, 1993
4*2fe8fb19SBen Gras.\"	The Regents of the University of California.  All rights reserved.
5*2fe8fb19SBen Gras.\"
6*2fe8fb19SBen Gras.\" Redistribution and use in source and binary forms, with or without
7*2fe8fb19SBen Gras.\" modification, are permitted provided that the following conditions
8*2fe8fb19SBen Gras.\" are met:
9*2fe8fb19SBen Gras.\" 1. Redistributions of source code must retain the above copyright
10*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer.
11*2fe8fb19SBen Gras.\" 2. Redistributions in binary form must reproduce the above copyright
12*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer in the
13*2fe8fb19SBen Gras.\"    documentation and/or other materials provided with the distribution.
14*2fe8fb19SBen Gras.\" 3. Neither the name of the University nor the names of its contributors
15*2fe8fb19SBen Gras.\"    may be used to endorse or promote products derived from this software
16*2fe8fb19SBen Gras.\"    without specific prior written permission.
17*2fe8fb19SBen Gras.\"
18*2fe8fb19SBen Gras.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19*2fe8fb19SBen Gras.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20*2fe8fb19SBen Gras.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21*2fe8fb19SBen Gras.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22*2fe8fb19SBen Gras.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23*2fe8fb19SBen Gras.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24*2fe8fb19SBen Gras.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25*2fe8fb19SBen Gras.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26*2fe8fb19SBen Gras.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27*2fe8fb19SBen Gras.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28*2fe8fb19SBen Gras.\" SUCH DAMAGE.
29*2fe8fb19SBen Gras.\"
30*2fe8fb19SBen Gras.\"     @(#)shutdown.2	8.1 (Berkeley) 6/4/93
31*2fe8fb19SBen Gras.\"
32*2fe8fb19SBen Gras.Dd August 18, 2002
33*2fe8fb19SBen Gras.Dt SHUTDOWN 2
34*2fe8fb19SBen Gras.Os
35*2fe8fb19SBen Gras.Sh NAME
36*2fe8fb19SBen Gras.Nm shutdown
37*2fe8fb19SBen Gras.Nd shut down part of a full-duplex connection
38*2fe8fb19SBen Gras.Sh LIBRARY
39*2fe8fb19SBen Gras.Lb libc
40*2fe8fb19SBen Gras.Sh SYNOPSIS
41*2fe8fb19SBen Gras.In sys/socket.h
42*2fe8fb19SBen Gras.Ft int
43*2fe8fb19SBen Gras.Fn shutdown "int s" "int how"
44*2fe8fb19SBen Gras.Sh DESCRIPTION
45*2fe8fb19SBen GrasThe
46*2fe8fb19SBen Gras.Fn shutdown
47*2fe8fb19SBen Grascall causes all or part of a full-duplex connection on
48*2fe8fb19SBen Grasthe socket associated with
49*2fe8fb19SBen Gras.Fa s
50*2fe8fb19SBen Grasto be shut down.
51*2fe8fb19SBen GrasThe
52*2fe8fb19SBen Gras.Fa how
53*2fe8fb19SBen Grasargument specifies which part of the connection will be shut down.
54*2fe8fb19SBen GrasPermissible values are:
55*2fe8fb19SBen Gras.Bl -tag -width SHUT_RDWRXX -offset indent
56*2fe8fb19SBen Gras.It SHUT_RD
57*2fe8fb19SBen Grasfurther receives will be disallowed.
58*2fe8fb19SBen Gras.It SHUT_WR
59*2fe8fb19SBen Grasfurther sends will be disallowed.
60*2fe8fb19SBen Gras.It SHUT_RDWR
61*2fe8fb19SBen Grasfurther sends and receives will be disallowed.
62*2fe8fb19SBen Gras.El
63*2fe8fb19SBen Gras.Sh RETURN VALUES
64*2fe8fb19SBen GrasA 0 is returned if the call succeeds, \-1 if it fails.
65*2fe8fb19SBen Gras.Sh ERRORS
66*2fe8fb19SBen GrasThe call succeeds unless:
67*2fe8fb19SBen Gras.Bl -tag -width Er
68*2fe8fb19SBen Gras.It Bq Er EBADF
69*2fe8fb19SBen Gras.Fa s
70*2fe8fb19SBen Grasis not a valid descriptor.
71*2fe8fb19SBen Gras.It Bq Er EINVAL
72*2fe8fb19SBen GrasThe
73*2fe8fb19SBen Gras.Fa how
74*2fe8fb19SBen Grasargument is invalid.
75*2fe8fb19SBen Gras.It Bq Er ENOTCONN
76*2fe8fb19SBen GrasThe specified socket is not connected.
77*2fe8fb19SBen Gras.It Bq Er ENOTSOCK
78*2fe8fb19SBen Gras.Fa s
79*2fe8fb19SBen Grasis a file, not a socket.
80*2fe8fb19SBen Gras.El
81*2fe8fb19SBen Gras.Sh SEE ALSO
82*2fe8fb19SBen Gras.Xr connect 2 ,
83*2fe8fb19SBen Gras.Xr socket 2
84*2fe8fb19SBen Gras.Sh HISTORY
85*2fe8fb19SBen GrasThe
86*2fe8fb19SBen Gras.Fn shutdown
87*2fe8fb19SBen Grasfunction call appeared in
88*2fe8fb19SBen Gras.Bx 4.2 .
89*2fe8fb19SBen GrasThe
90*2fe8fb19SBen Gras.Fa how
91*2fe8fb19SBen Grasarguments used to be simply 0, 1, and 2, but now have named values
92*2fe8fb19SBen Grasas specified by
93*2fe8fb19SBen Gras.St -xpg4 .
94