aboutsummaryrefslogtreecommitdiffstats
path: root/extension/rwarray.3am
diff options
context:
space:
mode:
Diffstat (limited to 'extension/rwarray.3am')
-rw-r--r--extension/rwarray.3am19
1 files changed, 16 insertions, 3 deletions
diff --git a/extension/rwarray.3am b/extension/rwarray.3am
index b8977604..c68e4b4a 100644
--- a/extension/rwarray.3am
+++ b/extension/rwarray.3am
@@ -1,12 +1,12 @@
-.TH RWARRAY 3am "Aug 01 2012" "Free Software Foundation" "GNU Awk Extension Modules"
+.TH RWARRAY 3am "Aug 08 2012" "Free Software Foundation" "GNU Awk Extension Modules"
.SH NAME
writea, reada \- write and read gawk arrays to/from files
.SH SYNOPSIS
.ft CW
@load "rwarray"
-.br
-ret = writea(file, array)
.sp
+ret = writea(file, array)
+.br
ret = reada(file, array)
.ft R
.SH DESCRIPTION
@@ -34,6 +34,19 @@ the array named as the second argument. It clears the array
first.
Here too, the return value is 1 on success and 0 on failure.
.SH NOTES
+The array created by
+.B reada()
+is identical to that written by
+.B writea()
+in the sense that the contents are the same. However, due
+to implementation issues, the array traversal order of the recreated
+array will likely be different from that of the original array.
+As array traversal order in AWK is by default undefined, this is
+not (technically) a problem. If you need to guarantee a particular
+traversal order, use the array sorting features in
+.I gawk
+to do so.
+.PP
The file contains binary data. All integral values are written
in network byte order.
However, double precision floating-point values are written as