1. SCons
  2. Core
  3. SCons


SCons / src / engine / SCons / Tool / zip.xml


This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
<tool name="zip">
Sets construction variables for the &zip; archiver.

<builder name="Zip">
Builds a zip archive of the specified files
and/or directories.
Unlike most builder methods,
builder method may be called multiple times
for a given target;
each additional call
adds to the list of entries
that will be built into the archive.
Any source directories will
be scanned for changes to
any on-disk files,
regardless of whether or not
knows about them from other Builder or function calls.

env.Zip('src.zip', 'src')

# Create the stuff.zip file.
env.Zip('stuff', ['subdir1', 'subdir2'])
# Also add "another" to the stuff.tar file.
env.Zip('stuff', 'another')

<cvar name="ZIP">
The zip compression and file packaging utility.

<cvar name="ZIPCOM">
The command line used to call the zip utility,
or the internal Python function used to create a
zip archive.

<cvar name="ZIPCOMSTR">
The string displayed when archiving files
using the zip utility.
If this is not set, then &cv-link-ZIPCOM;
(the command line or internal Python function) is displayed.

env = Environment(ZIPCOMSTR = "Zipping $TARGET")

<cvar name="ZIPCOMPRESSION">
from the Python
module used by the internal Python function
to control whether the zip archive
is compressed or not.
The default value is
which creates a compressed zip archive.
This value has no effect if the
module is unavailable.

<cvar name="ZIPFLAGS">
General options passed to the zip utility.

<cvar name="ZIPSUFFIX">
The suffix used for zip file names.