xref: /freebsd/share/man/man5/ethers.5 (revision e627b39baccd1ec9129690167cf5e6d860509655)
1.\" Copyright (c) 1995
2.\"	Bill Paul <wpaul@ctr.columbia.edu>.  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 Bill Paul.
15.\" 4. Neither the name of the author nor the names of any co-contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\"     $Id: ethers.5,v 1.1 1995/04/12 22:16:08 wpaul Exp $
32.\"
33.Dd April 12, 1995
34.Dt ETHERS 5
35.Os FreeBSD 2.1
36.Sh NAME
37.Nm ethers
38.Nd ethernet address database
39.Sh DESCRIPTION
40The
41.Nm ethers
42database contains information regarding known 48-bit ethernet addresses
43of hosts on an Internetwork. The data is stored in a file called
44.Pa /etc/ethers
45in the following format:
46.Bd -unfilled -offset indent
47.Pa ethernet-address fully-qualified-host-name
48.Ed
49.Pp
50Items are separated by any number of blanks and/or
51tab characters. A ``#'' at the start of a line indicates the
52beginning of a comment that extends to the end of the line. A ``+'' at
53the start of a line will cause the
54.Xr ethers 3
55library functions to use data stored in the NIS
56.Pa ethers.byname
57and
58.Pa ethers.byaddr
59maps in addition to the data in the
60.Pa /etc/ethers
61file.
62.Pp
63An ethernet address is expressed in
64.Tn ASCII
65form as "x:x:x:x:x:x" where
66.Ar x
67is a hexadecimal value between 0x00 and 0xFF. The address values
68should be in network order. Hostnames specified in the
69.Pa /etc/ethers
70database should correspond to entries in the
71.Xr hosts 5
72file.
73.Pp
74The
75.Fn ether_line
76function in the standard C library can be used to break individual
77lines in the
78.Pa /etc/ethers
79database into their individual components: a binary Ethernet address
80stored as an
81.Pa ether_addr
82structure, and a hostname stored as a character string.
83.Sh FILES
84.Bl -tag -width /etc/services -compact
85.It Pa /etc/ethers
86The
87.Nm ethers
88file resides in
89.Pa /etc .
90.El
91.Sh SEE ALSO
92.Xr ethers 3
93.Sh HISTORY
94The
95.Nm ethers
96format is based on the format used in SunOS 4.1.x.
97