xref: /freebsd/lib/libc/string/swab.3 (revision 3fb3b97c4d38990da5f45b37e48a5110b3e9bc58)
158f0484fSRodney W. Grimes.\" Copyright (c) 1990, 1991, 1993
258f0484fSRodney W. Grimes.\"	The Regents of the University of California.  All rights reserved.
358f0484fSRodney W. Grimes.\"
458f0484fSRodney W. Grimes.\" Redistribution and use in source and binary forms, with or without
558f0484fSRodney W. Grimes.\" modification, are permitted provided that the following conditions
658f0484fSRodney W. Grimes.\" are met:
758f0484fSRodney W. Grimes.\" 1. Redistributions of source code must retain the above copyright
858f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer.
958f0484fSRodney W. Grimes.\" 2. Redistributions in binary form must reproduce the above copyright
1058f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer in the
1158f0484fSRodney W. Grimes.\"    documentation and/or other materials provided with the distribution.
12*3fb3b97cSEd Maste.\" 3. Neither the name of the University nor the names of its contributors
1358f0484fSRodney W. Grimes.\"    may be used to endorse or promote products derived from this software
1458f0484fSRodney W. Grimes.\"    without specific prior written permission.
1558f0484fSRodney W. Grimes.\"
1658f0484fSRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
1758f0484fSRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1858f0484fSRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1958f0484fSRodney W. Grimes.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2058f0484fSRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2158f0484fSRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2258f0484fSRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2358f0484fSRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2458f0484fSRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2558f0484fSRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2658f0484fSRodney W. Grimes.\" SUCH DAMAGE.
2758f0484fSRodney W. Grimes.\"
2858f0484fSRodney W. Grimes.\"     @(#)swab.3	8.1 (Berkeley) 6/4/93
297f3dea24SPeter Wemm.\" $FreeBSD$
3058f0484fSRodney W. Grimes.\"
310a0c8e01SEitan Adler.Dd March 4, 2012
3258f0484fSRodney W. Grimes.Dt SWAB 3
3358f0484fSRodney W. Grimes.Os
3458f0484fSRodney W. Grimes.Sh NAME
3558f0484fSRodney W. Grimes.Nm swab
3658f0484fSRodney W. Grimes.Nd swap adjacent bytes
3725bb73e0SAlexey Zelkin.Sh LIBRARY
3825bb73e0SAlexey Zelkin.Lb libc
3958f0484fSRodney W. Grimes.Sh SYNOPSIS
402f5cde3cSTom Rhodes.In unistd.h
4158f0484fSRodney W. Grimes.Ft void
422f5cde3cSTom Rhodes.Fn swab "const void * restrict src" "void * restrict dst" "ssize_t len"
4358f0484fSRodney W. Grimes.Sh DESCRIPTION
4458f0484fSRodney W. GrimesThe function
4558f0484fSRodney W. Grimes.Fn swab
4658f0484fSRodney W. Grimescopies
4758f0484fSRodney W. Grimes.Fa len
4858f0484fSRodney W. Grimesbytes from the location referenced by
4958f0484fSRodney W. Grimes.Fa src
5058f0484fSRodney W. Grimesto the location referenced by
5158f0484fSRodney W. Grimes.Fa dst ,
5258f0484fSRodney W. Grimesswapping adjacent bytes.
5358f0484fSRodney W. Grimes.Pp
5458f0484fSRodney W. GrimesThe argument
5558f0484fSRodney W. Grimes.Fa len
561ecbf08aSBill Fumerolamust be an even number.
570a0c8e01SEitan AdlerIf
580a0c8e01SEitan Adler.Fa len
590a0c8e01SEitan Adleris less than zero, nothing will be done.
6058f0484fSRodney W. Grimes.Sh SEE ALSO
6158f0484fSRodney W. Grimes.Xr bzero 3 ,
6258f0484fSRodney W. Grimes.Xr memset 3
6358f0484fSRodney W. Grimes.Sh HISTORY
6458f0484fSRodney W. GrimesA
6558f0484fSRodney W. Grimes.Fn swab
6658f0484fSRodney W. Grimesfunction appeared in
6758f0484fSRodney W. Grimes.At v7 .
68