string/swab.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)swab.3      8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/string/swab.3,v 1.7 2002/08/30 21:18:39 robert Exp $
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt SWAB 3
  37 .Os
  38 .Sh NAME
  39 .Nm swab
  40 .Nd swap adjacent bytes
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In unistd.h
  45 .Ft void
  46 .Fo swab
  47 .Fa "const void *restrict src"
  48 .Fa "void *restrict dest"
  49 .Fa "ssize_t nbytes"
  50 .Fc
  51 .Sh DESCRIPTION
  52 The function
  53 .Fn swab
  54 copies
  55 .Fa nbytes
  56 bytes from the location referenced by
  57 .Fa src
  58 to the location referenced by
  59 .Fa dest ,
  60 swapping adjacent bytes.
  61 .Pp
  62 The argument
  63 .Fa nbytes
  64 must be an even number.
  65 .Sh LEGACY SYNOPSIS
  66 .Fd #include <string.h>
  67 .Pp
  68 .Ft void
  69 .br
  70 .Fo swab
  71 .Fa "const void *restrict src"
  72 .Fa "void *restrict dest"
  73 .Fa "size_t nbytes"
  74 .Fc ;
  75 .Pp
  76 The include file
  77 .In string.h
  78 is necessary for this function.
  79 The type of
  80 .Fa nbytes
  81 has changed.
  82 .Sh SEE ALSO
  83 .Xr bzero 3 ,
  84 .Xr memset 3 ,
  85 .Xr compat 5
  86 .Sh HISTORY
  87 A
  88 .Fn swab
  89 function appeared in
  90 .At v7 .