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 Autoconf "<application>Autoconf</application>">
  19 <!ENTITY Cons "<application>Cons</application>">
  20 <!ENTITY gcc "<application>gcc</application>">
  21 <!ENTITY Jam "<application>Jam</application>">
  22 <!ENTITY Make "<application>Make</application>">
  23 <!ENTITY Makepp "<application>Make++</application>">
  24 <!ENTITY ranlib "<application>ranlib</application>">
  25 <!ENTITY SCons "<application>SCons</application>">
  26 <!ENTITY scons "<application>scons</application>">
  27 <!ENTITY ScCons "<application>ScCons</application>">
  28 <!ENTITY tar "<application>tar</application>">
  29 <!ENTITY touch "<application>touch</application>">
  30 <!ENTITY zip "<application>zip</application>">
  31
  32
  33 <!--
  34
  35   Classes.
  36
  37 -->
  38
  39 <!ENTITY Action "<classname>Action</classname>">
  40 <!ENTITY ActionBase "<classname>ActionBase</classname>">
  41 <!ENTITY CommandAction "<classname>CommandAction</classname>">
  42 <!ENTITY FunctionAction "<classname>FunctionAction</classname>">
  43 <!ENTITY ListAction "<classname>ListAction</classname>">
  44 <!ENTITY Builder "<classname>Builder</classname>">
  45 <!ENTITY BuilderBase "<classname>BuilderBase</classname>">
  46 <!ENTITY CompositeBuilder "<classname>CompositeBuilder</classname>">
  47 <!ENTITY MultiStepBuilder "<classname>MultiStepBuilder</classname>">
  48 <!ENTITY Job "<classname>Job</classname>">
  49 <!ENTITY Jobs "<classname>Jobs</classname>">
  50 <!ENTITY Serial "<classname>Serial</classname>">
  51 <!ENTITY Parallel "<classname>Parallel</classname>">
  52 <!ENTITY Node "<classname>Node</classname>">
  53 <!ENTITY Node_FS "<classname>Node.FS</classname>">
  54 <!ENTITY Scanner "<classname>Scanner</classname>">
  55 <!ENTITY Sig "<classname>Sig</classname>">
  56 <!ENTITY Signature "<classname>Signature</classname>">
  57 <!ENTITY Taskmaster "<classname>Taskmaster</classname>">
  58 <!ENTITY TimeStamp "<classname>TimeStamp</classname>">
  59 <!ENTITY Walker "<classname>Walker</classname>">
  60 <!ENTITY Wrapper "<classname>Wrapper</classname>">
  61
  62
  63
  64 <!--
  65
  66   File and directory names.
  67
  68 -->
  69
  70 <!ENTITY build "<filename>build</filename>">
  71 <!ENTITY Makefile "<filename>Makefile</filename>">
  72 <!ENTITY Makefiles "<filename>Makefiles</filename>">
  73 <!ENTITY SConscript "<filename>SConscript</filename>">
  74 <!ENTITY SConstruct "<filename>SConstruct</filename>">
  75 <!ENTITY Sconstruct "<filename>Sconstruct</filename>">
  76 <!ENTITY sconstruct "<filename>sconstruct</filename>">
  77 <!ENTITY sconsign "<filename>.sconsign</filename>">
  78 <!ENTITY src "<filename>src</filename>">
  79
  80
  81
  82 <!--
  83
  84   Methods and functions.  This includes functions from both
  85   the Build Engine and the Native Python Interface.
  86
  87 -->
  88
  89 <!ENTITY Alias "<function>Alias</function>">
  90 <!ENTITY Aliases "<function>Aliases</function>">
  91 <!ENTITY Append "<function>Append</function>">
  92 <!ENTITY Build "<function>Build</function>">
  93 <!ENTITY CacheDir "<function>CacheDir</function>">
  94 <!ENTITY Clean "<function>Clean</function>">
  95 <!ENTITY Clone "<function>Clone</function>">
  96 <!ENTITY Command "<function>Command</function>">
  97 <!ENTITY Copy "<function>Copy</function>">
  98 <!ENTITY Default "<function>Default</function>">
  99 <!ENTITY DefaultRules "<function>DefaultRules</function>">
 100 <!ENTITY Depends "<function>Depends</function>">
 101 <!ENTITY Environment "<function>Environment</function>">
 102 <!ENTITY Export "<function>Export</function>">
 103 <!ENTITY Help "<function>Help</function>">
 104 <!ENTITY Ignore "<function>Ignore</function>">
 105 <!ENTITY Install "<function>Install</function>">
 106 <!ENTITY InstallAs "<function>InstallAs</function>">
 107 <!ENTITY Link "<function>Link</function>">
 108 <!ENTITY Local "<function>Local</function>">
 109 <!ENTITY Module "<function>Module</function>">
 110 <!ENTITY Objects "<function>Objects</function>">
 111 <!ENTITY Precious "<function>Precious</function>">
 112 <!ENTITY Prepend "<function>Prepend</function>">
 113 <!ENTITY Replace "<function>Replace</function>">
 114 <!ENTITY Repository "<function>Repository</function>">
 115 <!ENTITY RuleSet "<function>RuleSet</function>">
 116 <!ENTITY Salt "<function>Salt</function>">
 117 <!ENTITY SetBuildSignatureType "<function>SetBuildSignatureType</function>">
 118 <!ENTITY SetContentSignatureType "<function>SetContentSignatureType</function>">
 119 <!ENTITY SourceSignature "<function>SourceSignature</function>">
 120 <!ENTITY SourceSignatures "<function>SourceSignatures</function>">
 121 <!ENTITY Split "<function>Split</function>">
 122 <!ENTITY TargetSignatures "<function>TargetSignatures</function>">
 123 <!ENTITY Task "<function>Task</function>">
 124
 125 <!ENTITY str "<function>str</function>">
 126 <!ENTITY zipfile "<function>zipfile</function>">
 127
 128 <!-- Obsolete, but referenced in old documents.  -->
 129 <!ENTITY Cache "<function>Cache</function>">
 130
 131
 132
 133 <!--
 134
 135   Construction variables.
 136
 137 -->
 138
 139 <!ENTITY BUILDERMAP "<varname>BUILDERMAP</varname>">
 140 <!ENTITY BUILDERS "<varname>BUILDERS</varname>">
 141 <!ENTITY SCANNERMAP "<varname>SCANNERMAP</varname>">
 142 <!ENTITY SCANNERS "<varname>SCANNERS</varname>">
 143 <!ENTITY TARFLAGS "<varname>TARFLAGS</varname>">
 144 <!ENTITY TARSUFFIX "<varname>TARSUFFIX</varname>">
 145
 146
 147
 148 <!--
 149
 150   Environment variables.
 151
 152 -->
 153
 154 <!ENTITY CC "<varname>CC</varname>">
 155 <!ENTITY CCFLAGS "<varname>CCFLAGS</varname>">
 156 <!ENTITY LIBPATH "<varname>LIBPATH</varname>">
 157 <!ENTITY LIBS "<varname>LIBS</varname>">
 158 <!ENTITY PYTHONPATH "<varname>PYTHONPATH</varname>">
 159 <!ENTITY SCONSFLAGS "<varname>SCONSFLAGS</varname>">
 160
 161
 162
 163 <!--
 164
 165   Function and method arguments.
 166
 167 -->
 168
 169 <!ENTITY build_dir "<varname>build_dir</varname>">
 170 <!ENTITY source "<varname>source</varname>">
 171 <!ENTITY target "<varname>target</varname>">
 172
 173
 174
 175 <!--
 176
 177   Builder and Scanner objects.
 178
 179 -->
 180
 181 <!ENTITY BuildDir "<function>BuildDir</function>">
 182 <!ENTITY CFile "<function>CFile</function>">
 183 <!ENTITY CXXFile "<function>CXXFile</function>">
 184 <!ENTITY DVI "<function>DVI</function>">
 185 <!ENTITY Jar "<function>Jar</function>">
 186 <!ENTITY Java "<function>Java</function>">
 187 <!ENTITY JavaH "<function>JavaH</function>">
 188 <!ENTITY Library "<function>Library</function>">
 189 <!ENTITY Object "<function>Object</function>">
 190 <!ENTITY PCH "<function>PCH</function>">
 191 <!ENTITY PDF "<function>PDF</function>">
 192 <!ENTITY PostScript "<function>PostScript</function>">
 193 <!ENTITY Program "<function>Program</function>">
 194 <!ENTITY RES "<function>RES</function>">
 195 <!ENTITY RMIC "<function>RMIC</function>">
 196 <!ENTITY SharedLibrary "<function>SharedLibrary</function>">
 197 <!ENTITY SharedObject "<function>SharedObject</function>">
 198 <!ENTITY StaticLibrary "<function>StaticLibrary</function>">
 199 <!ENTITY StaticObject "<function>StaticObject</function>">
 200 <!ENTITY Tar "<function>Tar</function>">
 201 <!ENTITY Zip "<function>Zip</function>">
 202
 203 <!-- Obsolete, but referenced in old documents.  -->
 204 <!ENTITY MakeBuilder "<function>Make</function>">
 205
 206
 207
 208 <!--
 209
 210   Terms.  Define both singular and plural forms in various
 211   case-sensitive combinations for use in titles, in-line, etc.
 212
 213 -->
 214
 215 <!ENTITY buildfunc "<literal>builder function</literal>">
 216
 217 <!ENTITY ConsEnv "<literal>Construction Environment</literal>">
 218 <!ENTITY ConsEnvs "<literal>Construction Environments</literal>">
 219 <!ENTITY Consenv "<literal>Construction environment</literal>">
 220 <!ENTITY Consenvs "<literal>Construction environments</literal>">
 221 <!ENTITY consenv "<literal>construction environment</literal>">
 222 <!ENTITY consenvs "<literal>construction environments</literal>">
 223
 224 <!ENTITY ConsVar "<literal>Construction Variable</literal>">
 225 <!ENTITY ConsVars "<literal>Construction Variables</literal>">
 226 <!ENTITY Consvar "<literal>Construction variable</literal>">
 227 <!ENTITY Consvars "<literal>Construction variables</literal>">
 228 <!ENTITY consvar "<literal>construction variable</literal>">
 229 <!ENTITY consvars "<literal>construction variables</literal>">
 230
 231 <!ENTITY CPPPATH "<literal>CPPPATH</literal>">
 232
 233 <!ENTITY Dictionary "<literal>Dictionary</literal>">
 234
 235 <!ENTITY Emitter "<literal>Emitter</literal>">
 236 <!ENTITY emitter "<literal>emitter</literal>">
 237 <!ENTITY Generator "<literal>Generator</literal>">
 238 <!ENTITY generator "<literal>generator</literal>">
 239
 240 <!ENTITY signature "<literal>signature</literal>">
 241 <!ENTITY buildsignature "<literal>build signature</literal>">
 242
 243 <!--
 244
 245   File and program names used in examples.
 246
 247 -->
 248
 249 <!ENTITY common1_c "<application>common1.c</application>">
 250 <!ENTITY common2_c "<application>common2.c</application>">
 251 <!ENTITY goodbye "<application>goodbye</application>">
 252 <!ENTITY hello "<application>hello</application>">
 253 <!ENTITY hello_c "<filename>hello.c</filename>">
 254 <!ENTITY hello_exe "<filename>hello.exe</filename>">
 255 <!ENTITY hello_h "<filename>hello.h</filename>">
 256 <!ENTITY hello_o "<filename>hello.o</filename>">
 257 <!ENTITY prog "<filename>prog</filename>">
 258 <!ENTITY prog_c "<filename>prog.c</filename>">
 259 <!ENTITY prog_exe "<filename>prog.exe</filename>">
 260 <!ENTITY stdio_h "<filename>stdio.h</filename>">