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 Alias "<function>Alias</function>">
 116 <!ENTITY Aliases "<function>Aliases</function>">
 117 <!ENTITY Append "<function>Append</function>">
 118 <!ENTITY Build "<function>Build</function>">
 119 <!ENTITY CacheDir "<function>CacheDir</function>">
 120 <!ENTITY Clean "<function>Clean</function>">
 121 <!ENTITY Clone "<function>Clone</function>">
 122 <!ENTITY Command "<function>Command</function>">
 123 <!ENTITY Copy "<function>Copy</function>">
 124 <!ENTITY Default "<function>Default</function>">
 125 <!ENTITY DefaultRules "<function>DefaultRules</function>">
 126 <!ENTITY Depends "<function>Depends</function>">
 127 <!ENTITY Environment "<function>Environment</function>">
 128 <!ENTITY Export "<function>Export</function>">
 129 <!ENTITY Help "<function>Help</function>">
 130 <!ENTITY Ignore "<function>Ignore</function>">
 131 <!ENTITY Import "<function>Import</function>">
 132 <!ENTITY Install "<function>Install</function>">
 133 <!ENTITY InstallAs "<function>InstallAs</function>">
 134 <!ENTITY Link "<function>Link</function>">
 135 <!ENTITY Local "<function>Local</function>">
 136 <!ENTITY Module "<function>Module</function>">
 137 <!ENTITY Objects "<function>Objects</function>">
 138 <!ENTITY Precious "<function>Precious</function>">
 139 <!ENTITY Prepend "<function>Prepend</function>">
 140 <!ENTITY Replace "<function>Replace</function>">
 141 <!ENTITY Repository "<function>Repository</function>">
 142 <!ENTITY Return "<function>Return</function>">
 143 <!ENTITY RuleSet "<function>RuleSet</function>">
 144 <!ENTITY Salt "<function>Salt</function>">
 145 <!ENTITY SetBuildSignatureType "<function>SetBuildSignatureType</function>">
 146 <!ENTITY SetContentSignatureType "<function>SetContentSignatureType</function>">
 147 <!ENTITY SourceSignature "<function>SourceSignature</function>">
 148 <!ENTITY SourceSignatures "<function>SourceSignatures</function>">
 149 <!ENTITY Split "<function>Split</function>">
 150 <!ENTITY TargetSignatures "<function>TargetSignatures</function>">
 151 <!ENTITY Task "<function>Task</function>">
 152
 153 <!ENTITY str "<function>str</function>">
 154 <!ENTITY zipfile "<function>zipfile</function>">
 155
 156 <!-- Obsolete, but referenced in old documents.  -->
 157 <!ENTITY Cache "<function>Cache</function>">
 158
 159
 160
 161 <!--
 162
 163   Construction variables.
 164
 165 -->
 166
 167 <!ENTITY BUILDERMAP "<varname>BUILDERMAP</varname>">
 168 <!ENTITY BUILDERS "<varname>BUILDERS</varname>">
 169 <!ENTITY LIBDIRPREFIX "<varname>LIBDIRPREFIX</varname>">
 170 <!ENTITY LIBDIRSUFFIX "<varname>LIBDIRSUFFIX</varname>">
 171 <!ENTITY LIBLINKPREFIX "<varname>LIBLINKPREFIX</varname>">
 172 <!ENTITY LIBLINKSUFFIX "<varname>LIBLINKSUFFIX</varname>">
 173 <!ENTITY LINK "<varname>LINK</varname>">
 174 <!ENTITY LINKCOM "<varname>LINKCOM</varname>">
 175 <!ENTITY LINKFLAGS "<varname>LINKFLAGS</varname>">
 176 <!ENTITY SCANNERMAP "<varname>SCANNERMAP</varname>">
 177 <!ENTITY SCANNERS "<varname>SCANNERS</varname>">
 178 <!ENTITY TARFLAGS "<varname>TARFLAGS</varname>">
 179 <!ENTITY TARSUFFIX "<varname>TARSUFFIX</varname>">
 180
 181
 182
 183 <!--
 184
 185   Environment variables.
 186
 187 -->
 188
 189 <!ENTITY CC "<varname>CC</varname>">
 190 <!ENTITY CCFLAGS "<varname>CCFLAGS</varname>">
 191 <!ENTITY LIBPATH "<varname>LIBPATH</varname>">
 192 <!ENTITY LIBS "<varname>LIBS</varname>">
 193 <!ENTITY PYTHONPATH "<varname>PYTHONPATH</varname>">
 194 <!ENTITY SCONSFLAGS "<varname>SCONSFLAGS</varname>">
 195
 196
 197
 198 <!--
 199
 200   Function and method arguments.
 201
 202 -->
 203
 204 <!ENTITY build_dir "<varname>build_dir</varname>">
 205 <!ENTITY exports "<varname>exports</varname>">
 206 <!ENTITY source "<varname>source</varname>">
 207 <!ENTITY target "<varname>target</varname>">
 208
 209
 210
 211 <!--
 212
 213   Builder and Scanner objects.
 214
 215 -->
 216
 217 <!ENTITY BuildDir "<function>BuildDir</function>">
 218 <!ENTITY CFile "<function>CFile</function>">
 219 <!ENTITY CXXFile "<function>CXXFile</function>">
 220 <!ENTITY DVI "<function>DVI</function>">
 221 <!ENTITY Jar "<function>Jar</function>">
 222 <!ENTITY Java "<function>Java</function>">
 223 <!ENTITY JavaH "<function>JavaH</function>">
 224 <!ENTITY Library "<function>Library</function>">
 225 <!ENTITY Object "<function>Object</function>">
 226 <!ENTITY PCH "<function>PCH</function>">
 227 <!ENTITY PDF "<function>PDF</function>">
 228 <!ENTITY PostScript "<function>PostScript</function>">
 229 <!ENTITY Program "<function>Program</function>">
 230 <!ENTITY RES "<function>RES</function>">
 231 <!ENTITY RMIC "<function>RMIC</function>">
 232 <!ENTITY SharedLibrary "<function>SharedLibrary</function>">
 233 <!ENTITY SharedObject "<function>SharedObject</function>">
 234 <!ENTITY StaticLibrary "<function>StaticLibrary</function>">
 235 <!ENTITY StaticObject "<function>StaticObject</function>">
 236 <!ENTITY Tar "<function>Tar</function>">
 237 <!ENTITY Zip "<function>Zip</function>">
 238
 239 <!-- Obsolete, but referenced in old documents.  -->
 240 <!ENTITY MakeBuilder "<function>Make</function>">
 241
 242
 243
 244 <!--
 245
 246   Terms.  Define both singular and plural forms in various
 247   case-sensitive combinations for use in titles, in-line, etc.
 248
 249 -->
 250
 251 <!ENTITY buildfunc "<literal>builder function</literal>">
 252
 253 <!ENTITY ConsEnv "<literal>Construction Environment</literal>">
 254 <!ENTITY ConsEnvs "<literal>Construction Environments</literal>">
 255 <!ENTITY Consenv "<literal>Construction environment</literal>">
 256 <!ENTITY Consenvs "<literal>Construction environments</literal>">
 257 <!ENTITY consenv "<literal>construction environment</literal>">
 258 <!ENTITY consenvs "<literal>construction environments</literal>">
 259
 260 <!ENTITY ConsVar "<literal>Construction Variable</literal>">
 261 <!ENTITY ConsVars "<literal>Construction Variables</literal>">
 262 <!ENTITY Consvar "<literal>Construction variable</literal>">
 263 <!ENTITY Consvars "<literal>Construction variables</literal>">
 264 <!ENTITY consvar "<literal>construction variable</literal>">
 265 <!ENTITY consvars "<literal>construction variables</literal>">
 266
 267 <!ENTITY CPPPATH "<literal>CPPPATH</literal>">
 268
 269 <!ENTITY Dictionary "<literal>Dictionary</literal>">
 270
 271 <!ENTITY Emitter "<literal>Emitter</literal>">
 272 <!ENTITY emitter "<literal>emitter</literal>">
 273 <!ENTITY Generator "<literal>Generator</literal>">
 274 <!ENTITY generator "<literal>generator</literal>">
 275
 276 <!ENTITY signature "<literal>signature</literal>">
 277 <!ENTITY buildsignature "<literal>build signature</literal>">
 278
 279 <!--
 280
 281   File and program names used in examples.
 282
 283 -->
 284
 285 <!ENTITY bar "<application>bar</application>">
 286 <!ENTITY common1_c "<application>common1.c</application>">
 287 <!ENTITY common2_c "<application>common2.c</application>">
 288 <!ENTITY goodbye "<application>goodbye</application>">
 289 <!ENTITY file_dll "<application>file.dll</application>">
 290 <!ENTITY file_lib "<application>file.lib</application>">
 291 <!ENTITY file_o "<application>file.o</application>">
 292 <!ENTITY file_obj "<application>file.obj</application>">
 293 <!ENTITY foo "<application>foo</application>">
 294 <!ENTITY hello "<application>hello</application>">
 295 <!ENTITY hello_c "<filename>hello.c</filename>">
 296 <!ENTITY hello_exe "<filename>hello.exe</filename>">
 297 <!ENTITY hello_h "<filename>hello.h</filename>">
 298 <!ENTITY hello_o "<filename>hello.o</filename>">
 299 <!ENTITY libfile_a "<filename>libfile_a</filename>">
 300 <!ENTITY libfile_so "<filename>libfile_so</filename>">
 301 <!ENTITY prog "<filename>prog</filename>">
 302 <!ENTITY prog1 "<filename>prog1</filename>">
 303 <!ENTITY prog2 "<filename>prog2</filename>">
 304 <!ENTITY prog_c "<filename>prog.c</filename>">
 305 <!ENTITY prog_exe "<filename>prog.exe</filename>">
 306 <!ENTITY stdio_h "<filename>stdio.h</filename>">
 307
 308 <!--
 309
 310   Punctuation.
 311
 312 -->
 313
 314 <!ENTITY plus "<literal>+</literal>">
 315 <!ENTITY hash "<literal>#</literal>">
 316
 317 <!--
 318
 319   Mailing lists
 320
 321 -->
 322
 323 <!ENTITY scons-announce "<literal>scons-announce@lists.sourceforge.net</literal>">
 324 <!ENTITY scons-devel "<literal>scons-devel@lists.sourceforge.net</literal>">
 325 <!ENTITY scons-users "<literal>scons-users@lists.sourceforge.net</literal>">