diff options
author | Steven Knight <knight@baldmt.com> | 2005-02-15 13:55:44 (GMT) |
---|---|---|
committer | Steven Knight <knight@baldmt.com> | 2005-02-15 13:55:44 (GMT) |
commit | d809676c50c89f74f3210d4faf61c3f66a600777 (patch) | |
tree | 18a308eb5aa145b95de56c05aca90a609c3eaaf6 /src/engine/SCons/Tool/zip.xml | |
parent | f995934a8dca09977039d3a9bdb263805c1282b6 (diff) | |
download | SCons-d809676c50c89f74f3210d4faf61c3f66a600777.zip SCons-d809676c50c89f74f3210d4faf61c3f66a600777.tar.gz SCons-d809676c50c89f74f3210d4faf61c3f66a600777.tar.bz2 |
Accumulated documentation changes.
Diffstat (limited to 'src/engine/SCons/Tool/zip.xml')
-rw-r--r-- | src/engine/SCons/Tool/zip.xml | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/src/engine/SCons/Tool/zip.xml b/src/engine/SCons/Tool/zip.xml new file mode 100644 index 0000000..4e33c15 --- /dev/null +++ b/src/engine/SCons/Tool/zip.xml @@ -0,0 +1,83 @@ +<!-- __COPYRIGHT__ --> +<tool name="zip"> +<summary> +XXX +</summary> +</tool> + +<builder name="Zip"> +<summary> +Builds a zip archive of the specified files +and/or directories. +Unlike most builder methods, +the +&b-Zip; +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. + +<example> +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') +</example> +</summary> +</builder> + +<cvar name="ZIP"> +<summary> +The zip compression and file packaging utility. +</summary> +</cvar> + +<cvar name="ZIPCOM"> +<summary> +The command line used to call the zip utility, +or the internal Python function used to create a +zip archive. +</summary> +</cvar> + +<cvar name="ZIPCOMSTR"> +<summary> +The string displayed when archiving files +using the zip utility. +If this is not set, then &cv-ZIPCOM; +(the command line or internal Python function) is displayed. + +<example> +env = Environment(ZIPCOMSTR = "Zipping $TARGET") +</example> +</summary> +</cvar> + +<cvar name="ZIPCOMPRESSION"> +<summary> +The +<varname>compression</varname> +flag +from the Python +<filename>zipfile</filename> +module used by the internal Python function +to control whether the zip archive +is compressed or not. +The default value is +<varname>zipfile.ZIP_DEFLATED</varname>, +which creates a compressed zip archive. +This value has no effect when using Python 1.5.2 +or if the +<varname>zipfile</varname> +module is otherwise unavailable. +</summary> +</cvar> + +<cvar name="ZIPFLAGS"> +<summary> +General options passed to the zip utility. +</summary> +</cvar> |