diff options
Diffstat (limited to 'src/lib/libc/string/swab.3')
-rw-r--r-- | src/lib/libc/string/swab.3 | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/src/lib/libc/string/swab.3 b/src/lib/libc/string/swab.3 new file mode 100644 index 0000000000..d1bfc358fb --- /dev/null +++ b/src/lib/libc/string/swab.3 | |||
@@ -0,0 +1,65 @@ | |||
1 | .\" Copyright (c) 1990, 1991 The Regents of the University of California. | ||
2 | .\" 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 | .\" 3. All advertising materials mentioning features or use of this software | ||
13 | .\" must display the following acknowledgement: | ||
14 | .\" This product includes software developed by the University of | ||
15 | .\" California, Berkeley and its contributors. | ||
16 | .\" 4. Neither the name of the University nor the names of its contributors | ||
17 | .\" may be used to endorse or promote products derived from this software | ||
18 | .\" without specific prior written permission. | ||
19 | .\" | ||
20 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | ||
21 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
22 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
23 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | ||
24 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
25 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
26 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
27 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
28 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
29 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
30 | .\" SUCH DAMAGE. | ||
31 | .\" | ||
32 | .\" $OpenBSD: swab.3,v 1.3 1998/02/10 02:19:48 deraadt Exp $ | ||
33 | .\" | ||
34 | .Dd May 1, 1991 | ||
35 | .Dt SWAB 3 | ||
36 | .Os | ||
37 | .Sh NAME | ||
38 | .Nm swab | ||
39 | .Nd swap adjacent bytes | ||
40 | .Sh SYNOPSIS | ||
41 | .Fd #include <unistd.h> | ||
42 | .Ft void | ||
43 | .Fn swab "const void *src" "void *dst" "size_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 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 . | ||