SCons/Tool/f03.xml

   1 <?xml version="1.0"?>
   2 <!--
   3 Copyright The SCons Foundation
   4
   5 This file is processed by the bin/SConsDoc.py module.
   6 See its __doc__ string for a discussion of the format.
   7 -->
   8
   9 <!DOCTYPE sconsdoc [
  10 <!ENTITY % scons SYSTEM '../../doc/scons.mod'>
  11 %scons;
  12 <!ENTITY % builders-mod SYSTEM '../../doc/generated/builders.mod'>
  13 %builders-mod;
  14 <!ENTITY % functions-mod SYSTEM '../../doc/generated/functions.mod'>
  15 %functions-mod;
  16 <!ENTITY % tools-mod SYSTEM '../../doc/generated/tools.mod'>
  17 %tools-mod;
  18 <!ENTITY % variables-mod SYSTEM '../../doc/generated/variables.mod'>
  19 %variables-mod;
  20 ]>
  21
  22 <sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
  23           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  24           xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
  25
  26 <tool name="f03">
  27 <summary>
  28 <para>
  29 Set construction variables for generic POSIX Fortran 03 compilers.
  30 </para>
  31 </summary>
  32 <sets>
  33 <item>F03</item>
  34 <item>F03FLAGS</item>
  35 <item>F03COM</item>
  36 <item>F03PPCOM</item>
  37 <item>SHF03</item>
  38 <item>SHF03FLAGS</item>
  39 <item>SHF03COM</item>
  40 <item>SHF03PPCOM</item>
  41 <item>_F03INCFLAGS</item>
  42 </sets>
  43 <uses>
  44 <item>F03COMSTR</item>
  45 <item>F03PPCOMSTR</item>
  46 <item>SHF03COMSTR</item>
  47 <item>SHF03PPCOMSTR</item>
  48 <item>FORTRANCOMMONFLAGS</item>
  49 </uses>
  50 </tool>
  51
  52 <cvar name="F03">
  53 <summary>
  54 <para>
  55 The Fortran 03 compiler.
  56 You should normally set the &cv-link-FORTRAN; variable,
  57 which specifies the default Fortran compiler
  58 for all Fortran versions.
  59 You only need to set &cv-link-F03; if you need to use a specific compiler
  60 or compiler version for Fortran 03 files.
  61 </para>
  62 </summary>
  63 </cvar>
  64
  65 <cvar name="F03COM">
  66 <summary>
  67 <para>
  68 The command line used to compile a Fortran 03 source file to an object file.
  69 You only need to set &cv-link-F03COM; if you need to use a specific
  70 command line for Fortran 03 files.
  71 You should normally set the &cv-link-FORTRANCOM; variable,
  72 which specifies the default command line
  73 for all Fortran versions.
  74 </para>
  75 </summary>
  76 </cvar>
  77
  78 <cvar name="F03COMSTR">
  79 <summary>
  80 <para>
  81 If set, the string displayed when a Fortran 03 source file
  82 is compiled to an object file.
  83 If not set, then &cv-link-F03COM; or &cv-link-FORTRANCOM;
  84 (the command line) is displayed.
  85 </para>
  86 </summary>
  87 </cvar>
  88
  89 <cvar name="F03FILESUFFIXES">
  90 <summary>
  91 <para>
  92 The list of file extensions for which the F03 dialect will be used. By
  93 default, this is <literal>['.f03']</literal>
  94 </para>
  95 </summary>
  96 </cvar>
  97
  98 <cvar name="F03PPFILESUFFIXES">
  99 <summary>
 100 <para>
 101 The list of file extensions for which the compilation + preprocessor pass for
 102 F03 dialect will be used. By default, this is empty.
 103 </para>
 104 </summary>
 105 </cvar>
 106
 107 <cvar name="F03FLAGS">
 108 <summary>
 109 <para>
 110 General user-specified options that are passed to the Fortran 03 compiler.
 111 Note that this variable does
 112 <emphasis>not</emphasis>
 113 contain
 114 <option>-I</option>
 115 (or similar) include search path options
 116 that scons generates automatically from &cv-link-F03PATH;.
 117 See
 118 &cv-link-_F03INCFLAGS;
 119 below,
 120 for the variable that expands to those options.
 121 You only need to set &cv-link-F03FLAGS; if you need to define specific
 122 user options for Fortran 03 files.
 123 You should normally set the &cv-link-FORTRANFLAGS; variable,
 124 which specifies the user-specified options
 125 passed to the default Fortran compiler
 126 for all Fortran versions.
 127 </para>
 128 </summary>
 129 </cvar>
 130
 131 <cvar name="_F03INCFLAGS">
 132 <summary>
 133 <para>
 134 An automatically-generated construction variable
 135 containing the Fortran 03 compiler command-line options
 136 for specifying directories to be searched for include files.
 137 The value of &cv-link-_F03INCFLAGS; is created
 138 by appending &cv-link-INCPREFIX; and &cv-link-INCSUFFIX;
 139 to the beginning and end
 140 of each directory in &cv-link-F03PATH;.
 141 </para>
 142 </summary>
 143 </cvar>
 144
 145 <cvar name="F03PATH">
 146 <summary>
 147 <para>
 148 The list of directories that the Fortran 03 compiler will search for include
 149 directories. The implicit dependency scanner will search these
 150 directories for include files. Don't explicitly put include directory
 151 arguments in &cv-link-F03FLAGS; because the result will be non-portable
 152 and the directories will not be searched by the dependency scanner. Note:
 153 directory names in &cv-link-F03PATH; will be looked-up relative to the SConscript
 154 directory when they are used in a command. To force
 155 &scons;
 156 to look-up a directory relative to the root of the source tree use #:
 157 You only need to set &cv-link-F03PATH; if you need to define a specific
 158 include path for Fortran 03 files.
 159 You should normally set the &cv-link-FORTRANPATH; variable,
 160 which specifies the include path
 161 for the default Fortran compiler
 162 for all Fortran versions.
 163 </para>
 164
 165 <example_commands>
 166 env = Environment(F03PATH='#/include')
 167 </example_commands>
 168
 169 <para>
 170 The directory look-up can also be forced using the
 171 &Dir;()
 172 function:
 173 </para>
 174
 175 <example_commands>
 176 include = Dir('include')
 177 env = Environment(F03PATH=include)
 178 </example_commands>
 179
 180 <para>
 181 The directory list will be added to command lines
 182 through the automatically-generated
 183 &cv-link-_F03INCFLAGS;
 184 construction variable,
 185 which is constructed by
 186 appending the values of the
 187 &cv-link-INCPREFIX; and &cv-link-INCSUFFIX;
 188 construction variables
 189 to the beginning and end
 190 of each directory in &cv-link-F03PATH;.
 191 Any command lines you define that need
 192 the F03PATH directory list should
 193 include &cv-link-_F03INCFLAGS;:
 194 </para>
 195
 196 <example_commands>
 197 env = Environment(F03COM="my_compiler $_F03INCFLAGS -c -o $TARGET $SOURCE")
 198 </example_commands>
 199 </summary>
 200 </cvar>
 201
 202 <cvar name="F03PPCOM">
 203 <summary>
 204 <para>
 205 The command line used to compile a Fortran 03 source file to an object file
 206 after first running the file through the C preprocessor.
 207 Any options specified in the &cv-link-F03FLAGS; and &cv-link-CPPFLAGS; construction variables
 208 are included on this command line.
 209 You only need to set &cv-link-F03PPCOM; if you need to use a specific
 210 C-preprocessor command line for Fortran 03 files.
 211 You should normally set the &cv-link-FORTRANPPCOM; variable,
 212 which specifies the default C-preprocessor command line
 213 for all Fortran versions.
 214 </para>
 215 </summary>
 216 </cvar>
 217
 218 <cvar name="F03PPCOMSTR">
 219 <summary>
 220 <para>
 221 If set, the string displayed when a Fortran 03 source file
 222 is compiled to an object file
 223 after first running the file through the C preprocessor.
 224 If not set, then &cv-link-F03PPCOM; or &cv-link-FORTRANPPCOM;
 225 (the command line) is displayed.
 226 </para>
 227 </summary>
 228 </cvar>
 229
 230 <cvar name="SHF03">
 231 <summary>
 232 <para>
 233 The Fortran 03 compiler used for generating shared-library objects.
 234 You should normally set the &cv-link-SHFORTRAN; variable,
 235 which specifies the default Fortran compiler
 236 for all Fortran versions.
 237 You only need to set &cv-link-SHF03; if you need to use a specific compiler
 238 or compiler version for Fortran 03 files.
 239 </para>
 240 </summary>
 241 </cvar>
 242
 243 <cvar name="SHF03COM">
 244 <summary>
 245 <para>
 246 The command line used to compile a Fortran 03 source file
 247 to a shared-library object file.
 248 You only need to set &cv-link-SHF03COM; if you need to use a specific
 249 command line for Fortran 03 files.
 250 You should normally set the &cv-link-SHFORTRANCOM; variable,
 251 which specifies the default command line
 252 for all Fortran versions.
 253 </para>
 254 </summary>
 255 </cvar>
 256
 257 <cvar name="SHF03COMSTR">
 258 <summary>
 259 <para>
 260 If set, the string displayed when a Fortran 03 source file
 261 is compiled to a shared-library object file.
 262 If not set, then &cv-link-SHF03COM; or &cv-link-SHFORTRANCOM;
 263 (the command line) is displayed.
 264 </para>
 265 </summary>
 266 </cvar>
 267
 268 <cvar name="SHF03FLAGS">
 269 <summary>
 270 <para>
 271 Options that are passed to the Fortran 03 compiler
 272 to generated shared-library objects.
 273 You only need to set &cv-link-SHF03FLAGS; if you need to define specific
 274 user options for Fortran 03 files.
 275 You should normally set the &cv-link-FORTRANCOMMONFLAGS; variable,
 276 which specifies the user-specified options
 277 passed to the default Fortran compiler
 278 for all Fortran versions.
 279 </para>
 280 </summary>
 281 </cvar>
 282
 283 <cvar name="SHF03PPCOM">
 284 <summary>
 285 <para>
 286 The command line used to compile a Fortran 03 source file to a
 287 shared-library object file
 288 after first running the file through the C preprocessor.
 289 Any options specified in the &cv-link-SHF03FLAGS; and &cv-link-CPPFLAGS; construction variables
 290 are included on this command line.
 291 You only need to set &cv-link-SHF03PPCOM; if you need to use a specific
 292 C-preprocessor command line for Fortran 03 files.
 293 You should normally set the &cv-link-SHFORTRANPPCOM; variable,
 294 which specifies the default C-preprocessor command line
 295 for all Fortran versions.
 296 </para>
 297 </summary>
 298 </cvar>
 299
 300 <cvar name="SHF03PPCOMSTR">
 301 <summary>
 302 <para>
 303 If set, the string displayed when a Fortran 03 source file
 304 is compiled to a shared-library object file
 305 after first running the file through the C preprocessor.
 306 If not set, then &cv-link-SHF03PPCOM; or &cv-link-SHFORTRANPPCOM;
 307 (the command line) is displayed.
 308 </para>
 309 </summary>
 310 </cvar>
 311
 312 </sconsdoc>