summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/f77.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Tool/f77.xml')
-rw-r--r--src/engine/SCons/Tool/f77.xml125
1 files changed, 92 insertions, 33 deletions
diff --git a/src/engine/SCons/Tool/f77.xml b/src/engine/SCons/Tool/f77.xml
index 167a7d7..8410705 100644
--- a/src/engine/SCons/Tool/f77.xml
+++ b/src/engine/SCons/Tool/f77.xml
@@ -1,92 +1,124 @@
+<?xml version="1.0" encoding="UTF-8"?>
<!--
-Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation
+Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation
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/scons.xsd scons.xsd">
+
<tool name="f77">
<summary>
+<para>
Set construction variables for generic POSIX Fortran 77 compilers.
+</para>
</summary>
<sets>
-F77
-F77FLAGS
-F77COM
-F77PPCOM
-F77FILESUFFIXES
-F77PPFILESUFFIXES
-FORTRAN
-FORTRANFLAGS
-FORTRANCOM
-SHF77
-SHF77FLAGS
-SHF77COM
-SHF77PPCOM
-SHFORTRAN
-SHFORTRANFLAGS
-SHFORTRANCOM
-SHFORTRANPPCOM
-_F77INCFLAGS
+<item>F77</item>
+<item>F77FLAGS</item>
+<item>F77COM</item>
+<item>F77PPCOM</item>
+<item>F77FILESUFFIXES</item>
+<item>F77PPFILESUFFIXES</item>
+<item>FORTRAN</item>
+<item>FORTRANFLAGS</item>
+<item>FORTRANCOM</item>
+<item>SHF77</item>
+<item>SHF77FLAGS</item>
+<item>SHF77COM</item>
+<item>SHF77PPCOM</item>
+<item>SHFORTRAN</item>
+<item>SHFORTRANFLAGS</item>
+<item>SHFORTRANCOM</item>
+<item>SHFORTRANPPCOM</item>
+<item>_F77INCFLAGS</item>
</sets>
<uses>
-F77COMSTR
-F77PPCOMSTR
-FORTRANCOMSTR
-FORTRANPPCOMSTR
-SHF77COMSTR
-SHF77PPCOMSTR
-SHFORTRANCOMSTR
-SHFORTRANPPCOMSTR
+<item>F77COMSTR</item>
+<item>F77PPCOMSTR</item>
+<item>FORTRANCOMSTR</item>
+<item>FORTRANPPCOMSTR</item>
+<item>SHF77COMSTR</item>
+<item>SHF77PPCOMSTR</item>
+<item>SHFORTRANCOMSTR</item>
+<item>SHFORTRANPPCOMSTR</item>
</uses>
</tool>
<cvar name="F77">
<summary>
+<para>
The Fortran 77 compiler.
You should normally set the &cv-link-FORTRAN; variable,
which specifies the default Fortran compiler
for all Fortran versions.
You only need to set &cv-link-F77; if you need to use a specific compiler
or compiler version for Fortran 77 files.
+</para>
</summary>
</cvar>
<cvar name="F77COM">
<summary>
+<para>
The command line used to compile a Fortran 77 source file to an object file.
You only need to set &cv-link-F77COM; if you need to use a specific
command line for Fortran 77 files.
You should normally set the &cv-link-FORTRANCOM; variable,
which specifies the default command line
for all Fortran versions.
+</para>
</summary>
</cvar>
<cvar name="F77FILESUFFIXES">
<summary>
+<para>
The list of file extensions for which the F77 dialect will be used. By
default, this is ['.f77']
+</para>
</summary>
</cvar>
<cvar name="F77PPFILESUFFIXES">
<summary>
+<para>
The list of file extensions for which the compilation + preprocessor pass for
F77 dialect will be used. By default, this is empty
+</para>
</summary>
</cvar>
<cvar name="F77COMSTR">
<summary>
+<para>
The string displayed when a Fortran 77 source file
is compiled to an object file.
If this is not set, then &cv-link-F77COM; or &cv-link-FORTRANCOM;
(the command line) is displayed.
+</para>
</summary>
</cvar>
<cvar name="F77FLAGS">
<summary>
+<para>
General user-specified options that are passed to the Fortran 77 compiler.
Note that this variable does
<emphasis>not</emphasis>
@@ -104,11 +136,13 @@ You should normally set the &cv-link-FORTRANFLAGS; variable,
which specifies the user-specified options
passed to the default Fortran compiler
for all Fortran versions.
+</para>
</summary>
</cvar>
<cvar name="_F77INCFLAGS">
<summary>
+<para>
An automatically-generated construction variable
containing the Fortran 77 compiler command-line options
for specifying directories to be searched for include files.
@@ -116,11 +150,13 @@ The value of &cv-link-_F77INCFLAGS; is created
by appending &cv-link-INCPREFIX; and &cv-link-INCSUFFIX;
to the beginning and end
of each directory in &cv-link-F77PATH;.
+</para>
</summary>
</cvar>
<cvar name="F77PATH">
<summary>
+<para>
The list of directories that the Fortran 77 compiler will search for include
directories. The implicit dependency scanner will search these
directories for include files. Don't explicitly put include directory
@@ -136,20 +172,24 @@ You should normally set the &cv-link-FORTRANPATH; variable,
which specifies the include path
for the default Fortran compiler
for all Fortran versions.
+</para>
-<example>
+<example_commands>
env = Environment(F77PATH='#/include')
-</example>
+</example_commands>
+<para>
The directory look-up can also be forced using the
&Dir;()
function:
+</para>
-<example>
+<example_commands>
include = Dir('include')
env = Environment(F77PATH=include)
-</example>
+</example_commands>
+<para>
The directory list will be added to command lines
through the automatically-generated
&cv-link-_F77INCFLAGS;
@@ -163,15 +203,17 @@ of each directory in &cv-link-F77PATH;.
Any command lines you define that need
the F77PATH directory list should
include &cv-link-_F77INCFLAGS;:
+</para>
-<example>
+<example_commands>
env = Environment(F77COM="my_compiler $_F77INCFLAGS -c -o $TARGET $SOURCE")
-</example>
+</example_commands>
</summary>
</cvar>
<cvar name="F77PPCOM">
<summary>
+<para>
The command line used to compile a Fortran 77 source file to an object file
after first running the file through the C preprocessor.
Any options specified in the &cv-link-F77FLAGS; and &cv-link-CPPFLAGS; construction variables
@@ -181,32 +223,38 @@ C-preprocessor command line for Fortran 77 files.
You should normally set the &cv-link-FORTRANPPCOM; variable,
which specifies the default C-preprocessor command line
for all Fortran versions.
+</para>
</summary>
</cvar>
<cvar name="F77PPCOMSTR">
<summary>
+<para>
The string displayed when a Fortran 77 source file
is compiled to an object file
after first running the file through the C preprocessor.
If this is not set, then &cv-link-F77PPCOM; or &cv-link-FORTRANPPCOM;
(the command line) is displayed.
+</para>
</summary>
</cvar>
<cvar name="SHF77">
<summary>
+<para>
The Fortran 77 compiler used for generating shared-library objects.
You should normally set the &cv-link-SHFORTRAN; variable,
which specifies the default Fortran compiler
for all Fortran versions.
You only need to set &cv-link-SHF77; if you need to use a specific compiler
or compiler version for Fortran 77 files.
+</para>
</summary>
</cvar>
<cvar name="SHF77COM">
<summary>
+<para>
The command line used to compile a Fortran 77 source file
to a shared-library object file.
You only need to set &cv-link-SHF77COM; if you need to use a specific
@@ -214,20 +262,24 @@ command line for Fortran 77 files.
You should normally set the &cv-link-SHFORTRANCOM; variable,
which specifies the default command line
for all Fortran versions.
+</para>
</summary>
</cvar>
<cvar name="SHF77COMSTR">
<summary>
+<para>
The string displayed when a Fortran 77 source file
is compiled to a shared-library object file.
If this is not set, then &cv-link-SHF77COM; or &cv-link-SHFORTRANCOM;
(the command line) is displayed.
+</para>
</summary>
</cvar>
<cvar name="SHF77FLAGS">
<summary>
+<para>
Options that are passed to the Fortran 77 compiler
to generated shared-library objects.
You only need to set &cv-link-SHF77FLAGS; if you need to define specific
@@ -236,11 +288,13 @@ You should normally set the &cv-link-SHFORTRANFLAGS; variable,
which specifies the user-specified options
passed to the default Fortran compiler
for all Fortran versions.
+</para>
</summary>
</cvar>
<cvar name="SHF77PPCOM">
<summary>
+<para>
The command line used to compile a Fortran 77 source file to a
shared-library object file
after first running the file through the C preprocessor.
@@ -251,15 +305,20 @@ C-preprocessor command line for Fortran 77 files.
You should normally set the &cv-link-SHFORTRANPPCOM; variable,
which specifies the default C-preprocessor command line
for all Fortran versions.
+</para>
</summary>
</cvar>
<cvar name="SHF77PPCOMSTR">
<summary>
+<para>
The string displayed when a Fortran 77 source file
is compiled to a shared-library object file
after first running the file through the C preprocessor.
If this is not set, then &cv-link-SHF77PPCOM; or &cv-link-SHFORTRANPPCOM;
(the command line) is displayed.
+</para>
</summary>
</cvar>
+
+</sconsdoc> \ No newline at end of file
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-17 16:50:15 +0000