xref: /dragonfly/share/man/man9/kether_ntoa.9 (revision 25a2db75)
1.\"
2.\" Copyright (c) 2013 The DragonFly Project.  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.\"
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in
12.\"    the documentation and/or other materials provided with the
13.\"    distribution.
14.\" 3. Neither the name of The DragonFly Project nor the names of its
15.\"    contributors may be used to endorse or promote products derived
16.\"    from this software without specific, prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
22.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
24.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.Dd February 7, 2012
32.Dt KETHER_NTOA 9
33.Os
34.Sh NAME
35.Nm kether_ntoa, kether_aton
36.Nd ethernet address conversion routines
37.Sh SYNOPSIS
38.In net/if_var.h
39.Ft char *
40.Fn kether_ntoa "const u_char *addr" "char *buf"
41.Ft u_char *
42.Fn kether_aton "const char *macstr" "u_char *addr"
43.Sh DESCRIPTION
44The
45.Fn kether_ntoa
46function converts the ethernet address specified in
47.Fa addr
48to its corresponding hexadecimal ASCII representation.
49Likewise, the
50.Fn kether_aton
51function converts an ASCII
52string specified in
53.Fa macstr
54to an ethernet address.
55.Pp
56.Fn kether_ntoa
57serves a similar purpose as the former, non-standard
58.Cm D
59conversion of
60.Xr kprintf 9
61(as in,
62.Dq %6D )
63which some
64.Bx Ns s
65still have.
66.Pp
67Notational conventions for hexadecimal ASCII
68representation of a MAC
69address are specified in IEEE 802.
70.Sh RETURN VALUES
71The
72.Fn kether_ntoa
73function returns a pointer to the string containing the hexadecimal ASCII
74representation of the ethernet address passed in
75.Fa addr ,
76or NULL in the case of failure.
77.Pp
78The
79.Fn kether_aton
80function returns a pointer to a block of bytes containing the conversion
81of the specified ASCII
82string in
83.Fa macstr ,
84or NULL in the case of failure.
85.Sh SEE ALSO
86.Xr ascii 7 ,
87.Xr hexdump 9 ,
88.Xr hexncpy 9
89.Sh HISTORY
90The
91.Fn kether_ntoa
92and
93.Fn kether_aton
94functions first appeared in
95.Dx 3.3 .
96