3rd-party/zisofs_tools/mkzftree.1

   1 .\" $Id: mkzftree.1,v 1.13 2004/07/20 04:03:53 hpa Exp $
   2 .\" -----------------------------------------------------------------------
   3 .\"
   4 .\"   Copyright 2001 H. Peter Anvin - All Rights Reserved
   5 .\"
   6 .\"   This program is free software; you can redistribute it and/or modify
   7 .\"   it under the terms of the GNU General Public License as published by
   8 .\"   the Free Software Foundation, Inc., 675 Mass Ave, Cambridge MA 02139,
   9 .\"   USA; either version 2 of the License, or (at your option) any later
  10 .\"   version; incorporated herein by reference.
  11 .\"
  12 .\" -----------------------------------------------------------------------
  13 .TH MKZFTREE "1" "30 July 2001" "zisofs-tools" "H. Peter Anvin"
  14 .SH NAME
  15 mkzftree \- Create a zisofs/RockRidge compressed file tree
  16 .SH SYNOPSIS
  17 .B mkzftree
  18 [\fIOPTIONS\fR]... \fIINPUT\fR \fIOUTPUT\fR
  19 .SH DESCRIPTION
  20 .PP
  21 Takes an input file tree (\fIINPUT\fR) and create a corresponding
  22 compressed file tree (\fIOUTPUT\fR) that can be used with an
  23 appropriately patched
  24 .BR mkisofs (8)
  25 to create a transparent-compression ISO 9660/Rock Ridge filesystem using
  26 the "ZF" compression records.
  27 .SH OPTIONS
  28 .TP
  29 \fB\-f\fP, \fB\-\-force\fP
  30 Always compress all files, even if they get larger when compressed.
  31 .TP
  32 \fB\-z\fP \fIlevel\fP, \fB\-\-level\fP \fIlevel\fP
  33 Select compression level (1-9, default is 9).  Lower compression
  34 levels are faster, but typically result in larger output.
  35 .TP
  36 \fB\-u\fP, \fB\-\-uncompress\fP
  37 Uncompress an already compressed tree.  This can be used to read a
  38 compressed filesystem on a system which cannot read them natively.
  39 .TP
  40 \fB\-p\fP \fIparallelism\fP, \fB\-\-parallelism\fP \fIparallelism\fP
  41 Compress in parallel.  The
  42 .I parallelism
  43 value indicates how many compression threads are allowed to run.
  44 .TP
  45 \fB\-x\fP, \fB\-\-one-filesystem\fP
  46 Do not cross filesystem boundaries, but create directory stubs at
  47 mount points.
  48 .TP
  49 \fB\-X\fP, \fB\-\-strict-one-filesystem\fP
  50 Do not cross filesystem boundaries, and do not create directory stubs
  51 at mount points.
  52 .TP
  53 \fB\-C\fP \fIpath\fP, \fB\-\-crib-path\fP \fIpath\fP
  54 Steal ("crib") files from another directory if it looks (based on
  55 name, size, type and modification time) like they match entries in the
  56 new filesystem.  The "crib tree" is usually the compressed version of
  57 an older version of the same workload; this thus allows for
  58 "incremental rebuilds" of a compressed filesystem tree.  The files are
  59 hardlinked from the crib tree to the output tree, so if it is
  60 desirable to keep the link count correct the crib path should be
  61 deleted before running \fBmkisofs\fP.  The crib tree must be on the
  62 same filesystem as the output tree.
  63 .TP
  64 \fB\-l\fP, \fB\-\-local\fP
  65 Do not recurse into subdirectories, but create the directories
  66 themselves.
  67 .TP
  68 \fB\-L\fP, \fB\-\-strict-local\fP
  69 Do not recurse into subdirectories, and do not create directories.
  70 .TP
  71 \fB\-F\fP, \fB\-\-file\fP
  72 Indicates that \fIINPUT\fP may not necessarily be a directory; this
  73 allows operation on a single file.  Note especially that if \fI\-F\fP
  74 is specified, and \fIINPUT\fP is a symlink, the symlink itself will be
  75 copied rather than whatever it happens to point to.
  76 .TP
  77 \fB\-s\fP, \fB\-\-sloppy\fP
  78 Treat file modes, times and ownership data as less than precious
  79 information and don't abort if they cannot be set.  This may be useful
  80 if running
  81 .B mkisofs
  82 on an input tree you do not own.
  83 .TP
  84 \fB\-v\fP, \fB\-\-verbose\fP
  85 Increase the program verbosity.
  86 .TP
  87 \fB\-V\fP \fIvalue\fP, \fB\-\-verbosity\fP \fIvalue\fP
  88 Set the program verbosity to
  89 .IR value .
  90 .TP
  91 \fB\-q\fP, \fB\-\-quiet\fP
  92 Issue no messages whatsoever, including error messages.  This is the same
  93 as specifying
  94 .IR "\-V\ 0" .
  95 .TP
  96 \fB\-h\fP, \fB\-\-help\fP
  97 Display a brief help message.
  98 .TP
  99 \fB\-w\fP, \fB\-\-version\fP
 100 Display the release version.
 101 .SH BUGS
 102 Long options (beginning with \fI\-\-\fP) may not work on all systems.
 103 See the message printed out by \fImkzftree\ \-h\fP to see if this
 104 applies to your system.
 105 .PP
 106 Inode change times (ctimes) are not copied.  This is a system
 107 limitation and applies to all file copy programs.
 108 .PP
 109 If using the parallel option (\fI\-z\fP) the access times (atimes) on
 110 directories may or may not be copied.  If it is important that the
 111 atimes on directories are copied exactly, avoid using \fI\-z\fP.
 112 .SH AUTHOR
 113 Written by H. Peter Anvin <hpa@zytor.com>.
 114 .SH COPYRIGHT
 115 Copyright \(co 2001-2002 H. Peter Anvin.
 116 .br
 117 This is free software; see the source for copying conditions.  There is NO
 118 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 119 .SH "SEE ALSO"
 120 .BR mkisofs (8)