![[me]](../me/logo.gif){kind=logo}
find-zfile(3)
find-zfile(3)find-zfile - Compressed file support
zfile-setup - Compressed file support setup
find-zfile "file-name"
zfile-setup "extension" "list-command" "cut-to"
find-zfile provides generic support for listing and extracting the contents of compressed files. find-zfile also supports the extraction of the internal files into another buffer.
find-zfile must be configured for each compression format using zfile-setup. It relies on command-line programs to generate content lists which are used to generate the main file listing, and subsequently, the ability to extract individual files for file extraction support.
For basic content listing support the first 3 arguments must be given to zfile-setup. The first argument "extension" is used as the compressed file id string. The compressed file type is derived from the file extension, e.g. "zip" or "Z" for UNIX compressed files. The exact case of the extension is checked first, followed by the lower case and upper case string.
The compressed file contents list is generated from executing the user supplied "list-command" and dumping the output into the list buffer. The command is run from the directory containing the compressed file and the following special tags may be used within the "list-command" which get substituted as follows:-
%zb
%zf
The head of the list output is often unwanted verbose printout, this can be automatically be removed by the use of the "cut-to" argument. The argument, if supplied (not an empty string), must be a regexp search string matching the start of the required list. If found, all text before it is removed.
For single file extraction support the last 4 arguments must be specified by zfile-setup. The file to extract is selected either by selecting the file name using the left mouse button or by moving the cursor to the line containing the file name and pressing the "return" key.
find-zfile assumes that the file name starts at a fixed column number, specified with the "column" argument. The end of the file name is obtained by searching for the regular expression "file-end" string, the file name is assumed to end at the start of the search string match.
The file is then extracted by executing the supplied "extract-command" and then loading the extracted file into a new buffer. The command is run from the system temporary directory (i.e. "/tmp/" on UNIX or $TEMP on Windows etc.). The following special tags may be used within the "extract-command" which get substituted as follows:-
%zb
%zf
%fb
The file is assumed to be extracted to the temp directory due to the way the command is run, this file is then loaded into a new buffer. The temporary file should then be removed using the supplied "remove-command" with is run from the temp directory, the "%fb" special tag may be used in the command. This argument may be given as an empty string, thereby disabling the removal.
For zip file support the freely available unzip(1) command can be used, following is the list of arguments with suitable entries:
extension zip list-command unzip -v %zb cut-to ^ Length column 58 file-end $ extract-command unzip -o %zf %fb remove-command rm %fb
For the zip file "/usr/jasspa/memacros.zip", after substitution the list command becomes "unzip -v memacros.zip" which will be executed in the "/usr/jasspa/" directory. This will produce the following form of output:
Archive: memacros.zip Length Method Size Ratio Date Time CRC-32 Name ------ ------ ---- ----- ---- ---- ------ ---- 565 Defl:N 258 54% 02-27-99 22:56 018a7f70 american.emf 3409 Defl:N 872 74% 02-28-99 01:37 6a6f9722 americar.emf 4201 Defl:N 772 82% 03-01-99 12:58 d4e3bc4a benchmrk.emf 565 Defl:N 258 54% 02-27-99 22:56 dd394e24 british.emf 3408 Defl:N 872 74% 02-28-99 01:37 32f3eeca britishr.emf 7239 Defl:N 1923 73% 02-28-99 15:13 d408f0da calc.emf 7292 Defl:N 2072 72% 01-23-99 12:49 5979d6b2 cbox.emf 7104 Defl:N 1402 80% 02-28-99 15:13 6faf4fc5 cmacros.emf 5967 Defl:N 1239 79% 02-13-99 16:38 27601523 ctags.emf 1097 Defl:N 489 55% 02-16-99 10:58 53a55e36 dos.emf 562 Defl:N 310 45% 01-16-98 07:54 ec24f65e dos2unix.emf . . .
The top Archive line is not require, this is automatically removed by setting the "cut-to" to "^ Length" which matches the start of the next line.
For file extract, consider the file "ctags.emf", the first character 'c' is at column 58 and the first character after the end of the file name is the end-of-line character ('\n') which is matched by the regexp string "$", hence the settings on "column" and "file-end". When this and the zip file name are substituted into the extract-command, it becomes "unzip -o /usr/jasspa/memacros.zip calc.emf" and is run from the "/tmp." directory. Note that the "-o" option disables any overwrite prompts, these are not required as tests and prompting have already been performed by find-zfile. The extracted file "/tmp/calc.emf" is then loaded into a new buffer.
The temporary file is removed by executing the substituted remove-command which becomes "rm calc.emf" from the "/tmp/" directory.
For gzipped tar files, extension "tgz" the following setup can be used on UNIX platforms:
extension tgz list-command unzip -v %zb cut-to column 43 file-end $ extract-command gunzip -c %zf | tar xof - %fb remove-command rm %fb
For the tgz file "/usr/jasspa/memacros.tgz", this will produce the following listing:
tgz file: /usr/jasspa/memacros.tgz rw-rw-r-- 211/200 565 Feb 27 22:56 1999 american.emf rw-rw-r-- 211/200 3409 Feb 28 01:37 1999 americar.emf rw-rw-r-- 211/200 4201 Mar 1 12:58 1999 benchmrk.emf rw-rw-r-- 211/200 565 Feb 27 22:56 1999 british.emf rw-rw-r-- 211/200 3408 Feb 28 01:37 1999 britishr.emf rw-rw-r-- 211/200 7239 Feb 28 15:13 1999 calc.emf rw-rw-r-- 211/200 7292 Jan 23 12:49 1999 cbox.emf rw-rw-r-- 211/200 7104 Feb 28 15:13 1999 cmacros.emf rw-rw-r-- 211/200 5967 Feb 13 16:38 1999 ctags.emf rw-rw-r-- 211/200 1097 Feb 16 10:58 1999 dos.emf rw-rw-r-- 211/200 562 Jan 16 07:54 1998 dos2unix.emf . . .
find-zfile and zfile-setup are macros defined in zfile.emf.
(c) Copyright JASSPA 1999
Last Modified: 1999/08/16
Generated On: 1999/12/01