src/engine/SCons/Tool/tar.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="tar">
   8 <summary>
   9 XXX
  10 </summary>
  11 </tool>
  12
  13 <builder name="Tar">
  14 <summary>
  15 Builds a tar archive of the specified files
  16 and/or directories.
  17 Unlike most builder methods,
  18 the
  19 &b-Tar;
  20 builder method may be called multiple times
  21 for a given target;
  22 each additional call
  23 adds to the list of entries
  24 that will be built into the archive.
  25 Any source directories will
  26 be scanned for changes to
  27 any on-disk files,
  28 regardless of whether or not
  29 &scons;
  30 knows about them from other Builder or function calls.
  31
  32 <example>
  33 env.Tar('src.tar', 'src')
  34
  35 # Create the stuff.tar file.
  36 env.Tar('stuff', ['subdir1', 'subdir2'])
  37 # Also add "another" to the stuff.tar file.
  38 env.Tar('stuff', 'another')
  39
  40 # Set TARFLAGS to create a gzip-filtered archive.
  41 env = Environment(TARFLAGS = '-c -z')
  42 env.Tar('foo.tar.gz', 'foo')
  43
  44 # Also set the suffix to .tgz.
  45 env = Environment(TARFLAGS = '-c -z',
  46                   TARSUFFIX = '.tgz')
  47 env.Tar('foo')
  48 </example>
  49 </summary>
  50 </builder>
  51
  52 <cvar name="TAR">
  53 <summary>
  54 The tar archiver.
  55 </summary>
  56 </cvar>
  57
  58 <cvar name="TARCOM">
  59 <summary>
  60 The command line used to call the tar archiver.
  61 </summary>
  62 </cvar>
  63
  64 <cvar name="TARCOMSTR">
  65 <summary>
  66 The string displayed when archiving files
  67 using the tar archiver.
  68 If this is not set, then &cv-link-TARCOM; (the command line) is displayed.
  69
  70 <example>
  71 env = Environment(TARCOMSTR = "Archiving $TARGET")
  72 </example>
  73 </summary>
  74 </cvar>
  75
  76 <cvar name="TARFLAGS">
  77 <summary>
  78 General options passed to the tar archiver.
  79 </summary>
  80 </cvar>
  81
  82 <cvar name="TARSUFFIX">
  83 <summary>
  84 The suffix used for tar file names.
  85 </summary>
  86 </cvar>