endian.3: CONFORMING TO: Explain differences in function names across systems

glibc/NetBSD/FreeBSD follow a naming convention for these
functions that unfortunately differs from that originally
established by OpenBSD's implementation.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2009-01-18 13:53:05 +13:00
parent 67b59ff59d
commit 373d0736d1
1 changed files with 11 additions and 2 deletions

View File

@ -23,7 +23,7 @@
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.TH ENDIAN 3 2009-01-15 "GNU" "Linux Programmer's Manual"
.TH ENDIAN 3 2009-01-19 "GNU" "Linux Programmer's Manual"
.SH NAME
htobe16, htole16, be16toh, le16toh, htobe32, htole32, be32toh, le32toh,
htobe64, htole64, be64toh, le64toh \-
@ -72,11 +72,20 @@ from little-endian order to host byte order.
.SH VERSIONS
These function were added to glibc in version 2.9.
.SH "CONFORMING TO"
These functions are non-standard, but present on the BSDs,
These functions are non-standard.
Similar functions are present on the BSDs,
where the required header file is
.I <sys/endian.h>
instead of
.IR <endian.h> .
Unfortunately,
NetBSD, FreeBSD, and glibc haven't followed the original
OpenBSD naming convention for these functions,
whereby the
.I nn
component always appears at the end of the function name
(thus, for example, in NetBSD, FreeBSD, and glibc,
the equivalent of OpenBSDs "betoh32" is "be32toh").
.SH NOTES
These functions are similar to the older
.BR byteorder (3)