src/engine/SCons/Tool/zip.xml

   1 <!--
   2 __COPYRIGHT__
   3
   4 This file is processed by the bin/SConsDoc.py module.
   5 See its __doc__ string for a discussion of the format.
   6 -->
   7 <tool name="zip">
   8 <summary>
   9 Sets construction variables for the &zip; archiver.
  10 </summary>
  11 <sets>
  12 ZIP
  13 ZIPFLAGS
  14 ZIPCOM
  15 ZIPCOMPRESSION
  16 ZIPSUFFIX
  17 </sets>
  18 <uses>
  19 ZIPCOMSTR
  20 </uses>
  21 </tool>
  22
  23 <builder name="Zip">
  24 <summary>
  25 Builds a zip archive of the specified files
  26 and/or directories.
  27 Unlike most builder methods,
  28 the
  29 &b-Zip;
  30 builder method may be called multiple times
  31 for a given target;
  32 each additional call
  33 adds to the list of entries
  34 that will be built into the archive.
  35 Any source directories will
  36 be scanned for changes to
  37 any on-disk files,
  38 regardless of whether or not
  39 &scons;
  40 knows about them from other Builder or function calls.
  41
  42 <example>
  43 env.Zip('src.zip', 'src')
  44
  45 # Create the stuff.zip file.
  46 env.Zip('stuff', ['subdir1', 'subdir2'])
  47 # Also add "another" to the stuff.tar file.
  48 env.Zip('stuff', 'another')
  49 </example>
  50 </summary>
  51 </builder>
  52
  53 <cvar name="ZIP">
  54 <summary>
  55 The zip compression and file packaging utility.
  56 </summary>
  57 </cvar>
  58
  59 <cvar name="ZIPCOM">
  60 <summary>
  61 The command line used to call the zip utility,
  62 or the internal Python function used to create a
  63 zip archive.
  64 </summary>
  65 </cvar>
  66
  67 <cvar name="ZIPCOMSTR">
  68 <summary>
  69 The string displayed when archiving files
  70 using the zip utility.
  71 If this is not set, then &cv-link-ZIPCOM;
  72 (the command line or internal Python function) is displayed.
  73
  74 <example>
  75 env = Environment(ZIPCOMSTR = "Zipping $TARGET")
  76 </example>
  77 </summary>
  78 </cvar>
  79
  80 <cvar name="ZIPCOMPRESSION">
  81 <summary>
  82 The
  83 <varname>compression</varname>
  84 flag
  85 from the Python
  86 <filename>zipfile</filename>
  87 module used by the internal Python function
  88 to control whether the zip archive
  89 is compressed or not.
  90 The default value is
  91 <literal>zipfile.ZIP_DEFLATED</literal>,
  92 which creates a compressed zip archive.
  93 This value has no effect when using Python 1.5.2
  94 or if the
  95 <literal>zipfile</literal>
  96 module is otherwise unavailable.
  97 </summary>
  98 </cvar>
  99
 100 <cvar name="ZIPFLAGS">
 101 <summary>
 102 General options passed to the zip utility.
 103 </summary>
 104 </cvar>
 105
 106 <cvar name="ZIPSUFFIX">
 107 <summary>
 108 The suffix used for zip file names.
 109 </summary>
 110 </cvar>