aboutsummaryrefslogtreecommitdiff
path: root/local/src/doc
diff options
context:
space:
mode:
Diffstat (limited to 'local/src/doc')
-rwxr-xr-xlocal/src/doc/bswap.hlp36
-rw-r--r--local/src/doc/pavg.hlp29
2 files changed, 65 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
diff --git a/local/src/doc/pavg.hlp b/local/src/doc/pavg.hlp
new file mode 100644
index 00000000..d0c29185
--- /dev/null
+++ b/local/src/doc/pavg.hlp
@@ -0,0 +1,29 @@
+.help pavg Apr86 local
+.ih
+NAME
+pavg - plot the average of the lines of an image or image section
+.ih
+USAGE
+pavg image
+.ih
+PARAMETERS
+.ls image
+The image or image section to be averaged and plotted.
+.le
+.ih
+DESCRIPTION
+The \fIpavg\fR task averages the lines of the given image or image section
+and plots the result on the standard graphics output.
+.ih
+EXAMPLES
+1. Plot line 125 of the standard test image "dev$pix".
+
+ cl> pavg dev$pix[*,125]
+
+2. Plot the average of lines 100 through 200 of the same image.
+
+ cl> pavg dev$pix[*,100:200]
+.ih
+SEE ALSO
+plot.*
+.endhelp