packages/net/common/v2_0/doc/manpages/net/ns.3

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