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 Autoconf "<application>Autoconf</application>">
  18 <!ENTITY Cons "<application>Cons</application>">
  19 <!ENTITY Make "<application>Make</application>">
  20 <!ENTITY Makepp "<application>Make++</application>">
  21 <!ENTITY SCons "<application>SCons</application>">
  22 <!ENTITY scons "<application>scons</application>">
  23 <!ENTITY ScCons "<application>ScCons</application>">
  24
  25
  26 <!--
  27
  28   Classes.
  29
  30 -->
  31
  32 <!ENTITY Action "<classname>Action</classname>">
  33 <!ENTITY ActionBase "<classname>ActionBase</classname>">
  34 <!ENTITY CommandAction "<classname>CommandAction</classname>">
  35 <!ENTITY FunctionAction "<classname>FunctionAction</classname>">
  36 <!ENTITY ListAction "<classname>ListAction</classname>">
  37 <!ENTITY Builder "<classname>Builder</classname>">
  38 <!ENTITY BuilderBase "<classname>BuilderBase</classname>">
  39 <!ENTITY CompositeBuilder "<classname>CompositeBuilder</classname>">
  40 <!ENTITY MultiStepBuilder "<classname>MultiStepBuilder</classname>">
  41 <!ENTITY Job "<classname>Job</classname>">
  42 <!ENTITY Jobs "<classname>Jobs</classname>">
  43 <!ENTITY Serial "<classname>Serial</classname>">
  44 <!ENTITY Parallel "<classname>Parallel</classname>">
  45 <!ENTITY Node "<classname>Node</classname>">
  46 <!ENTITY Node_FS "<classname>Node.FS</classname>">
  47 <!ENTITY Scanner "<classname>Scanner</classname>">
  48 <!ENTITY Sig "<classname>Sig</classname>">
  49 <!ENTITY Signature "<classname>Signature</classname>">
  50 <!ENTITY Taskmaster "<classname>Taskmaster</classname>">
  51 <!ENTITY TimeStamp "<classname>TimeStamp</classname>">
  52 <!ENTITY Walker "<classname>Walker</classname>">
  53 <!ENTITY Wrapper "<classname>Wrapper</classname>">
  54
  55
  56
  57 <!--
  58
  59   File names.
  60
  61 -->
  62
  63 <!ENTITY Makefile "<filename>Makefile</filename>">
  64 <!ENTITY Makefiles "<filename>Makefiles</filename>">
  65 <!ENTITY SConscript "<filename>SConscript</filename>">
  66 <!ENTITY SConstruct "<filename>SConstruct</filename>">
  67 <!ENTITY Sconstruct "<filename>Sconstruct</filename>">
  68 <!ENTITY sconstruct "<filename>sconstruct</filename>">
  69 <!ENTITY sconsign "<filename>.sconsign</filename>">
  70
  71
  72
  73 <!--
  74
  75   Methods and functions.  This includes functions from both
  76   the Build Engine and the Native Python Interface.
  77
  78 -->
  79
  80 <!ENTITY Alias "<function>Alias</function>">
  81 <!ENTITY Aliases "<function>Aliases</function>">
  82 <!ENTITY Build "<function>Build</function>">
  83 <!ENTITY Cache "<function>Cache</function>">
  84 <!ENTITY Clean "<function>Clean</function>">
  85 <!ENTITY Clone "<function>Clone</function>">
  86 <!ENTITY Command "<function>Command</function>">
  87 <!ENTITY Copy "<function>Copy</function>">
  88 <!ENTITY Default "<function>Default</function>">
  89 <!ENTITY DefaultRules "<function>DefaultRules</function>">
  90 <!ENTITY Depends "<function>Depends</function>">
  91 <!ENTITY Environment "<function>Environment</function>">
  92 <!ENTITY Export "<function>Export</function>">
  93 <!ENTITY Help "<function>Help</function>">
  94 <!ENTITY Ignore "<function>Ignore</function>">
  95 <!ENTITY Install "<function>Install</function>">
  96 <!ENTITY InstallAs "<function>InstallAs</function>">
  97 <!ENTITY Link "<function>Link</function>">
  98 <!ENTITY Local "<function>Local</function>">
  99 <!ENTITY Module "<function>Module</function>">
 100 <!ENTITY Objects "<function>Objects</function>">
 101 <!ENTITY Precious "<function>Precious</function>">
 102 <!ENTITY Repository "<function>Repository</function>">
 103 <!ENTITY RuleSet "<function>RuleSet</function>">
 104 <!ENTITY Salt "<function>Salt</function>">
 105 <!ENTITY SourceSignature "<function>SourceSignature</function>">
 106 <!ENTITY Split "<function>Split</function>">
 107 <!ENTITY Task "<function>Task</function>">
 108
 109
 110
 111 <!--
 112
 113   Construction variables.
 114
 115 -->
 116
 117 <!ENTITY BUILDERMAP "<varname>BUILDERMAP</varname>">
 118 <!ENTITY BUILDERS "<varname>BUILDERS</varname>">
 119 <!ENTITY SCANNERMAP "<varname>SCANNERMAP</varname>">
 120 <!ENTITY SCANNERS "<varname>SCANNERS</varname>">
 121
 122
 123
 124 <!--
 125
 126   Environment variables.
 127
 128 -->
 129
 130 <!ENTITY CCFLAGS "<varname>CCFLAGS</varname>">
 131 <!ENTITY LIBPATH "<varname>LIBPATH</varname>">
 132 <!ENTITY PYTHONPATH "<varname>PYTHONPATH</varname>">
 133 <!ENTITY SCONSFLAGS "<varname>SCONSFLAGS</varname>">
 134
 135
 136
 137 <!--
 138
 139   Builder and Scanner objects.
 140
 141 -->
 142
 143 <!ENTITY Object "<function>Object</function>">
 144 <!ENTITY Library "<function>Library</function>">
 145 <!ENTITY SharedLibrary "<function>SharedLibrary</function>">
 146 <!ENTITY Program "<function>Program</function>">
 147 <!ENTITY MakeBuilder "<function>Make</function>">
 148 <!ENTITY BuildDir "<function>BuildDir</function>">
 149
 150
 151
 152 <!--
 153
 154   Terms.  Define both singular and plural forms in various
 155   case-sensitive combinations for use in titles, in-line, etc.
 156
 157 -->
 158
 159 <!ENTITY ConsEnv "<literal>Construction Environment</literal>">
 160 <!ENTITY ConsEnvs "<literal>Construction Environments</literal>">
 161 <!ENTITY Consenv "<literal>Construction environment</literal>">
 162 <!ENTITY Consenvs "<literal>Construction environments</literal>">
 163 <!ENTITY consenv "<literal>construction environment</literal>">
 164 <!ENTITY consenvs "<literal>construction environments</literal>">
 165
 166 <!ENTITY ConsVar "<literal>Construction Variable</literal>">
 167 <!ENTITY ConsVars "<literal>Construction Variables</literal>">
 168 <!ENTITY Consvar "<literal>Construction variable</literal>">
 169 <!ENTITY Consvars "<literal>Construction variables</literal>">
 170 <!ENTITY consvar "<literal>construction variable</literal>">
 171 <!ENTITY consvars "<literal>construction variables</literal>">
 172
 173 <!ENTITY CPPPATH "<literal>CPPPATH</literal>">
 174
 175 <!ENTITY Dictionary "<literal>Dictionary</literal>">
 176
 177 <!--
 178
 179   File and program names used in examples.
 180
 181 -->
 182
 183 <!ENTITY goodbye "<application>goodbye</application>">
 184 <!ENTITY hello "<application>hello</application>">
 185 <!ENTITY hello_c "<filename>hello.c</filename>">
 186 <!ENTITY hello_h "<filename>hello.h</filename>">
 187 <!ENTITY stdio_h "<filename>stdio.h</filename>">