Skunkware 5

home *** CD-ROM | disk | FTP | other *** search

/ Skunkware 5 / Skunkware 5.iso / man / cat.1 / zoo.1 < prev

Wrap

Text File | 1995-07-26 | 68.2 KB | 1,453 lines

ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) NNNNAAAAMMMMEEEE zoo - manipulate archives of files in compressed form SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS zzzzoooooooo {aaaaccccffffDDDDeeeegggghhhhHHHHllllLLLLPPPPTTTTuuuuUUUUvvvvVVVVxxxx}[aaaaAAAAccccCCCCddddEEEEffffgggghhhhIIIImmmmMMMMnnnnNNNNooooOOOOppppPPPPqqqqSSSSuuuu1111::::////....@@@@nnnn++++----====] archive [file] ... zzzzoooooooo ----ccccoooommmmmmmmaaaannnndddd archive [file] ... zzzzoooooooo hhhh DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN _Z_o_o is used to create and maintain collections of files in compressed form. It uses a Lempel-Ziv compression algorithm that gives space savings in the range of 20% to 80% depending on the type of file data. _Z_o_o can store and selectively extract multiple generations of the same file. Data can be recovered from damaged archives by skipping the damaged portion and locating undamaged data with the help of _f_i_z(_1). This documentation is for version 2.1. Changes from previous versions are described in the section labelled CCCCHHHHAAAANNNNGGGGEEEESSSS. The command _z_o_o hhhh gives a summary of commands. Extended multiscreen help can be obtained with _z_o_o HHHH. _Z_o_o will not add an archive to itself, nor add the archive's backup (with ....bbbbaaaakkkk extension to the filename) to the archive. _Z_o_o has two types of commands: Expert commands, which consist of one command letter followed by zero or more modifier characters, and Novice commands, which consist of a hyphen (`-') followed by a command word that may be abbreviated. Expert commands are case-sensitive but Novice commands are not. When _z_o_o adds a file to an existing archive, the default action is to maintain one generation of each file in an archive and to mark any older generation as deleted. A limit on the number of generations to save can be specified by the user for an entire archive, or for each file individually, or both. _Z_o_o deletes a stored copy of an added file if necessary to prevent the number of stored generations from exceeding the user-specified limit. Deleted files may be later undeleted. Archives may be packed to recover space occupied by deleted files. All commands assume that the archive name ends with the characters ....zzzzoooooooo unless a different extension is supplied. NNNNoooovvvviiiicccceeee ccccoooommmmmmmmaaaannnnddddssss Page 1 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) Novice commands may be abbreviated to a hyphen followed by at least one command character. Each Novice command works in two stages. First, the command does its intended work. Then, if the result was that one or more files were deleted in the specified archive, the archive is packed. If packing occurs, the original unpacked archive is always left behind with an extension of ....bbbbaaaakkkk. No Novice command ever stores the directory prefix of a file. The Novice commands are as follows. ----aaaadddddddd Adds the specified files to the archive. ----ffffrrrreeeesssshhhheeeennnn Adds a specified file to the archive if and only if an older file by the same name already exists in the archive. ----ddddeeeelllleeeetttteeee Deletes the specified files from the archive. ----uuuuppppddddaaaatttteeee Adds a specified file to the archive either: if an older file by the same name already exists in the archive or: if a file by the same name does not already exist in the archive. ----eeeexxxxttttrrrraaaacccctttt Extracts the specified files from the archive. If no file is specified all files are extracted. ----mmmmoooovvvveeee Equivalent to ----aaaadddddddd except that source files are deleted after addition. ----pppprrrriiiinnnntttt Equivalent to ----eeeexxxxttttrrrraaaacccctttt except that extracted data are sent to standard output. ----lllliiiisssstttt Gives information about the specified archived files including any attached comments. If no files are specified all files are listed. Deleted files are not listed. ----tttteeeesssstttt Equivalent to ----eeeexxxxttttrrrraaaacccctttt except that the extracted data are not saved but any errors encountered are reported. ----ccccoooommmmmmmmeeeennnntttt Page 2 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) Allows the user to add or update comments attached to archived files. When prompted, the user may: type a carriage return to skip the file, leaving any current comment unchanged; or type a (possibly null) comment of up to 32,767 characters terminated by ////eeeennnndddd (case- insensitive) on a separate line; or type the end-of- file character (normally control D) to skip all remaining files. ----ddddeeeelllleeeetttteeee Deletes the specified files. The correspondence between Novice and Expert commands is as follows. tab(@); l l l. Novice@@Equivalent Command@Description@Expert Command _ -add@add files to archive@aP: -extract@extract files from archive@x -move@move files to archive@aMP: -test@test archive integrity@xNd -print@extract files to standard output@xp -delete@delete files from archive@DP -list@list archive contents@VC -update@add new or newer files@aunP: -freshen@by add newer files@auP: -comment@add comments to files@c EEEExxxxppppeeeerrrrtttt ccccoooommmmmmmmaaaannnnddddssss The general format of expert commands is: _z_o_o {aaaaccccffffDDDDeeeegggghhhhHHHHllllLLLLPPPPTTTTuuuuUUUUvvvvVVVVxxxx}[aaaaAAAAccccCCCCddddEEEEffffgggghhhhIIIImmmmMMMMnnnnNNNNooooOOOOppppPPPPqqqqSSSSuuuu1111::::////....@@@@nnnn++++----====] archive [file] ... The characters enclosed within {} are commands. Choose any one of these. The characters enclosed within [] just to the right of the {} are modifiers and zero or more of these may immediately follow the command character. All combinations of command and modifier characters may not be valid. Files are added to an archive with the command: _z_o_o {aaaauuuu}[ccccffffhhhhIIIIMMMMnnnnPPPPqqqquuuu::::++++----] archive [file] ... Command characters are: aaaa Add each specified file to archive. Any already- archived copy of the file is deleted if this is necessary to avoid exceeding the user-specified limit Page 3 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) on the number of generations of the file to maintain in the archive. uuuu Do an update of the archive. A specified file is added to the archive only if a copy of it is already in the archive and the copy being added is newer than the copy already in the archive. The following modifiers are specific to these commands. MMMM Move files to archive. This makes _z_o_o delete (unlink) the original files after they have been added to the archive. Files are deleted after addition of all files to the archive is complete and after any requested packing of the archive has been done, and only if _z_o_o detected no errors. nnnn Add new files only. A specified file is added only if it isn't already in the archive. hhhh Use the high performance compression algorithm. This option may be used with either the add (a) or filter (f) commands to gain extra compression at the expense of using somewhat more processor time. Extracting files compressed with the method is usually slightly faster than those saved with the default method. PPPP Pack archive after files have been added. uuuu Applied to the aaaa command, this modifier makes it behave identically to the uuuu command. The combination of the nnnn modifier with the uuuu modifier or uuuu command causes addition of a file to the archive either if the file is not already in the archive, _o_r if the file is already in the archive but the archived copy is older than the copy being added. :::: Do not store directory names. In the absence of this modifier _z_o_o stores the full pathname of each archived file. IIII Read filenames to be archived from standard input. _Z_o_o will read its standard input and assume that each line of text contains a filename. Under AmigaDOS and the **IX family, the entire line is used. Under MS-DOS and VAX/VMS, _z_o_o assumes that the filename is terminated by a blank, tab, or newline; thus it is permissible for the line of text to contain more than one field separated by white space, and only the first field will be used. Page 4 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) Under the **IX family of operating systems, _z_o_o can be used as follows in a pipeline: find . -print | _z_o_o aI sources If the IIII modifier is specified, no filenames may be supplied on the command line itself. ++++,---- These modifiers take effect only if the aaaa command results in the creation of a new archive. ++++ causes any newly-created archive to have generations enabled. ---- is provided for symmetry and causes any newly-created archive to have generations disabled; this is also the default if neither ++++ nor ---- is specified. Files are extracted from an archive with the command: _z_o_o {eeeexxxx}[ddddNNNNooooOOOOppppqqqqSSSS....////@@@@] archive [file] ... The eeee and xxxx commands are synonymous. If no file was specified, all files are extracted from the archive. The following modifiers are specific to the e and x commands: NNNN Do not save extracted data but report any errors encountered. OOOO Overwrite files. Normally, if a file being extracted would overwrite an already-existing file of the same name, _z_o_o asks you if you really want to overwrite it. You may answer the question with `y', which means yes, overwrite; or `n', which means no, don't overwrite; or `a', which means assume the answer is `y' for this and all subsequent files. The OOOO modifier makes _z_o_o assume that files may always be overwritten. Neither answering the question affirmatively nor using OOOO alone will cause read-only files to be overwritten. On **IX systems, however, doubling this modifier as OOOOOOOO will force _z_o_o to unconditionally overwrite any read- protected files with extracted files if it can do so. The OOOO,,,, NNNN,,,, and pppp modifiers are mutually exclusive. SSSS Supersede newer files on disk with older extracted files. Unless this modifier is used, _z_o_o will not overwrite a newer existing file with an older extracted file. Page 5 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) oooo This is equivalent to the OOOO modifier if and only if it is given at least twice. It is otherwise ignored. pppp Pipe extracted data to standard output. Error messages are piped to standard output as well. However, if a bad CRC is detected, an error message is sent both to standard error and to standard output. //// Extract to original pathname. Any needed directories must already exist. In the absence of this modifier all files are extracted into the current directory. If this modifier is doubled as ////////, required directories need not exist and are created if necessary. The management of multiple generations of archived files is done with the commands: zzzzoooooooo ggggllll[AAAAqqqq]{++++----====}nnnnuuuummmmbbbbeeeerrrr aaaarrrrcccchhhhiiiivvvveeee ffffiiiilllleeeessss ........ zzzzoooooooo ggggcccc[qqqq]{++++----====}nnnnuuuummmmbbbbeeeerrrr aaaarrrrcccchhhhiiiivvvveeee ffffiiiilllleeeessss ........ zzzzoooooooo ggggAAAA[qqqq]---- aaaarrrrcccchhhhiiiivvvveeee zzzzoooooooo ggggAAAA[qqqq]++++ aaaarrrrcccchhhhiiiivvvveeee The first form, ggggllll, adjusts the generation limit of selected files by the specified value. If the form ====nnnn is used, where n is a decimal number, this sets the generation limit to the specified value. If ++++ or ---- are used in placed of ==== the effect is to increment or decrement the generation limit by the specified value. For example, the command zzzzoooooooo ggggllll====5555 xxxxyyyyzzzz :::: sets the generation limit of each file in the archive xxxxyyyyzzzz....zzzzoooooooo to a value of 5. The command zzzzoooooooo ggggllll----3333 xxxxyyyyzzzz :::: decrements the generation limit of each file in the archive to 3 less than it currently is. If the AAAA modifier is used, the archive-wide generation limit is adjusted instead. The number of generations of a file maintained in an archive is limited by the file generation limit, or the archive generation limit, whichever is lower. As a special case, a generation limit of 0 stands for no limit. Thus the default file generation limit of 0 and archive generation limit of 3 limits the number of generations of each file in a newly- created archive to three. Page 6 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) The generation limit specified should be in the range 0 through 15; any higher numbers are interpreted modulo 16. The second form of the command, using ggggcccc, adjusts the generation count of selected files. Each file has a generation count of 1 when it is first added to an archive. Each time a file by the same name is added again to an archive, it receives a generation count that is one higher than the highest generation count of the archived copy of the file. The permissible range of generation counts is 1 through 65535. If repeated manipulations of an archive result in files having very high generation counts, they may be set back to lower numbers with the ggggcccc command. The syntax of the command is analogous to the syntax of the ggggllll command, except that the AAAA modifier is not applicable to the ggggcccc command. The third form, ggggAAAA----, disables generations in an archive. Generations are off when an archive is first created, but may be enabled with the fourth form of the command, ggggAAAA++++. When generations are disabled in an archive, _z_o_o will not display generation numbers in archive listings or maintain multiple generations. Generations can be re-enabled at any time, though manipulation of an archive with repeated interspersed ggggAAAA---- and ggggAAAA++++ commands may result in an archive whose behavior is not easily understandable. Archived files are listed with the command: _z_o_o {llllLLLLvvvvVVVV}[aaaaAAAAccccCCCCddddffffggggmmmmqqqqvvvvVVVV@@@@////1111++++----] archive[....zzzzoooooooo] [file] ... llll Information presented includes the date and time of each file, its original and current (compressed) sizes, and the percentage size decrease due to compression (labelled CF or compression factor). If a file was added to the archive in a different timezone, the difference between timezones is shown in hours as a signed number. As an example, if the difference is listed as +3, this means that the file was added to the archive in a timezone that is 3 hours west of the current timezone. The file time listed is, however, always the original timestamp of the archived file, as observed by the user who archived the file, expressed as that user's local time. (Timezone information is stored and displayed only if the underlying operating system knows about timezones.) If no filename is supplied all files are listed except deleted files. _Z_o_o selects which generation(s) of a file to list according to the following algorithm. Page 7 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) If no filename is supplied, only the latest generation of each file is listed. If any filenames are specified, and a generation is specified for an argument, only the requested generation is listed. If a filename is specified ending with the generation character (`:' or `;'), all generations of that file are listed. Thus a filename argument of the form zzzzoooooooo....cccc will cause only the latest generation of _z_o_o._c to be listed; an argument of the form zzzzoooooooo....cccc::::4444 will cause generation 4 of _z_o_o._c to be listed; and an argument of the form zzzzoooooooo....cccc:::: or zzzzoooooooo....cccc::::**** will cause all generations of _z_o_o._c to be listed. LLLL This is similar to the llll command except that all supplied arguments must be archives and all non-deleted generations of all files in each archive appear in the listing. On **IX systems, on which the shell expands arguments, if multiple archives are to be listed, the LLLL command must be used. On other systems (VAX/VMS, AmigaDOS, MSDOS) on which wildcard expansion is done internally by _z_o_o, wildcards may be used in the archive name, and a multiple archive listing obtained, using the llll command. vvvv This causes any comment attached to the archive to be listed in addition to the other information. VVVV This causes any comment attached to the archive and also any comment attached to each file to be listed. Both the VVVV and vvvv command characters can also be used as modifiers to the llll and LLLL commands. In addition to the general modifiers described later, the following modifiers can be applied to the archive list commands. aaaa This gives a single-line format containing both each filename and the name of the archive, sorted by archive name. It is especially useful with the LLLL command, since the result can be further sorted on any field to give a master listing of the entire contents of a set of archives. AAAA This causes any comment attached to the archive to be listed. gggg This modifier causes file generation information to be listed about the archive. For each file listed, the user-specified generation limit, if any, is listed. Page 8 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) For example, `3g' for a file means that the user wants no more than three generations of the file to be kept. In archives created by older versions of _z_o_o, the listing will show `-g', meaning that no generation information is kept and multiple generations of the file are not being maintained. In addition to the generation information for each file, the archive-wide generation limit, if any, is shown at the end of the listing. If generations have been disabled by the user, this is so indicated, for example: Archive generation limit is 3 (generations off). For more information about generations see the description of the gggg command. mmmm This modifier is currently applicable to **IX systems only. It causes the mode bits (file protection code) of each file to be listed as a three-digit octal number. Currently _z_o_o preserves only the lowest nine mode bits. Their meanings are as described in the **IX documentation for the _c_h_m_o_d(_1) command. CCCC This modifier causes the stored cyclic redundancy code (CRC) for each archived file to be shown as a four- digit hexadecimal number. 1111 This forces one filename to be listed per line. It is most useful in combination with the ffff modifier. //// This forces any directory name to be always listed, even in fast columnized listings that do not normally include any directory names. ++++,---- The ---- modifier causes trailing generation numbers to be omitted from filenames. The ++++ modifier causes the trailing generation numbers to be shown, which is also the default if neither ---- nor ++++ is specified. Files may be deleted and undeleted from an archive with the following commands: _z_o_o {DDDDUUUU}[PPPPqqqq1111] archive file ... The DDDD command deletes the specified files and the UUUU command undeletes the specified files. The 1111 modifier (the digit one, not the letter ell) forces deletion or undeletion of at most one file. If multiple instances of the same file exist in an archive, use of the 1111 modifier may allow selective extraction of one of these. Page 9 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) Comments may be added to an archive with the command: _z_o_o cccc[AAAA] archive Without the modifier AAAA, this behaves identically to the ----ccccoooommmmmmmmeeeennnntttt command. With the modifier AAAA, the command serves to add or update the comment attached to the archive as a whole. This comment may be listed with the llllAAAA,,,, LLLLAAAA,,,, vvvv,,,, aaaannnndddd VVVV commands. Applying the ccccAAAA command to an archive that was created with an older version of _z_o_o will result in an error message requesting that the user first pack the archive with the PPPP command. This reorganizes the archive and creates space for the archive comment. The timestamp of an archive may be adjusted with the command: _z_o_o TTTT[qqqq] archive _Z_o_o normally attempts to maintain the timestamp of an archive to reflect the age of the newest file stored in it. Should the timestamp ever be incorrect it can be fixed with the TTTT command. An archive may be packed with the command: _z_o_o PPPP[EEEEPPPPqqqq] archive If the backup copy of the archive already exists, _z_o_o will refuse to pack the archive unless the PPPP modifier is also given. The EEEE modifier causes _z_o_o not to save a backup copy of the original archive after packing. A unique temporary file in the current directory is used to initially hold the packed archive. This file will be left behind if packing is interrupted or if for some reason this file cannot be renamed to the name of the original archive when packing is complete. Packing removes any garbage data appended to an archive because of Xmodem file transfer and also recovers any wasted space remaining in an archive that has been frequently updated or in which comments were replaced. Packing also updates the format of any archive that was created by an older version of _z_o_o so that newer features (e.g. archive- wide generation limit, archive comment) become fully available. _Z_o_o can act as a pure compression or uncompression filter, reading from standard input and writing to standard output. This is achieved with the command: _z_o_o ffff{ccccuuuu}[[[[h Page 10 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) where cccc specifies compression, uuuu specifies uncompression, and hhhh used in addition requests the high-performance compression be used. A CRC value is used to check the integrity of the data. The compressed data stream has no internal archive structure and contains multiple files only if the input data stream was already structured, as might be obtained, for example, from _t_a_r or _c_p_i_o. Modem transfers can be speeded up with these commands: _z_o_o ffffcccc < file | _s_z ... _r_z | _z_o_o ffffuuuu > file GGGGeeeennnneeeerrrraaaallll mmmmooooddddiiiiffffiiiieeeerrrrssss The following modifiers are applicable to several commands: cccc Applied to the aaaa and uuuu commands, this causes the user to be prompted for a comment for each file added to the archive. If the file being added has replaced, or is a newer generation of, a file already in the archive, any comment attached to that file is shown to the user and becomes attached to the newly-added file unless the user changes it. Possible user responses are as described for the ----ccccoooommmmmmmmeeeennnntttt command. Applied to the archive list command llll, the cccc modifier causes the listing of any comments attached to archived files. .... In conjunction with //// or //////// this modifier causes any extracted pathname beginning with `/' to be interpreted relative to the current directory, resulting in the possible creation of a subtree rooted at the current directory. In conjunction with the command PPPP the .... modifier causes the packed archive to be created in the current directory. This is intended to allow users with limited disk space but multiple disk drives to pack large archives. dddd Most commands that act on an archive act only on files that are not deleted. The dddd modifier makes commands act on both normal and deleted files. If doubled as dddddddd, this modifier forces selection only of deleted files. ffff Applied to the aaaa and uuuu commands, the ffff modifier causes fast archiving by adding files without compression. Applied to llll it causes a fast listing of files in a multicolumn format. qqqq Be quiet. Normally _z_o_o lists the name of each file and what action it is performing. The qqqq modifier Page 11 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) suppresses this. When files are being extracted to standard output, the qqqq modifier suppresses the header preceding each file. When archive contents are being listed, this modifier suppresses any header and trailer. When a fast columnized listing is being obtained, this modifier causes all output to be combined into a single set of filenames for all archives being listed. When doubled as qqqqqqqq, this modifier suppresses WARNING messages, and when tripled as qqqqqqqqqqqq, ERROR messages are suppressed too. FATAL error messages are never suppressed. RRRReeeeccccoooovvvveeeerrrriiiinnnngggg ddddaaaattttaaaa ffffrrrroooommmm ddddaaaammmmaaaaggggeeeedddd aaaarrrrcccchhhhiiiivvvveeeessss The @@@@ modifier allows the user to specify the exact position in an archive where _z_o_o should extract a file from, allowing damaged portions of an archive to be skipped. This modifier must be immediately followed by a decimal integer without intervening spaces, and possibly by a comma and another decimal integer, giving a command of the form llll@@@@mmmm or llll@@@@mmmm,,,,nnnn (to list archive contents) or xxxx@@@@mmmm or xxxx@@@@mmmm,,,,nnnn (to extract files from an archive). Listing or extraction begin at position mmmm in the archive. The value of mmmm must be the position within the archive of an undamaged directory entry. This position is usually obtained from _f_i_z(_1) version 2.0 or later. If damage to the archive has shortened or lengthened it, all positions within the archive may be changed by some constant amount. To compensate for this, the value of nnnn may be specified. This value is also usually obtained from _f_i_z(_1). It should be the position in the archive of the file data corresponding to the directory entry that has been specified with mmmm. Thus if the command xxxx@@@@444455556666,,,,555577775555 is given, it will cause the first 456 bytes of the archive to be skipped and extraction to begin at offset 456; in addition, _z_o_o will attempt to extract the file data from position 575 in the archive instead of the value that is found in the directory entry read from the archive. For example, here is some of the output of _f_i_z when it acts on a damaged _z_o_o archive: **************** 2526: DIR [changes] ==> 95 2587: DATA **************** 3909: DIR [copyrite] ==> 1478 3970: DATA 4769: DATA **************** In such output, DDDDIIIIRRRR indicates where _f_i_z found a directory Page 12 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) entry in the archive, and DDDDAAAATTTTAAAA indicates where _f_i_z found file data in the archive. Filenames located by _f_i_z are enclosed in square brackets, and the notation "==> 95" indicates that the directory entry found by _f_i_z at position 2526 has a file data pointer to position 95. (This is clearly wrong, since file data always occur in an archive _a_f_t_e_r their directory entry.) In actuality, _f_i_z found file data at positions 2587, 3970, and 4769. Since _f_i_z found only two directory entries, and each directory entry corresponds to one file, one of the file data positions is an artifact. In this case, commands to try giving to _z_o_o might be xxxx@@@@2222555522226666,,,,2222555588887777 (extract beginning at position 2526, and get file data from position 2587), xxxx@@@@3333000099990000,,,,3333999977770000 (extract at 3090, get data from 3970) and xxxx@@@@3333999900009999,,,,4444777766669999 (extract at 3909, get data from 4769). Once a correctly-matched directory entry/file data pair is found, _z_o_o will in most cases synchronize with and correctly extract all files subsequently found in the archive. Trial and error should allow all undamaged files to be extracted. Also note that self-extracting archives created using _s_e_z (the Self- Extracting _Z_o_o utility for MS-DOS), which are normally executed on an MS-DOS system for extraction, can be extracted on non-MSDOS systems using _z_o_o'_s damaged-archive recovery method using the @@@@ modifier. WWWWiiiillllddddccccaaaarrrrdddd hhhhaaaannnnddddlllliiiinnnngggg Under the **IX family of operating systems, the shell normally expands wildcards to a list of matching files. Wildcards that are meant to match files within an archive must therefore be escaped or quoted. When selecting files to be added to an archive, wildcard conventions are as defined for the shell. When selecting files from within an archive, wildcard handling is done by _z_o_o as described below. Under MS-DOS and AmigaDOS, quoting of wildcards is not needed. All wildcard expansion of filenames is done by _z_o_o, and wildcards inside directory names are expanded only when listing or extracting files but not when adding them. The wildcard syntax interpreted by _z_o_o is limited to the following characters. **** Matches any sequence of zero or more characters. ???? Matches any single character. Arbitrary combinations of **** and ???? are allowed. Page 13 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) //// If a supplied pattern contains a slash anywhere in it, then the slash separating any directory prefix from the filename must be matched explicitly. If a supplied pattern contains no slashes, the match is selective only on the filename. cccc----cccc Two characters separated by a hyphen specify a character range. All filenames beginning with those characters will match. The character range is meaningful only by itself or preceded by a directory name. It is not specially interpreted if it is part of a filename. :::: aaaannnndddd ;;;; These characters are used to separate a filename from a generation number and are used when selecting specific generations of archived files. If no generation character is used, the filename specified matches only the latest generation of the file. If the generation character is specified, the filename and the generation are matched independently by _z_o_o'_s wildcard mechanism. If no generation is specified following the :::: or ;;;; character, all generations of that file will match. As a special case, a generation number of 0000 matches only the latest generation of a file, while ^^^^0000 matches all generations of a file except the latest one. If no filename is specified preceding the generation character, all filenames will match. As a corollary, the generation character by itself matches all generations of all files. MS-DOS users should note that _z_o_o does not treat the dot as a special character, and it does not ignore characters following an asterisk. Thus **** matches all filenames; ****....**** matches filenames containing a dot; ****____**** matches filenames containing an underscore; and ****zzzz matches all filenames that end with the character zzzz, whether or not they contain a dot. UUUUssssaaaaggggeeee hhhhiiiinnnnttttssss The Novice command set in _z_o_o is meant to provide an interface with functionality and format that will be familiar to users of other similar archive utilities. In keeping with this objective, the Novice commands do not maintain or use any subdirectory information or allow the use of _z_o_o'_s ability to maintain multiple generations of files. For this reason, users should switch to exclusively using the Expert commands as soon as possible. Although the Expert command set is quite large, it should be noted that in almost every case, all legal modifiers for a command are fully orthogonal. This means that the user can Page 14 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) select any combination of modifiers, and when they act together, they will have the intuitively obvious effect. Thus the user need only memorize what each modifier does, and then can combine them as needed without much further thought. For example, consider the aaaa command which is used to add files to an archive. By itself, it simply adds the specified files. To cause only already-archived files to be updated if their disk copies have been modified, it is only necessary to add the uuuu modifier, making the command aaaauuuu. To cause only new files (i.e., files not already in the archive) to be added, the nnnn modifier is used to create the command aaaannnn. To cause _b_o_t_h already-archived files to be updated and new files to be added, the uuuu and nnnn modifiers can be used together, giving the command aaaauuuunnnn. Since the order of modifiers is not significant, the command could also be aaaannnnuuuu. Further, the cccc modifier can be used to cause _z_o_o to prompt the user for a comment to attach to each file added. And the ffff modifier can cause fast addition (addition without compression). It should be obvious then that the command aaaauuuunnnnccccffff will cause _z_o_o to update already-archived files, add new files, prompt the user for comments, and do the addition of files without any compression. Furthermore, if the user wishes to move files to the archive, i.e., delete the disk copy of each file after it is added to the archive, it is only necessary to add the MMMM modifier to the command, so it becomes aaaauuuunnnnccccffffMMMM. And if the user also wishes to cause the archive to be packed as part of the command, thus recovering space from any files that are replaced, the command can be modified to aaaauuuunnnnccccffffMMMMPPPP by adding the PPPP modifier that causes packing. Similarly, the archive listing commands can be built up by combining modifiers. The basic command to list the contents of an archive is llll. If the user wants a fast columnized listing, the ffff modifier can be added to give the llllffff command. Since this listing will have a header giving the archive name and a trailer summarizing interesting information about the archive, such as the number of deleted files, the user may wish to "quieten" the listing by suppressing these; the relevant modifier is qqqq, which when added to the command gives llllffffqqqq. If the user wishes to see the **IX mode (file protection) bits, and also information about multiple generations, the modifiers mmmm (show mode bits) and gggg (show generation information) can be added, giving the command llllffffqqqqmmmmgggg. If the user also wishes to see an attached archive comment, the modifier AAAA (for archive) will serve. Thus the command llllffffqqqqmmmmggggAAAA will give a fast columnized listing of the archive, suppressing any header and trailer, showing mode Page 15 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) bits and generation information, and showing any comment attached to the archive as a whole. If in addition individual comments attached to files are also needed, simply append the cccc modifier to the command, making it llllffffqqqqmmmmggggAAAAcccc. The above command will not show any deleted files, however; to see them, use the dddd modifier, making the command llllffffqqqqmmmmggggAAAAccccdddd (or double it as in llllffffqqqqmmmmggggAAAAccccdddddddd if _o_n_l_y the deleted files are to be listed). And if the user also wishes to see the CRC value for each file being listed, the modifier CCCC will do this, as in the command llllffffqqqqmmmmggggAAAAccccddddCCCC, which gives a fast columnized listing of all files, including deleted files, showing any archive comment and file comments, and file protection codes and generation information, as well as the CRC value of each file. Note that the above command llllffffqqqqmmmmggggAAAAccccddddCCCC could also be abbreviated to VVVVffffqqqqmmmmggggddddCCCC because the command VVVV is shorthand for llllccccAAAA (archive listing with all comments shown). Similarly the command vvvv is shorthand for llllAAAA (archive listing with archive comment shown). Both VVVV and vvvv can be used as modifiers to any of the other archive listing commands. GGGGeeeennnneeeerrrraaaattttiiiioooonnnnssss By default, _z_o_o assumes that only the latest generation of a specified file is needed. If generations other than the latest one need to be selected, this may be done by specifying them in the filename. For example, the name ssssttttddddiiiioooo....hhhh would normally refer to the latest generation of the file _s_t_d_i_o._h stored in a _z_o_o archive. To get an archive listing showing all generations of _s_t_d_i_o._h in the archive, the specification ssssttttddddiiiioooo....hhhh::::**** could be used (enclosed in single quotes if necessary to protect the wildcard character **** from the shell). Also, ssssttttddddiiiioooo....hhhh::::0000 selects only the latest generation of _s_t_d_i_o._h, while ssssttttddddiiiioooo....hhhh::::^^^^0000 selects all generations except the latest one. The :::: character here separates the filename from the generation number, and the character **** is a wildcard that matches all possible generations. For convenience, the generation itself may be left out, so that the name ssssttttddddiiiioooo....hhhh:::: (with the :::: but without a generation number or a wildcard) matches all generations exactly as ssssttttddddiiiioooo....hhhh::::**** does. If a generation is specified but no filename is present, as in ::::5555, ::::****, or just ::::, all filenames of the specified generation will be selected. Thus ::::5555 selects generation 5 of each file, and ::::**** and :::: select all generations of all files. It is important to note that _z_o_o'_s idea of the latest generation of a file is not based upon searching the entire archive. Instead, whenever _z_o_o adds a file to an archive, Page 16 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) it is marked as being the latest generation. Thus, if the latest generation of a file is deleted, then _n_o generation of that file is considered the latest any more. This can be surprising to the user. For example, if an archive already contains the file _s_t_d_i_o._h:_5 and a new copy is added, appearing in the archive listing as _s_t_d_i_o._h:_6, and then _s_t_d_i_o._h:_6 is deleted, the remaining copy _s_t_d_i_o._h:_5 will no longer be considered to be the latest generation, and the file _s_t_d_i_o._h:_5, even if undeleted, will no longer appear in an archive listing unless generation 5 (or every generation) is specifically requested. This behavior will likely be improved in future releases of _z_o_o. FFFFIIIILLLLEEEESSSS xXXXXXX - temporary file used during packing archive_name.bbbbaaaakkkk - backup of archive SSSSEEEEEEEE AAAALLLLSSSSOOOO compress(1), fiz(1) BBBBUUUUGGGGSSSS When files are being added to an archive on a non-MS-DOS system, it is possible for _z_o_o to fail to detect a full disk and hence create an invalid archive. This bug will be fixed in a future release. Files with generation counts that wrap around from 65535 to 1 are not currently handled correctly. If a file's generation count reaches a value close to 65535, it should be manually set back down to a low number. This may be easily done with a command such as ggggcccc----66665555000000000000, which subtracts 65000 from the generation count of each specified file. This problem will be fixed in a future release. Although _z_o_o on **IX systems preserves the lowest nine mode bits of regular files, it does not currently do the same for directories. Currently _z_o_o'_s handling of the characters :::: and ;;;; in filenames is not robust, because it interprets these to separate a filename from a generation number. A quoting mechanism will eventually be implemented. Standard input cannot be archived nor can a created archive be sent to standard output. Spurious error messages may appear if the filename of an archive is too long. Since _z_o_o never archives any file with the same name as the archive or its backup (regardless of any path prefixes), care should be taken to make sure that a file to be archived does not coincidentally have the same name as the archive it is being added to. It usually suffices to make sure that no Page 17 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) file being archived is itself a _z_o_o archive. (Previous versions of _z_o_o sometimes tried to add an archive to itself. This bug now seems to be fixed.) Only regular files are archived; devices and empty directories are not. Support for archiving empty directories and for preserving directory attributes is planned for the near future. Early versions of MS-DOS have a bug that prevents "." from referring to the root directory; this leads to anomalous results if the extraction of paths beginning with a dot is attempted. VAX/VMS destroys case information unless arguments are enclosed in double quotes. For this reason if a command given to _z_o_o on a VAX/VMS system includes any uppercase characters, it must be enclosed in double quotes. Under VAX/VMS, _z_o_o does not currently restore file timestamps; this will be fixed as soon as I figure out RMS extended attribute blocks, or DEC supplies a utime() function, whichever occurs first. Other VMS bugs, related to file structures, can often be overcome by using the program _b_i_l_f._c that is supplied with _z_o_o. It is not currently possible to create a _z_o_o archive containing all _z_o_o archives that do not contain themselves. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS Error messages are intended to be self-explanatory and are divided into three categories. WARNINGS are intended to inform the user of an unusual situation, such as a CRC error during extraction, or ----ffffrrrreeeesssshhhheeeennnning of an archive containing a file newer than one specified on the command line. ERRORS are fatal to one file, but execution continues with the next file if any. FATAL errors cause execution to be aborted. The occurrence of any of these causes an exit status of 1. Normal termination without any errors gives an exit status of 0. (Under VAX/VMS, however, to avoid an annoying message, _z_o_o always exits with an error code of 1.) CCCCOOOOMMMMPPPPAAAATTTTIIIIBBBBIIIILLLLIIIITTTTYYYY All versions of _z_o_o on all systems are required to create archives that can be extracted and listed with all versions of _z_o_o on all systems, regardless of filename and directory syntax or archive structure; furthermore, any version of _z_o_o must be able to fully manipulate all archives created by all lower-numbered versions of _z_o_o on all systems. So far as I can tell, this upward compatibility (all manipulations) and downward compatiblity (ability to extract and list) is maintained by _z_o_o versions up to 2.01. Version 2.1 adds the incompatibility that if high-performance compression is Page 18 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) used, earlier versions cannot extract files compressed with version 2.1. This is the only incompatibility that is permissible. You are forbidden, with the force of copyright law, to create from the _z_o_o source code any derivative work that violates this compatibility goal, whether knowingly or through negligence. If any violation of this compatibility goal is observed, this should be considered a serious problem and reported to me. CCCCHHHHAAAANNNNGGGGEEEESSSS Here is a list of changes occurring from version 1.50 to version 2.01. In parentheses is given the version in which each change occurred. - (1.71) New modifiers to the list commands permit optional suppression of header and trailer information, inclusion of directory names in columnized listings, and fast one-column listings. - (1.71) Timezones are handled. - (1.71) A bug was fixed that had made it impossible to individually update comments for a file whose name did not correspond to MS-DOS format. - (1.71) A change was made that now permits use of the shared library on the **IX PC. - (1.71) VAX/VMS is now supported reasonably well. - (2.00) A comment may now be attached to the archive itself. - (2.00) The OOOOOOOO option allows forced overwriting of read-only files. - (2.00) _Z_o_o will no longer extract a file if a newer copy already exists on disk; the SSSS option will override this. - (2.00) File attributes are preserved for **IX systems. - (2.00) Multiple generations of the same file are supported. - (2.00) _Z_o_o will now act as a compression or decompression filter on a stream of data and will use a CRC value to check the integrity of a data stream that is uncompressed. - (2.00) A bug was fixed that caused removal of a directory link if files were moved to an archive by the Page 19 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) superuser on a **IX system. - (2.00) The data recovery modifier @@@@ was greatly enhanced. Self-extracting archives created for MS-DOS systems can now be extracted by _z_o_o on any system with help from _f_i_z(_1). - (2.01) A bug was fixed that had caused the first generation of a file to sometimes unexpectedly show up in archive listings. - (2.01) A bug was fixed that had caused the MS-DOS version to silently skip files that could not be extracted because of insufficient disk space. - (2.01) A bug was fixed that had sometimes made it impossible to selectively extract a file by specifying its name, even though all files could be extracted from the archive by not specifying any filenames. This occurred when a file had been archived on a longer- filename system (e.g. AmigaDOS) and extraction was attempted on a shorter-filename system (e.g. MS-DOS). - (2.01) A change was made that will make zoo preserve the mode (file protection) of a zoo archive when it is packed. This is effective only if zoo is compiled to preserve and restore file attributes. Currently this is so only for **IX systems. - (2.01) A bug was fixed that had caused an update of an archive to not always add all newer files. - (2.01) Blanks around equal signs in commands given to "make" were removed from the mk* scripts for better compatiblity with more **IX implementations including Sun's. - (2.1) Compression is now greatly improved if the "h" option is used. - (2.1) The default behavior is to preserve full pathnames during extraction. - (2.1) On some systems, extraction of files using the older (default) compression method is greatly speeded up. - (2.1) Extended multiscreen help is available. - (2.1) Memory allocation is improved, so that the MS-DOS version will not prematurely abort when updating a large archive. Page 20 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) - (2.1) The VAX/VMS version preserves file timestamps during extraction. - (2.1) The default archive-wide generation limit, when generations are enabled, is 3. FFFFUUUUTTTTUUUURRRREEEE DDDDIIIIRRRREEEECCCCTTTTIIIIOOOONNNNSSSS A revised version of _z_o_o is in the works that will be able to write newly-created archives to standard output and will support multivolume archives. It will be upward and downward compatible with this version of _z_o_o. AAAACCCCKKKKNNNNOOOOWWWWLLLLEEEEDDDDGGGGEEEEMMMMEEEENNNNTTTTSSSS The _z_o_o archiver was initially developed using Microsoft C 3.0 on a PC clone manufactured by Toshiba of Japan and almost sold by Xerox. Availability of the following systems was helpful in achieving portability: Paul Homchick's Compaq running Microport System V/AT; The Eskimo BBS somewhere in Oregon running Xenix/68000; Greg Laskin's system 'gryphon' which is an Intel 310 running Xenix/286; Ball State University's AT&T 3B2/300, UNIX PC, and VAX-11/785 (4.3BSD and VAX/VMS) systems. In addition J. Brian Waters provided feedback to help me make the code compilable on his Amiga using Manx/Aztec C. The executable version 2.0 for MS-DOS is currently compiled with Borland's Turbo C++ 1.0. Thanks are due to the following people and many others too numerous to mention. J. Brian Waters <jbwaters@bsu-cs.bsu.edu>, who has worked diligently to port _z_o_o to AmigaDOS, created Amiga-specific code, and continues keeping it updated. Paul Homchick <rutgers!cgh!paul>, who provided numerous detailed reports about some nasty bugs. Bill Davidsen <davidsen@crdos1.crd.ge.com>, who provided numerous improvements to this manual, contributed multiscreen help, and provided many useful bug reports, bug fixes, code improvements, and suggestions. Mark Alexander <amdahl!drivax!alexande>, who provided me with some bug fixes. Haruhiko Okumura, who wrote the _a_r archiver and some excellent compression code, which I adapted for use in _z_o_o. Randal L. Barnes <rlb@skyler.mavd.honeywell.com>, who (with Randy Magnuson) wrote the code to support the preservation of file timestamps under VAX/VMS. Raymond D. Gardner, who contributed replacement Page 21 (printed 3/9/94) ZZZZOOOOOOOO((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 7777,,,, 1111999999991111)))) ZZZZOOOOOOOO((((1111)))) uncompression code that on some systems is twice as fast as the original. Greg Yachuk and Andre Van Dalen, who independently modified MS-DOS _z_o_o to support multivolume archives. (This support is not yet in this official release.) AAAAUUUUTTTTHHHHOOOORRRR Rahul Dhesi Page 22 (printed 3/9/94)