lib/libc/gen/bswap.3

   1 .\" $NetBSD: bswap.3,v 1.10 2005/12/26 19:40:14 perry 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 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 .\" INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .Dd March 17, 1998
  26 .Dt BSWAP 3
  27 .Os
  28 .Sh NAME
  29 .Nm bswap16 ,
  30 .Nm bswap32 ,
  31 .Nm bswap64
  32 .Nd byte-order swapping functions
  33 .Sh LIBRARY
  34 .Lb libc
  35 .Sh SYNOPSIS
  36 .In sys/types.h
  37 .In machine/bswap.h
  38 .Ft uint16_t
  39 .Fn bswap16 "uint16_t"
  40 .Ft uint32_t
  41 .Fn bswap32 "uint32_t"
  42 .Ft uint64_t
  43 .Fn bswap64 "uint64_t"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn bswap16 ,
  47 .Fn bswap32 ,
  48 and
  49 .Fn bswap64
  50 functions return the value of their argument with the bytes inverted.
  51 They can be used to convert 16, 32 or 64 bits integers from little to big
  52 endian, or vice-versa.
  53 .Sh SEE ALSO
  54 .Xr byteorder 3