SCons/Tool/ar.xml

   1 <?xml version="1.0"?>
   2 <!--
   3 __COPYRIGHT__
   4
   5 This file is processed by the bin/SConsDoc.py module.
   6 See its __doc__ string for a discussion of the format.
   7 -->
   8
   9 <!DOCTYPE sconsdoc [
  10 <!ENTITY % scons SYSTEM '../../doc/scons.mod'>
  11 %scons;
  12 <!ENTITY % builders-mod SYSTEM '../../doc/generated/builders.mod'>
  13 %builders-mod;
  14 <!ENTITY % functions-mod SYSTEM '../../doc/generated/functions.mod'>
  15 %functions-mod;
  16 <!ENTITY % tools-mod SYSTEM '../../doc/generated/tools.mod'>
  17 %tools-mod;
  18 <!ENTITY % variables-mod SYSTEM '../../doc/generated/variables.mod'>
  19 %variables-mod;
  20 ]>
  21
  22 <sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
  23           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  24           xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
  25
  26 <tool name="ar">
  27 <summary>
  28 <para>
  29 Sets construction variables for the &ar; library archiver.
  30 </para>
  31 </summary>
  32 <sets>
  33 <item>AR</item>
  34 <item>ARFLAGS</item>
  35 <item>ARCOM</item>
  36 <item>LIBPREFIX</item>
  37 <item>LIBSUFFIX</item>
  38 <item>RANLIB</item>
  39 <item>RANLIBFLAGS</item>
  40 <item>RANLIBCOM</item>
  41 </sets>
  42 <uses>
  43 </uses>
  44 </tool>
  45
  46 <cvar name="AR">
  47 <summary>
  48 <para>
  49 The static library archiver.
  50 </para>
  51 </summary>
  52 </cvar>
  53
  54 <cvar name="ARCOM">
  55 <summary>
  56 <para>
  57 The command line used to generate a static library from object files.
  58 </para>
  59 </summary>
  60 </cvar>
  61
  62 <cvar name="ARCOMSTR">
  63 <summary>
  64 <para>
  65 The string displayed when a static library is
  66 generated from object files.
  67 If this is not set, then &cv-link-ARCOM; (the command line) is displayed.
  68 </para>
  69
  70 <example_commands>
  71 env = Environment(ARCOMSTR = "Archiving $TARGET")
  72 </example_commands>
  73 </summary>
  74 </cvar>
  75
  76 <cvar name="ARFLAGS">
  77 <summary>
  78 <para>
  79 General options passed to the static library archiver.
  80 </para>
  81 </summary>
  82 </cvar>
  83
  84 <cvar name="RANLIB">
  85 <summary>
  86 <para>
  87 The archive indexer.
  88 </para>
  89 </summary>
  90 </cvar>
  91
  92 <cvar name="RANLIBCOM">
  93 <summary>
  94 <para>
  95 The command line used to index a static library archive.
  96 </para>
  97 </summary>
  98 </cvar>
  99
 100 <cvar name="RANLIBCOMSTR">
 101 <summary>
 102 <para>
 103 The string displayed when a static library archive is indexed.
 104 If this is not set, then &cv-link-RANLIBCOM; (the command line) is displayed.
 105 </para>
 106
 107 <example_commands>
 108 env = Environment(RANLIBCOMSTR = "Indexing $TARGET")
 109 </example_commands>
 110 </summary>
 111 </cvar>
 112
 113 <cvar name="RANLIBFLAGS">
 114 <summary>
 115 <para>
 116 General options passed to the archive indexer.
 117 </para>
 118 </summary>
 119 </cvar>
 120
 121 </sconsdoc>