src/engine/SCons/Tool/ar.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="ar">
   8 <summary>
   9 Sets construction variables for the &ar; library archiver.
  10 </summary>
  11 <sets>
  12 AR
  13 ARFLAGS
  14 ARCOM
  15 LIBPREFIX
  16 LIBSUFFIX
  17 RANLIB
  18 RANLIBFLAGS
  19 RANLIBCOM
  20 </sets>
  21 <uses>
  22 </uses>
  23 </tool>
  24
  25 <cvar name="AR">
  26 <summary>
  27 The static library archiver.
  28 </summary>
  29 </cvar>
  30
  31 <cvar name="ARCOM">
  32 <summary>
  33 The command line used to generate a static library from object files.
  34 </summary>
  35 </cvar>
  36
  37 <cvar name="ARCOMSTR">
  38 <summary>
  39 The string displayed when an object file
  40 is generated from an assembly-language source file.
  41 If this is not set, then &cv-link-ARCOM; (the command line) is displayed.
  42
  43 <example>
  44 env = Environment(ARCOMSTR = "Archiving $TARGET")
  45 </example>
  46 </summary>
  47 </cvar>
  48
  49 <cvar name="ARFLAGS">
  50 <summary>
  51 General options passed to the static library archiver.
  52 </summary>
  53 </cvar>
  54
  55 <cvar name="RANLIB">
  56 <summary>
  57 The archive indexer.
  58 </summary>
  59 </cvar>
  60
  61 <cvar name="RANLIBCOM">
  62 <summary>
  63 The command line used to index a static library archive.
  64 </summary>
  65 </cvar>
  66
  67 <cvar name="RANLIBCOMSTR">
  68 <summary>
  69 The string displayed when a static library archive is indexed.
  70 If this is not set, then &cv-link-RANLIBCOM; (the command line) is displayed.
  71
  72 <example>
  73 env = Environment(RANLIBCOMSTR = "Indexing $TARGET")
  74 </example>
  75 </summary>
  76 </cvar>
  77
  78 <cvar name="RANLIBFLAGS">
  79 <summary>
  80 General options passed to the archive indexer.
  81 </summary>
  82 </cvar>