| 1 |
27 |
unneback |
.\" $OpenBSD: ipx.3,v 1.8 2001/08/02 20:37:35 hugh Exp $
|
| 2 |
|
|
.\"
|
| 3 |
|
|
.\" Copyright (c) 1986, 1991, 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 IPX 3
|
| 36 |
|
|
.Os
|
| 37 |
|
|
.Sh NAME
|
| 38 |
|
|
.Nm ipx_addr ,
|
| 39 |
|
|
.Nm ipx_ntoa
|
| 40 |
|
|
.Nd IPX address conversion routines
|
| 41 |
|
|
.Sh SYNOPSIS
|
| 42 |
|
|
.Fd #include
|
| 43 |
|
|
.Fd #include
|
| 44 |
|
|
.Ft struct ipx_addr
|
| 45 |
|
|
.Fn ipx_addr "const char *cp"
|
| 46 |
|
|
.Ft char *
|
| 47 |
|
|
.Fn ipx_ntoa "struct ipx_addr ipx"
|
| 48 |
|
|
.Sh DESCRIPTION
|
| 49 |
|
|
The routine
|
| 50 |
|
|
.Fn ipx_addr
|
| 51 |
|
|
interprets character strings representing
|
| 52 |
|
|
.Tn IPX
|
| 53 |
|
|
addresses, returning binary information suitable
|
| 54 |
|
|
for use in system calls.
|
| 55 |
|
|
The routine
|
| 56 |
|
|
.Fn ipx_ntoa
|
| 57 |
|
|
takes
|
| 58 |
|
|
.Tn IPX
|
| 59 |
|
|
addresses and returns
|
| 60 |
|
|
.Tn ASCII
|
| 61 |
|
|
strings representing the address in a
|
| 62 |
|
|
notation in common use:
|
| 63 |
|
|
.Bd -filled -offset indent
|
| 64 |
|
|
..
|
| 65 |
|
|
.Ed
|
| 66 |
|
|
.Pp
|
| 67 |
|
|
Trailing zero fields are suppressed, and each number is printed in hexadecimal,
|
| 68 |
|
|
in a format suitable for input to
|
| 69 |
|
|
.Fn ipx_addr .
|
| 70 |
|
|
Any fields lacking super-decimal digits will have a
|
| 71 |
|
|
trailing
|
| 72 |
|
|
.Sq H
|
| 73 |
|
|
appended.
|
| 74 |
|
|
.Pp
|
| 75 |
|
|
An effort has been made to ensure that
|
| 76 |
|
|
.Fn ipx_addr
|
| 77 |
|
|
be compatible with most formats in common use.
|
| 78 |
|
|
It will first separate an address into 1 to 3 fields using a single delimiter
|
| 79 |
|
|
chosen from
|
| 80 |
|
|
period
|
| 81 |
|
|
.Pq Ql \&. ,
|
| 82 |
|
|
colon
|
| 83 |
|
|
.Pq Ql \&: ,
|
| 84 |
|
|
or pound-sign
|
| 85 |
|
|
.Pq Ql # .
|
| 86 |
|
|
Each field is then examined for byte separators (colon or period).
|
| 87 |
|
|
If there are byte separators, each subfield separated is taken to be
|
| 88 |
|
|
a small hexadecimal number, and the entirety is taken as a network-byte-ordered
|
| 89 |
|
|
quantity to be zero extended in the high-network-order bytes.
|
| 90 |
|
|
Next, the field is inspected for hyphens, in which case
|
| 91 |
|
|
the field is assumed to be a number in decimal notation
|
| 92 |
|
|
with hyphens separating the millenia.
|
| 93 |
|
|
Next, the field is assumed to be a number:
|
| 94 |
|
|
It is interpreted
|
| 95 |
|
|
as hexadecimal if there is a leading
|
| 96 |
|
|
.Ql 0x
|
| 97 |
|
|
(as in C),
|
| 98 |
|
|
a trailing
|
| 99 |
|
|
.Sq H
|
| 100 |
|
|
(as in Mesa), or there are any super-decimal digits present.
|
| 101 |
|
|
It is interpreted as octal is there is a leading
|
| 102 |
|
|
.Ql 0
|
| 103 |
|
|
and there are no super-octal digits.
|
| 104 |
|
|
Otherwise, it is converted as a decimal number.
|
| 105 |
|
|
.Sh RETURN VALUES
|
| 106 |
|
|
None.
|
| 107 |
|
|
(See
|
| 108 |
|
|
.Sx BUGS . )
|
| 109 |
|
|
.Sh SEE ALSO
|
| 110 |
|
|
.Xr ns 4 ,
|
| 111 |
|
|
.Xr hosts 5 ,
|
| 112 |
|
|
.Xr networks 5
|
| 113 |
|
|
.Sh HISTORY
|
| 114 |
|
|
The precursor
|
| 115 |
|
|
.Fn ns_addr
|
| 116 |
|
|
and
|
| 117 |
|
|
.Fn ns_ntoa
|
| 118 |
|
|
functions appeared in
|
| 119 |
|
|
.Bx 4.3 .
|
| 120 |
|
|
.Sh BUGS
|
| 121 |
|
|
The string returned by
|
| 122 |
|
|
.Fn ipx_ntoa
|
| 123 |
|
|
resides in a static memory area.
|
| 124 |
|
|
The function
|
| 125 |
|
|
.Fn ipx_addr
|
| 126 |
|
|
should diagnose improperly formed input, and there should be an unambiguous
|
| 127 |
|
|
way to recognize this.
|
