diff options
author | Richard Lowe <richlowe@richlowe.net> | 2011-03-14 14:05:30 -0400 |
---|---|---|
committer | Richard Lowe <richlowe@richlowe.net> | 2011-03-14 14:05:30 -0400 |
commit | c10c16dec587a0662068f6e2991c29ed3a9db943 (patch) | |
tree | f414286f4bba41d75683ed4fbbaa6bfa4bf7fabd /usr/src/man/man3head/in.h.3head | |
parent | 68caef18a23a498d9e3017b983562c0f4fd8ab23 (diff) | |
download | illumos-joyent-c10c16dec587a0662068f6e2991c29ed3a9db943.tar.gz |
243 system manual pages should live with the software
Reviewed by: garrett@nexenta.com
Reviewed by: gwr@nexenta.com
Reviewed by: trisk@opensolaris.org
Approved by: gwr@nexenta.com
--HG--
extra : rebase_source : 0c599d0bec0dc8865fbba67721a7a6cd6b1feefb
Diffstat (limited to 'usr/src/man/man3head/in.h.3head')
-rw-r--r-- | usr/src/man/man3head/in.h.3head | 198 |
1 files changed, 198 insertions, 0 deletions
diff --git a/usr/src/man/man3head/in.h.3head b/usr/src/man/man3head/in.h.3head new file mode 100644 index 0000000000..37f4d54a41 --- /dev/null +++ b/usr/src/man/man3head/in.h.3head @@ -0,0 +1,198 @@ +'\" te +.\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved +.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at +.\" http://www.opengroup.org/bookstore/. +.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. +.\" This notice shall appear on any product containing this material. +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH in.h 3HEAD "30 Aug 2002" "SunOS 5.11" "Headers" +.SH NAME +in.h, in \- Internet Protocol family +.SH SYNOPSIS +.LP +.nf +#include <netinet/in.h> +.fi + +.SH DESCRIPTION +.sp +.LP +The <\fBnetinet/in.h\fR> header defines the following types through +\fBtypedef\fR: +.sp +.ne 2 +.mk +.na +\fB\fBin_port_t\fR\fR +.ad +.RS 13n +.rt +An unsigned integral type of exactly 16 bits. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBin_addr_t\fR\fR +.ad +.RS 13n +.rt +An unsigned integral type of exactly 32 bits. The <\fBnetinet/in.h\fR> header +defines the \fBin_addr\fR structure that includes the following member: +.RE + +.sp +.LP +The <\fBnetinet/in.h\fR> header defines the \fBin_addr\fR structure that +includes the following member: +.sp +.in +2 +.nf +in_addr_t s_addr +.fi +.in -2 + +.sp +.LP +The <\fBnetinet/in.h\fR> header defines the type \fBsa_family_t\fR as described +in \fBsocket.h\fR(3HEAD). +.sp +.LP +The <\fBnetinet/in.h\fR> header defines the following macros for use as values +of the \fIlevel\fR argument of \fBgetsockopt()\fR and \fBsetsockopt()\fR: +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_IP\fR \fR +.ad +.RS 21n +.rt +Dummy for \fBIP\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_ICMP\fR \fR +.ad +.RS 21n +.rt +Control message protocol +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_TCP\fR \fR +.ad +.RS 21n +.rt +\fBTCP\fR +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBIPPROTO_UDP\fR \fR +.ad +.RS 21n +.rt +User datagram protocol The <\fBnetinet/in.h\fR> header defines the following +macros for use as destination addresses for \fBconnect()\fR, \fBsendmsg()\fR, +and \fBsendto()\fR: +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBINADDR_ANY\fR \fR +.ad +.RS 21n +.rt +Local host address +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBINADDR_BROADCAST\fR \fR +.ad +.RS 21n +.rt +Broadcast address +.RE + +.sp +.LP +The <\fBnetinet/in.h\fR> header defines the \fBsockaddr_in\fR structure that is +used to store addresses for the Internet protocol family. Values of this type +must be cast to \fBstruct sockaddr\fR for use with the socket interfaces. +.SS "Default" +.sp +.LP +For applications that do not require standard-conforming behavior (those that +use the socket interfaces described in section (3SOCKET) of the reference +manual; see \fBIntro\fR(3) and \fBstandards\fR(5)), the <\fBnetinet/in.h\fR> +header defines the \fBsockaddr_in\fR structure that includes the following +members: +.sp +.in +2 +.nf +sa_family_t sin_family +in_port_t sin_port +struct in_addr sin_addr +char sin_zero[8] +.fi +.in -2 + +.SS "Standard conforming" +.sp +.LP +For applications that require standard-conforming behavior (those that use the +socket interfaces described in section (3XNET) of the reference manual; see +\fBIntro\fR(3) and \fBstandards\fR(5)), the <\fBnetinet/in.h\fR> header defines +the \fBsockaddr_in\fR structure that includes the following members: +.sp +.in +2 +.nf +sa_family_t sin_family +in_port_t sin_port +struct in_addr sin_addr +unsigned char sin_zero[8] +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +.TE + +.SH SEE ALSO +.sp +.LP +\fBIntro\fR(3), \fBconnect\fR(3SOCKET), \fBconnect\fR(3XNET), +\fBgetsockopt\fR(3SOCKET), \fBgetsockopt\fR(3XNET), \fBsendmsg\fR(3SOCKET), +\fBsendmsg\fR(3XNET), \fBsendto\fR(3SOCKET), \fBsendto\fR(3XNET), +\fBsetsockopt\fR(3SOCKET), \fBsetsockopt\fR(3XNET), \fBsocket.h\fR(3HEAD), +\fBattributes\fR(5), \fBstandards\fR(5) |