diff options
Diffstat (limited to 'src/lib/libc/net/ethers.3')
-rw-r--r-- | src/lib/libc/net/ethers.3 | 114 |
1 files changed, 0 insertions, 114 deletions
diff --git a/src/lib/libc/net/ethers.3 b/src/lib/libc/net/ethers.3 deleted file mode 100644 index 021e1ced73..0000000000 --- a/src/lib/libc/net/ethers.3 +++ /dev/null | |||
@@ -1,114 +0,0 @@ | |||
1 | .\" $OpenBSD: ethers.3,v 1.25 2018/11/09 17:49:32 brynet Exp $ | ||
2 | .\" | ||
3 | .\" Written by roland@frob.com. Public domain. | ||
4 | .\" | ||
5 | .Dd $Mdocdate: November 9 2018 $ | ||
6 | .Dt ETHER_ATON 3 | ||
7 | .Os | ||
8 | .Sh NAME | ||
9 | .Nm ether_aton , | ||
10 | .Nm ether_ntoa , | ||
11 | .Nm ether_ntohost , | ||
12 | .Nm ether_hostton , | ||
13 | .Nm ether_line | ||
14 | .Nd get ethers entry | ||
15 | .Sh SYNOPSIS | ||
16 | .In sys/types.h | ||
17 | .In sys/socket.h | ||
18 | .In net/if.h | ||
19 | .In netinet/in.h | ||
20 | .In netinet/if_ether.h | ||
21 | .Ft char * | ||
22 | .Fn ether_ntoa "struct ether_addr *e" | ||
23 | .Ft struct ether_addr * | ||
24 | .Fn ether_aton "const char *s" | ||
25 | .Ft int | ||
26 | .Fn ether_ntohost "char *hostname" "struct ether_addr *e" | ||
27 | .Ft int | ||
28 | .Fn ether_hostton "const char *hostname" "struct ether_addr *e" | ||
29 | .Ft int | ||
30 | .Fn ether_line "const char *l" "struct ether_addr *e" "char *hostname" | ||
31 | .Sh DESCRIPTION | ||
32 | Ethernet addresses are represented by the | ||
33 | following structure: | ||
34 | .Bd -literal -offset indent | ||
35 | struct ether_addr { | ||
36 | u_int8_t ether_addr_octet[ETHER_ADDR_LEN]; | ||
37 | }; | ||
38 | .Ed | ||
39 | .Pp | ||
40 | The | ||
41 | .Fn ether_ntoa | ||
42 | function converts this structure into an | ||
43 | .Tn ASCII | ||
44 | string of the form | ||
45 | .Dq xx:xx:xx:xx:xx:xx , | ||
46 | consisting of 6 hexadecimal numbers separated | ||
47 | by colons. | ||
48 | It returns a pointer to a static buffer that is reused for each call. | ||
49 | The | ||
50 | .Fn ether_aton | ||
51 | converts an | ||
52 | .Tn ASCII | ||
53 | string of the same form and to a structure | ||
54 | containing the 6 octets of the address. | ||
55 | It returns a pointer to a static structure that is reused for each call. | ||
56 | .Fn ether_aton | ||
57 | will return NULL if the string does not represent a valid address. | ||
58 | .Pp | ||
59 | The | ||
60 | .Fn ether_ntohost | ||
61 | and | ||
62 | .Fn ether_hostton | ||
63 | functions interrogate the database mapping host names to Ethernet | ||
64 | addresses, | ||
65 | .Pa /etc/ethers . | ||
66 | The | ||
67 | .Fn ether_ntohost | ||
68 | function looks up the given Ethernet address and writes the associated | ||
69 | host name into the character buffer passed. | ||
70 | This buffer should be | ||
71 | .Dv MAXHOSTNAMELEN | ||
72 | characters in size. | ||
73 | The | ||
74 | .Fn ether_hostton | ||
75 | function looks up the given host name and writes the associated | ||
76 | Ethernet address into the structure passed. | ||
77 | Both functions return | ||
78 | zero if they find the requested host name or address, and \-1 if not. | ||
79 | .Pp | ||
80 | Each call reads | ||
81 | .Pa /etc/ethers | ||
82 | from the beginning. | ||
83 | .Pp | ||
84 | The | ||
85 | .Fn ether_line | ||
86 | function parses a line from the | ||
87 | .Pa /etc/ethers | ||
88 | file and fills in the passed | ||
89 | .Li struct ether_addr | ||
90 | and character buffer with the Ethernet address and host name on the line. | ||
91 | It returns zero if the line was successfully parsed and \-1 if not. | ||
92 | The character buffer should be | ||
93 | .Dv MAXHOSTNAMELEN | ||
94 | characters in size. | ||
95 | .Sh FILES | ||
96 | .Bl -tag -width /etc/ethers -compact | ||
97 | .It Pa /etc/ethers | ||
98 | .El | ||
99 | .Sh SEE ALSO | ||
100 | .Xr ethers 5 | ||
101 | .Sh HISTORY | ||
102 | The | ||
103 | .Fn ether_ntoa , | ||
104 | .Fn ether_aton , | ||
105 | .Fn ether_ntohost , | ||
106 | .Fn ether_hostton , | ||
107 | and | ||
108 | .Fn ether_line | ||
109 | functions were adopted from SunOS and appeared in | ||
110 | .Nx 0.9b . | ||
111 | .Sh BUGS | ||
112 | The data space used by these functions is static; if future use | ||
113 | requires the data, it should be copied before any subsequent calls to | ||
114 | these functions overwrite it. | ||