summaryrefslogtreecommitdiff
path: root/src/lib/libc/net/ethers.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libc/net/ethers.3')
-rw-r--r--src/lib/libc/net/ethers.3124
1 files changed, 0 insertions, 124 deletions
diff --git a/src/lib/libc/net/ethers.3 b/src/lib/libc/net/ethers.3
deleted file mode 100644
index 041ee981ec..0000000000
--- a/src/lib/libc/net/ethers.3
+++ /dev/null
@@ -1,124 +0,0 @@
1.\" $OpenBSD: ethers.3,v 1.21 2011/04/19 22:38:26 matthew Exp $
2.\"
3.\" Written by roland@frob.com. Public domain.
4.\"
5.Dd $Mdocdate: April 19 2011 $
6.Dt ETHERS 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.Fd #include <sys/types.h>
17.Fd #include <sys/socket.h>
18.Fd #include <net/if.h>
19.Fd #include <netinet/in.h>
20.Fd #include <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
32Ethernet addresses are represented by the
33following structure:
34.Bd -literal -offset indent
35struct ether_addr {
36 u_int8_t ether_addr_octet[6];
37};
38.Ed
39.Pp
40The
41.Fn ether_ntoa
42function converts this structure into an
43.Tn ASCII
44string of the form
45.Dq xx:xx:xx:xx:xx:xx ,
46consisting of 6 hexadecimal numbers separated
47by colons.
48It returns a pointer to a static buffer that is reused for each call.
49The
50.Fn ether_aton
51converts an
52.Tn ASCII
53string of the same form and to a structure
54containing the 6 octets of the address.
55It returns a pointer to a static structure that is reused for each call.
56.Fn ether_aton
57will return NULL if the string does not represent a valid address.
58.Pp
59The
60.Fn ether_ntohost
61and
62.Fn ether_hostton
63functions interrogate the database mapping host names to Ethernet
64addresses,
65.Pa /etc/ethers .
66The
67.Fn ether_ntohost
68function looks up the given Ethernet address and writes the associated
69host name into the character buffer passed.
70This buffer should be
71.Dv MAXHOSTNAMELEN
72characters in size.
73The
74.Fn ether_hostton
75function looks up the given host name and writes the associated
76Ethernet address into the structure passed.
77Both functions return
78zero if they find the requested host name or address, and \-1 if not.
79.Pp
80Each call reads
81.Pa /etc/ethers
82from the beginning; if a
83.Ql +
84appears alone on a line in the file, then
85.Fn ether_hostton
86will consult the
87.Pa ethers.byname
88YP map, and
89.Fn ether_ntohost
90will consult the
91.Pa ethers.byaddr
92YP map.
93.Pp
94The
95.Fn ether_line
96function parses a line from the
97.Pa /etc/ethers
98file and fills in the passed
99.Li struct ether_addr
100and character buffer with the Ethernet address and host name on the line.
101It returns zero if the line was successfully parsed and \-1 if not.
102The character buffer should be
103.Dv MAXHOSTNAMELEN
104characters in size.
105.Sh FILES
106.Bl -tag -width /etc/ethers -compact
107.It Pa /etc/ethers
108.El
109.Sh SEE ALSO
110.Xr ethers 5
111.Sh HISTORY
112The
113.Fn ether_ntoa ,
114.Fn ether_aton ,
115.Fn ether_ntohost ,
116.Fn ether_hostton ,
117and
118.Fn ether_line
119functions were adopted from SunOS and appeared in
120.Nx 0.9b .
121.Sh BUGS
122The data space used by these functions is static; if future use
123requires the data, it should be copied before any subsequent calls to
124these functions overwrite it.