Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / lib / libcr / net / inet_net.3
1 .\"     $NetBSD: inet_net.3,v 1.4 1999/03/22 19:44:52 garbled Exp $
2 .\"
3 .\" Copyright (c) 1997 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Luke Mewburn.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\" 3. All advertising materials mentioning features or use of this software
18 .\"    must display the following acknowledgement:
19 .\"        This product includes software developed by the NetBSD
20 .\"        Foundation, Inc. and its contributors.
21 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
22 .\"    contributors may be used to endorse or promote products derived
23 .\"    from this software without specific prior written permission.
24 .\"
25 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 .\" POSSIBILITY OF SUCH DAMAGE.
36 .\"
37 .\" $FreeBSD: src/lib/libc/net/inet_net.3,v 1.1.2.1 2001/09/03 08:46:42 ru Exp $
38 .\" $DragonFly: src/lib/libcr/net/Attic/inet_net.3,v 1.2 2003/06/17 04:26:44 dillon Exp $
39 .\"
40 .Dd June 18, 1997
41 .Dt INET_NET 3
42 .Os
43 .Sh NAME
44 .Nm inet_net_ntop ,
45 .Nm inet_net_pton
46 .Nd Internet network number manipulation routines
47 .Sh LIBRARY
48 .Lb libc
49 .Sh SYNOPSIS
50 .In sys/types.h
51 .In sys/socket.h
52 .In netinet/in.h
53 .In arpa/inet.h
54 .Ft char *
55 .Fn inet_net_ntop "int af" "const void *src" "int bits" "char *dst" "size_t size"
56 .Ft int
57 .Fn inet_net_pton "int af" "const char *src" "void *dst" "size_t size"
58 .Sh DESCRIPTION
59 The
60 .Fn inet_net_ntop
61 function converts an Internet network number from network format (usually a
62 .Vt "struct in_addr"
63 or some other binary form, in network byte order) to CIDR presentation format
64 (suitable for external display purposes).
65 .Fa bits
66 is the number of bits in
67 .Fa src
68 that are the network number.
69 It returns
70 .Dv NULL
71 if a system error occurs (in which case,
72 .Va errno
73 will have been set), or it returns a pointer to the destination string.
74 .Pp
75 The
76 .Fn inet_net_pton
77 function converts a presentation format Internet network number (that is,
78 printable form as held in a character string) to network format (usually a
79 .Vt "struct in_addr"
80 or some other internal binary representation, in network byte order).
81 It returns the number of bits (either computed based on the class, or
82 specified with /CIDR), or \-1 if a failure occurred
83 (in which case
84 .Va errno
85 will have been set.
86 It will be set to
87 .Er ENOENT
88 if the Internet network number was not valid).
89 .Pp
90 The only value for
91 .Fa af
92 currently supported is
93 .Dv AF_INET .
94 .Fa size
95 is the size of the result buffer
96 .Fa dst .
97 .Pp
98 .Sh NETWORK NUMBERS (IP VERSION 4)
99 Internet network numbers may be specified in one of the following forms:
100 .Bd -literal -offset indent
101 a.b.c.d/bits
102 a.b.c.d
103 a.b.c
104 a.b
105 a
106 .Ed
107 .Pp
108 When four parts are specified, each is interpreted
109 as a byte of data and assigned, from left to right,
110 to the four bytes of an Internet network number.
111 Note
112 that when an Internet network number is viewed as a 32-bit
113 integer quantity on a system that uses little-endian
114 byte order (such as the
115 .Tn Intel 386 , 486 ,
116 and
117 .Tn Pentium
118 processors) the bytes referred to above appear as
119 .Dq Li d.c.b.a .
120 That is, little-endian bytes are ordered from right to left.
121 .Pp
122 When a three part number is specified, the last
123 part is interpreted as a 16-bit quantity and placed
124 in the rightmost two bytes of the Internet network number.
125 This makes the three part number format convenient
126 for specifying Class B network numbers as
127 .Dq Li 128.net.host .
128 .Pp
129 When a two part number is supplied, the last part
130 is interpreted as a 24-bit quantity and placed in
131 the rightmost three bytes of the Internet network number.
132 This makes the two part number format convenient
133 for specifying Class A network numbers as
134 .Dq Li net.host .
135 .Pp
136 When only one part is given, the value is stored
137 directly in the Internet network number without any byte
138 rearrangement.
139 .Pp
140 All numbers supplied as
141 .Dq parts
142 in a
143 .Ql \&.
144 notation
145 may be decimal, octal, or hexadecimal, as specified
146 in the C language (i.e., a leading 0x or 0X implies
147 hexadecimal; otherwise, a leading 0 implies octal;
148 otherwise, the number is interpreted as decimal).
149 .Sh SEE ALSO
150 .Xr byteorder 3 ,
151 .Xr inet 3 ,
152 .Xr networks 5
153 .Sh HISTORY
154 The
155 .Fn inet_net_ntop
156 and
157 .Fn inet_net_pton
158 functions appeared in BIND 4.9.4.