doc/scons.mod

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