From 06ae8c6d9e8de0918c8fdaef03556e07aef9de1d Mon Sep 17 00:00:00 2001 From: apnadkarni Date: Wed, 4 Oct 2023 10:00:00 +0000 Subject: Misc fixes in zipfs manpage --- doc/file.n | 13 +++++++++++++ doc/zipfs.n | 6 +++++- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/doc/file.n b/doc/file.n index 36f0415..16b8a77 100644 --- a/doc/file.n +++ b/doc/file.n @@ -83,6 +83,19 @@ clears the readonly attribute of the file. \fB\-rsrclength\fR gives the length of the resource fork of the file, this attribute can only be set to the value 0, which results in the resource fork being stripped off the file. +.PP +On all platforms, files in \fBzipfs\fR mounted archives return the following +attributes. These are all read-only and cannot be directly set. +\fB-archive\fR gives the path of the mounted ZIP archive containing the file. +\fB-compsize\fR gives the compressed size of the file within the archive. +This is \fB0\fR for directories. +\fB-crc\fR gives the CRC of the file if present, else \fB0\fR. +\fB-mount\fR gives the path where the containing archive is mounted. +\fB-offset\fR gives the offset of the file within the archive. +\fB-uncompsize\fR gives the uncompressed size of the file. +This is \fB0\fR for directories. +Other attributes may be present in the returned list. These should +be ignored. .RE .TP \fBfile channels\fR ?\fIpattern\fR? diff --git a/doc/zipfs.n b/doc/zipfs.n index 2a29a67..26b45a6 100644 --- a/doc/zipfs.n +++ b/doc/zipfs.n @@ -43,6 +43,10 @@ simple encryption, sufficient to prevent casual inspection of their contents but not able to prevent access by even a moderately determined attacker. Strong encryption, multi-part archives, platform metadata, zip64 formats and other compression methods like bzip2 are not supported. +.PP +Files within mounted archives can be written to but new files or directories +cannot be created. Further, modifications to files are limited to the +mounted archive in memory and are not persisted to disk. .TP \fBzipfs canonical\fR ?\fImountpoint\fR? \fIfilename\fR ?\fIinZipfs\fR? . @@ -116,7 +120,7 @@ In the third form, the command mounts the ZIP archive \fIzipfile\fR as a Tcl vir filesystem at \fImountpoint\fR. After this command executes, files contained in \fIzipfile\fR will appear to Tcl to be regular files at the mount point. If \fImountpoint\fR is -specified as an empty string, it is defaulted to the file path. +specified as an empty string, it is defaulted to the \fB[zipfs root]\fR. .PP \fBNB:\fR because the current working directory is a concept maintained by the operating system, using \fBcd\fR into a mounted archive will only work in the -- cgit v0.12