]> git.ipfire.org Git - thirdparty/man-pages.git/blame - man3/swab.3
"-1" should be "\-1"
[thirdparty/man-pages.git] / man3 / swab.3
CommitLineData
fea681da
MK
1.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
2.\"
3.\" Permission is granted to make and distribute verbatim copies of this
4.\" manual provided the copyright notice and this permission notice are
5.\" preserved on all copies.
6.\"
7.\" Permission is granted to copy and distribute modified versions of this
8.\" manual under the conditions for verbatim copying, provided that the
9.\" entire resulting derived work is distributed under the terms of a
10.\" permission notice identical to this one.
c13182ef 11.\"
fea681da
MK
12.\" Since the Linux kernel and libraries are constantly changing, this
13.\" manual page may be incorrect or out-of-date. The author(s) assume no
14.\" responsibility for errors or omissions, or for damages resulting from
15.\" the use of the information contained herein. The author(s) may not
16.\" have taken the same level of care in the production of this manual,
17.\" which is licensed free of charge, as they might when working
18.\" professionally.
c13182ef 19.\"
fea681da
MK
20.\" Formatted or processed versions of this manual, if unaccompanied by
21.\" the source, must acknowledge the copyright and authors of this work.
22.\"
23.\" References consulted:
24.\" Linux libc source code
25.\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
26.\" 386BSD man pages
27.\" Modified Sat Jul 24 17:52:15 1993 by Rik Faith (faith@cs.unc.edu)
28.\" Modified 2001-12-15, aeb
29.TH SWAB 3 2001-12-15 "" "Linux Programmer's Manual"
30.SH NAME
31swab \- swap adjacent bytes
32.SH SYNOPSIS
33.nf
d18b5684 34.B #define _XOPEN_SOURCE
fea681da
MK
35.B #include <unistd.h>
36.sp
37.BI "void swab(const void *" from ", void *" to ", ssize_t " n );
38.fi
39.SH DESCRIPTION
63aa9df0 40The \fBswab\fP() function copies \fIn\fP bytes from the array pointed
fea681da 41to by \fIfrom\fP to the array pointed to by \fIto\fP, exchanging
c13182ef
MK
42adjacent even and odd bytes.
43This function is used to exchange data
fea681da
MK
44between machines that have different low/high byte ordering.
45.LP
46This function does nothing when \fIn\fP is negative.
0fcd5bc9 47When \fIn\fP is positive and odd, it handles \fIn\fP\-1 bytes
fea681da
MK
48as above, and does something unspecified with the last byte.
49(In other words, \fIn\fP should be even.)
50.SH "RETURN VALUE"
63aa9df0 51The \fBswab\fP() function returns no value.
fea681da 52.SH "CONFORMING TO"
68e1685c 53SVr4, 4.3BSD, POSIX.1-2001
fea681da 54.SH "SEE ALSO"
0a90178c
MK
55.BR bstring (3),
56.BR feature_test_macros (7)