Libc-498.tar.gz

[apple/libc.git] / string / swab.3

diff --git a/string/swab.3 b/string/swab.3
new file mode 100644 (file)
index 0000000..42b8a9d
--- /dev/null
+++ b/string/swab.3
@@ -0,0 +1,90 @@
+.\" Copyright (c) 1990, 1991, 1993
+.\"    The Regents of the University of California.  All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"     @(#)swab.3     8.1 (Berkeley) 6/4/93
+.\" $FreeBSD: src/lib/libc/string/swab.3,v 1.7 2002/08/30 21:18:39 robert Exp $
+.\"
+.Dd June 4, 1993
+.Dt SWAB 3
+.Os
+.Sh NAME
+.Nm swab
+.Nd swap adjacent bytes
+.Sh LIBRARY
+.Lb libc
+.Sh SYNOPSIS
+.In unistd.h
+.Ft void
+.Fo swab
+.Fa "const void *restrict src"
+.Fa "void *restrict dest"
+.Fa "ssize_t nbytes"
+.Fc
+.Sh DESCRIPTION
+The function
+.Fn swab
+copies
+.Fa nbytes
+bytes from the location referenced by
+.Fa src
+to the location referenced by
+.Fa dest ,
+swapping adjacent bytes.
+.Pp
+The argument
+.Fa nbytes
+must be an even number.
+.Sh LEGACY SYNOPSIS
+.Fd #include <string.h>
+.Pp
+.Ft void
+.br
+.Fo swab
+.Fa "const void *restrict src"
+.Fa "void *restrict dest"
+.Fa "size_t nbytes"
+.Fc ;
+.Pp
+The include file
+.In string.h
+is necessary for this function.
+The type of
+.Fa nbytes
+has changed.
+.Sh SEE ALSO
+.Xr bzero 3 ,
+.Xr memset 3 ,
+.Xr compat 5
+.Sh HISTORY
+A
+.Fn swab
+function appeared in
+.At v7 .