Sync lib/libc/string with FreeBSD:
[dragonfly.git] / lib / libc / 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 .\" 4. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     @(#)swab.3      8.1 (Berkeley) 6/4/93
29 .\" $FreeBSD: src/lib/libc/string/swab.3,v 1.10 2007/01/09 00:28:12 imp Exp $
30 .\" $DragonFly: src/lib/libc/string/swab.3,v 1.2 2003/06/17 04:26:47 dillon Exp $
31 .\"
32 .Dd December 10, 2004
33 .Dt SWAB 3
34 .Os
35 .Sh NAME
36 .Nm swab
37 .Nd swap adjacent bytes
38 .Sh LIBRARY
39 .Lb libc
40 .Sh SYNOPSIS
41 .In unistd.h
42 .Ft void
43 .Fn swab "const void * restrict src" "void * restrict dst" "ssize_t len"
44 .Sh DESCRIPTION
45 The function
46 .Fn swab
47 copies
48 .Fa len
49 bytes from the location referenced by
50 .Fa src
51 to the location referenced by
52 .Fa dst ,
53 swapping adjacent bytes.
54 .Pp
55 The argument
56 .Fa len
57 must be an even number.
58 .Sh SEE ALSO
59 .Xr bzero 3 ,
60 .Xr memset 3
61 .Sh HISTORY
62 A
63 .Fn swab
64 function appeared in
65 .At v7 .