doc/user/variables.in

   1 <!--
   2
   3   __COPYRIGHT__
   4
   5   Permission is hereby granted, free of charge, to any person obtaining
   6   a copy of this software and associated documentation files (the
   7   "Software"), to deal in the Software without restriction, including
   8   without limitation the rights to use, copy, modify, merge, publish,
   9   distribute, sublicense, and/or sell copies of the Software, and to
  10   permit persons to whom the Software is furnished to do so, subject to
  11   the following conditions:
  12
  13   The above copyright notice and this permission notice shall be included
  14   in all copies or substantial portions of the Software.
  15
  16   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  17   KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  18   WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23
  24 -->
  25
  26 <para>
  27
  28 This appendix contains descriptions of all of the
  29 construction variables that are <emphasis>potentially</emphasis>
  30 available "out of the box" in this version of SCons.
  31 Whether or not setting a construction variable
  32 in a construction environment
  33 will actually have an effect depends on
  34 whether any of the Tools and/or Builders
  35 that use the variable have been
  36 included in the construction environment.
  37
  38 </para>
  39
  40 <para>
  41
  42 In this appendix, we have
  43 appended the initial <envar>$</envar>
  44 (dollar sign) to the beginning of each
  45 variable name when it appears in the text,
  46 but left off the dollar sign
  47 in the left-hand column
  48 where the name appears for each entry.
  49
  50 </para>
  51
  52 <variablelist>
  53
  54 &variables-gen;
  55
  56 </variablelist>