Aren
/
NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
NetBSD/lib/libc/gen/bswap.3

55 lines
1.9 KiB
Groff
Raw Normal View History

Remove closes 3 and 4 from my copyright.
2009-10-23 01:50:01 +04:00
.\" $NetBSD: bswap.3,v 1.11 2009/10/22 21:50:01 bouyer Exp $
Add bswap{16,32,64} functions to libutil. Because of this, bump minor.
1998-03-18 19:40:45 +03:00
.\"
.\" Copyright (c) 1998 Manuel Bouyer.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
Use the same copyrigth notice everywhere.
2000-05-15 10:26:42 +04:00
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Add bswap{16,32,64} functions to libutil. Because of this, bump minor.
1998-03-18 19:40:45 +03:00
.\"
.Dd March 17, 1998
Uppercase Dt argument, fix typos, remove an empty line.
2001-06-05 16:16:23 +04:00
.Dt BSWAP 3
Last of the .Os cleanups. .Os is defined in the tmac.doc-common file, so we shouldn't override it with versions in the manpages. Wheee!
1999-03-22 22:44:33 +03:00
.Os
Add bswap{16,32,64} functions to libutil. Because of this, bump minor.
1998-03-18 19:40:45 +03:00
.Sh NAME
.Nm bswap16 ,
.Nm bswap32 ,
.Nm bswap64
.Nd byte-order swapping functions
.Sh LIBRARY
Move the bswap functions from libutil to libc (this bups the minor of libc and the major of libutil). For little-endian architectures merge the bnswap() assembly versions with nto* and hton* using symbols aliasing. Use symbol renaming for the bswap function in this case to avoid namespace pollution. Declare bswap* in machine/bswap.h, not machine/endian.h. For little-endian machines, common code for inline macros go in machine/byte_swap.h Sync libkern with libc. Adjust #include in kernel sources for machine/bswap.h.
1999-01-15 16:31:15 +03:00
.Lb libc
Add bswap{16,32,64} functions to libutil. Because of this, bump minor.
1998-03-18 19:40:45 +03:00
.Sh SYNOPSIS
Use .In header.h instead of .Fd #include \*[Lt]header.h\*[Gt] Much easier to read and write, and supported by groff for ages. Okayed by ross.
2003-04-16 17:34:34 +04:00
.In sys/types.h
.In machine/bswap.h
u_intN_t -> uintN_t
2005-12-26 22:40:14 +03:00
.Ft uint16_t
.Fn bswap16 "uint16_t"
.Ft uint32_t
.Fn bswap32 "uint32_t"
.Ft uint64_t
.Fn bswap64 "uint64_t"
Add bswap{16,32,64} functions to libutil. Because of this, bump minor.
1998-03-18 19:40:45 +03:00
.Sh DESCRIPTION
The
.Fn bswap16 ,
.Fn bswap32 ,
and
.Fn bswap64
Uppercase Dt argument, fix typos, remove an empty line.
2001-06-05 16:16:23 +04:00
functions return the value of their argument with the bytes inverted.
They can be used to convert 16, 32 or 64 bits integers from little to big
Add bswap{16,32,64} functions to libutil. Because of this, bump minor.
1998-03-18 19:40:45 +03:00
endian, or vice-versa.
.Sh SEE ALSO
.Xr byteorder 3