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