diff options
Diffstat (limited to 'src/lib/libc/string/swab.3')
| -rw-r--r-- | src/lib/libc/string/swab.3 | 61 |
1 files changed, 61 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..abeff903de --- /dev/null +++ b/src/lib/libc/string/swab.3 | |||
| @@ -0,0 +1,61 @@ | |||
| 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. Neither the name of the University nor the names of its contributors | ||
| 13 | .\" may be used to endorse or promote products derived from this software | ||
| 14 | .\" without specific prior written permission. | ||
| 15 | .\" | ||
| 16 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | ||
| 17 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| 18 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| 19 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | ||
| 20 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
| 21 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
| 22 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
| 23 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
| 24 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
| 25 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
| 26 | .\" SUCH DAMAGE. | ||
| 27 | .\" | ||
| 28 | .\" $OpenBSD: swab.3,v 1.5 2003/06/02 20:18:38 millert Exp $ | ||
| 29 | .\" | ||
| 30 | .Dd May 1, 1991 | ||
| 31 | .Dt SWAB 3 | ||
| 32 | .Os | ||
| 33 | .Sh NAME | ||
| 34 | .Nm swab | ||
| 35 | .Nd swap adjacent bytes | ||
| 36 | .Sh SYNOPSIS | ||
| 37 | .Fd #include <unistd.h> | ||
| 38 | .Ft void | ||
| 39 | .Fn swab "const void *src" "void *dst" "size_t len" | ||
| 40 | .Sh DESCRIPTION | ||
| 41 | The function | ||
| 42 | .Fn swab | ||
| 43 | copies | ||
| 44 | .Fa len | ||
| 45 | bytes from the location referenced by | ||
| 46 | .Fa src | ||
| 47 | to the location referenced by | ||
| 48 | .Fa dst , | ||
| 49 | swapping adjacent bytes. | ||
| 50 | .Pp | ||
| 51 | The argument | ||
| 52 | .Fa len | ||
| 53 | must be an even number. | ||
| 54 | .Sh SEE ALSO | ||
| 55 | .Xr bzero 3 , | ||
| 56 | .Xr memset 3 | ||
| 57 | .Sh HISTORY | ||
| 58 | A | ||
| 59 | .Fn swab | ||
| 60 | function appeared in | ||
| 61 | .At v7 . | ||