Imported Upstream version 1.1.11
[platform/upstream/cdrkit.git] / 3rd-party / zisofs_tools / README
1                     H. Peter Anvin <hpa@zytor.com>
2                             June 13, 2004
3
4
5 User tools for zisofs:
6
7 The user tools for zisofs come in two parts: a utility "mkzftree" and
8 mkisofs, which is part of the cdrtools package.  cdrtools 1.11a20 or
9 later is required.
10
11 First create a directory tree containing compressed files:
12
13         mkzftree input_dir compressed_dir
14
15 mkzftree will not overwrite an existing directory; you may want to "rm
16 -rf" the directory tree if you are doing this from a script:
17
18 Second, invoke the patched mkisofs with the -z option:
19
20         mkisofs -z -R [other options] -o compressed.iso compressed_dir
21
22 IMPORTANT: you *must* enable RockRidge (-R or -r) since this is an
23 extensions to the RockRidge specification.  Without RockRidge, -z will
24 have no effect.
25
26 Note that if there are files you do not want compressed (for example,
27 files involved in booting, or README files you want to be readable
28 under all circumstances) you can simply put them in a separate tree
29 and not run mkzftree on that tree.
30
31 mkzftree will not compress files that end up larger when compressed;
32 if you want it to compress the files anyway, you can give the -f
33 option to mkzftree.
34
35 mkzftree also accepts a -u option (uncompress), which can be used to
36 convert a compressed tree back to normal form.  This can be used to
37 read a zisofs CD-ROM on a machine without zisofs kernel support.
38
39 This version of mkzftree supports a -p option (parallelize.)
40 Specifying -p and a parallelism (e.g. -p4) allows files (up to the
41 number specified) to compress in parallel.  Depending on your setup
42 and your data set size, this might speed things up if you are not
43 completely I/O bound.  Use -p0 to completely disable parallel
44 execution; this is the default.