| 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|---|
| 2 | |
|---|
| 3 | <html> |
|---|
| 4 | <head> |
|---|
| 5 | <meta name="generator" content= |
|---|
| 6 | "HTML Tidy for Linux/x86 (vers 1st September 2003), see www.w3.org"> |
|---|
| 7 | <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> |
|---|
| 8 | <link rel="stylesheet" type="text/css" href="../../../boost.css"> |
|---|
| 9 | |
|---|
| 10 | <title>Boost.Build - variables</title> |
|---|
| 11 | <meta name="author" content="Rene Rivera"> |
|---|
| 12 | </head> |
|---|
| 13 | |
|---|
| 14 | <body link="#0000FF" vlink="#800080"> |
|---|
| 15 | <table border="0" cellpadding="7" cellspacing="0" width="100%" summary= |
|---|
| 16 | "header"> |
|---|
| 17 | <tbody> |
|---|
| 18 | <tr> |
|---|
| 19 | <td valign="top" width="300"> |
|---|
| 20 | <h3><a href="http://www.boost.org/"><img height="86" width="277" |
|---|
| 21 | alt="C++ Boost" src="../../../boost.png" border="0"></a></h3> |
|---|
| 22 | </td> |
|---|
| 23 | |
|---|
| 24 | <td valign="top"> |
|---|
| 25 | <h1 align="center">Boost.Build</h1> |
|---|
| 26 | |
|---|
| 27 | <h2 align="center">variables</h2> |
|---|
| 28 | </td> |
|---|
| 29 | </tr> |
|---|
| 30 | </tbody> |
|---|
| 31 | </table> |
|---|
| 32 | <hr> |
|---|
| 33 | |
|---|
| 34 | <h2>Introduction</h2> |
|---|
| 35 | |
|---|
| 36 | <p>Boost.Build's behaviour can be controlled by setting of variables either |
|---|
| 37 | from the shell environment or using the |
|---|
| 38 | "<code>-s<i>VARIABLE_NAME</i>=</code><i>value</i>" Jam command line option. |
|---|
| 39 | Most of these variables are used internally and don't need to be |
|---|
| 40 | manipulated by the user.</p> |
|---|
| 41 | |
|---|
| 42 | <h2>Variables</h2> |
|---|
| 43 | |
|---|
| 44 | <table border="1" summary="variables"> |
|---|
| 45 | <tbody> |
|---|
| 46 | <tr> |
|---|
| 47 | <th>Variable Name</th> |
|---|
| 48 | |
|---|
| 49 | <th>Semantics</th> |
|---|
| 50 | |
|---|
| 51 | <th valign="top">Notes<br></th> |
|---|
| 52 | </tr> |
|---|
| 53 | |
|---|
| 54 | <tr> |
|---|
| 55 | <td valign="top"><code>AS</code><br></td> |
|---|
| 56 | |
|---|
| 57 | <td valign="top">Command to compile assermbler source files.<br></td> |
|---|
| 58 | |
|---|
| 59 | <td valign="top"><br></td> |
|---|
| 60 | </tr> |
|---|
| 61 | |
|---|
| 62 | <tr> |
|---|
| 63 | <td valign="top"><code>ASFLAGS</code><br></td> |
|---|
| 64 | |
|---|
| 65 | <td valign="top">Flags to pass to As command.<br></td> |
|---|
| 66 | |
|---|
| 67 | <td valign="top"><br></td> |
|---|
| 68 | </tr> |
|---|
| 69 | |
|---|
| 70 | <tr> |
|---|
| 71 | <td valign="top"><code>AWK</code><br></td> |
|---|
| 72 | |
|---|
| 73 | <td valign="top">Command to process awk commands.<br></td> |
|---|
| 74 | |
|---|
| 75 | <td valign="top"><br></td> |
|---|
| 76 | </tr> |
|---|
| 77 | |
|---|
| 78 | <tr> |
|---|
| 79 | <td valign="top"><code>CHMOD</code><br></td> |
|---|
| 80 | |
|---|
| 81 | <td valign="top">Command to set the permissions of files.<br></td> |
|---|
| 82 | |
|---|
| 83 | <td valign="top"><br></td> |
|---|
| 84 | </tr> |
|---|
| 85 | |
|---|
| 86 | <tr> |
|---|
| 87 | <td><code>CP</code></td> |
|---|
| 88 | |
|---|
| 89 | <td>Command used to copy files.</td> |
|---|
| 90 | |
|---|
| 91 | <td valign="top"><br></td> |
|---|
| 92 | </tr> |
|---|
| 93 | |
|---|
| 94 | <tr> |
|---|
| 95 | <td valign="top"><code>CRELIB</code><br></td> |
|---|
| 96 | |
|---|
| 97 | <td valign="top">?<br></td> |
|---|
| 98 | |
|---|
| 99 | <td valign="top"><br></td> |
|---|
| 100 | </tr> |
|---|
| 101 | |
|---|
| 102 | <tr> |
|---|
| 103 | <td valign="top"><code>DLLMODE</code><br></td> |
|---|
| 104 | |
|---|
| 105 | <td valign="top">Permissions to set for generated shared library |
|---|
| 106 | files.<br></td> |
|---|
| 107 | |
|---|
| 108 | <td valign="top"><br></td> |
|---|
| 109 | </tr> |
|---|
| 110 | |
|---|
| 111 | <tr> |
|---|
| 112 | <td valign="top"><code>DLL_AS_LIB</code><br></td> |
|---|
| 113 | |
|---|
| 114 | <td valign="top">Platform flag indicating that when linking the |
|---|
| 115 | platform treats shared libraries as link libraries when linking. |
|---|
| 116 | Notably Win32 type platforms.<br></td> |
|---|
| 117 | |
|---|
| 118 | <td valign="top"><br></td> |
|---|
| 119 | </tr> |
|---|
| 120 | |
|---|
| 121 | <tr> |
|---|
| 122 | <td valign="top"><code>DOT</code><br></td> |
|---|
| 123 | |
|---|
| 124 | <td valign="top">Representation of current directory in a |
|---|
| 125 | path.<br></td> |
|---|
| 126 | |
|---|
| 127 | <td valign="top"><br></td> |
|---|
| 128 | </tr> |
|---|
| 129 | |
|---|
| 130 | <tr> |
|---|
| 131 | <td valign="top"><code>DOTDOT</code><br></td> |
|---|
| 132 | |
|---|
| 133 | <td valign="top">Represetation of parent directory in a |
|---|
| 134 | path.<br></td> |
|---|
| 135 | |
|---|
| 136 | <td valign="top"><br></td> |
|---|
| 137 | </tr> |
|---|
| 138 | |
|---|
| 139 | <tr> |
|---|
| 140 | <td valign="top"><code>EXEMODE</code><br></td> |
|---|
| 141 | |
|---|
| 142 | <td valign="top">Permissions to set for generated executable |
|---|
| 143 | files.<br></td> |
|---|
| 144 | |
|---|
| 145 | <td valign="top"><br></td> |
|---|
| 146 | </tr> |
|---|
| 147 | |
|---|
| 148 | <tr> |
|---|
| 149 | <td valign="top"><code>FILEMODE</code><br></td> |
|---|
| 150 | |
|---|
| 151 | <td valign="top">Permissions to set for generated regular |
|---|
| 152 | files.<br></td> |
|---|
| 153 | |
|---|
| 154 | <td valign="top"><br></td> |
|---|
| 155 | </tr> |
|---|
| 156 | |
|---|
| 157 | <tr> |
|---|
| 158 | <td valign="top"><code>FORTRAN</code><br></td> |
|---|
| 159 | |
|---|
| 160 | <td valign="top">Command to compile Fortran source files.<br></td> |
|---|
| 161 | |
|---|
| 162 | <td valign="top"><br></td> |
|---|
| 163 | </tr> |
|---|
| 164 | |
|---|
| 165 | <tr> |
|---|
| 166 | <td valign="top"><code>FORTRANFLAGS</code><br></td> |
|---|
| 167 | |
|---|
| 168 | <td valign="top">Flags to pass to FORTRAN command.<br></td> |
|---|
| 169 | |
|---|
| 170 | <td valign="top"><br></td> |
|---|
| 171 | </tr> |
|---|
| 172 | |
|---|
| 173 | <tr> |
|---|
| 174 | <td valign="top"><code>HDRS</code><br></td> |
|---|
| 175 | |
|---|
| 176 | <td valign="top">Default list of directories of platform |
|---|
| 177 | headers.<br></td> |
|---|
| 178 | |
|---|
| 179 | <td valign="top"><br></td> |
|---|
| 180 | </tr> |
|---|
| 181 | |
|---|
| 182 | <tr> |
|---|
| 183 | <td valign="top"><code>HDRPATTERN</code><br></td> |
|---|
| 184 | |
|---|
| 185 | <td valign="top">Regex pattern used to match the file part of CPP |
|---|
| 186 | include directives.<br></td> |
|---|
| 187 | |
|---|
| 188 | <td valign="top"><br></td> |
|---|
| 189 | </tr> |
|---|
| 190 | |
|---|
| 191 | <tr> |
|---|
| 192 | <td valign="top"><code>JAMFILE</code><br></td> |
|---|
| 193 | |
|---|
| 194 | <td valign="top">File to read build instructions/descriptions |
|---|
| 195 | from.<br></td> |
|---|
| 196 | |
|---|
| 197 | <td valign="top">Default is "Jamfile".<br></td> |
|---|
| 198 | </tr> |
|---|
| 199 | |
|---|
| 200 | <tr> |
|---|
| 201 | <td valign="top"><code>JAMRULES</code><br></td> |
|---|
| 202 | |
|---|
| 203 | <td valign="top">File to read for global rules and variable.<br></td> |
|---|
| 204 | |
|---|
| 205 | <td valign="top">Default is "Jamrules".<br></td> |
|---|
| 206 | </tr> |
|---|
| 207 | |
|---|
| 208 | <tr> |
|---|
| 209 | <td valign="top"><code>JAMSHELL</code><br></td> |
|---|
| 210 | |
|---|
| 211 | <td valign="top">See Perforce/Jam documentation.<br></td> |
|---|
| 212 | |
|---|
| 213 | <td valign="top"><br></td> |
|---|
| 214 | </tr> |
|---|
| 215 | |
|---|
| 216 | <tr> |
|---|
| 217 | <td valign="top"><code>LEX</code><br></td> |
|---|
| 218 | |
|---|
| 219 | <td valign="top">Command for processing Lex compatible |
|---|
| 220 | parsers.<br></td> |
|---|
| 221 | |
|---|
| 222 | <td valign="top"><br></td> |
|---|
| 223 | </tr> |
|---|
| 224 | |
|---|
| 225 | <tr> |
|---|
| 226 | <td valign="top"><code>LEX_OUTPUT</code><br></td> |
|---|
| 227 | |
|---|
| 228 | <td valign="top">LEX option to directly specify the output files to |
|---|
| 229 | generate.<br></td> |
|---|
| 230 | |
|---|
| 231 | <td valign="top"><br></td> |
|---|
| 232 | </tr> |
|---|
| 233 | |
|---|
| 234 | <tr> |
|---|
| 235 | <td valign="top"><code>LN</code><br></td> |
|---|
| 236 | |
|---|
| 237 | <td valign="top">Command to create a hard-link to a file.<br></td> |
|---|
| 238 | |
|---|
| 239 | <td valign="top"><br></td> |
|---|
| 240 | </tr> |
|---|
| 241 | |
|---|
| 242 | <tr> |
|---|
| 243 | <td valign="top"><code>MANDIR</code><br></td> |
|---|
| 244 | |
|---|
| 245 | <td valign="top">Directory to install MAN documentation |
|---|
| 246 | files.<br></td> |
|---|
| 247 | |
|---|
| 248 | <td valign="top"><br></td> |
|---|
| 249 | </tr> |
|---|
| 250 | |
|---|
| 251 | <tr> |
|---|
| 252 | <td valign="top"><code>MKDIR</code><br></td> |
|---|
| 253 | |
|---|
| 254 | <td valign="top">Command to create a directory.<br></td> |
|---|
| 255 | |
|---|
| 256 | <td valign="top"><br></td> |
|---|
| 257 | </tr> |
|---|
| 258 | |
|---|
| 259 | <tr> |
|---|
| 260 | <td valign="top"><code>MV</code></td> |
|---|
| 261 | |
|---|
| 262 | <td valign="top">Command to rename files.<br></td> |
|---|
| 263 | |
|---|
| 264 | <td valign="top"><br></td> |
|---|
| 265 | </tr> |
|---|
| 266 | |
|---|
| 267 | <tr> |
|---|
| 268 | <td valign="top"><code>NOARSCAN</code></td> |
|---|
| 269 | |
|---|
| 270 | <td valign="top">Platforms archive format does not support |
|---|
| 271 | scanning.</td> |
|---|
| 272 | |
|---|
| 273 | <td valign="top"><br></td> |
|---|
| 274 | </tr> |
|---|
| 275 | |
|---|
| 276 | <tr> |
|---|
| 277 | <td valign="top"><code>OSFULL</code><br></td> |
|---|
| 278 | |
|---|
| 279 | <td valign="top">List of all the variations of the OS platform name |
|---|
| 280 | and version.<br></td> |
|---|
| 281 | |
|---|
| 282 | <td valign="top"><br></td> |
|---|
| 283 | </tr> |
|---|
| 284 | |
|---|
| 285 | <tr> |
|---|
| 286 | <td valign="top"><code>PREDLL</code></td> |
|---|
| 287 | |
|---|
| 288 | <td valign="top">Prefix for generated shared library files.<br></td> |
|---|
| 289 | |
|---|
| 290 | <td valign="top"><br></td> |
|---|
| 291 | </tr> |
|---|
| 292 | |
|---|
| 293 | <tr> |
|---|
| 294 | <td valign="top"><code>PRELIB</code><br></td> |
|---|
| 295 | |
|---|
| 296 | <td valign="top">Prefix for generated link library files.<br></td> |
|---|
| 297 | |
|---|
| 298 | <td valign="top"><br></td> |
|---|
| 299 | </tr> |
|---|
| 300 | |
|---|
| 301 | <tr> |
|---|
| 302 | <td valign="top"><code>RANLIB</code><br></td> |
|---|
| 303 | |
|---|
| 304 | <td valign="top">Command to post-process archives or link |
|---|
| 305 | libraries.<br></td> |
|---|
| 306 | |
|---|
| 307 | <td valign="top">Set to empty ("") if there is no command.<br></td> |
|---|
| 308 | </tr> |
|---|
| 309 | |
|---|
| 310 | <tr> |
|---|
| 311 | <td valign="top"><code>RELOCATE</code><br></td> |
|---|
| 312 | |
|---|
| 313 | <td valign="top">Flag to indicate that the platform compiler does not |
|---|
| 314 | support placing generated object files, so we must move |
|---|
| 315 | them.<br></td> |
|---|
| 316 | |
|---|
| 317 | <td valign="top"><br></td> |
|---|
| 318 | </tr> |
|---|
| 319 | |
|---|
| 320 | <tr> |
|---|
| 321 | <td valign="top"><code>RM</code></td> |
|---|
| 322 | |
|---|
| 323 | <td valign="top">Command used to delete files.<br></td> |
|---|
| 324 | |
|---|
| 325 | <td valign="top"><br></td> |
|---|
| 326 | </tr> |
|---|
| 327 | |
|---|
| 328 | <tr> |
|---|
| 329 | <td valign="top"><code>SED</code><br></td> |
|---|
| 330 | |
|---|
| 331 | <td valign="top">Command to execute sed scripts.<br></td> |
|---|
| 332 | |
|---|
| 333 | <td valign="top"><br></td> |
|---|
| 334 | </tr> |
|---|
| 335 | |
|---|
| 336 | <tr> |
|---|
| 337 | <td valign="top"><code>SHELLHEADER</code><br></td> |
|---|
| 338 | |
|---|
| 339 | <td valign="top">Header to prepend in generated shell |
|---|
| 340 | scripts.<br></td> |
|---|
| 341 | |
|---|
| 342 | <td valign="top"><br></td> |
|---|
| 343 | </tr> |
|---|
| 344 | |
|---|
| 345 | <tr> |
|---|
| 346 | <td valign="top"><code>SHELLMODE</code><br></td> |
|---|
| 347 | |
|---|
| 348 | <td valign="top">Permissions to set for generated shell script |
|---|
| 349 | files.<br></td> |
|---|
| 350 | |
|---|
| 351 | <td valign="top"><br></td> |
|---|
| 352 | </tr> |
|---|
| 353 | |
|---|
| 354 | <tr> |
|---|
| 355 | <td valign="top"><code>SHELL_EXPORT</code><br></td> |
|---|
| 356 | |
|---|
| 357 | <td valign="top">Command for exporting variables set by Boost.Build |
|---|
| 358 | to the shell. Not set if there is no command.<br></td> |
|---|
| 359 | |
|---|
| 360 | <td valign="top"><br></td> |
|---|
| 361 | </tr> |
|---|
| 362 | |
|---|
| 363 | <tr> |
|---|
| 364 | <td valign="top"><code>SHELL_SET</code><br></td> |
|---|
| 365 | |
|---|
| 366 | <td valign="top">Comamnd for setting variables in the shell. Includes |
|---|
| 367 | trailing " " as needed. Set to empty ("") if there is no |
|---|
| 368 | command.<br></td> |
|---|
| 369 | |
|---|
| 370 | <td valign="top"><br></td> |
|---|
| 371 | </tr> |
|---|
| 372 | |
|---|
| 373 | <tr> |
|---|
| 374 | <td valign="top"><code>SLASH</code><br></td> |
|---|
| 375 | |
|---|
| 376 | <td valign="top">Directory and file separator of the platform.</td> |
|---|
| 377 | |
|---|
| 378 | <td valign="top"><br></td> |
|---|
| 379 | </tr> |
|---|
| 380 | |
|---|
| 381 | <tr> |
|---|
| 382 | <td valign="top"><code>SOURCE_GENERATING_EXTENSIONS</code><br></td> |
|---|
| 383 | |
|---|
| 384 | <td valign="top">A list of all file extensions which generate source |
|---|
| 385 | files when built.<br></td> |
|---|
| 386 | |
|---|
| 387 | <td valign="top"><br></td> |
|---|
| 388 | </tr> |
|---|
| 389 | |
|---|
| 390 | <tr> |
|---|
| 391 | <td valign="top"><code>SPLITPATH</code><br></td> |
|---|
| 392 | |
|---|
| 393 | <td valign="top">Separator of the platform for variables that hold a |
|---|
| 394 | list of paths.</td> |
|---|
| 395 | |
|---|
| 396 | <td valign="top"><br></td> |
|---|
| 397 | </tr> |
|---|
| 398 | |
|---|
| 399 | <tr> |
|---|
| 400 | <td valign="top"><code>STDHDRS</code><br></td> |
|---|
| 401 | |
|---|
| 402 | <td valign="top">Directory location of standard C/C++ |
|---|
| 403 | headers.<br></td> |
|---|
| 404 | |
|---|
| 405 | <td valign="top"><br></td> |
|---|
| 406 | </tr> |
|---|
| 407 | |
|---|
| 408 | <tr> |
|---|
| 409 | <td valign="top"><code>SUFDLL</code></td> |
|---|
| 410 | |
|---|
| 411 | <td valign="top">Suffix for generated shared library files.<br></td> |
|---|
| 412 | |
|---|
| 413 | <td valign="top">Includes any "." as needed.</td> |
|---|
| 414 | </tr> |
|---|
| 415 | |
|---|
| 416 | <tr> |
|---|
| 417 | <td valign="top"><code>SUFFEXE</code><br></td> |
|---|
| 418 | |
|---|
| 419 | <td valign="top">Suffix for generated executable files.<br></td> |
|---|
| 420 | |
|---|
| 421 | <td valign="top">Includes any "." as needed.<br></td> |
|---|
| 422 | </tr> |
|---|
| 423 | |
|---|
| 424 | <tr> |
|---|
| 425 | <td valign="top"><code>SUFLIB</code><br></td> |
|---|
| 426 | |
|---|
| 427 | <td valign="top">Suffix for generated link library files.<br></td> |
|---|
| 428 | |
|---|
| 429 | <td valign="top">Includes any "." as needed.</td> |
|---|
| 430 | </tr> |
|---|
| 431 | |
|---|
| 432 | <tr> |
|---|
| 433 | <td valign="top"><code>SUFOBJ</code><br></td> |
|---|
| 434 | |
|---|
| 435 | <td valign="top">Suffix for generated compiled object files.<br></td> |
|---|
| 436 | |
|---|
| 437 | <td valign="top">Includes any "." as needed.<br></td> |
|---|
| 438 | </tr> |
|---|
| 439 | |
|---|
| 440 | <tr> |
|---|
| 441 | <td valign="top"><code>YACC</code><br></td> |
|---|
| 442 | |
|---|
| 443 | <td valign="top">Command for processing Yacc compatible |
|---|
| 444 | grammars.<br></td> |
|---|
| 445 | |
|---|
| 446 | <td valign="top"><br></td> |
|---|
| 447 | </tr> |
|---|
| 448 | |
|---|
| 449 | <tr> |
|---|
| 450 | <td valign="top"><code>YACCFILES</code><br></td> |
|---|
| 451 | |
|---|
| 452 | <td valign="top">The filenames that the YACC command |
|---|
| 453 | produces.<br></td> |
|---|
| 454 | |
|---|
| 455 | <td valign="top"><br></td> |
|---|
| 456 | </tr> |
|---|
| 457 | |
|---|
| 458 | <tr> |
|---|
| 459 | <td valign="top"><code>YACCFLAGS</code><br></td> |
|---|
| 460 | |
|---|
| 461 | <td valign="top">Extra flags to pass to the YACC command.<br></td> |
|---|
| 462 | |
|---|
| 463 | <td valign="top"><br></td> |
|---|
| 464 | </tr> |
|---|
| 465 | |
|---|
| 466 | <tr> |
|---|
| 467 | <td valign="top"><code>YACC_OUTPUT</code><br></td> |
|---|
| 468 | |
|---|
| 469 | <td valign="top">YACC option to directly specify the output files to |
|---|
| 470 | generate.<br></td> |
|---|
| 471 | |
|---|
| 472 | <td valign="top"><br></td> |
|---|
| 473 | </tr> |
|---|
| 474 | </tbody> |
|---|
| 475 | </table> |
|---|
| 476 | <hr> |
|---|
| 477 | |
|---|
| 478 | <p>Revised |
|---|
| 479 | <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan --> |
|---|
| 480 | 14 May, 2002 <!--webbot bot="Timestamp" endspan i-checksum="39359" --></p> |
|---|
| 481 | |
|---|
| 482 | <p>Copyright © Rene Rivera 2002.</p> |
|---|
| 483 | |
|---|
| 484 | <p><small>Distributed under the Boost Software License, Version 1.0. (See |
|---|
| 485 | accompanying file <a href="../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or |
|---|
| 486 | copy at <a href= |
|---|
| 487 | "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</small></p> |
|---|
| 488 | </body> |
|---|
| 489 | </html> |
|---|
