lib/libc/net/iso_addr.3

   1 .\" Copyright (c) 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 .\"     @(#)iso_addr.3  8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/net/iso_addr.3,v 1.3.2.4 2001/12/14 18:33:55 ru Exp $
  34 .\" $DragonFly: src/lib/libc/net/iso_addr.3,v 1.2 2003/06/17 04:26:44 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt ISO_ADDR 3
  38 .Os
  39 .Sh NAME
  40 .Nm iso_addr ,
  41 .Nm iso_ntoa
  42 .Nd "elementary network address conversion routines for Open System Interconnection
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In sys/types.h
  47 .In netiso/iso.h
  48 .Ft struct iso_addr *
  49 .Fn iso_addr "char *cp"
  50 .Ft char *
  51 .Fn iso_ntoa "struct iso_addr *isoa"
  52 .Sh DESCRIPTION
  53 The routine
  54 .Fn iso_addr
  55 interprets character strings representing
  56 .Tn OSI
  57 addresses, returning binary information suitable
  58 for use in system calls.
  59 The routine
  60 .Fn iso_ntoa
  61 takes
  62 .Tn OSI
  63 addresses and returns
  64 .Tn ASCII
  65 strings representing NSAPs (network service
  66 access points) in a
  67 notation inverse to that accepted by
  68 .Fn iso_addr .
  69 .Pp
  70 Unfortunately, no universal standard exists for representing
  71 .Tn OSI
  72 network addresses.
  73 .Pp
  74 The format employed by
  75 .Fn iso_addr
  76 is a sequence of hexadecimal
  77 .Dq digits
  78 (optionally separated by periods),
  79 of the form:
  80 .Bd -ragged -offset indent
  81 <hex digits>.<hex digits>.<hex digits>
  82 .Ed
  83 .Pp
  84 Each pair of hexadecimal digits represents a byte
  85 with the leading digit indicating the higher-ordered bits.
  86 A period following an even number of bytes has no
  87 effect (but may be used to increase legibility).
  88 A period following an odd number of bytes has the
  89 effect of causing the byte of address being translated
  90 to have its higher order bits filled with zeros.
  91 .Sh RETURN VALUES
  92 .Fn iso_ntoa
  93 always returns a null terminated string.
  94 .Fn iso_addr
  95 always returns a pointer to a struct iso_addr.
  96 (See
  97 .Sx BUGS . )
  98 .Sh SEE ALSO
  99 .Xr iso 4
 100 .Sh HISTORY
 101 The
 102 .Fn iso_addr
 103 and
 104 .Fn iso_ntoa
 105 functions appeared in
 106 .Bx 4.3 Reno .
 107 .Sh BUGS
 108 The returned values
 109 reside in a static memory area.
 110 .Pp
 111 The function
 112 .Fn iso_addr
 113 should diagnose improperly formed input, and there should be an unambiguous
 114 way to recognize this.