doc/scons.mod

   1 <!--
   2
   3   __COPYRIGHT__
   4
   5   An SCons-specific DTD module, for use with SCons DocBook
   6   documentation, that contains names, phrases, acronyms, etc. used
   7   throughout the SCons documentation.
   8
   9 -->
  10
  11
  12
  13 <!--
  14
  15   Other applications that we reference.
  16
  17 -->
  18
  19 <!ENTITY Aegis          "<application>Aegis</application>">
  20 <!ENTITY Ant            "<application>Ant</application>">
  21 <!ENTITY ar             "<application>ar</application>">
  22 <!ENTITY as             "<application>as</application>">
  23 <!ENTITY Autoconf       "<application>Autoconf</application>">
  24 <!ENTITY Automake       "<application>Automake</application>">
  25 <!ENTITY bison          "<application>bison</application>">
  26 <!ENTITY cc             "<application>cc</application>">
  27 <!ENTITY Cons           "<application>Cons</application>">
  28 <!ENTITY cp             "<application>cp</application>">
  29 <!ENTITY csh            "<application>csh</application>">
  30 <!ENTITY gas            "<application>gas</application>">
  31 <!ENTITY gcc            "<application>gcc</application>">
  32 <!ENTITY g77            "<application>g77</application>">
  33 <!ENTITY gXX            "<application>gXX</application>">
  34 <!ENTITY Jam            "<application>Jam</application>">
  35 <!ENTITY jar            "<application>jar</application>">
  36 <!ENTITY javac          "<application>javac</application>">
  37 <!ENTITY javah          "<application>javah</application>">
  38 <!ENTITY latex          "<application>latex</application>">
  39 <!ENTITY lex            "<application>lex</application>">
  40 <!ENTITY m4             "<application>m4</application>">
  41 <!ENTITY Make           "<application>Make</application>">
  42 <!ENTITY Makepp         "<application>Make++</application>">
  43 <!ENTITY pdflatex       "<application>pdflatex</application>">
  44 <!ENTITY pdftex         "<application>pdftex</application>">
  45 <!ENTITY Python         "<application>Python</application>">
  46 <!ENTITY ranlib         "<application>ranlib</application>">
  47 <!ENTITY rmic           "<application>rmic</application>">
  48 <!ENTITY SCons          "<application>SCons</application>">
  49 <!ENTITY scons          "<application>scons</application>">
  50 <!ENTITY ScCons         "<application>ScCons</application>">
  51 <!ENTITY swig           "<application>swig</application>">
  52 <!ENTITY tar            "<application>tar</application>">
  53 <!ENTITY tex            "<application>tex</application>">
  54 <!ENTITY touch          "<application>touch</application>">
  55 <!ENTITY yacc           "<application>yacc</application>">
  56 <!ENTITY zip            "<application>zip</application>">
  57
  58
  59 <!--
  60
  61   Classes.
  62
  63 -->
  64
  65 <!ENTITY Action "<classname>Action</classname>">
  66 <!ENTITY ActionBase "<classname>ActionBase</classname>">
  67 <!ENTITY CommandAction "<classname>CommandAction</classname>">
  68 <!ENTITY FunctionAction "<classname>FunctionAction</classname>">
  69 <!ENTITY ListAction "<classname>ListAction</classname>">
  70 <!ENTITY Builder "<classname>Builder</classname>">
  71 <!ENTITY BuilderBase "<classname>BuilderBase</classname>">
  72 <!ENTITY CompositeBuilder "<classname>CompositeBuilder</classname>">
  73 <!ENTITY MultiStepBuilder "<classname>MultiStepBuilder</classname>">
  74 <!ENTITY Job "<classname>Job</classname>">
  75 <!ENTITY Jobs "<classname>Jobs</classname>">
  76 <!ENTITY Serial "<classname>Serial</classname>">
  77 <!ENTITY Parallel "<classname>Parallel</classname>">
  78 <!ENTITY Node "<classname>Node</classname>">
  79 <!ENTITY Node_FS "<classname>Node.FS</classname>">
  80 <!ENTITY Scanner "<classname>Scanner</classname>">
  81 <!ENTITY Sig "<classname>Sig</classname>">
  82 <!ENTITY Signature "<classname>Signature</classname>">
  83 <!ENTITY Taskmaster "<classname>Taskmaster</classname>">
  84 <!ENTITY TimeStamp "<classname>TimeStamp</classname>">
  85 <!ENTITY Walker "<classname>Walker</classname>">
  86 <!ENTITY Wrapper "<classname>Wrapper</classname>">
  87
  88
  89
  90 <!--
  91
  92   Options, command-line.
  93
  94 -->
  95
  96 <!ENTITY config "<literal>--config</literal>">
  97 <!ENTITY debug-explain "<literal>--debug=explain</literal>">
  98 <!ENTITY debug-findlibs "<literal>--debug=findlibs</literal>">
  99 <!ENTITY debug-includes "<literal>--debug=includes</literal>">
 100 <!ENTITY debug-presub "<literal>--debug=presub</literal>">
 101 <!ENTITY debug-stacktrace "<literal>--debug=stacktrace</literal>">
 102 <!ENTITY implicit-cache "<literal>--implicit-cache</literal>">
 103 <!ENTITY implicit-deps-changed "<literal>--implicit-deps-changed</literal>">
 104 <!ENTITY implicit-deps-unchanged "<literal>--implicit-deps-unchanged</literal>">
 105 <!ENTITY profile "<literal>--profile</literal>">
 106 <!ENTITY taskmastertrace "<literal>--taskmastertrace</literal>">
 107 <!ENTITY tree "<literal>--tree</literal>">
 108 <!ENTITY Q "<literal>-Q</literal>">
 109
 110 <!--
 111
 112   Options, SConscript-settable.
 113
 114 -->
 115
 116 <!ENTITY implicit_cache "<literal>implicit_cache</literal>">
 117 <!ENTITY implicit_deps_changed "<literal>implicit_deps_changed</literal>">
 118 <!ENTITY implicit_deps_unchanged "<literal>implicit_deps_unchanged</literal>">
 119
 120
 121
 122 <!--
 123
 124   File and directory names.
 125
 126 -->
 127
 128 <!ENTITY build "<filename>build</filename>">
 129 <!ENTITY Makefile "<filename>Makefile</filename>">
 130 <!ENTITY Makefiles "<filename>Makefiles</filename>">
 131 <!ENTITY SConscript "<filename>SConscript</filename>">
 132 <!ENTITY SConstruct "<filename>SConstruct</filename>">
 133 <!ENTITY Sconstruct "<filename>Sconstruct</filename>">
 134 <!ENTITY sconstruct "<filename>sconstruct</filename>">
 135 <!ENTITY sconsign "<filename>.sconsign</filename>">
 136 <!ENTITY src "<filename>src</filename>">
 137
 138
 139
 140 <!--
 141
 142   Methods and functions.  This includes functions from both
 143   the Build Engine and the Native Python Interface.
 144
 145 -->
 146
 147 <!ENTITY Add "<function>Add</function>">
 148 <!ENTITY AddPostAction "<function>AddPostAction</function>">
 149 <!ENTITY AddPreAction "<function>AddPreAction</function>">
 150 <!ENTITY AddOptions "<function>AddOptions</function>">
 151 <!ENTITY AddVariables "<function>AddVariables</function>">
 152 <!ENTITY Alias "<function>Alias</function>">
 153 <!ENTITY Aliases "<function>Aliases</function>">
 154 <!ENTITY AlwaysBuild "<function>AlwaysBuild</function>">
 155 <!ENTITY Append "<function>Append</function>">
 156 <!ENTITY AppendENVPath "<function>AppendENVPath</function>">
 157 <!ENTITY AppendUnique "<function>AppendUnique</function>">
 158 <!ENTITY BoolOption "<function>BoolOption</function>">
 159 <!ENTITY BoolVariable "<function>BoolVariable</function>">
 160 <!ENTITY Build "<function>Build</function>">
 161 <!ENTITY CacheDir "<function>CacheDir</function>">
 162 <!ENTITY Chmod "<function>Chmod</function>">
 163 <!ENTITY Clean "<function>Clean</function>">
 164 <!ENTITY Clone "<function>Clone</function>">
 165 <!ENTITY Command "<function>Command</function>">
 166 <!ENTITY Configure "<function>Configure</function>">
 167 <!ENTITY Copy "<function>Copy</function>">
 168 <!ENTITY Decider "<function>Decider</function>">
 169 <!ENTITY Default "<function>Default</function>">
 170 <!ENTITY DefaultRules "<function>DefaultRules</function>">
 171 <!ENTITY Delete "<function>Delete</function>">
 172 <!ENTITY Depends "<function>Depends</function>">
 173 <!ENTITY Dir "<function>Dir</function>">
 174 <!ENTITY Dump "<function>Dump</function>">
 175 <!ENTITY Entry "<function>Entry</function>">
 176 <!ENTITY EnumOption "<function>EnumOption</function>">
 177 <!ENTITY EnumVariable "<function>EnumVariable</function>">
 178 <!ENTITY Environment "<function>Environment</function>">
 179 <!ENTITY Execute "<function>Execute</function>">
 180 <!ENTITY Export "<function>Export</function>">
 181 <!ENTITY File "<function>File</function>">
 182 <!ENTITY FindFile "<function>FindFile</function>">
 183 <!ENTITY FindInstalledFiles "<function>FindInstalledFiles</function>">
 184 <!ENTITY Finish "<function>Finish</function>">
 185 <!ENTITY GenerateHelpText "<function>GenerateHelpText</function>">
 186 <!ENTITY GetOption "<function>GetOption</function>">
 187 <!ENTITY Help "<function>Help</function>">
 188 <!ENTITY Ignore "<function>Ignore</function>">
 189 <!ENTITY Import "<function>Import</function>">
 190 <!ENTITY Install "<function>Install</function>">
 191 <!ENTITY InstallAs "<function>InstallAs</function>">
 192 <!ENTITY Link "<function>Link</function>">
 193 <!ENTITY ListOption "<function>ListOption</function>">
 194 <!ENTITY ListVariable "<function>ListVariable</function>">
 195 <!ENTITY Local "<function>Local</function>">
 196 <!ENTITY Mkdir "<function>Mkdir</function>">
 197 <!ENTITY Module "<function>Module</function>">
 198 <!ENTITY Move "<function>Move</function>">
 199 <!ENTITY NoClean "<function>NoClean</function>">
 200 <!ENTITY NoCache "<function>NoCache</function>">
 201 <!ENTITY Objects "<function>Objects</function>">
 202 <!ENTITY Options "<function>Options</function>">
 203 <!ENTITY Variables "<function>Variables</function>">
 204 <!ENTITY PackageOption "<function>PackageOption</function>">
 205 <!ENTITY PackageVariable "<function>PackageVariable</function>">
 206 <!ENTITY ParseConfig "<function>ParseConfig</function>">
 207 <!ENTITY PathOption "<function>PathOption</function>">
 208 <!ENTITY PathOption_PathAccept "<function>PathOption.PathAccept</function>">
 209 <!ENTITY PathOption_PathExists "<function>PathOption.PathExists</function>">
 210 <!ENTITY PathOption_PathIsDir "<function>PathOption.PathIsDir</function>">
 211 <!ENTITY PathOption_PathIsDirCreate "<function>PathOption.PathIsDirCreate</function>">
 212 <!ENTITY PathOption_PathIsFile "<function>PathOption.PathIsFile</function>">
 213 <!ENTITY PathVariable "<function>PathVariable</function>">
 214 <!ENTITY PathVariable_PathAccept "<function>PathVariable.PathAccept</function>">
 215 <!ENTITY PathVariable_PathExists "<function>PathVariable.PathExists</function>">
 216 <!ENTITY PathVariable_PathIsDir "<function>PathVariable.PathIsDir</function>">
 217 <!ENTITY PathVariable_PathIsDirCreate "<function>PathVariable.PathIsDirCreate</function>">
 218 <!ENTITY PathVariable_PathIsFile "<function>PathVariable.PathIsFile</function>">
 219 <!ENTITY Precious "<function>Precious</function>">
 220 <!ENTITY Prepend "<function>Prepend</function>">
 221 <!ENTITY PrependENVPath "<function>PrependENVPath</function>">
 222 <!ENTITY PrependUnique "<function>PrependUnique</function>">
 223 <!ENTITY Replace "<function>Replace</function>">
 224 <!ENTITY Repository "<function>Repository</function>">
 225 <!ENTITY Return "<function>Return</function>">
 226 <!ENTITY RuleSet "<function>RuleSet</function>">
 227 <!ENTITY Salt "<function>Salt</function>">
 228 <!ENTITY SetBuildSignatureType "<function>SetBuildSignatureType</function>">
 229 <!ENTITY SetContentSignatureType "<function>SetContentSignatureType</function>">
 230 <!ENTITY SetOption "<function>SetOption</function>">
 231 <!ENTITY SideEffect "<function>SideEffect</function>">
 232 <!ENTITY SourceSignature "<function>SourceSignature</function>">
 233 <!ENTITY SourceSignatures "<function>SourceSignatures</function>">
 234 <!ENTITY Split "<function>Split</function>">
 235 <!ENTITY Tag "<function>Tag</function>">
 236 <!ENTITY TargetSignatures "<function>TargetSignatures</function>">
 237 <!ENTITY Task "<function>Task</function>">
 238 <!ENTITY Touch "<function>Touch</function>">
 239
 240 <!-- Environment methods -->
 241 <!ENTITY subst "<function>subst</function>">
 242
 243 <!-- Configure context functions -->
 244 <!ENTITY Message "<function>Message</function>">
 245 <!ENTITY Result "<function>Result</function>">
 246 <!ENTITY CheckCHeader "<function>CheckCHeader</function>">
 247 <!ENTITY CheckCXXHeader "<function>CheckCXXHeader</function>">
 248 <!ENTITY CheckFunc "<function>CheckFunc</function>">
 249 <!ENTITY CheckHeader "<function>CheckHeader</function>">
 250 <!ENTITY CheckLib "<function>CheckLib</function>">
 251 <!ENTITY CheckLibWithHeader "<function>CheckLibWithHeader</function>">
 252 <!ENTITY CheckType "<function>CheckType</function>">
 253 <!ENTITY TryAction "<function>TryAction</function>">
 254 <!ENTITY TryBuild "<function>TryBuild</function>">
 255 <!ENTITY TryCompile "<function>TryCompile</function>">
 256 <!ENTITY TryLink "<function>TryLink</function>">
 257 <!ENTITY TryRun "<function>TryRun</function>">
 258
 259
 260 <!-- Python functions -->
 261 <!ENTITY str "<function>str</function>">
 262 <!ENTITY zipfile "<function>zipfile</function>">
 263
 264 <!-- Obsolete, but referenced in old documents.  -->
 265 <!ENTITY Cache "<function>Cache</function>">
 266
 267
 268
 269 <!--
 270
 271   Global variables.
 272
 273 -->
 274
 275 <!ENTITY ARGUMENTS "<varname>ARGUMENTS</varname>">
 276 <!ENTITY BUILD_TARGETS "<varname>BUILD_TARGETS</varname>">
 277 <!ENTITY COMMAND_LINE_TARGETS "<varname>COMMAND_LINE_TARGETS</varname>">
 278 <!ENTITY DEFAULT_TARGETS "<varname>DEFAULT_TARGETS</varname>">
 279
 280
 281
 282 <!--
 283
 284   Construction variables.
 285
 286 -->
 287
 288 <!ENTITY BUILDERMAP "<varname>BUILDERMAP</varname>">
 289 <!ENTITY COLOR "<varname>COLOR</varname>">
 290 <!ENTITY COLORS "<varname>COLORS</varname>">
 291 <!ENTITY CONFIG "<varname>CONFIG</varname>">
 292 <!ENTITY RELEASE "<varname>RELEASE</varname>">
 293 <!ENTITY RELEASE_BUILD "<varname>RELEASE_BUILD</varname>">
 294 <!ENTITY SCANNERMAP "<varname>SCANNERMAP</varname>">
 295 <!ENTITY TARFLAGS "<varname>TARFLAGS</varname>">
 296 <!ENTITY TARSUFFIX "<varname>TARSUFFIX</varname>">
 297
 298
 299
 300 <!--
 301
 302   Environment variables.
 303
 304 -->
 305
 306 <!ENTITY PATH "<varname>PATH</varname>">
 307 <!ENTITY PYTHONPATH "<varname>PYTHONPATH</varname>">
 308 <!ENTITY SCONSFLAGS "<varname>SCONSFLAGS</varname>">
 309
 310
 311
 312 <!--
 313
 314   Function and method arguments.
 315
 316 -->
 317
 318 <!ENTITY allowed_values "<varname>allowed_values</varname>">
 319 <!ENTITY build_dir "<varname>build_dir</varname>">
 320 <!ENTITY map "<varname>map</varname>">
 321 <!ENTITY ignorecase "<varname>ignorecase</varname>">
 322 <!ENTITY options "<varname>options</varname>">
 323 <!ENTITY exports "<varname>exports</varname>">
 324 <!ENTITY source "<varname>source</varname>">
 325 <!ENTITY target "<varname>target</varname>">
 326 <!ENTITY variant_dir "<varname>variant_dir</varname>">
 327
 328
 329
 330 <!--
 331
 332   Values of function and method arguments.
 333
 334 -->
 335
 336 <!ENTITY all "<literal>all</literal>">
 337 <!ENTITY none "<literal>none</literal>">
 338
 339
 340
 341 <!--
 342
 343   Builder and Scanner objects.
 344
 345 -->
 346
 347 <!ENTITY BuildDir "<function>BuildDir</function>">
 348 <!ENTITY CFile "<function>CFile</function>">
 349 <!ENTITY CXXFile "<function>CXXFile</function>">
 350 <!ENTITY DVI "<function>DVI</function>">
 351 <!ENTITY Jar "<function>Jar</function>">
 352 <!ENTITY Java "<function>Java</function>">
 353 <!ENTITY JavaH "<function>JavaH</function>">
 354 <!ENTITY Library "<function>Library</function>">
 355 <!ENTITY Object "<function>Object</function>">
 356 <!ENTITY PCH "<function>PCH</function>">
 357 <!ENTITY PDF "<function>PDF</function>">
 358 <!ENTITY PostScript "<function>PostScript</function>">
 359 <!ENTITY Program "<function>Program</function>">
 360 <!ENTITY RES "<function>RES</function>">
 361 <!ENTITY RMIC "<function>RMIC</function>">
 362 <!ENTITY SharedLibrary "<function>SharedLibrary</function>">
 363 <!ENTITY SharedObject "<function>SharedObject</function>">
 364 <!ENTITY StaticLibrary "<function>StaticLibrary</function>">
 365 <!ENTITY StaticObject "<function>StaticObject</function>">
 366 <!ENTITY Tar "<function>Tar</function>">
 367 <!ENTITY VariantDir "<function>VariantDir</function>">
 368 <!ENTITY Zip "<function>Zip</function>">
 369
 370 <!-- Obsolete, but referenced in old documents.  -->
 371 <!ENTITY MakeBuilder "<function>Make</function>">
 372
 373
 374
 375 <!--
 376
 377   Terms.  Define both singular and plural forms in various
 378   case-sensitive combinations for use in titles, in-line, etc.
 379
 380 -->
 381
 382 <!ENTITY buildfunc "<literal>builder function</literal>">
 383 <!ENTITY builder_method "<literal>builder method</literal>">
 384
 385 <!ENTITY Configure_Contexts "<literal>Configure Contexts</literal>">
 386 <!ENTITY configure_context "<literal>configure context</literal>">
 387
 388 <!ENTITY ConsEnv "<literal>Construction Environment</literal>">
 389 <!ENTITY ConsEnvs "<literal>Construction Environments</literal>">
 390 <!ENTITY Consenv "<literal>Construction environment</literal>">
 391 <!ENTITY Consenvs "<literal>Construction environments</literal>">
 392 <!ENTITY consenv "<literal>construction environment</literal>">
 393 <!ENTITY consenvs "<literal>construction environments</literal>">
 394
 395 <!ENTITY ConsVar "<literal>Construction Variable</literal>">
 396 <!ENTITY ConsVars "<literal>Construction Variables</literal>">
 397 <!ENTITY Consvar "<literal>Construction variable</literal>">
 398 <!ENTITY Consvars "<literal>Construction variables</literal>">
 399 <!ENTITY consvar "<literal>construction variable</literal>">
 400 <!ENTITY consvars "<literal>construction variables</literal>">
 401
 402 <!ENTITY CPPPATH "<literal>CPPPATH</literal>">
 403
 404 <!ENTITY Dictionary "<literal>Dictionary</literal>">
 405
 406 <!ENTITY Emitter "<literal>Emitter</literal>">
 407 <!ENTITY emitter "<literal>emitter</literal>">
 408
 409 <!ENTITY factory "<literal>factory</literal>">
 410
 411 <!ENTITY Generator "<literal>Generator</literal>">
 412 <!ENTITY generator "<literal>generator</literal>">
 413
 414 <!ENTITY Nodes "<literal>Nodes</literal>">
 415
 416 <!ENTITY signature "<literal>signature</literal>">
 417 <!ENTITY buildsignature "<literal>build signature</literal>">
 418
 419 <!ENTITY true "<literal>true</literal>">
 420 <!ENTITY false "<literal>false</literal>">
 421
 422 <!ENTITY typedef "<literal>typedef</literal>">
 423
 424 <!--
 425
 426   File and program names used in examples.
 427
 428 -->
 429
 430 <!ENTITY bar "<application>bar</application>">
 431 <!ENTITY common1_c "<filename>common1.c</filename>">
 432 <!ENTITY common2_c "<filename>common2.c</filename>">
 433 <!ENTITY custom_py "<filename>custom.py</filename>">
 434 <!ENTITY goodbye "<application>goodbye</application>">
 435 <!ENTITY goodbye_o "<filename>goodbye.o</filename>">
 436 <!ENTITY goodbye_obj "<filename>goodbye.obj</filename>">
 437 <!ENTITY file_dll "<filename>file.dll</filename>">
 438 <!ENTITY file_in "<filename>file.in</filename>">
 439 <!ENTITY file_lib "<filename>file.lib</filename>">
 440 <!ENTITY file_o "<filename>file.o</filename>">
 441 <!ENTITY file_obj "<filename>file.obj</filename>">
 442 <!ENTITY file_out "<filename>file.out</filename>">
 443 <!ENTITY foo "<application>foo</application>">
 444 <!ENTITY foo_o "<filename>foo.o</filename>">
 445 <!ENTITY foo_obj "<filename>foo.obj</filename>">
 446 <!ENTITY hello "<application>hello</application>">
 447 <!ENTITY hello_c "<filename>hello.c</filename>">
 448 <!ENTITY hello_exe "<filename>hello.exe</filename>">
 449 <!ENTITY hello_h "<filename>hello.h</filename>">
 450 <!ENTITY hello_o "<filename>hello.o</filename>">
 451 <!ENTITY hello_obj "<filename>hello.obj</filename>">
 452 <!ENTITY libfile_a "<filename>libfile_a</filename>">
 453 <!ENTITY libfile_so "<filename>libfile_so</filename>">
 454 <!ENTITY new_hello "<application>new_hello</application>">
 455 <!ENTITY new_hello_exe "<application>new_hello.exe</application>">
 456 <!ENTITY prog "<filename>prog</filename>">
 457 <!ENTITY prog1 "<filename>prog1</filename>">
 458 <!ENTITY prog2 "<filename>prog2</filename>">
 459 <!ENTITY prog_c "<filename>prog.c</filename>">
 460 <!ENTITY prog_exe "<filename>prog.exe</filename>">
 461 <!ENTITY stdio_h "<filename>stdio.h</filename>">
 462
 463 <!--
 464
 465   Punctuation.
 466
 467 -->
 468
 469 <!ENTITY plus "<literal>+</literal>">
 470 <!ENTITY hash "<literal>#</literal>">
 471
 472 <!--
 473
 474   Mailing lists
 475
 476 -->
 477
 478 <!ENTITY scons-announce "<literal>announce@scons.tigris.org</literal>">
 479 <!ENTITY scons-devel "<literal>dev@scons.tigris.org</literal>">
 480 <!ENTITY scons-users "<literal>users@scons.tigris.org</literal>">