Merge from vendor branch CVS:
[dragonfly.git] / share / man / man5 / eui64.5
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 .\" $FreeBSD: src/share/man/man5/eui64.5,v 1.2 2004/07/07 20:32:33 ru Exp $
32 .\" $DragonFly: src/share/man/man5/eui64.5,v 1.1 2004/09/23 06:33:04 simokawa Exp $
33 .\"
34 .Dd May 11, 2004
35 .Dt EUI64 5
36 .Os
37 .Sh NAME
38 .Nm eui64
39 .Nd IEEE EUI-64 address database
40 .Sh DESCRIPTION
41 The
42 .Nm
43 database contains information regarding known IEEE EUI-64s of hosts.
44 The data is stored in a file called
45 .Pa /etc/eui64
46 in the following format:
47 .Bd -ragged -offset indent
48 .Em EUI-64 host-name
49 .Ed
50 .Pp
51 Items are separated by any number of blanks and/or
52 tab characters.
53 A
54 .Ql #
55 at the start of a line indicates the
56 beginning of a comment that extends to the end of the line.
57 Valid lines may also contain comments.
58 A
59 .Ql +
60 at the start of a line will cause the
61 .Xr eui64 3
62 library functions to use data stored in the
63 NIS
64 .Pa eui64.byname
65 and
66 .Pa eui64.byid
67 maps in addition to the data in the
68 .Pa /etc/eui64
69 file.
70 .Pp
71 An EUI-64 is expressed in
72 .Tn ASCII
73 form as
74 .Qq x-x-x-x-x-x-x-x
75 where
76 .Ar x
77 is a hexadecimal value between 0x00 and 0xFF.
78 The address values
79 should be in network order.
80 Hostnames specified in the
81 .Pa /etc/eui64
82 database should correspond to entries in the
83 .Xr hosts 5
84 file.
85 .\" .Pp
86 .\" The
87 .\" .Fn eui64_line
88 .\" function in the standard C library can be used to break individual
89 .\" lines in the
90 .\" .Pa /etc/eui64
91 .\" database into their individual components: a binary EUI-64 is
92 .\" stored as an
93 .\" .Pa eui64_addr
94 .\" structure, and a hostname stored as a character string.
95 .Sh FILES
96 .Bl -tag -width ".Pa /etc/eui64" -compact
97 .It Pa /etc/eui64
98 The
99 .Nm
100 file resides in
101 .Pa /etc .
102 .El
103 .Sh SEE ALSO
104 .Xr eui64 3 ,
105 .Xr yp 8
106 .Sh HISTORY
107 The
108 .Nm
109 format is based on the
110 .Xr ethers 5
111 format.