aboutsummaryrefslogtreecommitdiff
path: root/local/src/doc/bswap.hlp
diff options
context:
space:
mode:
authorJoe Hunkeler <jhunkeler@gmail.com>2015-08-11 16:51:37 -0400
committerJoe Hunkeler <jhunkeler@gmail.com>2015-08-11 16:51:37 -0400
commit40e5a5811c6ffce9b0974e93cdd927cbcf60c157 (patch)
tree4464880c571602d54f6ae114729bf62a89518057 /local/src/doc/bswap.hlp
downloadiraf-osx-40e5a5811c6ffce9b0974e93cdd927cbcf60c157.tar.gz
Repatch (from linux) of OSX IRAF
Diffstat (limited to 'local/src/doc/bswap.hlp')
-rwxr-xr-xlocal/src/doc/bswap.hlp36
1 files changed, 36 insertions, 0 deletions
diff --git a/local/src/doc/bswap.hlp b/local/src/doc/bswap.hlp
new file mode 100755
index 00000000..779105de
--- /dev/null
+++ b/local/src/doc/bswap.hlp
@@ -0,0 +1,36 @@
+.help bswap Mar89 local
+.ih
+NAME
+bswap - swap the bytes in a file
+.ih
+USAGE
+bswap input output
+.ih
+PARAMETERS
+.ls input
+The file to be swapped.
+.le
+.ls output
+The name of the output swapped file.
+.le
+.ls wordswap = no
+Swap four-byte longwords rather than pairs of bytes.
+.le
+.ih
+DESCRIPTION
+The \fIbswap\fR task reads the input file as a binary file,
+writing the result to the output file.
+Successive byte pairs are interchanged if \fIwordswap\fR=no,
+otherwise the four bytes within each successive longword are swapped.
+.ih
+EXAMPLES
+1. Byte swap file A, writing the result to file B.
+
+ cl> bswap a b
+.ih
+BUGS
+The input and output files cannot be the same.
+.ih
+SEE ALSO
+dataio.reblock
+.endhelp