1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
<!--
Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 The SCons Foundation
This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->
<tool name="tar">
<summary>
Sets construction variables for the &tar; archiver.
</summary>
<sets>
TAR
TARFLAGS
TARCOM
TARSUFFIX
</sets>
<uses>
TARCOMSTR
</uses>
</tool>
<builder name="Tar">
<summary>
Builds a tar archive of the specified files
and/or directories.
Unlike most builder methods,
the
&b-Tar;
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
&scons;
knows about them from other Builder or function calls.
<example>
env.Tar('src.tar', 'src')
# Create the stuff.tar file.
env.Tar('stuff', ['subdir1', 'subdir2'])
# Also add "another" to the stuff.tar file.
env.Tar('stuff', 'another')
# Set TARFLAGS to create a gzip-filtered archive.
env = Environment(TARFLAGS = '-c -z')
env.Tar('foo.tar.gz', 'foo')
# Also set the suffix to .tgz.
env = Environment(TARFLAGS = '-c -z',
TARSUFFIX = '.tgz')
env.Tar('foo')
</example>
</summary>
</builder>
<cvar name="TAR">
<summary>
The tar archiver.
</summary>
</cvar>
<cvar name="TARCOM">
<summary>
The command line used to call the tar archiver.
</summary>
</cvar>
<cvar name="TARCOMSTR">
<summary>
The string displayed when archiving files
using the tar archiver.
If this is not set, then &cv-link-TARCOM; (the command line) is displayed.
<example>
env = Environment(TARCOMSTR = "Archiving $TARGET")
</example>
</summary>
</cvar>
<cvar name="TARFLAGS">
<summary>
General options passed to the tar archiver.
</summary>
</cvar>
<cvar name="TARSUFFIX">
<summary>
The suffix used for tar file names.
</summary>
</cvar>
|
