diff options
Diffstat (limited to 'lib/libipx/ipx.3')
-rw-r--r-- | lib/libipx/ipx.3 | 125 |
1 files changed, 125 insertions, 0 deletions
diff --git a/lib/libipx/ipx.3 b/lib/libipx/ipx.3 new file mode 100644 index 0000000..ab6de2d --- /dev/null +++ b/lib/libipx/ipx.3 @@ -0,0 +1,125 @@ +.\" Copyright (c) 1986, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 4. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd June 4, 1993 +.Dt IPX 3 +.Os +.Sh NAME +.Nm ipx_addr , +.Nm ipx_ntoa +.Nd IPX address conversion routines +.Sh LIBRARY +.Lb libipx +.Sh SYNOPSIS +.In sys/types.h +.In netipx/ipx.h +.Ft struct ipx_addr +.Fn ipx_addr "const char *cp" +.Ft char * +.Fn ipx_ntoa "struct ipx_addr ipx" +.Sh DESCRIPTION +The routine +.Fn ipx_addr +interprets character strings representing +.Tn IPX +addresses, returning binary information suitable +for use in system calls. +The routine +.Fn ipx_ntoa +takes +.Tn IPX +addresses and returns +.Tn ASCII +strings representing the address in a +notation in common use: +.Bd -ragged -offset indent +<network number>.<host number>.<port number> +.Ed +.Pp +Trailing zero fields are suppressed, and each number is printed in hexadecimal, +in a format suitable for input to +.Fn ipx_addr . +Any fields lacking super-decimal digits will have a +trailing +.Ql H +appended. +.Pp +An effort has been made to ensure that +.Fn ipx_addr +be compatible with most formats in common use. +It will first separate an address into 1 to 3 fields using a single delimiter +chosen from +period +.Ql \&. , +colon +.Ql \&: +or pound-sign +.Ql \&# . +Each field is then examined for byte separators (colon or period). +If there are byte separators, each subfield separated is taken to be +a small hexadecimal number, and the entirety is taken as a network-byte-ordered +quantity to be zero extended in the high-network-order bytes. +Next, the field is inspected for hyphens, in which case +the field is assumed to be a number in decimal notation +with hyphens separating the millennia. +Next, the field is assumed to be a number: +It is interpreted +as hexadecimal if there is a leading +.Ql 0x +(as in C), +a trailing +.Ql H +(as in Mesa), or there are any super-decimal digits present. +It is interpreted as octal if there is a leading +.Ql 0 +and there are no super-octal digits. +Otherwise, it is converted as a decimal number. +.Sh RETURN VALUES +None. +(See +.Sx BUGS . ) +.Sh SEE ALSO +.\" .Xr ns 4 , +.Xr hosts 5 , +.Xr networks 5 +.Sh HISTORY +The precursor +.Fn ns_addr +and +.Fn ns_toa +functions appeared in +.Bx 4.3 . +.Sh BUGS +The string returned by +.Fn ipx_ntoa +resides in a static memory area. +The function +.Fn ipx_addr +should diagnose improperly formed input, and there should be an unambiguous +way to recognize this. |