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

   1 .\"     $OpenBSD: link_addr.3,v 1.7 2000/04/18 03:01:32 aaron Exp $
   2 .\"
   3 .\" Copyright (c) 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" Donn Seeley at BSDI.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. All advertising materials mentioning features or use of this software
  18 .\"    must display the following acknowledgement:
  19 .\"     This product includes software developed by the University of
  20 .\"     California, Berkeley and its contributors.
  21 .\" 4. Neither the name of the University nor the names of its contributors
  22 .\"    may be used to endorse or promote products derived from this software
  23 .\"    without specific prior written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35 .\" SUCH DAMAGE.
  36 .\"
  37 .Dd July 28, 1993
  38 .Dt LINK_ADDR 3
  39 .Os
  40 .Sh NAME
  41 .Nm link_addr ,
  42 .Nm link_ntoa
  43 .Nd elementary address specification routines for link level access
  44 .Sh SYNOPSIS
  45 .Fd #include <sys/types.h>
  46 .Fd #include <sys/socket.h>
  47 .Fd #include <net/if_dl.h>
  48 .Ft void
  49 .Fn link_addr "const char *addr" "struct sockaddr_dl *sdl"
  50 .Ft char *
  51 .Fn link_ntoa "const struct sockaddr_dl *sdl"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn link_addr
  55 function interprets character strings representing
  56 link-level addresses, returning binary information suitable
  57 for use in system calls.
  58 .Fn link_ntoa
  59 takes
  60 a link-level
  61 address and returns an
  62 .Tn ASCII
  63 string representing some of the information present,
  64 including the link level address itself, and the interface name
  65 or number, if present.
  66 This facility is experimental and is
  67 still subject to change.
  68 .Pp
  69 For
  70 .Fn link_addr ,
  71 the string
  72 .Fa addr
  73 may contain
  74 an optional network interface identifier of the form
  75 .Dq name unit-number ,
  76 suitable for the first argument to
  77 .Xr ifconfig 8 ,
  78 followed in all cases by a colon and
  79 an interface address in the form of
  80 groups of hexadecimal digits
  81 separated by periods.
  82 Each group represents a byte of address;
  83 address bytes are filled left to right from
  84 low order bytes through high order bytes.
  85 .Pp
  86 .\" A regular expression may make this format clearer:
  87 .\" .Bd -literal -offset indent
  88 .\" ([a-z]+[0-9]+:)?[0-9a-f]+(\e.[0-9a-f]+)*
  89 .\" .Ed
  90 .\" .Pp
  91 Thus
  92 .Li le0:8.0.9.13.d.30
  93 represents an Ethernet address
  94 to be transmitted on the first Lance Ethernet interface.
  95 .Sh RETURN VALUES
  96 .Fn link_ntoa
  97 always returns a null-terminated string.
  98 .Fn link_addr
  99 has no return value.
 100 (See
 101 .Sx BUGS . )
 102 .Sh SEE ALSO
 103 .Xr iso 4 ,
 104 .Xr ifconfig 8
 105 .Sh HISTORY
 106 The
 107 .Fn link_addr
 108 and
 109 .Fn link_ntoa
 110 functions appeared in
 111 .Bx 4.3 Reno .
 112 .Sh BUGS
 113 The returned values for link_ntoa
 114 reside in a static memory area.
 115 .Pp
 116 The function
 117 .Fn link_addr
 118 should diagnose improperly formed input, and there should be an unambiguous
 119 way to recognize this.
 120 .Pp
 121 If the
 122 .Fa sdl_len
 123 field of the link socket address
 124 .Fa sdl
 125 is 0,
 126 .Fn link_ntoa
 127 will not insert a colon before the interface address bytes.
 128 If this translated address is given to
 129 .Fn link_addr
 130 without inserting an initial colon,
 131 the latter will not interpret it correctly.