lib/libipx/ipx.3

   1 .\" Copyright (c) 1986, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $FreeBSD: src/lib/libipx/ipx.3,v 1.7.2.6 2003/06/10 21:04:14 ceri Exp $
  33 .\" $DragonFly: src/lib/libipx/ipx.3,v 1.3 2007/12/23 15:31:28 swildner Exp $
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt IPX 3
  37 .Os
  38 .Sh NAME
  39 .Nm ipx_addr ,
  40 .Nm ipx_ntoa
  41 .Nd IPX address conversion routines
  42 .Sh LIBRARY
  43 .Lb libipx
  44 .Sh SYNOPSIS
  45 .In sys/types.h
  46 .In netipx/ipx.h
  47 .Ft struct ipx_addr
  48 .Fn ipx_addr "const char *cp"
  49 .Ft char *
  50 .Fn ipx_ntoa "struct ipx_addr ipx"
  51 .Sh DESCRIPTION
  52 The routine
  53 .Fn ipx_addr
  54 interprets character strings representing
  55 .Tn IPX
  56 addresses, returning binary information suitable
  57 for use in system calls.
  58 The routine
  59 .Fn ipx_ntoa
  60 takes
  61 .Tn IPX
  62 addresses and returns
  63 .Tn ASCII
  64 strings representing the address in a
  65 notation in common use:
  66 .Bd -ragged -offset indent
  67 <network number>.<host number>.<port number>
  68 .Ed
  69 .Pp
  70 Trailing zero fields are suppressed, and each number is printed in hexadecimal,
  71 in a format suitable for input to
  72 .Fn ipx_addr .
  73 Any fields lacking super-decimal digits will have a
  74 trailing
  75 .Ql H
  76 appended.
  77 .Pp
  78 An effort has been made to insure that
  79 .Fn ipx_addr
  80 be compatible with most formats in common use.
  81 It will first separate an address into 1 to 3 fields using a single delimiter
  82 chosen from
  83 period
  84 .Ql \&. ,
  85 colon
  86 .Ql \&:
  87 or pound-sign
  88 .Ql \&# .
  89 Each field is then examined for byte separators (colon or period).
  90 If there are byte separators, each subfield separated is taken to be
  91 a small hexadecimal number, and the entirety is taken as a network-byte-ordered
  92 quantity to be zero extended in the high-network-order bytes.
  93 Next, the field is inspected for hyphens, in which case
  94 the field is assumed to be a number in decimal notation
  95 with hyphens separating the millennia.
  96 Next, the field is assumed to be a number:
  97 It is interpreted
  98 as hexadecimal if there is a leading
  99 .Ql 0x
 100 (as in C),
 101 a trailing
 102 .Ql H
 103 (as in Mesa), or there are any super-decimal digits present.
 104 It is interpreted as octal if there is a leading
 105 .Ql 0
 106 and there are no super-octal digits.
 107 Otherwise, it is converted as a decimal number.
 108 .Sh RETURN VALUES
 109 None. (See
 110 .Sx BUGS . )
 111 .Sh SEE ALSO
 112 .\" .Xr ns 4 ,
 113 .Xr hosts 5 ,
 114 .Xr networks 5
 115 .Sh HISTORY
 116 The precursor
 117 .Fn ns_addr
 118 and
 119 .Fn ns_toa
 120 functions appeared in
 121 .Bx 4.3 .
 122 .Sh BUGS
 123 The string returned by
 124 .Fn ipx_ntoa
 125 resides in a static memory area.
 126 The function
 127 .Fn ipx_addr
 128 should diagnose improperly formed input, and there should be an unambiguous
 129 way to recognize this.