SCons/Tool/ar.xml

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