diff options
Diffstat (limited to 'src/lib/libc/net/iso_addr.3')
-rw-r--r-- | src/lib/libc/net/iso_addr.3 | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/src/lib/libc/net/iso_addr.3 b/src/lib/libc/net/iso_addr.3 new file mode 100644 index 0000000000..8655a63973 --- /dev/null +++ b/src/lib/libc/net/iso_addr.3 | |||
@@ -0,0 +1,111 @@ | |||
1 | .\" $OpenBSD: iso_addr.3,v 1.4 1999/07/05 06:08:05 aaron Exp $ | ||
2 | .\" | ||
3 | .\" Copyright (c) 1993 | ||
4 | .\" The Regents of the University of California. All rights reserved. | ||
5 | .\" | ||
6 | .\" Redistribution and use in source and binary forms, with or without | ||
7 | .\" modification, are permitted provided that the following conditions | ||
8 | .\" are met: | ||
9 | .\" 1. Redistributions of source code must retain the above copyright | ||
10 | .\" notice, this list of conditions and the following disclaimer. | ||
11 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
12 | .\" notice, this list of conditions and the following disclaimer in the | ||
13 | .\" documentation and/or other materials provided with the distribution. | ||
14 | .\" 3. All advertising materials mentioning features or use of this software | ||
15 | .\" must display the following acknowledgement: | ||
16 | .\" This product includes software developed by the University of | ||
17 | .\" California, Berkeley and its contributors. | ||
18 | .\" 4. Neither the name of the University nor the names of its contributors | ||
19 | .\" may be used to endorse or promote products derived from this software | ||
20 | .\" without specific prior written permission. | ||
21 | .\" | ||
22 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | ||
23 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
24 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
25 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | ||
26 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
27 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
28 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
29 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
30 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
31 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
32 | .\" SUCH DAMAGE. | ||
33 | .\" | ||
34 | .Dd June 4, 1993 | ||
35 | .Dt ISO_ADDR 3 | ||
36 | .Os | ||
37 | .Sh NAME | ||
38 | .Nm iso_addr , | ||
39 | .Nm iso_ntoa | ||
40 | .Nd "network address conversion routines for Open System Interconnection" | ||
41 | .Sh SYNOPSIS | ||
42 | .Fd #include <sys/types.h> | ||
43 | .Fd #include <netiso/iso.h> | ||
44 | .Ft struct iso_addr * | ||
45 | .Fn iso_addr "char *cp" | ||
46 | .Ft char * | ||
47 | .Fn iso_ntoa "struct iso_addr *isoa" | ||
48 | .Sh DESCRIPTION | ||
49 | The routine | ||
50 | .Fn iso_addr | ||
51 | interprets character strings representing | ||
52 | .Tn OSI | ||
53 | addresses, returning binary information suitable | ||
54 | for use in system calls. | ||
55 | The routine | ||
56 | .Fn iso_ntoa | ||
57 | takes | ||
58 | .Tn OSI | ||
59 | addresses and returns | ||
60 | .Tn ASCII | ||
61 | strings representing NSAPs (network service | ||
62 | access points) in a | ||
63 | notation inverse to that accepted by | ||
64 | .Fn iso_addr . | ||
65 | .Pp | ||
66 | Unfortunately, no universal standard exists for representing | ||
67 | .Tn OSI | ||
68 | network addresses. | ||
69 | .Pp | ||
70 | The format employed by | ||
71 | .Fn iso_addr | ||
72 | is a sequence of hexadecimal | ||
73 | .Dq digits | ||
74 | (optionally separated by periods), | ||
75 | of the form: | ||
76 | .Bd -filled -offset indent | ||
77 | <hex digits>.<hex digits>.<hex digits> | ||
78 | .Ed | ||
79 | .Pp | ||
80 | Each pair of hexadecimal digits represents a byte | ||
81 | with the leading digit indicating the higher-ordered bits. | ||
82 | A period following an even number of bytes has no | ||
83 | effect (but may be used to increase legibility). | ||
84 | A period following an odd number of bytes has the | ||
85 | effect of causing the byte of address being translated | ||
86 | to have its higher order bits filled with zeros. | ||
87 | .Sh RETURN VALUES | ||
88 | .Fn iso_ntoa | ||
89 | always returns a null terminated string. | ||
90 | .Fn iso_addr | ||
91 | always returns a pointer to a | ||
92 | .Li struct iso_addr . | ||
93 | (See | ||
94 | .Sx BUGS . ) | ||
95 | .Sh SEE ALSO | ||
96 | .Xr iso 4 | ||
97 | .Sh HISTORY | ||
98 | The | ||
99 | .Fn iso_addr | ||
100 | and | ||
101 | .Fn iso_ntoa | ||
102 | functions appeared in | ||
103 | .Bx 4.3 Reno . | ||
104 | .Sh BUGS | ||
105 | The returned values | ||
106 | reside in a static memory area. | ||
107 | .Pp | ||
108 | The function | ||
109 | .Fn iso_addr | ||
110 | should diagnose improperly formed input, and there should be an unambiguous | ||
111 | way to recognize this. | ||