src/engine/SCons/Tool/tar.xml

   1 <!-- __COPYRIGHT__ -->
   2 <tool name="tar">
   3 <summary>
   4 XXX
   5 </summary>
   6 </tool>
   7
   8 <builder name="Tar">
   9 <summary>
  10 Builds a tar archive of the specified files
  11 and/or directories.
  12 Unlike most builder methods,
  13 the
  14 &b-Tar;
  15 builder method may be called multiple times
  16 for a given target;
  17 each additional call
  18 adds to the list of entries
  19 that will be built into the archive.
  20
  21 <example>
  22 env.Tar('src.tar', 'src')
  23
  24 # Create the stuff.tar file.
  25 env.Tar('stuff', ['subdir1', 'subdir2'])
  26 # Also add "another" to the stuff.tar file.
  27 env.Tar('stuff', 'another')
  28
  29 # Set TARFLAGS to create a gzip-filtered archive.
  30 env = Environment(TARFLAGS = '-c -z')
  31 env.Tar('foo.tar.gz', 'foo')
  32
  33 # Also set the suffix to .tgz.
  34 env = Environment(TARFLAGS = '-c -z',
  35                   TARSUFFIX = '.tgz')
  36 env.Tar('foo')
  37 </example>
  38 </summary>
  39 </builder>
  40
  41 <cvar name="TAR">
  42 <summary>
  43 The tar archiver.
  44 </summary>
  45 </cvar>
  46
  47 <cvar name="TARCOM">
  48 <summary>
  49 The command line used to call the tar archiver.
  50 </summary>
  51 </cvar>
  52
  53 <cvar name="TARCOMSTR">
  54 <summary>
  55 The string displayed when archiving files
  56 using the tar archiver.
  57 If this is not set, then &cv-TARCOM; (the command line) is displayed.
  58
  59 <example>
  60 env = Environment(TARCOMSTR = "Archiving $TARGET")
  61 </example>
  62 </summary>
  63 </cvar>
  64
  65 <cvar name="TARFLAGS">
  66 <summary>
  67 General options passed to the tar archiver.
  68 </summary>
  69 </cvar>
  70
  71 <cvar name="TARSUFFIX">
  72 <summary>
  73 The suffix used for tar file names.
  74 </summary>
  75 </cvar>