2005-12-26 22:40:14 +03:00
|
|
|
.\" $NetBSD: bswap.3,v 1.10 2005/12/26 19:40:14 perry Exp $
|
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.
|
2003-10-05 21:48:49 +04:00
|
|
|
.\" 3. The name of the author may not be used to endorse or promote products
|
|
|
|
.\" derived from this software without specific prior written permission.
|
1998-03-18 19:40:45 +03:00
|
|
|
.\"
|
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.
|
1998-03-18 19:40:45 +03:00
|
|
|
.\"
|
|
|
|
.Dd March 17, 1998
|
2001-06-05 16:16:23 +04:00
|
|
|
.Dt BSWAP 3
|
1999-03-22 22:44:33 +03:00
|
|
|
.Os
|
1998-03-18 19:40:45 +03:00
|
|
|
.Sh NAME
|
|
|
|
.Nm bswap16 ,
|
|
|
|
.Nm bswap32 ,
|
|
|
|
.Nm bswap64
|
|
|
|
.Nd byte-order swapping functions
|
|
|
|
.Sh LIBRARY
|
1999-01-15 16:31:15 +03:00
|
|
|
.Lb libc
|
1998-03-18 19:40:45 +03:00
|
|
|
.Sh SYNOPSIS
|
2003-04-16 17:34:34 +04:00
|
|
|
.In sys/types.h
|
|
|
|
.In machine/bswap.h
|
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"
|
1998-03-18 19:40:45 +03:00
|
|
|
.Sh DESCRIPTION
|
|
|
|
The
|
|
|
|
.Fn bswap16 ,
|
|
|
|
.Fn bswap32 ,
|
|
|
|
and
|
|
|
|
.Fn bswap64
|
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
|
1998-03-18 19:40:45 +03:00
|
|
|
endian, or vice-versa.
|
|
|
|
.Sh SEE ALSO
|
|
|
|
.Xr byteorder 3
|