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