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 Set construction variables for generic POSIX Fortran 77 compilers.
  10 </summary>
  11 <sets>
  12 F77
  13 F77FLAGS
  14 F77COM
  15 F77PPCOM
  16 FORTRAN
  17 FORTRANFLAGS
  18 FORTRANCOM
  19 SHF77
  20 SHF77FLAGS
  21 SHF77COM
  22 SHF77PPCOM
  23 SHFORTRAN
  24 SHFORTRANFLAGS
  25 SHFORTRANCOM
  26 SHFORTRANPPCOM
  27 _F77INCFLAGS
  28 </sets>
  29 <uses>
  30 F77COMSTR
  31 F77PPCOMSTR
  32 FORTRANCOMSTR
  33 FORTRANPPCOMSTR
  34 SHF77COMSTR
  35 SHF77PPCOMSTR
  36 SHFORTRANCOMSTR
  37 SHFORTRANPPCOMSTR
  38 </uses>
  39 </tool>
  40
  41 <cvar name="F77">
  42 <summary>
  43 The Fortran 77 compiler.
  44 You should normally set the &cv-link-FORTRAN; variable,
  45 which specifies the default Fortran compiler
  46 for all Fortran versions.
  47 You only need to set &cv-link-F77; if you need to use a specific compiler
  48 or compiler version for Fortran 77 files.
  49 </summary>
  50 </cvar>
  51
  52 <cvar name="F77COM">
  53 <summary>
  54 The command line used to compile a Fortran 77 source file to an object file.
  55 You only need to set &cv-link-F77COM; if you need to use a specific
  56 command line for Fortran 77 files.
  57 You should normally set the &cv-link-FORTRANCOM; variable,
  58 which specifies the default command line
  59 for all Fortran versions.
  60 </summary>
  61 </cvar>
  62
  63 <cvar name="F77COMSTR">
  64 <summary>
  65 The string displayed when a Fortran 77 source file
  66 is compiled to an object file.
  67 If this is not set, then &cv-link-F77COM; or &cv-link-FORTRANCOM;
  68 (the command line) is displayed.
  69 </summary>
  70 </cvar>
  71
  72 <cvar name="F77FLAGS">
  73 <summary>
  74 General user-specified options that are passed to the Fortran 77 compiler.
  75 Note that this variable does
  76 <emphasis>not</emphasis>
  77 contain
  78 <option>-I</option>
  79 (or similar) include search path options
  80 that scons generates automatically from &cv-link-F77PATH;.
  81 See
  82 &cv-link-_F77INCFLAGS;
  83 below,
  84 for the variable that expands to those options.
  85 You only need to set &cv-link-F77FLAGS; if you need to define specific
  86 user options for Fortran 77 files.
  87 You should normally set the &cv-link-FORTRANFLAGS; variable,
  88 which specifies the user-specified options
  89 passed to the default Fortran compiler
  90 for all Fortran versions.
  91 </summary>
  92 </cvar>
  93
  94 <cvar name="_F77INCFLAGS">
  95 <summary>
  96 An automatically-generated construction variable
  97 containing the Fortran 77 compiler command-line options
  98 for specifying directories to be searched for include files.
  99 The value of &cv-link-_F77INCFLAGS; is created
 100 by appending &cv-link-INCPREFIX; and &cv-link-INCSUFFIX;
 101 to the beginning and end
 102 of each directory in &cv-link-F77PATH;.
 103 </summary>
 104 </cvar>
 105
 106 <cvar name="F77PATH">
 107 <summary>
 108 The list of directories that the Fortran 77 compiler will search for include
 109 directories. The implicit dependency scanner will search these
 110 directories for include files. Don't explicitly put include directory
 111 arguments in &cv-link-F77FLAGS; because the result will be non-portable
 112 and the directories will not be searched by the dependency scanner. Note:
 113 directory names in &cv-link-F77PATH; will be looked-up relative to the SConscript
 114 directory when they are used in a command. To force
 115 &scons;
 116 to look-up a directory relative to the root of the source tree use #:
 117 You only need to set &cv-link-F77PATH; if you need to define a specific
 118 include path for Fortran 77 files.
 119 You should normally set the &cv-link-FORTRANPATH; variable,
 120 which specifies the include path
 121 for the default Fortran compiler
 122 for all Fortran versions.
 123
 124 <example>
 125 env = Environment(F77PATH='#/include')
 126 </example>
 127
 128 The directory look-up can also be forced using the
 129 &Dir;()
 130 function:
 131
 132 <example>
 133 include = Dir('include')
 134 env = Environment(F77PATH=include)
 135 </example>
 136
 137 The directory list will be added to command lines
 138 through the automatically-generated
 139 &cv-link-_F77INCFLAGS;
 140 construction variable,
 141 which is constructed by
 142 appending the values of the
 143 &cv-link-INCPREFIX; and &cv-link-INCSUFFIX;
 144 construction variables
 145 to the beginning and end
 146 of each directory in &cv-link-F77PATH;.
 147 Any command lines you define that need
 148 the F77PATH directory list should
 149 include &cv-link-_F77INCFLAGS;:
 150
 151 <example>
 152 env = Environment(F77COM="my_compiler $_F77INCFLAGS -c -o $TARGET $SOURCE")
 153 </example>
 154 </summary>
 155 </cvar>
 156
 157 <cvar name="F77PPCOM">
 158 <summary>
 159 The command line used to compile a Fortran 77 source file to an object file
 160 after first running the file through the C preprocessor.
 161 Any options specified in the &cv-link-F77FLAGS; and &cv-link-CPPFLAGS; construction variables
 162 are included on this command line.
 163 You only need to set &cv-link-F77PPCOM; if you need to use a specific
 164 C-preprocessor command line for Fortran 77 files.
 165 You should normally set the &cv-link-FORTRANPPCOM; variable,
 166 which specifies the default C-preprocessor command line
 167 for all Fortran versions.
 168 </summary>
 169 </cvar>
 170
 171 <cvar name="F77PPCOMSTR">
 172 <summary>
 173 The string displayed when a Fortran 77 source file
 174 is compiled to an object file
 175 after first running the file through the C preprocessor.
 176 If this is not set, then &cv-link-F77PPCOM; or &cv-link-FORTRANPPCOM;
 177 (the command line) is displayed.
 178 </summary>
 179 </cvar>
 180
 181 <cvar name="SHF77">
 182 <summary>
 183 The Fortran 77 compiler used for generating shared-library objects.
 184 You should normally set the &cv-link-SHFORTRAN; variable,
 185 which specifies the default Fortran compiler
 186 for all Fortran versions.
 187 You only need to set &cv-link-SHF77; if you need to use a specific compiler
 188 or compiler version for Fortran 77 files.
 189 </summary>
 190 </cvar>
 191
 192 <cvar name="SHF77COM">
 193 <summary>
 194 The command line used to compile a Fortran 77 source file
 195 to a shared-library object file.
 196 You only need to set &cv-link-SHF77COM; if you need to use a specific
 197 command line for Fortran 77 files.
 198 You should normally set the &cv-link-SHFORTRANCOM; variable,
 199 which specifies the default command line
 200 for all Fortran versions.
 201 </summary>
 202 </cvar>
 203
 204 <cvar name="SHF77COMSTR">
 205 <summary>
 206 The string displayed when a Fortran 77 source file
 207 is compiled to a shared-library object file.
 208 If this is not set, then &cv-link-SHF77COM; or &cv-link-SHFORTRANCOM;
 209 (the command line) is displayed.
 210 </summary>
 211 </cvar>
 212
 213 <cvar name="SHF77FLAGS">
 214 <summary>
 215 Options that are passed to the Fortran 77 compiler
 216 to generated shared-library objects.
 217 You only need to set &cv-link-SHF77FLAGS; if you need to define specific
 218 user options for Fortran 77 files.
 219 You should normally set the &cv-link-SHFORTRANFLAGS; variable,
 220 which specifies the user-specified options
 221 passed to the default Fortran compiler
 222 for all Fortran versions.
 223 </summary>
 224 </cvar>
 225
 226 <cvar name="SHF77PPCOM">
 227 <summary>
 228 The command line used to compile a Fortran 77 source file to a
 229 shared-library object file
 230 after first running the file through the C preprocessor.
 231 Any options specified in the &cv-link-SHF77FLAGS; and &cv-link-CPPFLAGS; construction variables
 232 are included on this command line.
 233 You only need to set &cv-link-SHF77PPCOM; if you need to use a specific
 234 C-preprocessor command line for Fortran 77 files.
 235 You should normally set the &cv-link-SHFORTRANPPCOM; variable,
 236 which specifies the default C-preprocessor command line
 237 for all Fortran versions.
 238 </summary>
 239 </cvar>
 240
 241 <cvar name="SHF77PPCOMSTR">
 242 <summary>
 243 The string displayed when a Fortran 77 source file
 244 is compiled to a shared-library object file
 245 after first running the file through the C preprocessor.
 246 If this is not set, then &cv-link-SHF77PPCOM; or &cv-link-SHFORTRANPPCOM;
 247 (the command line) is displayed.
 248 </summary>
 249 </cvar>