More regularizing of function names, field names and testing styles

1 files changed, 26 insertions, 4 deletions

diff --git a/doc/zipfs.3 b/doc/zipfs.3
index 568f461..8e2eacc 100644
--- a/doc/zipfs.3
+++ b/doc/zipfs.3
@@ -10,7 +10,7 @@
 .so man.macros
 .BS
 .SH NAME
-TclZipfs_AppHook, Tclzipfs_Mount, Tclzipfs_Unmount \- handle ZIP files as Tcl virtual filesystems
+TclZipfs_AppHook, Tclzipfs_Mount, TclZipfs_MountBuffer, Tclzipfs_Unmount \- handle ZIP files as Tcl virtual filesystems
 .SH SYNOPSIS
 .nf
 int
@@ -20,7 +20,10 @@ int
 \fBTclzipfs_Mount\fR(\fIinterp, mountpoint, zipname, password\fR)
 .sp
 int
-\fBTclzipfs_Unmount\fR(\fIinterp, zipname\fR)
+\fBTclZipfs_MountBuffer\fR(\fIinterp, mountpoint, data, dataLen, copy\fR)
+.sp
+int
+\fBTclzipfs_Unmount\fR(\fIinterp, mountpoint\fR)
 .fi
 .SH ARGUMENTS
 .AS Tcl_Interp *mountpoint in
@@ -40,6 +43,16 @@ Name of a mount point, which must be a legal Tcl file or directory name. May
 be NULL to query current mount points.
 .AP "const char" *password in
 An (optional) password. Use NULL if no password is wanted to read the file.
+.AP "unsigned char" *data in
+A data buffer to mount. The data buffer must hold the contents of a ZIP
+archive, and must not be NULL.
+.AP size_t dataLen in
+The number of bytes in the supplied data buffer argument, \fIdata\fR.
+.AP int copy in
+If non-zero, the ZIP archive in the data buffer will be internally copied
+before mounting, allowing the data buffer to be disposed once
+\fBTclZipfs_MountBuffer\fR returns. If zero, the caller guarantees that the
+buffer will be valid to read from for the duration of the mount.
 .BE
 .SH DESCRIPTION
 \fBTclZipfs_AppHook\fR is a utility function to perform standard application
@@ -85,11 +98,20 @@ given in \fImountpoint\fR using the optional ZIP password \fIpassword\fR.
 Errors during that process are reported in the interpreter \fIinterp\fR.  If
 \fImountpoint\fR is a NULL pointer, information on all currently mounted ZIP
 file systems is written into \fIinterp\fR's result as a sequence of mount
-points and ZIP file names.
+points and ZIP file names.  The result of this call is a standard Tcl result
+code.
+.PP
+\fBTclzipfs_MountBuffer\fR mounts the ZIP archive in the buffer pointed to by
+\fIdata\fR on the mount point given in \fImountpoint\fR. The ZIP archive is
+assumed to be not password protected.  Errors during that process are reported
+in the interpreter \fIinterp\fR. The \fIcopy\fR argument determines whether
+the buffer is internally copied before mounting or not. The result of this
+call is a standard Tcl result code.
 .PP
 \fBTclzipfs_Unmount\fR undoes the effect of \fBTclzipfs_Mount\fR, i.e., it
 unmounts the mounted ZIP file system that was mounted from \fIzipname\fR (at
-\fImountpoint\fR). Errors are reported in the interpreter \fIinterp\fR.
+\fImountpoint\fR). Errors are reported in the interpreter \fIinterp\fR.  The
+result of this call is a standard Tcl result code.
 .SH "SEE ALSO"
 zipfs(n)
 .SH KEYWORDS