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