Merged revisions 1826-1882 via svnmerge from
[scons.git] / src / engine / SCons / Tool / f77.xml
1 <!--
2 __COPYRIGHT__
3
4 This file is processed by the bin/SConsDoc.py module.
5 See its __doc__ string for a discussion of the format.
6 -->
7 <tool name="f77">
8 <summary>
9 XXX
10 </summary>
11 </tool>
12
13 <cvar name="F77">
14 <summary>
15 The Fortran 77 compiler.
16 You should normally set the &cv-link-FORTRAN; variable,
17 which specifies the default Fortran compiler
18 for all Fortran versions.
19 You only need to set &cv-link-F77; if you need to use a specific compiler
20 or compiler version for Fortran 77 files.
21 </summary>
22 </cvar>
23
24 <cvar name="F77COM">
25 <summary>
26 The command line used to compile a Fortran 77 source file to an object file.
27 You only need to set &cv-link-F77COM; if you need to use a specific
28 command line for Fortran 77 files.
29 You should normally set the &cv-link-FORTRANCOM; variable,
30 which specifies the default command line
31 for all Fortran versions.
32 </summary>
33 </cvar>
34
35 <cvar name="F77COMSTR">
36 <summary>
37 The string displayed when a Fortran 77 source file
38 is compiled to an object file.
39 If this is not set, then &cv-link-F77COM; or &cv-link-FORTRANCOM;
40 (the command line) is displayed.
41 </summary>
42 </cvar>
43
44 <cvar name="F77FLAGS">
45 <summary>
46 General user-specified options that are passed to the Fortran 77 compiler.
47 Note that this variable does
48 <emphasis>not</emphasis>
49 contain
50 <option>-I</option>
51 (or similar) include search path options
52 that scons generates automatically from &cv-link-F77PATH;.
53 See
54 &cv-link-_F77INCFLAGS;
55 below,
56 for the variable that expands to those options.
57 You only need to set &cv-link-F77FLAGS; if you need to define specific
58 user options for Fortran 77 files.
59 You should normally set the &cv-link-FORTRANFLAGS; variable,
60 which specifies the user-specified options
61 passed to the default Fortran compiler
62 for all Fortran versions.
63 </summary>
64 </cvar>
65
66 <cvar name="_F77INCFLAGS">
67 <summary>
68 An automatically-generated construction variable
69 containing the Fortran 77 compiler command-line options
70 for specifying directories to be searched for include files.
71 The value of &cv-link-_F77INCFLAGS; is created
72 by appending &cv-link-INCPREFIX; and &cv-link-INCSUFFIX;
73 to the beginning and end
74 of each directory in &cv-link-F77PATH;.
75 </summary>
76 </cvar>
77
78 <cvar name="F77PATH">
79 <summary>
80 The list of directories that the Fortran 77 compiler will search for include
81 directories. The implicit dependency scanner will search these
82 directories for include files. Don't explicitly put include directory
83 arguments in &cv-link-F77FLAGS; because the result will be non-portable
84 and the directories will not be searched by the dependency scanner. Note:
85 directory names in &cv-link-F77PATH; will be looked-up relative to the SConscript
86 directory when they are used in a command. To force
87 &scons;
88 to look-up a directory relative to the root of the source tree use #:
89 You only need to set &cv-link-F77PATH; if you need to define a specific
90 include path for Fortran 77 files.
91 You should normally set the &cv-link-FORTRANPATH; variable,
92 which specifies the include path
93 for the default Fortran compiler
94 for all Fortran versions.
95
96 <example>
97 env = Environment(F77PATH='#/include')
98 </example>
99
100 The directory look-up can also be forced using the
101 &Dir;()
102 function:
103
104 <example>
105 include = Dir('include')
106 env = Environment(F77PATH=include)
107 </example>
108
109 The directory list will be added to command lines
110 through the automatically-generated
111 &cv-link-_F77INCFLAGS;
112 construction variable,
113 which is constructed by
114 appending the values of the
115 &cv-link-INCPREFIX; and &cv-link-INCSUFFIX;
116 construction variables
117 to the beginning and end
118 of each directory in &cv-link-F77PATH;.
119 Any command lines you define that need
120 the F77PATH directory list should
121 include &cv-link-_F77INCFLAGS;:
122
123 <example>
124 env = Environment(F77COM="my_compiler $_F77INCFLAGS -c -o $TARGET $SOURCE")
125 </example>
126 </summary>
127 </cvar>
128
129 <cvar name="F77PPCOM">
130 <summary>
131 The command line used to compile a Fortran 77 source file to an object file
132 after first running the file through the C preprocessor.
133 Any options specified in the &cv-link-F77FLAGS; and &cv-link-CPPFLAGS; construction variables
134 are included on this command line.
135 You only need to set &cv-link-F77PPCOM; if you need to use a specific
136 C-preprocessor command line for Fortran 77 files.
137 You should normally set the &cv-link-FORTRANPPCOM; variable,
138 which specifies the default C-preprocessor command line
139 for all Fortran versions.
140 </summary>
141 </cvar>
142
143 <cvar name="SHF77">
144 <summary>
145 The Fortran 77 compiler used for generating shared-library objects.
146 You should normally set the &cv-link-SHFORTRAN; variable,
147 which specifies the default Fortran compiler
148 for all Fortran versions.
149 You only need to set &cv-link-SHF77; if you need to use a specific compiler
150 or compiler version for Fortran 77 files.
151 </summary>
152 </cvar>
153
154 <cvar name="SHF77COM">
155 <summary>
156 The command line used to compile a Fortran 77 source file
157 to a shared-library object file.
158 You only need to set &cv-link-SHF77COM; if you need to use a specific
159 command line for Fortran 77 files.
160 You should normally set the &cv-link-SHFORTRANCOM; variable,
161 which specifies the default command line
162 for all Fortran versions.
163 </summary>
164 </cvar>
165
166 <cvar name="SHF77COMSTR">
167 <summary>
168 The string displayed when a Fortran 77 source file
169 is compiled to a shared-library object file.
170 If this is not set, then &cv-link-SHF77COM; or &cv-link-SHFORTRANCOM;
171 (the command line) is displayed.
172 </summary>
173 </cvar>
174
175 <cvar name="SHF77FLAGS">
176 <summary>
177 Options that are passed to the Fortran 77 compiler
178 to generated shared-library objects.
179 You only need to set &cv-link-SHF77FLAGS; if you need to define specific
180 user options for Fortran 77 files.
181 You should normally set the &cv-link-SHFORTRANFLAGS; variable,
182 which specifies the user-specified options
183 passed to the default Fortran compiler
184 for all Fortran versions.
185 </summary>
186 </cvar>
187
188 <cvar name="SHF77PPCOM">
189 <summary>
190 The command line used to compile a Fortran 77 source file to a
191 shared-library object file
192 after first running the file through the C preprocessor.
193 Any options specified in the &cv-link-SHF77FLAGS; and &cv-link-CPPFLAGS; construction variables
194 are included on this command line.
195 You only need to set &cv-link-SHF77PPCOM; if you need to use a specific
196 C-preprocessor command line for Fortran 77 files.
197 You should normally set the &cv-link-SHFORTRANPPCOM; variable,
198 which specifies the default C-preprocessor command line
199 for all Fortran versions.
200 </summary>
201 </cvar>