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