<?xml version="1.0"?>
<!--
__COPYRIGHT__

This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->

<!DOCTYPE sconsdoc [
<!ENTITY % scons SYSTEM '../../doc/scons.mod'>
%scons;
<!ENTITY % builders-mod SYSTEM '../../doc/generated/builders.mod'>
%builders-mod;
<!ENTITY % functions-mod SYSTEM '../../doc/generated/functions.mod'>
%functions-mod;
<!ENTITY % tools-mod SYSTEM '../../doc/generated/tools.mod'>
%tools-mod;
<!ENTITY % variables-mod SYSTEM '../../doc/generated/variables.mod'>
%variables-mod;
]>

<sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">

<tool name="as">
<summary>
<para>
Sets construction variables for the &as; assembler.
</para>
</summary>
<sets>
<item>AS</item>
<item>ASFLAGS</item>
<item>ASCOM</item>
<item>ASPPFLAGS</item>
<item>ASPPCOM</item>
</sets>
<uses>
<item>CC</item>
<item>CPPFLAGS</item>
<item>_CPPDEFFLAGS</item>
<item>_CPPINCFLAGS</item>
</uses>
</tool>

<cvar name="AS">
<summary>
<para>
The assembler.
</para>
</summary>
</cvar>

<cvar name="ASCOM">
<summary>
<para>
The command line used to generate an object file
from an assembly-language source file.
</para>
</summary>
</cvar>

<cvar name="ASCOMSTR">
<summary>
<para>
The string displayed when an object file
is generated from an assembly-language source file.
If this is not set, then &cv-link-ASCOM; (the command line) is displayed.
</para>

<example_commands>
env = Environment(ASCOMSTR = "Assembling $TARGET")
</example_commands>
</summary>
</cvar>

<cvar name="ASFLAGS">
<summary>
<para>
General options passed to the assembler.
</para>
</summary>
</cvar>

<cvar name="ASPPCOM">
<summary>
<para>
The command line used to assemble an assembly-language
source file into an object file
after first running the file through the C preprocessor.
Any options specified
in the &cv-link-ASFLAGS; and &cv-link-CPPFLAGS; construction variables
are included on this command line.
</para>
</summary>
</cvar>

<cvar name="ASPPCOMSTR">
<summary>
<para>
The string displayed when an object file
is generated from an assembly-language source file
after first running the file through the C preprocessor.
If this is not set, then &cv-link-ASPPCOM; (the command line) is displayed.
</para>

<example_commands>
env = Environment(ASPPCOMSTR = "Assembling $TARGET")
</example_commands>
</summary>
</cvar>

<cvar name="ASPPFLAGS">
<summary>
<para>
General options when an assembling an assembly-language
source file into an object file
after first running the file through the C preprocessor.
The default is to use the value of &cv-link-ASFLAGS;.
</para>
</summary>
</cvar>

</sconsdoc>
