xref: /netbsd-src/lib/libc/gen/bswap.3 (revision de1dfb1250df962f1ff3a011772cf58e605aed11)
1.\" $NetBSD: bswap.3,v 1.9 2003/10/05 17:48:49 bouyer Exp $
2.\"
3.\" Copyright (c) 1998 Manuel Bouyer.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\" 3. The name of the author may not be used to endorse or promote products
14.\"    derived from this software without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24.\" INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd March 17, 1998
28.Dt BSWAP 3
29.Os
30.Sh NAME
31.Nm bswap16 ,
32.Nm bswap32 ,
33.Nm bswap64
34.Nd byte-order swapping functions
35.Sh LIBRARY
36.Lb libc
37.Sh SYNOPSIS
38.In sys/types.h
39.In machine/bswap.h
40.Ft u_int16_t
41.Fn bswap16 "u_int16_t"
42.Ft u_int32_t
43.Fn bswap32 "u_int32_t"
44.Ft u_int64_t
45.Fn bswap64 "u_int64_t"
46.Sh DESCRIPTION
47The
48.Fn bswap16 ,
49.Fn bswap32 ,
50and
51.Fn bswap64
52functions return the value of their argument with the bytes inverted.
53They can be used to convert 16, 32 or 64 bits integers from little to big
54endian, or vice-versa.
55.Sh SEE ALSO
56.Xr byteorder 3
57