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