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