2004-11-03 13:51:07 +00:00
|
|
|
.\" Hey Emacs! This file is -*- nroff -*- source.
|
|
|
|
.\"
|
|
|
|
.\" Copyright 2002 Ian Redfern (redferni@logica.com)
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
|
|
|
.\" References consulted:
|
|
|
|
.\" Linux libc source code
|
|
|
|
.\" FreeBSD 4.4 man pages
|
|
|
|
.\"
|
|
|
|
.\" Minor additions, aeb, 2002-07-20
|
|
|
|
.\"
|
2007-05-18 09:55:10 +00:00
|
|
|
.TH ETHER_ATON 3 2002-07-20 "GNU" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
2007-04-12 22:42:49 +00:00
|
|
|
ether_aton, ether_ntoa, ether_ntohost, ether_hostton, ether_line,
|
2004-11-03 13:51:07 +00:00
|
|
|
ether_ntoa_r, ether_aton_r \- Ethernet address manipulation routines
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <netinet/ether.h>
|
|
|
|
.sp
|
2007-04-03 15:32:52 +00:00
|
|
|
.BI "char *ether_ntoa(const struct ether_addr *" addr );
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
2007-04-03 15:32:52 +00:00
|
|
|
.BI "struct ether_addr *ether_aton(const char *" asc );
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
2007-04-03 15:32:52 +00:00
|
|
|
.BI "int ether_ntohost(char *" hostname ", const struct ether_addr *" addr );
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
2007-04-03 15:32:52 +00:00
|
|
|
.BI "int ether_hostton(const char *" hostname ", struct ether_addr *" addr );
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
2007-04-03 15:32:52 +00:00
|
|
|
.BI "int ether_line(const char *" line ", struct ether_addr *" addr ,
|
|
|
|
.BI " char *" hostname );
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
|
|
|
/* GNU extensions */
|
|
|
|
.br
|
2007-04-03 15:32:52 +00:00
|
|
|
.BI "char *ether_ntoa_r(const struct ether_addr *" addr ", char *" buf );
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
2007-04-12 22:42:49 +00:00
|
|
|
.BI "struct ether_addr *ether_aton_r(const char *" asc ,
|
2007-04-03 15:32:52 +00:00
|
|
|
.BI " struct ether_addr *" addr );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR ether_aton ()
|
|
|
|
converts the 48-bit Ethernet host address \fIasc\fP
|
2004-11-03 13:51:07 +00:00
|
|
|
from the standard hex-digits-and-colons notation into binary data in
|
|
|
|
network byte order and returns a pointer to it in a statically
|
|
|
|
allocated buffer, which subsequent calls will
|
2007-05-12 09:06:04 +00:00
|
|
|
overwrite.
|
|
|
|
.BR ether_aton ()
|
|
|
|
returns NULL if the address is invalid.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR ether_ntoa ()
|
|
|
|
function converts the Ethernet host address
|
2004-11-03 13:51:07 +00:00
|
|
|
\fIaddr\fP given in network byte order to a string in standard
|
2008-03-19 09:04:12 +00:00
|
|
|
hex-digits-and-colons notation, omitting leading zeros.
|
2004-11-03 13:51:07 +00:00
|
|
|
The string is returned in a statically allocated buffer,
|
|
|
|
which subsequent calls will overwrite.
|
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR ether_ntohost ()
|
|
|
|
function maps an Ethernet address to the
|
2007-04-12 22:42:49 +00:00
|
|
|
corresponding hostname in
|
2005-11-02 11:55:24 +00:00
|
|
|
.I /etc/ethers
|
intro.1, time.1, adjtimex.2, capget.2, eventfd.2, fcntl.2, getrlimit.2, getsockopt.2, gettimeofday.2, intro.2, ioctl_list.2, ioperm.2, mlock.2, pivot_root.2, poll.2, prctl.2, ptrace.2, sched_setscheduler.2, select_tut.2, semget.2, sigaltstack.2, signalfd.2, sysctl.2, timer_settime.2, timerfd_create.2, wait.2, CPU_SET.3, argz_add.3, assert_perror.3, atexit.3, backtrace.3, bcmp.3, clearenv.3, ctime.3, dl_iterate_phdr.3, dlopen.3, ecvt.3, errno.3, error.3, ether_aton.3, exit.3, fenv.3, ferror.3, finite.3, flockfile.3, fnmatch.3, fpathconf.3, fpclassify.3, ftime.3, ftok.3, ftw.3, fwide.3, getaddrinfo.3, gethostbyname.3, getlogin.3, getnameinfo.3, getnetent.3, getopt.3, getprotoent.3, getrpcent.3, getservent.3, glob.3, hsearch.3, inet.3, isalpha.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, longjmp.3, lsearch.3, malloc.3, matherr.3, mblen.3, mbsinit.3, mbtowc.3, on_exit.3, printf.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_equal.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, ptsname.3, putenv.3, putgrent.3, raise.3, rcmd.3, regex.3, rexec.3, rpc.3, rpmatch.3, rtnetlink.3, scandir.3, sem_init.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, signbit.3, stdio_ext.3, strtod.3, strtol.3, strtoul.3, system.3, termios.3, timeradd.3, tzset.3, ualarm.3, wctomb.3, xdr.3, st.4, tty_ioctl.4, core.5, elf.5, proc.5, bootparam.7, capabilities.7, icmp.7, ip.7, ipv6.7, math_error.7, mdoc.samples.7, mq_overview.7, pthreads.7, raw.7, regex.7, socket.7, tcp.7, tzselect.8: Global fix: s/non-zero/nonzero/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:40:55 +00:00
|
|
|
and returns nonzero if it cannot be found.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR ether_hostton ()
|
|
|
|
function maps a hostname to the
|
2004-11-03 13:51:07 +00:00
|
|
|
corresponding Ethernet address in
|
2005-11-02 11:55:24 +00:00
|
|
|
.I /etc/ethers
|
intro.1, time.1, adjtimex.2, capget.2, eventfd.2, fcntl.2, getrlimit.2, getsockopt.2, gettimeofday.2, intro.2, ioctl_list.2, ioperm.2, mlock.2, pivot_root.2, poll.2, prctl.2, ptrace.2, sched_setscheduler.2, select_tut.2, semget.2, sigaltstack.2, signalfd.2, sysctl.2, timer_settime.2, timerfd_create.2, wait.2, CPU_SET.3, argz_add.3, assert_perror.3, atexit.3, backtrace.3, bcmp.3, clearenv.3, ctime.3, dl_iterate_phdr.3, dlopen.3, ecvt.3, errno.3, error.3, ether_aton.3, exit.3, fenv.3, ferror.3, finite.3, flockfile.3, fnmatch.3, fpathconf.3, fpclassify.3, ftime.3, ftok.3, ftw.3, fwide.3, getaddrinfo.3, gethostbyname.3, getlogin.3, getnameinfo.3, getnetent.3, getopt.3, getprotoent.3, getrpcent.3, getservent.3, glob.3, hsearch.3, inet.3, isalpha.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, longjmp.3, lsearch.3, malloc.3, matherr.3, mblen.3, mbsinit.3, mbtowc.3, on_exit.3, printf.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_equal.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, ptsname.3, putenv.3, putgrent.3, raise.3, rcmd.3, regex.3, rexec.3, rpc.3, rpmatch.3, rtnetlink.3, scandir.3, sem_init.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, signbit.3, stdio_ext.3, strtod.3, strtol.3, strtoul.3, system.3, termios.3, timeradd.3, tzset.3, ualarm.3, wctomb.3, xdr.3, st.4, tty_ioctl.4, core.5, elf.5, proc.5, bootparam.7, capabilities.7, icmp.7, ip.7, ipv6.7, math_error.7, mdoc.samples.7, mq_overview.7, pthreads.7, raw.7, regex.7, socket.7, tcp.7, tzselect.8: Global fix: s/non-zero/nonzero/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:40:55 +00:00
|
|
|
and returns nonzero if it cannot be found.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR ether_line ()
|
|
|
|
function parses a line in
|
2005-11-02 11:55:24 +00:00
|
|
|
.I /etc/ethers
|
2004-11-03 13:51:07 +00:00
|
|
|
format (ethernet address followed by whitespace followed by
|
2008-06-09 15:49:35 +00:00
|
|
|
hostname; \(aq#\(aq introduces a comment) and returns an address
|
intro.1, time.1, adjtimex.2, capget.2, eventfd.2, fcntl.2, getrlimit.2, getsockopt.2, gettimeofday.2, intro.2, ioctl_list.2, ioperm.2, mlock.2, pivot_root.2, poll.2, prctl.2, ptrace.2, sched_setscheduler.2, select_tut.2, semget.2, sigaltstack.2, signalfd.2, sysctl.2, timer_settime.2, timerfd_create.2, wait.2, CPU_SET.3, argz_add.3, assert_perror.3, atexit.3, backtrace.3, bcmp.3, clearenv.3, ctime.3, dl_iterate_phdr.3, dlopen.3, ecvt.3, errno.3, error.3, ether_aton.3, exit.3, fenv.3, ferror.3, finite.3, flockfile.3, fnmatch.3, fpathconf.3, fpclassify.3, ftime.3, ftok.3, ftw.3, fwide.3, getaddrinfo.3, gethostbyname.3, getlogin.3, getnameinfo.3, getnetent.3, getopt.3, getprotoent.3, getrpcent.3, getservent.3, glob.3, hsearch.3, inet.3, isalpha.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, longjmp.3, lsearch.3, malloc.3, matherr.3, mblen.3, mbsinit.3, mbtowc.3, on_exit.3, printf.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_equal.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, ptsname.3, putenv.3, putgrent.3, raise.3, rcmd.3, regex.3, rexec.3, rpc.3, rpmatch.3, rtnetlink.3, scandir.3, sem_init.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, signbit.3, stdio_ext.3, strtod.3, strtol.3, strtoul.3, system.3, termios.3, timeradd.3, tzset.3, ualarm.3, wctomb.3, xdr.3, st.4, tty_ioctl.4, core.5, elf.5, proc.5, bootparam.7, capabilities.7, icmp.7, ip.7, ipv6.7, math_error.7, mdoc.samples.7, mq_overview.7, pthreads.7, raw.7, regex.7, socket.7, tcp.7, tzselect.8: Global fix: s/non-zero/nonzero/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:40:55 +00:00
|
|
|
and hostname pair, or nonzero if it cannot be parsed.
|
2004-11-03 13:51:07 +00:00
|
|
|
The buffer pointed to by
|
|
|
|
.I hostname
|
2007-06-08 11:56:22 +00:00
|
|
|
must be sufficiently long, for example, have the same length as
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR line .
|
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
The functions
|
|
|
|
.BR ether_ntoa_r ()
|
|
|
|
and
|
|
|
|
.BR ether_aton_r ()
|
2008-03-19 08:49:50 +00:00
|
|
|
are reentrant
|
2008-03-19 08:48:08 +00:00
|
|
|
thread-safe versions of
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR ether_ntoa ()
|
|
|
|
and
|
|
|
|
.BR ether_aton ()
|
2004-11-03 13:51:07 +00:00
|
|
|
respectively, and do not use static buffers.
|
|
|
|
.PP
|
2007-12-11 16:57:30 +00:00
|
|
|
The structure \fIether_addr\fP is defined in
|
2007-12-10 07:11:19 +00:00
|
|
|
.I <net/ethernet.h>
|
|
|
|
as:
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
2007-12-19 05:53:30 +00:00
|
|
|
.in +4n
|
2004-11-03 13:51:07 +00:00
|
|
|
.nf
|
|
|
|
struct ether_addr {
|
2007-12-23 17:26:26 +00:00
|
|
|
uint8_t ether_addr_octet[6];
|
2004-11-03 13:51:07 +00:00
|
|
|
}
|
|
|
|
.fi
|
2007-12-19 05:53:30 +00:00
|
|
|
.in
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "CONFORMING TO"
|
2008-07-15 13:39:17 +00:00
|
|
|
4.3BSD, SunOS.
|
2007-05-19 04:30:20 +00:00
|
|
|
.SH BUGS
|
2007-12-13 20:46:52 +00:00
|
|
|
The glibc 2.2.5 implementation of
|
|
|
|
.BR ether_line ()
|
|
|
|
is broken.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR ethers (5)
|