xref: /minix3/lib/libc/string/swab.3 (revision 2fe8fb192fe7e8720e3e7a77f928da545e872a6a)
1*2fe8fb19SBen Gras.\" Copyright (c) 1990, 1991, 1993
2*2fe8fb19SBen Gras.\"	The Regents of the University of California.  All rights reserved.
3*2fe8fb19SBen Gras.\"
4*2fe8fb19SBen Gras.\" Redistribution and use in source and binary forms, with or without
5*2fe8fb19SBen Gras.\" modification, are permitted provided that the following conditions
6*2fe8fb19SBen Gras.\" are met:
7*2fe8fb19SBen Gras.\" 1. Redistributions of source code must retain the above copyright
8*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer.
9*2fe8fb19SBen Gras.\" 2. Redistributions in binary form must reproduce the above copyright
10*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer in the
11*2fe8fb19SBen Gras.\"    documentation and/or other materials provided with the distribution.
12*2fe8fb19SBen Gras.\" 3. Neither the name of the University nor the names of its contributors
13*2fe8fb19SBen Gras.\"    may be used to endorse or promote products derived from this software
14*2fe8fb19SBen Gras.\"    without specific prior written permission.
15*2fe8fb19SBen Gras.\"
16*2fe8fb19SBen Gras.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17*2fe8fb19SBen Gras.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18*2fe8fb19SBen Gras.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19*2fe8fb19SBen Gras.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20*2fe8fb19SBen Gras.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21*2fe8fb19SBen Gras.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22*2fe8fb19SBen Gras.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23*2fe8fb19SBen Gras.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24*2fe8fb19SBen Gras.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25*2fe8fb19SBen Gras.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26*2fe8fb19SBen Gras.\" SUCH DAMAGE.
27*2fe8fb19SBen Gras.\"
28*2fe8fb19SBen Gras.\"     from: @(#)swab.3	8.1 (Berkeley) 6/4/93
29*2fe8fb19SBen Gras.\"	$NetBSD: swab.3,v 1.15 2010/04/30 03:52:13 jruoho Exp $
30*2fe8fb19SBen Gras.\"
31*2fe8fb19SBen Gras.Dd April 30, 2010
32*2fe8fb19SBen Gras.Dt SWAB 3
33*2fe8fb19SBen Gras.Os
34*2fe8fb19SBen Gras.Sh NAME
35*2fe8fb19SBen Gras.Nm swab
36*2fe8fb19SBen Gras.Nd swap adjacent bytes
37*2fe8fb19SBen Gras.Sh LIBRARY
38*2fe8fb19SBen Gras.Lb libc
39*2fe8fb19SBen Gras.Sh SYNOPSIS
40*2fe8fb19SBen Gras.In unistd.h
41*2fe8fb19SBen Gras.Ft void
42*2fe8fb19SBen Gras.Fn swab "const void * restrict src" "void * restrict dst" "ssize_t len"
43*2fe8fb19SBen Gras.Sh DESCRIPTION
44*2fe8fb19SBen GrasThe function
45*2fe8fb19SBen Gras.Fn swab
46*2fe8fb19SBen Grascopies
47*2fe8fb19SBen Gras.Fa len
48*2fe8fb19SBen Grasbytes from the location referenced by
49*2fe8fb19SBen Gras.Fa src
50*2fe8fb19SBen Grasto the location referenced by
51*2fe8fb19SBen Gras.Fa dst ,
52*2fe8fb19SBen Grasswapping adjacent bytes.
53*2fe8fb19SBen Gras.Pp
54*2fe8fb19SBen GrasIf
55*2fe8fb19SBen Gras.Fa len
56*2fe8fb19SBen Grasis negative or zero,
57*2fe8fb19SBen Gras.Fn swab
58*2fe8fb19SBen Grasdoes nothing.
59*2fe8fb19SBen GrasIf
60*2fe8fb19SBen Gras.Fa len
61*2fe8fb19SBen Grasis odd,
62*2fe8fb19SBen Gras.Fn swab
63*2fe8fb19SBen Grascopies
64*2fe8fb19SBen Gras.Fa len - 1
65*2fe8fb19SBen Grasbytes and the disposition of the last byte is unspecified.
66*2fe8fb19SBen Gras.Sh SEE ALSO
67*2fe8fb19SBen Gras.Xr bzero 3 ,
68*2fe8fb19SBen Gras.Xr memset 3
69*2fe8fb19SBen Gras.Sh STANDARDS
70*2fe8fb19SBen GrasThe
71*2fe8fb19SBen Gras.Fn swab
72*2fe8fb19SBen Grasfunction conforms to
73*2fe8fb19SBen Gras.St -p1003.1-2001 .
74*2fe8fb19SBen Gras.Sh HISTORY
75*2fe8fb19SBen GrasA
76*2fe8fb19SBen Gras.Fn swab
77*2fe8fb19SBen Grasfunction appeared in
78*2fe8fb19SBen Gras.At v7 .
79*2fe8fb19SBen GrasIt was originally documented to be
80*2fe8fb19SBen Gras.Dq useful for carrying binary data between PDP11's and other machines .
81*2fe8fb19SBen Gras.Pp
82*2fe8fb19SBen GrasIn
83*2fe8fb19SBen Gras.Nx 6.0
84*2fe8fb19SBen Grasthe type of
85*2fe8fb19SBen Gras.Fa len
86*2fe8fb19SBen Graswas changed from
87*2fe8fb19SBen Gras.Vt size_t
88*2fe8fb19SBen Grasto
89*2fe8fb19SBen Gras.Vt ssize_t
90*2fe8fb19SBen Grasfor
91*2fe8fb19SBen Gras.Tn POSIX
92*2fe8fb19SBen Grascompliance.
93