summaryrefslogtreecommitdiffstats
path: root/man/man3/bswap.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/man3/bswap.3')
-rw-r--r--man/man3/bswap.368
1 files changed, 68 insertions, 0 deletions
diff --git a/man/man3/bswap.3 b/man/man3/bswap.3
new file mode 100644
index 0000000..0e4808f
--- /dev/null
+++ b/man/man3/bswap.3
@@ -0,0 +1,68 @@
+.\" Copyright (C) 2016 Michael Kerrisk <mtk.manpages@gmail.com>
+.\"
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
+.\"
+.TH bswap 3 2024-05-02 "Linux man-pages (unreleased)"
+.SH NAME
+bswap_16, bswap_32, bswap_64 \- reverse order of bytes
+.SH LIBRARY
+Standard C library
+.RI ( libc ", " \-lc )
+.SH SYNOPSIS
+.nf
+.B #include <byteswap.h>
+.P
+.BI "uint16_t bswap_16(uint16_t " x );
+.BI "uint32_t bswap_32(uint32_t " x );
+.BI "uint64_t bswap_64(uint64_t " x );
+.fi
+.SH DESCRIPTION
+These functions return a value in which the order of the bytes
+in their 2-, 4-, or 8-byte arguments is reversed.
+.SH RETURN VALUE
+These functions return the value of their argument with the bytes reversed.
+.SH ERRORS
+These functions always succeed.
+.SH STANDARDS
+GNU.
+.SH EXAMPLES
+The program below swaps the bytes of the 8-byte integer supplied as
+its command-line argument.
+The following shell session demonstrates the use of the program:
+.P
+.in +4n
+.EX
+$ \fB./a.out 0x0123456789abcdef\fP
+0x123456789abcdef ==> 0xefcdab8967452301
+.EE
+.in
+.SS Program source
+\&
+.\" SRC BEGIN (bswap.c)
+.EX
+#include <byteswap.h>
+#include <inttypes.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+\&
+int
+main(int argc, char *argv[])
+{
+ uint64_t x;
+\&
+ if (argc != 2) {
+ fprintf(stderr, "Usage: %s <num>\en", argv[0]);
+ exit(EXIT_FAILURE);
+ }
+\&
+ x = strtoull(argv[1], NULL, 0);
+ printf("%#" PRIx64 " ==> %#" PRIx64 "\en", x, bswap_64(x));
+\&
+ exit(EXIT_SUCCESS);
+}
+.EE
+.\" SRC END
+.SH SEE ALSO
+.BR byteorder (3),
+.BR endian (3)