diff options
Diffstat (limited to 'upstream/archlinux/man3p/inet_addr.3p')
| -rw-r--r-- | upstream/archlinux/man3p/inet_addr.3p | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/upstream/archlinux/man3p/inet_addr.3p b/upstream/archlinux/man3p/inet_addr.3p new file mode 100644 index 00000000..6bc8bc44 --- /dev/null +++ b/upstream/archlinux/man3p/inet_addr.3p @@ -0,0 +1,118 @@ +'\" et +.TH INET_ADDR "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual" +.\" +.SH PROLOG +This manual page is part of the POSIX Programmer's Manual. +The Linux implementation of this interface may differ (consult +the corresponding Linux manual page for details of Linux behavior), +or the interface may not be implemented on Linux. +.\" +.SH NAME +inet_addr, +inet_ntoa +\(em IPv4 address manipulation +.SH SYNOPSIS +.LP +.nf +#include <arpa/inet.h> +.P +in_addr_t inet_addr(const char *\fIcp\fP); +char *inet_ntoa(struct in_addr \fIin\fP); +.fi +.SH DESCRIPTION +The +\fIinet_addr\fR() +function shall convert the string pointed to by +.IR cp , +in the standard IPv4 dotted decimal notation, to an integer value +suitable for use as an Internet address. +.P +The +\fIinet_ntoa\fR() +function shall convert the Internet host address specified by +.IR in +to a string in the Internet standard dot notation. +.P +The +\fIinet_ntoa\fR() +function need not be thread-safe. +.P +All Internet addresses shall be returned in network order (bytes +ordered from left to right). +.P +Values specified using IPv4 dotted decimal notation take one of the +following forms: +.IP "\fRa.b.c.d\fP" 10 +When four parts are specified, each shall be interpreted as a byte of +data and assigned, from left to right, to the four bytes of an Internet +address. +.IP "\fRa.b.c\fP" 10 +When a three-part address is specified, the last part shall be +interpreted as a 16-bit quantity and placed in the rightmost two bytes +of the network address. This makes the three-part address format +convenient for specifying Class B network addresses as +.BR \(dq128.net.host\(dq . +.IP "\fRa.b\fP" 10 +When a two-part address is supplied, the last part shall be interpreted +as a 24-bit quantity and placed in the rightmost three bytes of the +network address. This makes the two-part address format convenient for +specifying Class A network addresses as +.BR \(dqnet.host\(dq . +.IP "\fRa\fP" 10 +When only one part is given, the value shall be stored directly in the +network address without any byte rearrangement. +.P +All numbers supplied as parts in IPv4 dotted decimal notation may be +decimal, octal, or hexadecimal, as specified in the ISO\ C standard (that is, a +leading 0x or 0X implies hexadecimal; otherwise, a leading +.BR '0' +implies octal; otherwise, the number is interpreted as decimal). +.SH "RETURN VALUE" +Upon successful completion, +\fIinet_addr\fR() +shall return the Internet address. Otherwise, it shall return (\c +.BR in_addr_t )(\-1). +.P +The +\fIinet_ntoa\fR() +function shall return a pointer to the network address in Internet +standard dot notation. +.SH ERRORS +No errors are defined. +.LP +.IR "The following sections are informative." +.SH "EXAMPLES" +None. +.SH "APPLICATION USAGE" +The return value of +\fIinet_ntoa\fR() +may point to static data that may be overwritten by subsequent calls to +\fIinet_ntoa\fR(). +.SH "RATIONALE" +None. +.SH "FUTURE DIRECTIONS" +None. +.SH "SEE ALSO" +.IR "\fIendhostent\fR\^(\|)", +.IR "\fIendnetent\fR\^(\|)" +.P +The Base Definitions volume of POSIX.1\(hy2017, +.IR "\fB<arpa_inet.h>\fP" +.\" +.SH COPYRIGHT +Portions of this text are reprinted and reproduced in electronic form +from IEEE Std 1003.1-2017, Standard for Information Technology +-- Portable Operating System Interface (POSIX), The Open Group Base +Specifications Issue 7, 2018 Edition, +Copyright (C) 2018 by the Institute of +Electrical and Electronics Engineers, Inc and The Open Group. +In the event of any discrepancy between this version 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 . +.PP +Any typographical or formatting errors that appear +in this page are most likely +to have been introduced during the conversion of the source files to +man page format. To report such errors, see +https://www.kernel.org/doc/man-pages/reporting_bugs.html . |