aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRuslan Ermilov <ru@FreeBSD.org>2003-05-21 15:52:43 +0000
committerRuslan Ermilov <ru@FreeBSD.org>2003-05-21 15:52:43 +0000
commit923d84c0bcd6253a158ec4f56b8ac44fb53a7b0a (patch)
treeebab8bd640c68d249e7b17fb0e25babf6160be54
parentc8185672b28957105341b2ce95fd497e209ad64c (diff)
downloadsrc-923d84c0bcd6253a158ec4f56b8ac44fb53a7b0a.tar.gz
src-923d84c0bcd6253a158ec4f56b8ac44fb53a7b0a.zip
mdoc(7) fixes.
This manpage should really have only one short description (.Nd); if anyone could come up with a wording suitable for both conversion and decoding/encoding functions, that would unbreak the whatis(1) output for this manpage. Approved by: re (blanket)
Notes
Notes: svn path=/head/; revision=115210
-rw-r--r--share/man/man9/byteorder.954
1 files changed, 30 insertions, 24 deletions
diff --git a/share/man/man9/byteorder.9 b/share/man/man9/byteorder.9
index 8958bc71f4f6..f225f963d2e0 100644
--- a/share/man/man9/byteorder.9
+++ b/share/man/man9/byteorder.9
@@ -28,21 +28,13 @@
.Dt BYTEORDER 9
.Os
.Sh NAME
-.Nm be16toh ,
-.Nm be32toh ,
-.Nm be64toh ,
-.Nm htobe16 ,
-.Nm htobe32 ,
-.Nm htobe64 ,
-.Nm htole16 ,
-.Nm htole32 ,
-.Nm htole64 ,
-.Nm le16toh ,
-.Nm le32toh ,
-.Nm le64toh
+.Nm be16toh , be32toh , be64toh , htobe16 , htobe32 , htobe64 ,
+.Nm htole16 , htole32 , htole64 , le16toh , le32toh , le64toh
.Nd convert values between big endian, little endian, and host byte order
+.\" XXX the following breaks whatis(1)
.Pp
-.Nm {be,le}{16,32,64}{enc,dec}
+.Nm be16enc , be16dec , be32enc , be32dec , be64enc , be64dec ,
+.Nm le16enc , le16dec , le32enc , le32dec , le64enc , le64dec
.Nd encode and decode big or little endian values to and from byte strings
.Sh SYNOPSIS
.In sys/endian.h
@@ -89,17 +81,17 @@
.Ft uint64_t
.Fn le64dec "const void *"
.Ft void
-.Fn be16enc "void *, uint16_t"
+.Fn be16enc "void *" uint16_t
.Ft void
-.Fn be32enc "void *, uint32_t"
+.Fn be32enc "void *" uint32_t
.Ft void
-.Fn be64enc "void *, uint64_t"
+.Fn be64enc "void *" uint64_t
.Ft void
-.Fn le16enc "void *, uint16_t"
+.Fn le16enc "void *" uint16_t
.Ft void
-.Fn le32enc "void *, uint32_t"
+.Fn le32enc "void *" uint32_t
.Ft void
-.Fn le64enc "void *, uint64_t"
+.Fn le64enc "void *" uint64_t
.Sh DESCRIPTION
The
.Fn bswap16 ,
@@ -147,19 +139,33 @@ byte order converted to little endian byte order.
The return value will be the same as the argument on little endian systems.
.Pp
The
-.Fn {be,le}{16,32,64}{enc,dec}
+.Fn be16enc ,
+.Fn be16dec ,
+.Fn be32enc ,
+.Fn be32dec ,
+.Fn be64enc ,
+.Fn be64dec ,
+.Fn le16enc ,
+.Fn le16dec ,
+.Fn le32enc ,
+.Fn le32dec ,
+.Fn le64enc ,
+and
+.Fn le64dec
functions encode and decode integers to/from byte strings on any alignment
in big/little endian format.
.Sh SEE ALSO
.Xr byteorder 3
.Sh HISTORY
-The hto* and toh* functions first appeared in
+The
+.Fn hto*
+and
+.Fn toh*
+functions first appeared in
.Fx 5.0 ,
and were originally developed by the
.Nx
project.
.Pp
-The
-.Fn {be,le}{16,32,64}{enc,dec}
-Functions first appeared in
+The encode/decode functions first appeared in
.Fx 5.1 .