1BMAKE(1) FreeBSD General Commands Manual BMAKE(1) 2 3[1mNAME[0m 4 [1mbmake [22m-- maintain program dependencies 5 6[1mSYNOPSIS[0m 7 [1mbmake [22m[[1m-BeikNnqrstWwX[22m] [[1m-C [4m[22mdirectory[24m] [[1m-D [4m[22mvariable[24m] [[1m-d [4m[22mflags[24m] 8 [[1m-f [4m[22mmakefile[24m] [[1m-I [4m[22mdirectory[24m] [[1m-J [4m[22mprivate[24m] [[1m-j [4m[22mmax_jobs[24m] 9 [[1m-m [4m[22mdirectory[24m] [[1m-T [4m[22mfile[24m] [[1m-V [4m[22mvariable[24m] [[1m-v [4m[22mvariable[24m] 10 [[4mvariable=value[24m] [[4mtarget[24m [4m...[24m] 11 12[1mDESCRIPTION[0m 13 [1mbmake [22mis a program designed to simplify the maintenance of other pro- 14 grams. Its input is a list of specifications as to the files upon which 15 programs and other files depend. If no [1m-f [4m[22mmakefile[24m makefile option is 16 given, [1mbmake [22mwill try to open `[4mmakefile[24m' then `[4mMakefile[24m' in order to find 17 the specifications. If the file `[4m.depend[24m' exists, it is read (see 18 mkdep(1)). 19 20 This manual page is intended as a reference document only. For a more 21 thorough description of [1mbmake [22mand makefiles, please refer to [4mPMake[24m [4m-[24m [4mA[0m 22 [4mTutorial[24m. 23 24 [1mbmake [22mwill prepend the contents of the [4mMAKEFLAGS[24m environment variable to 25 the command line arguments before parsing them. 26 27 The options are as follows: 28 29 [1m-B [22mTry to be backwards compatible by executing a single shell per 30 command and by executing the commands to make the sources of a 31 dependency line in sequence. 32 33 [1m-C [4m[22mdirectory[0m 34 Change to [4mdirectory[24m before reading the makefiles or doing any- 35 thing else. If multiple [1m-C [22moptions are specified, each is inter- 36 preted relative to the previous one: [1m-C [4m[22m/[24m [1m-C [4m[22metc[24m is equivalent to 37 [1m-C [4m[22m/etc[24m. 38 39 [1m-D [4m[22mvariable[0m 40 Define [4mvariable[24m to be 1, in the global context. 41 42 [1m-d [4m[22m[-]flags[0m 43 Turn on debugging, and specify which portions of [1mbmake [22mare to 44 print debugging information. Unless the flags are preceded by 45 `-' they are added to the [4mMAKEFLAGS[24m environment variable and will 46 be processed by any child make processes. By default, debugging 47 information is printed to standard error, but this can be changed 48 using the [4mF[24m debugging flag. The debugging output is always 49 unbuffered; in addition, if debugging is enabled but debugging 50 output is not directed to standard output, then the standard out- 51 put is line buffered. [4mFlags[24m is one or more of the following: 52 53 [4mA[24m Print all possible debugging information; equivalent to 54 specifying all of the debugging flags. 55 56 [4ma[24m Print debugging information about archive searching and 57 caching. 58 59 [4mC[24m Print debugging information about current working direc- 60 tory. 61 62 [4mc[24m Print debugging information about conditional evaluation. 63 64 [4md[24m Print debugging information about directory searching and 65 caching. 66 67 [4me[24m Print debugging information about failed commands and 68 targets. 69 70 [4mF[24m[[1m+[22m][4mfilename[0m 71 Specify where debugging output is written. This must be 72 the last flag, because it consumes the remainder of the 73 argument. If the character immediately after the `F' 74 flag is `+', then the file will be opened in append mode; 75 otherwise the file will be overwritten. If the file name 76 is `stdout' or `stderr' then debugging output will be 77 written to the standard output or standard error output 78 file descriptors respectively (and the `+' option has no 79 effect). Otherwise, the output will be written to the 80 named file. If the file name ends `.%d' then the `%d' is 81 replaced by the pid. 82 83 [4mf[24m Print debugging information about loop evaluation. 84 85 [4mg1[24m Print the input graph before making anything. 86 87 [4mg2[24m Print the input graph after making everything, or before 88 exiting on error. 89 90 [4mg3[24m Print the input graph before exiting on error. 91 92 [4mj[24m Print debugging information about running multiple 93 shells. 94 95 [4ml[24m Print commands in Makefiles regardless of whether or not 96 they are prefixed by `@' or other "quiet" flags. Also 97 known as "loud" behavior. 98 99 [4mM[24m Print debugging information about "meta" mode decisions 100 about targets. 101 102 [4mm[24m Print debugging information about making targets, includ- 103 ing modification dates. 104 105 [4mn[24m Don't delete the temporary command scripts created when 106 running commands. These temporary scripts are created in 107 the directory referred to by the TMPDIR environment vari- 108 able, or in [4m/tmp[24m if TMPDIR is unset or set to the empty 109 string. The temporary scripts are created by mkstemp(3), 110 and have names of the form [4mmakeXXXXXX[24m. [4mNOTE[24m: This can 111 create many files in TMPDIR or [4m/tmp[24m, so use with care. 112 113 [4mp[24m Print debugging information about makefile parsing. 114 115 [4ms[24m Print debugging information about suffix-transformation 116 rules. 117 118 [4mt[24m Print debugging information about target list mainte- 119 nance. 120 121 [4mV[24m Force the [1m-V [22moption to print raw values of variables, 122 overriding the default behavior set via 123 [4m.MAKE.EXPAND_VARIABLES[24m. 124 125 [4mv[24m Print debugging information about variable assignment. 126 127 [4mx[24m Run shell commands with [1m-x [22mso the actual commands are 128 printed as they are executed. 129 130 [1m-e [22mSpecify that environment variables override macro assignments 131 within makefiles. 132 133 [1m-f [4m[22mmakefile[0m 134 Specify a makefile to read instead of the default `[4mmakefile[24m'. If 135 [4mmakefile[24m is `[1m-[22m', standard input is read. Multiple makefiles may 136 be specified, and are read in the order specified. 137 138 [1m-I [4m[22mdirectory[0m 139 Specify a directory in which to search for makefiles and included 140 makefiles. The system makefile directory (or directories, see 141 the [1m-m [22moption) is automatically included as part of this list. 142 143 [1m-i [22mIgnore non-zero exit of shell commands in the makefile. Equiva- 144 lent to specifying `[1m-[22m' before each command line in the makefile. 145 146 [1m-J [4m[22mprivate[0m 147 This option should [4mnot[24m be specified by the user. 148 149 When the [4mj[24m option is in use in a recursive build, this option is 150 passed by a make to child makes to allow all the make processes 151 in the build to cooperate to avoid overloading the system. 152 153 [1m-j [4m[22mmax_jobs[0m 154 Specify the maximum number of jobs that [1mbmake [22mmay have running at 155 any one time. The value is saved in [4m.MAKE.JOBS[24m. Turns compati- 156 bility mode off, unless the [4mB[24m flag is also specified. When com- 157 patibility mode is off, all commands associated with a target are 158 executed in a single shell invocation as opposed to the tradi- 159 tional one shell invocation per line. This can break traditional 160 scripts which change directories on each command invocation and 161 then expect to start with a fresh environment on the next line. 162 It is more efficient to correct the scripts rather than turn 163 backwards compatibility on. 164 165 [1m-k [22mContinue processing after errors are encountered, but only on 166 those targets that do not depend on the target whose creation 167 caused the error. 168 169 [1m-m [4m[22mdirectory[0m 170 Specify a directory in which to search for sys.mk and makefiles 171 included via the <[4mfile[24m>-style include statement. The [1m-m [22moption 172 can be used multiple times to form a search path. This path will 173 override the default system include path: /usr/share/mk. Fur- 174 thermore the system include path will be appended to the search 175 path used for "[4mfile[24m"-style include statements (see the [1m-I[0m 176 option). 177 178 If a file or directory name in the [1m-m [22margument (or the 179 MAKESYSPATH environment variable) starts with the string ".../" 180 then [1mbmake [22mwill search for the specified file or directory named 181 in the remaining part of the argument string. The search starts 182 with the current directory of the Makefile and then works upward 183 towards the root of the file system. If the search is success- 184 ful, then the resulting directory replaces the ".../" specifica- 185 tion in the [1m-m [22margument. If used, this feature allows [1mbmake [22mto 186 easily search in the current source tree for customized sys.mk 187 files (e.g., by using ".../mk/sys.mk" as an argument). 188 189 [1m-n [22mDisplay the commands that would have been executed, but do not 190 actually execute them unless the target depends on the .MAKE spe- 191 cial source (see below). 192 193 [1m-N [22mDisplay the commands which would have been executed, but do not 194 actually execute any of them; useful for debugging top-level 195 makefiles without descending into subdirectories. 196 197 [1m-q [22mDo not execute any commands, but exit 0 if the specified targets 198 are up-to-date and 1, otherwise. 199 200 [1m-r [22mDo not use the built-in rules specified in the system makefile. 201 202 [1m-s [22mDo not echo any commands as they are executed. Equivalent to 203 specifying `[1m@[22m' before each command line in the makefile. 204 205 [1m-T [4m[22mtracefile[0m 206 When used with the [1m-j [22mflag, append a trace record to [4mtracefile[0m 207 for each job started and completed. 208 209 [1m-t [22mRather than re-building a target as specified in the makefile, 210 create it or update its modification time to make it appear up- 211 to-date. 212 213 [1m-V [4m[22mvariable[0m 214 Print the value of [4mvariable[24m. Do not build any targets. Multiple 215 instances of this option may be specified; the variables will be 216 printed one per line, with a blank line for each null or unde- 217 fined variable. The value printed is extracted from the global 218 context after all makefiles have been read. By default, the raw 219 variable contents (which may include additional unexpanded vari- 220 able references) are shown. If [4mvariable[24m contains a `$' then the 221 value will be recursively expanded to its complete resultant text 222 before printing. The expanded value will also be printed if 223 [4m.MAKE.EXPAND_VARIABLES[24m is set to true and the [1m-dV [22moption has not 224 been used to override it. Note that loop-local and target-local 225 variables, as well as values taken temporarily by global vari- 226 ables during makefile processing, are not accessible via this 227 option. The [1m-dv [22mdebug mode can be used to see these at the cost 228 of generating substantial extraneous output. 229 230 [1m-v [4m[22mvariable[0m 231 Like [1m-V [22mbut the variable is always expanded to its complete 232 value. 233 234 [1m-W [22mTreat any warnings during makefile parsing as errors. 235 236 [1m-w [22mPrint entering and leaving directory messages, pre and post pro- 237 cessing. 238 239 [1m-X [22mDon't export variables passed on the command line to the environ- 240 ment individually. Variables passed on the command line are 241 still exported via the [4mMAKEFLAGS[24m environment variable. This 242 option may be useful on systems which have a small limit on the 243 size of command arguments. 244 245 [4mvariable=value[0m 246 Set the value of the variable [4mvariable[24m to [4mvalue[24m. Normally, all 247 values passed on the command line are also exported to sub-makes 248 in the environment. The [1m-X [22mflag disables this behavior. Vari- 249 able assignments should follow options for POSIX compatibility 250 but no ordering is enforced. 251 252 There are seven different types of lines in a makefile: file dependency 253 specifications, shell commands, variable assignments, include statements, 254 conditional directives, for loops, and comments. 255 256 In general, lines may be continued from one line to the next by ending 257 them with a backslash (`\'). The trailing newline character and initial 258 whitespace on the following line are compressed into a single space. 259 260[1mFILE DEPENDENCY SPECIFICATIONS[0m 261 Dependency lines consist of one or more targets, an operator, and zero or 262 more sources. This creates a relationship where the targets ``depend'' 263 on the sources and are usually created from them. The exact relationship 264 between the target and the source is determined by the operator that sep- 265 arates them. The three operators are as follows: 266 267 [1m: [22mA target is considered out-of-date if its modification time is less 268 than those of any of its sources. Sources for a target accumulate 269 over dependency lines when this operator is used. The target is 270 removed if [1mbmake [22mis interrupted. 271 272 [1m! [22mTargets are always re-created, but not until all sources have been 273 examined and re-created as necessary. Sources for a target accumu- 274 late over dependency lines when this operator is used. The target 275 is removed if [1mbmake [22mis interrupted. 276 277 [1m:: [22mIf no sources are specified, the target is always re-created. Oth- 278 erwise, a target is considered out-of-date if any of its sources 279 has been modified more recently than the target. Sources for a 280 target do not accumulate over dependency lines when this operator 281 is used. The target will not be removed if [1mbmake [22mis interrupted. 282 283 Targets and sources may contain the shell wildcard values `?', `*', `[]', 284 and `{}'. The values `?', `*', and `[]' may only be used as part of the 285 final component of the target or source, and must be used to describe 286 existing files. The value `{}' need not necessarily be used to describe 287 existing files. Expansion is in directory order, not alphabetically as 288 done in the shell. 289 290[1mSHELL COMMANDS[0m 291 Each target may have associated with it one or more lines of shell com- 292 mands, normally used to create the target. Each of the lines in this 293 script [4mmust[24m be preceded by a tab. (For historical reasons, spaces are 294 not accepted.) While targets can appear in many dependency lines if 295 desired, by default only one of these rules may be followed by a creation 296 script. If the `[1m::[22m' operator is used, however, all rules may include 297 scripts and the scripts are executed in the order found. 298 299 Each line is treated as a separate shell command, unless the end of line 300 is escaped with a backslash (`\') in which case that line and the next 301 are combined. If the first characters of the command are any combination 302 of `[1m@[22m', `[1m+[22m', or `[1m-[22m', the command is treated specially. A `[1m@[22m' causes the 303 command not to be echoed before it is executed. A `[1m+[22m' causes the command 304 to be executed even when [1m-n [22mis given. This is similar to the effect of 305 the .MAKE special source, except that the effect can be limited to a sin- 306 gle line of a script. A `[1m-[22m' in compatibility mode causes any non-zero 307 exit status of the command line to be ignored. 308 309 When [1mbmake [22mis run in jobs mode with [1m-j [4m[22mmax_jobs[24m, the entire script for 310 the target is fed to a single instance of the shell. In compatibility 311 (non-jobs) mode, each command is run in a separate process. If the com- 312 mand contains any shell meta characters (`#=|^(){};&<>*?[]:$`\\n') it 313 will be passed to the shell; otherwise [1mbmake [22mwill attempt direct execu- 314 tion. If a line starts with `[1m-[22m' and the shell has ErrCtl enabled then 315 failure of the command line will be ignored as in compatibility mode. 316 Otherwise `[1m-[22m' affects the entire job; the script will stop at the first 317 command line that fails, but the target will not be deemed to have 318 failed. 319 320 Makefiles should be written so that the mode of [1mbmake [22moperation does not 321 change their behavior. For example, any command which needs to use 322 ``cd'' or ``chdir'' without potentially changing the directory for subse- 323 quent commands should be put in parentheses so it executes in a subshell. 324 To force the use of one shell, escape the line breaks so as to make the 325 whole script one command. For example: 326 327 avoid-chdir-side-effects: 328 @echo Building $@ in `pwd` 329 @(cd ${.CURDIR} && ${MAKE} $@) 330 @echo Back in `pwd` 331 332 ensure-one-shell-regardless-of-mode: 333 @echo Building $@ in `pwd`; \ 334 (cd ${.CURDIR} && ${MAKE} $@); \ 335 echo Back in `pwd` 336 337 Since [1mbmake [22mwill chdir(2) to `[4m.OBJDIR[24m' before executing any targets, each 338 child process starts with that as its current working directory. 339 340[1mVARIABLE ASSIGNMENTS[0m 341 Variables in make are much like variables in the shell, and, by tradi- 342 tion, consist of all upper-case letters. 343 344 [1mVariable assignment modifiers[0m 345 The five operators that can be used to assign values to variables are as 346 follows: 347 348 [1m= [22mAssign the value to the variable. Any previous value is overrid- 349 den. 350 351 [1m+= [22mAppend the value to the current value of the variable. 352 353 [1m?= [22mAssign the value to the variable if it is not already defined. 354 355 [1m:= [22mAssign with expansion, i.e. expand the value before assigning it 356 to the variable. Normally, expansion is not done until the vari- 357 able is referenced. [4mNOTE[24m: References to undefined variables are 358 [4mnot[24m expanded. This can cause problems when variable modifiers 359 are used. 360 361 [1m!= [22mExpand the value and pass it to the shell for execution and 362 assign the result to the variable. Any newlines in the result 363 are replaced with spaces. 364 365 Any white-space before the assigned [4mvalue[24m is removed; if the value is 366 being appended, a single space is inserted between the previous contents 367 of the variable and the appended value. 368 369 Variables are expanded by surrounding the variable name with either curly 370 braces (`{}') or parentheses (`()') and preceding it with a dollar sign 371 (`$'). If the variable name contains only a single letter, the surround- 372 ing braces or parentheses are not required. This shorter form is not 373 recommended. 374 375 If the variable name contains a dollar, then the name itself is expanded 376 first. This allows almost arbitrary variable names, however names con- 377 taining dollar, braces, parenthesis, or whitespace are really best 378 avoided! 379 380 If the result of expanding a variable contains a dollar sign (`$') the 381 string is expanded again. 382 383 Variable substitution occurs at three distinct times, depending on where 384 the variable is being used. 385 386 1. Variables in dependency lines are expanded as the line is read. 387 388 2. Variables in shell commands are expanded when the shell command is 389 executed. 390 391 3. ``.for'' loop index variables are expanded on each loop iteration. 392 Note that other variables are not expanded inside loops so the fol- 393 lowing example code: 394 395 396 .for i in 1 2 3 397 a+= ${i} 398 j= ${i} 399 b+= ${j} 400 .endfor 401 402 all: 403 @echo ${a} 404 @echo ${b} 405 406 will print: 407 408 1 2 3 409 3 3 3 410 411 Because while ${a} contains ``1 2 3'' after the loop is executed, 412 ${b} contains ``${j} ${j} ${j}'' which expands to ``3 3 3'' since 413 after the loop completes ${j} contains ``3''. 414 415 [1mVariable classes[0m 416 The four different classes of variables (in order of increasing prece- 417 dence) are: 418 419 Environment variables 420 Variables defined as part of [1mbmake[22m's environment. 421 422 Global variables 423 Variables defined in the makefile or in included makefiles. 424 425 Command line variables 426 Variables defined as part of the command line. 427 428 Local variables 429 Variables that are defined specific to a certain target. 430 431 Local variables are all built in and their values vary magically from 432 target to target. It is not currently possible to define new local vari- 433 ables. The seven local variables are as follows: 434 435 [4m.ALLSRC[24m The list of all sources for this target; also known as 436 `[4m>[24m'. 437 438 [4m.ARCHIVE[24m The name of the archive file; also known as `[4m![24m'. 439 440 [4m.IMPSRC[24m In suffix-transformation rules, the name/path of the 441 source from which the target is to be transformed (the 442 ``implied'' source); also known as `[4m<[24m'. It is not 443 defined in explicit rules. 444 445 [4m.MEMBER[24m The name of the archive member; also known as `[4m%[24m'. 446 447 [4m.OODATE[24m The list of sources for this target that were deemed out- 448 of-date; also known as `[4m?[24m'. 449 450 [4m.PREFIX[24m The file prefix of the target, containing only the file 451 portion, no suffix or preceding directory components; 452 also known as `[4m*[24m'. The suffix must be one of the known 453 suffixes declared with [1m.SUFFIXES [22mor it will not be recog- 454 nized. 455 456 [4m.TARGET[24m The name of the target; also known as `[4m@[24m'. For compati- 457 bility with other makes this is an alias for [1m.ARCHIVE [22min 458 archive member rules. 459 460 The shorter forms (`[4m>[24m', `[4m![24m', `[4m<[24m', `[4m%[24m', `[4m?[24m', `[4m*[24m', and `[4m@[24m') are permitted 461 for backward compatibility with historical makefiles and legacy POSIX 462 make and are not recommended. 463 464 Variants of these variables with the punctuation followed immediately by 465 `D' or `F', e.g. `[4m$(@D)[24m', are legacy forms equivalent to using the `:H' 466 and `:T' modifiers. These forms are accepted for compatibility with AT&T 467 System V UNIX makefiles and POSIX but are not recommended. 468 469 Four of the local variables may be used in sources on dependency lines 470 because they expand to the proper value for each target on the line. 471 These variables are `[4m.TARGET[24m', `[4m.PREFIX[24m', `[4m.ARCHIVE[24m', and `[4m.MEMBER[24m'. 472 473 [1mAdditional built-in variables[0m 474 In addition, [1mbmake [22msets or knows about the following variables: 475 476 [4m$[24m A single dollar sign `$', i.e. `$$' expands to a single 477 dollar sign. 478 479 [4m.ALLTARGETS[24m The list of all targets encountered in the Makefile. If 480 evaluated during Makefile parsing, lists only those tar- 481 gets encountered thus far. 482 483 [4m.CURDIR[24m A path to the directory where [1mbmake [22mwas executed. Refer 484 to the description of `PWD' for more details. 485 486 [4m.INCLUDEDFROMDIR[0m 487 The directory of the file this Makefile was included 488 from. 489 490 [4m.INCLUDEDFROMFILE[0m 491 The filename of the file this Makefile was included from. 492 493 MAKE The name that [1mbmake [22mwas executed with ([4margv[0][24m). For 494 compatibility [1mbmake [22malso sets [4m.MAKE[24m with the same value. 495 The preferred variable to use is the environment variable 496 MAKE because it is more compatible with other versions of 497 [1mbmake [22mand cannot be confused with the special target with 498 the same name. 499 500 [4m.MAKE.DEPENDFILE[0m 501 Names the makefile (default `[4m.depend[24m') from which gener- 502 ated dependencies are read. 503 504 [4m.MAKE.EXPAND_VARIABLES[0m 505 A boolean that controls the default behavior of the [1m-V[0m 506 option. If true, variable values printed with [1m-V [22mare 507 fully expanded; if false, the raw variable contents 508 (which may include additional unexpanded variable refer- 509 ences) are shown. 510 511 [4m.MAKE.EXPORTED[24m The list of variables exported by [1mbmake[22m. 512 513 [4m.MAKE.JOBS[24m The argument to the [1m-j [22moption. 514 515 [4m.MAKE.JOB.PREFIX[0m 516 If [1mbmake [22mis run with [4mj[24m then output for each target is 517 prefixed with a token `--- target ---' the first part of 518 which can be controlled via [4m.MAKE.JOB.PREFIX[24m. If 519 [4m.MAKE.JOB.PREFIX[24m is empty, no token is printed. 520 For example: 521 .MAKE.JOB.PREFIX=${.newline}---${.MAKE:T}[${.MAKE.PID}] 522 would produce tokens like `---make[1234] target ---' mak- 523 ing it easier to track the degree of parallelism being 524 achieved. 525 526 MAKEFLAGS The environment variable `MAKEFLAGS' may contain anything 527 that may be specified on [1mbmake[22m's command line. Anything 528 specified on [1mbmake[22m's command line is appended to the 529 `MAKEFLAGS' variable which is then entered into the envi- 530 ronment for all programs which [1mbmake [22mexecutes. 531 532 [4m.MAKE.LEVEL[24m The recursion depth of [1mbmake[22m. The initial instance of 533 [1mbmake [22mwill be 0, and an incremented value is put into the 534 environment to be seen by the next generation. This 535 allows tests like: .if ${.MAKE.LEVEL} == 0 to protect 536 things which should only be evaluated in the initial 537 instance of [1mbmake[22m. 538 539 [4m.MAKE.MAKEFILE_PREFERENCE[0m 540 The ordered list of makefile names (default `[4mmakefile[24m', 541 `[4mMakefile[24m') that [1mbmake [22mwill look for. 542 543 [4m.MAKE.MAKEFILES[0m 544 The list of makefiles read by [1mbmake[22m, which is useful for 545 tracking dependencies. Each makefile is recorded only 546 once, regardless of the number of times read. 547 548 [4m.MAKE.MODE[24m Processed after reading all makefiles. Can affect the 549 mode that [1mbmake [22mruns in. It can contain a number of key- 550 words: 551 552 [4mcompat[24m Like [1m-B[22m, puts [1mbmake [22minto "compat" 553 mode. 554 555 [4mmeta[24m Puts [1mbmake [22minto "meta" mode, where 556 meta files are created for each tar- 557 get to capture the command run, the 558 output generated and if filemon(4) 559 is available, the system calls which 560 are of interest to [1mbmake[22m. The cap- 561 tured output can be very useful when 562 diagnosing errors. 563 564 [4mcurdirOk=[24m [4mbf[24m Normally [1mbmake [22mwill not create .meta 565 files in `[4m.CURDIR[24m'. This can be 566 overridden by setting [4mbf[24m to a value 567 which represents True. 568 569 [4mmissing-meta=[24m [4mbf[24m If [4mbf[24m is True, then a missing .meta 570 file makes the target out-of-date. 571 572 [4mmissing-filemon=[24m [4mbf[24m If [4mbf[24m is True, then missing filemon 573 data makes the target out-of-date. 574 575 [4mnofilemon[24m Do not use filemon(4). 576 577 [4menv[24m For debugging, it can be useful to 578 include the environment in the .meta 579 file. 580 581 [4mverbose[24m If in "meta" mode, print a clue 582 about the target being built. This 583 is useful if the build is otherwise 584 running silently. The message 585 printed the value of: 586 [4m.MAKE.META.PREFIX[24m. 587 588 [4mignore-cmd[24m Some makefiles have commands which 589 are simply not stable. This keyword 590 causes them to be ignored for deter- 591 mining whether a target is out of 592 date in "meta" mode. See also 593 [1m.NOMETA_CMP[22m. 594 595 [4msilent=[24m [4mbf[24m If [4mbf[24m is True, when a .meta file is 596 created, mark the target [1m.SILENT[22m. 597 598 [4m.MAKE.META.BAILIWICK[0m 599 In "meta" mode, provides a list of prefixes which match 600 the directories controlled by [1mbmake[22m. If a file that was 601 generated outside of [4m.OBJDIR[24m but within said bailiwick is 602 missing, the current target is considered out-of-date. 603 604 [4m.MAKE.META.CREATED[0m 605 In "meta" mode, this variable contains a list of all the 606 meta files updated. If not empty, it can be used to 607 trigger processing of [4m.MAKE.META.FILES[24m. 608 609 [4m.MAKE.META.FILES[0m 610 In "meta" mode, this variable contains a list of all the 611 meta files used (updated or not). This list can be used 612 to process the meta files to extract dependency informa- 613 tion. 614 615 [4m.MAKE.META.IGNORE_PATHS[0m 616 Provides a list of path prefixes that should be ignored; 617 because the contents are expected to change over time. 618 The default list includes: `[4m/dev[24m [4m/etc[24m [4m/proc[24m [4m/tmp[24m [4m/var/run[0m 619 [4m/var/tmp[24m' 620 621 [4m.MAKE.META.IGNORE_PATTERNS[0m 622 Provides a list of patterns to match against pathnames. 623 Ignore any that match. 624 625 [4m.MAKE.META.IGNORE_FILTER[0m 626 Provides a list of variable modifiers to apply to each 627 pathname. Ignore if the expansion is an empty string. 628 629 [4m.MAKE.META.PREFIX[0m 630 Defines the message printed for each meta file updated in 631 "meta verbose" mode. The default value is: 632 Building ${.TARGET:H:tA}/${.TARGET:T} 633 634 [4m.MAKEOVERRIDES[24m This variable is used to record the names of variables 635 assigned to on the command line, so that they may be 636 exported as part of `MAKEFLAGS'. This behavior can be 637 disabled by assigning an empty value to `[4m.MAKEOVERRIDES[24m' 638 within a makefile. Extra variables can be exported from 639 a makefile by appending their names to `[4m.MAKEOVERRIDES[24m'. 640 `MAKEFLAGS' is re-exported whenever `[4m.MAKEOVERRIDES[24m' is 641 modified. 642 643 [4m.MAKE.PATH_FILEMON[0m 644 If [1mbmake [22mwas built with filemon(4) support, this is set 645 to the path of the device node. This allows makefiles to 646 test for this support. 647 648 [4m.MAKE.PID[24m The process-id of [1mbmake[22m. 649 650 [4m.MAKE.PPID[24m The parent process-id of [1mbmake[22m. 651 652 [4m.MAKE.SAVE_DOLLARS[0m 653 value should be a boolean that controls whether `$$' are 654 preserved when doing `:=' assignments. The default is 655 false, for backwards compatibility. Set to true for com- 656 patability with other makes. If set to false, `$$' 657 becomes `$' per normal evaluation rules. 658 659 [4mMAKE_PRINT_VAR_ON_ERROR[0m 660 When [1mbmake [22mstops due to an error, it sets `[4m.ERROR_TARGET[24m' 661 to the name of the target that failed, `[4m.ERROR_CMD[24m' to 662 the commands of the failed target, and in "meta" mode, it 663 also sets `[4m.ERROR_CWD[24m' to the getcwd(3), and 664 `[4m.ERROR_META_FILE[24m' to the path of the meta file (if any) 665 describing the failed target. It then prints its name 666 and the value of `[4m.CURDIR[24m' as well as the value of any 667 variables named in `[4mMAKE_PRINT_VAR_ON_ERROR[24m'. 668 669 [4m.newline[24m This variable is simply assigned a newline character as 670 its value. This allows expansions using the [1m:@ [22mmodifier 671 to put a newline between iterations of the loop rather 672 than a space. For example, the printing of 673 `[4mMAKE_PRINT_VAR_ON_ERROR[24m' could be done as 674 ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}. 675 676 [4m.OBJDIR[24m A path to the directory where the targets are built. Its 677 value is determined by trying to chdir(2) to the follow- 678 ing directories in order and using the first match: 679 680 1. ${MAKEOBJDIRPREFIX}${.CURDIR} 681 682 (Only if `MAKEOBJDIRPREFIX' is set in the environ- 683 ment or on the command line.) 684 685 2. ${MAKEOBJDIR} 686 687 (Only if `MAKEOBJDIR' is set in the environment or 688 on the command line.) 689 690 3. ${.CURDIR}[4m/obj.[24m${MACHINE} 691 692 4. ${.CURDIR}[4m/obj[0m 693 694 5. [4m/usr/obj/[24m${.CURDIR} 695 696 6. ${.CURDIR} 697 698 Variable expansion is performed on the value before it's 699 used, so expressions such as 700 ${.CURDIR:S,^/usr/src,/var/obj,} 701 may be used. This is especially useful with 702 `MAKEOBJDIR'. 703 704 `[4m.OBJDIR[24m' may be modified in the makefile via the special 705 target `[1m.OBJDIR[22m'. In all cases, [1mbmake [22mwill chdir(2) to 706 the specified directory if it exists, and set `[4m.OBJDIR[24m' 707 and `PWD' to that directory before executing any targets. 708 709 [4m.PARSEDIR[24m A path to the directory of the current `[4mMakefile[24m' being 710 parsed. 711 712 [4m.PARSEFILE[24m The basename of the current `[4mMakefile[24m' being parsed. 713 This variable and `[4m.PARSEDIR[24m' are both set only while the 714 `[4mMakefiles[24m' are being parsed. If you want to retain 715 their current values, assign them to a variable using 716 assignment with expansion: (`[1m:=[22m'). 717 718 [4m.PATH[24m A variable that represents the list of directories that 719 [1mbmake [22mwill search for files. The search list should be 720 updated using the target `[4m.PATH[24m' rather than the vari- 721 able. 722 723 PWD Alternate path to the current directory. [1mbmake [22mnormally 724 sets `[4m.CURDIR[24m' to the canonical path given by getcwd(3). 725 However, if the environment variable `PWD' is set and 726 gives a path to the current directory, then [1mbmake [22msets 727 `[4m.CURDIR[24m' to the value of `PWD' instead. This behavior 728 is disabled if `MAKEOBJDIRPREFIX' is set or `MAKEOBJDIR' 729 contains a variable transform. `PWD' is set to the value 730 of `[4m.OBJDIR[24m' for all programs which [1mbmake [22mexecutes. 731 732 .TARGETS The list of targets explicitly specified on the command 733 line, if any. 734 735 VPATH Colon-separated (``:'') lists of directories that [1mbmake[0m 736 will search for files. The variable is supported for 737 compatibility with old make programs only, use `[4m.PATH[24m' 738 instead. 739 740 [1mVariable modifiers[0m 741 Variable expansion may be modified to select or modify each word of the 742 variable (where a ``word'' is white-space delimited sequence of charac- 743 ters). The general format of a variable expansion is as follows: 744 745 ${variable[:modifier[:...]]} 746 747 Each modifier begins with a colon, which may be escaped with a backslash 748 (`\'). 749 750 A set of modifiers can be specified via a variable, as follows: 751 752 modifier_variable=modifier[:...] 753 ${variable:${modifier_variable}[:...]} 754 755 In this case the first modifier in the modifier_variable does not start 756 with a colon, since that must appear in the referencing variable. If any 757 of the modifiers in the modifier_variable contain a dollar sign (`$'), 758 these must be doubled to avoid early expansion. 759 760 The supported modifiers are: 761 762 [1m:E [22mReplaces each word in the variable with its suffix. 763 764 [1m:H [22mReplaces each word in the variable with everything but the last com- 765 ponent. 766 767 [1m:M[4m[22mpattern[0m 768 Select only those words that match [4mpattern[24m. The standard shell 769 wildcard characters (`*', `?', and `[]') may be used. The wildcard 770 characters may be escaped with a backslash (`\'). As a consequence 771 of the way values are split into words, matched, and then joined, a 772 construct like 773 ${VAR:M*} 774 will normalize the inter-word spacing, removing all leading and 775 trailing space, and converting multiple consecutive spaces to single 776 spaces. 777 778 [1m:N[4m[22mpattern[0m 779 This is identical to `[1m:M[22m', but selects all words which do not match 780 [4mpattern[24m. 781 782 [1m:O [22mOrder every word in variable alphabetically. 783 784 [1m:Or [22mOrder every word in variable in reverse alphabetical order. 785 786 [1m:Ox [22mRandomize words in variable. The results will be different each 787 time you are referring to the modified variable; use the assignment 788 with expansion (`[1m:=[22m') to prevent such behavior. For example, 789 790 LIST= uno due tre quattro 791 RANDOM_LIST= ${LIST:Ox} 792 STATIC_RANDOM_LIST:= ${LIST:Ox} 793 794 all: 795 @echo "${RANDOM_LIST}" 796 @echo "${RANDOM_LIST}" 797 @echo "${STATIC_RANDOM_LIST}" 798 @echo "${STATIC_RANDOM_LIST}" 799 may produce output similar to: 800 801 quattro due tre uno 802 tre due quattro uno 803 due uno quattro tre 804 due uno quattro tre 805 806 [1m:Q [22mQuotes every shell meta-character in the variable, so that it can be 807 passed safely to the shell. 808 809 [1m:q [22mQuotes every shell meta-character in the variable, and also doubles 810 `$' characters so that it can be passed safely through recursive 811 invocations of [1mbmake[22m. This is equivalent to: `:S/\$/&&/g:Q'. 812 813 [1m:R [22mReplaces each word in the variable with everything but its suffix. 814 815 [1m:range[=count][0m 816 The value is an integer sequence representing the words of the orig- 817 inal value, or the supplied [4mcount[24m. 818 819 [1m:gmtime[=utc][0m 820 The value is a format string for strftime(3), using gmtime(3). If a 821 [4mutc[24m value is not provided or is 0, the current time is used. 822 823 [1m:hash[0m 824 Compute a 32-bit hash of the value and encode it as hex digits. 825 826 [1m:localtime[=utc][0m 827 The value is a format string for strftime(3), using localtime(3). 828 If a [4mutc[24m value is not provided or is 0, the current time is used. 829 830 [1m:tA [22mAttempt to convert variable to an absolute path using realpath(3), 831 if that fails, the value is unchanged. 832 833 [1m:tl [22mConverts variable to lower-case letters. 834 835 [1m:ts[4m[22mc[0m 836 Words in the variable are normally separated by a space on expan- 837 sion. This modifier sets the separator to the character [4mc[24m. If [4mc[24m is 838 omitted, then no separator is used. The common escapes (including 839 octal numeric codes), work as expected. 840 841 [1m:tu [22mConverts variable to upper-case letters. 842 843 [1m:tW [22mCauses the value to be treated as a single word (possibly containing 844 embedded white space). See also `[1m:[*][22m'. 845 846 [1m:tw [22mCauses the value to be treated as a sequence of words delimited by 847 white space. See also `[1m:[@][22m'. 848 849 [1m:S[22m/[4mold_string[24m/[4mnew_string[24m/[[1m1gW[22m] 850 Modify the first occurrence of [4mold_string[24m in the variable's value, 851 replacing it with [4mnew_string[24m. If a `g' is appended to the last 852 slash of the pattern, all occurrences in each word are replaced. If 853 a `1' is appended to the last slash of the pattern, only the first 854 word is affected. If a `W' is appended to the last slash of the 855 pattern, then the value is treated as a single word (possibly con- 856 taining embedded white space). If [4mold_string[24m begins with a caret 857 (`^'), [4mold_string[24m is anchored at the beginning of each word. If 858 [4mold_string[24m ends with a dollar sign (`$'), it is anchored at the end 859 of each word. Inside [4mnew_string[24m, an ampersand (`&') is replaced by 860 [4mold_string[24m (without any `^' or `$'). Any character may be used as a 861 delimiter for the parts of the modifier string. The anchoring, 862 ampersand and delimiter characters may be escaped with a backslash 863 (`\'). 864 865 Variable expansion occurs in the normal fashion inside both 866 [4mold_string[24m and [4mnew_string[24m with the single exception that a backslash 867 is used to prevent the expansion of a dollar sign (`$'), not a pre- 868 ceding dollar sign as is usual. 869 870 [1m:C[22m/[4mpattern[24m/[4mreplacement[24m/[[1m1gW[22m] 871 The [1m:C [22mmodifier is just like the [1m:S [22mmodifier except that the old and 872 new strings, instead of being simple strings, are an extended regu- 873 lar expression (see regex(3)) string [4mpattern[24m and an ed(1)-style 874 string [4mreplacement[24m. Normally, the first occurrence of the pattern 875 [4mpattern[24m in each word of the value is substituted with [4mreplacement[24m. 876 The `1' modifier causes the substitution to apply to at most one 877 word; the `g' modifier causes the substitution to apply to as many 878 instances of the search pattern [4mpattern[24m as occur in the word or 879 words it is found in; the `W' modifier causes the value to be 880 treated as a single word (possibly containing embedded white space). 881 Note that `1' and `g' are orthogonal; the former specifies whether 882 multiple words are potentially affected, the latter whether multiple 883 substitutions can potentially occur within each affected word. 884 885 As for the [1m:S [22mmodifier, the [4mpattern[24m and [4mreplacement[24m are subjected to 886 variable expansion before being parsed as regular expressions. 887 888 [1m:T [22mReplaces each word in the variable with its last component. 889 890 [1m:u [22mRemove adjacent duplicate words (like uniq(1)). 891 892 [1m:?[4m[22mtrue_string[24m[1m:[4m[22mfalse_string[0m 893 If the variable name (not its value), when parsed as a .if condi- 894 tional expression, evaluates to true, return as its value the 895 [4mtrue_string[24m, otherwise return the [4mfalse_string[24m. Since the variable 896 name is used as the expression, :? must be the first modifier after 897 the variable name itself - which will, of course, usually contain 898 variable expansions. A common error is trying to use expressions 899 like 900 ${NUMBERS:M42:?match:no} 901 which actually tests defined(NUMBERS), to determine is any words 902 match "42" you need to use something like: 903 ${"${NUMBERS:M42}" != "":?match:no}. 904 905 [4m:old_string=new_string[0m 906 This is the AT&T System V UNIX style variable substitution. It must 907 be the last modifier specified. If [4mold_string[24m or [4mnew_string[24m do not 908 contain the pattern matching character [4m%[24m then it is assumed that 909 they are anchored at the end of each word, so only suffixes or 910 entire words may be replaced. Otherwise [4m%[24m is the substring of 911 [4mold_string[24m to be replaced in [4mnew_string[24m. If only [4mold_string[24m con- 912 tains the pattern matching character [4m%[24m, and [4mold_string[24m matches, then 913 the result is the [4mnew_string[24m. If only the [4mnew_string[24m contains the 914 pattern matching character [4m%[24m, then it is not treated specially and 915 it is printed as a literal [4m%[24m on match. If there is more than one 916 pattern matching character ([4m%[24m) in either the [4mnew_string[24m or 917 [4mold_string[24m, only the first instance is treated specially (as the 918 pattern character); all subsequent instances are treated as regular 919 characters 920 921 Variable expansion occurs in the normal fashion inside both 922 [4mold_string[24m and [4mnew_string[24m with the single exception that a backslash 923 is used to prevent the expansion of a dollar sign (`$'), not a pre- 924 ceding dollar sign as is usual. 925 926 [1m:@[4m[22mtemp[24m[1m@[4m[22mstring[24m[1m@[0m 927 This is the loop expansion mechanism from the OSF Development Envi- 928 ronment (ODE) make. Unlike [1m.for [22mloops expansion occurs at the time 929 of reference. Assign [4mtemp[24m to each word in the variable and evaluate 930 [4mstring[24m. The ODE convention is that [4mtemp[24m should start and end with a 931 period. For example. 932 ${LINKS:@.LINK.@${LN} ${TARGET} ${.LINK.}@} 933 934 However a single character variable is often more readable: 935 ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@} 936 937 [1m:_[=var][0m 938 Save the current variable value in `$_' or the named [4mvar[24m for later 939 reference. Example usage: 940 941 M_cmpv.units = 1 1000 1000000 942 M_cmpv = S,., ,g:_:range:@i@+ $${_:[-$$i]} \ 943 \* $${M_cmpv.units:[$$i]}@:S,^,expr 0 ,1:sh 944 945 .if ${VERSION:${M_cmpv}} < ${3.1.12:L:${M_cmpv}} 946 947 Here `$_' is used to save the result of the `:S' modifier which is 948 later referenced using the index values from `:range'. 949 950 [1m:U[4m[22mnewval[0m 951 If the variable is undefined [4mnewval[24m is the value. If the variable 952 is defined, the existing value is returned. This is another ODE 953 make feature. It is handy for setting per-target CFLAGS for 954 instance: 955 ${_${.TARGET:T}_CFLAGS:U${DEF_CFLAGS}} 956 If a value is only required if the variable is undefined, use: 957 ${VAR:D:Unewval} 958 959 [1m:D[4m[22mnewval[0m 960 If the variable is defined [4mnewval[24m is the value. 961 962 [1m:L [22mThe name of the variable is the value. 963 964 [1m:P [22mThe path of the node which has the same name as the variable is the 965 value. If no such node exists or its path is null, then the name of 966 the variable is used. In order for this modifier to work, the name 967 (node) must at least have appeared on the rhs of a dependency. 968 969 [1m:![4m[22mcmd[24m[1m![0m 970 The output of running [4mcmd[24m is the value. 971 972 [1m:sh [22mIf the variable is non-empty it is run as a command and the output 973 becomes the new value. 974 975 [1m::=[4m[22mstr[0m 976 The variable is assigned the value [4mstr[24m after substitution. This 977 modifier and its variations are useful in obscure situations such as 978 wanting to set a variable when shell commands are being parsed. 979 These assignment modifiers always expand to nothing, so if appearing 980 in a rule line by themselves should be preceded with something to 981 keep [1mbmake [22mhappy. 982 983 The `[1m::[22m' helps avoid false matches with the AT&T System V UNIX style 984 [1m:= [22mmodifier and since substitution always occurs the [1m::= [22mform is 985 vaguely appropriate. 986 987 [1m::?=[4m[22mstr[0m 988 As for [1m::= [22mbut only if the variable does not already have a value. 989 990 [1m::+=[4m[22mstr[0m 991 Append [4mstr[24m to the variable. 992 993 [1m::!=[4m[22mcmd[0m 994 Assign the output of [4mcmd[24m to the variable. 995 996 [1m:[[4m[22mrange[24m[1m][0m 997 Selects one or more words from the value, or performs other opera- 998 tions related to the way in which the value is divided into words. 999 1000 Ordinarily, a value is treated as a sequence of words delimited by 1001 white space. Some modifiers suppress this behavior, causing a value 1002 to be treated as a single word (possibly containing embedded white 1003 space). An empty value, or a value that consists entirely of white- 1004 space, is treated as a single word. For the purposes of the `[1m:[][22m' 1005 modifier, the words are indexed both forwards using positive inte- 1006 gers (where index 1 represents the first word), and backwards using 1007 negative integers (where index -1 represents the last word). 1008 1009 The [4mrange[24m is subjected to variable expansion, and the expanded 1010 result is then interpreted as follows: 1011 1012 [4mindex[24m Selects a single word from the value. 1013 1014 [4mstart[24m[1m..[4m[22mend[0m 1015 Selects all words from [4mstart[24m to [4mend[24m, inclusive. For example, 1016 `[1m:[2..-1][22m' selects all words from the second word to the last 1017 word. If [4mstart[24m is greater than [4mend[24m, then the words are out- 1018 put in reverse order. For example, `[1m:[-1..1][22m' selects all 1019 the words from last to first. If the list is already 1020 ordered, then this effectively reverses the list, but it is 1021 more efficient to use `[1m:Or[22m' instead of `[1m:O:[-1..1][22m'. 1022 1023 [1m* [22mCauses subsequent modifiers to treat the value as a single 1024 word (possibly containing embedded white space). Analogous 1025 to the effect of "$*" in Bourne shell. 1026 1027 0 Means the same as `[1m:[*][22m'. 1028 1029 [1m@ [22mCauses subsequent modifiers to treat the value as a sequence 1030 of words delimited by white space. Analogous to the effect 1031 of "$@" in Bourne shell. 1032 1033 [1m# [22mReturns the number of words in the value. 1034 1035[1mINCLUDE STATEMENTS, CONDITIONALS AND FOR LOOPS[0m 1036 Makefile inclusion, conditional structures and for loops reminiscent of 1037 the C programming language are provided in [1mbmake[22m. All such structures 1038 are identified by a line beginning with a single dot (`.') character. 1039 Files are included with either [1m.include <[4m[22mfile[24m[1m> [22mor [1m.include "[4m[22mfile[24m[1m"[22m. Vari- 1040 ables between the angle brackets or double quotes are expanded to form 1041 the file name. If angle brackets are used, the included makefile is 1042 expected to be in the system makefile directory. If double quotes are 1043 used, the including makefile's directory and any directories specified 1044 using the [1m-I [22moption are searched before the system makefile directory. 1045 For compatibility with other versions of [1mbmake [22m`include file ...' is also 1046 accepted. 1047 1048 If the include statement is written as [1m.-include [22mor as [1m.sinclude [22mthen 1049 errors locating and/or opening include files are ignored. 1050 1051 If the include statement is written as [1m.dinclude [22mnot only are errors 1052 locating and/or opening include files ignored, but stale dependencies 1053 within the included file will be ignored just like [4m.MAKE.DEPENDFILE[24m. 1054 1055 Conditional expressions are also preceded by a single dot as the first 1056 character of a line. The possible conditionals are as follows: 1057 1058 [1m.error [4m[22mmessage[0m 1059 The message is printed along with the name of the makefile and 1060 line number, then [1mbmake [22mwill exit. 1061 1062 [1m.export [4m[22mvariable[24m [4m...[0m 1063 Export the specified global variable. If no variable list is 1064 provided, all globals are exported except for internal variables 1065 (those that start with `.'). This is not affected by the [1m-X[0m 1066 flag, so should be used with caution. For compatibility with 1067 other [1mbmake [22mprograms `export variable=value' is also accepted. 1068 1069 Appending a variable name to [4m.MAKE.EXPORTED[24m is equivalent to 1070 exporting a variable. 1071 1072 [1m.export-env [4m[22mvariable[24m [4m...[0m 1073 The same as `.export', except that the variable is not appended 1074 to [4m.MAKE.EXPORTED[24m. This allows exporting a value to the environ- 1075 ment which is different from that used by [1mbmake [22minternally. 1076 1077 [1m.export-literal [4m[22mvariable[24m [4m...[0m 1078 The same as `.export-env', except that variables in the value are 1079 not expanded. 1080 1081 [1m.info [4m[22mmessage[0m 1082 The message is printed along with the name of the makefile and 1083 line number. 1084 1085 [1m.undef [4m[22mvariable[0m 1086 Un-define the specified global variable. Only global variables 1087 may be un-defined. 1088 1089 [1m.unexport [4m[22mvariable[24m [4m...[0m 1090 The opposite of `.export'. The specified global [4mvariable[24m will be 1091 removed from [4m.MAKE.EXPORTED[24m. If no variable list is provided, 1092 all globals are unexported, and [4m.MAKE.EXPORTED[24m deleted. 1093 1094 [1m.unexport-env[0m 1095 Unexport all globals previously exported and clear the environ- 1096 ment inherited from the parent. This operation will cause a mem- 1097 ory leak of the original environment, so should be used spar- 1098 ingly. Testing for [4m.MAKE.LEVEL[24m being 0, would make sense. Also 1099 note that any variables which originated in the parent environ- 1100 ment should be explicitly preserved if desired. For example: 1101 1102 .if ${.MAKE.LEVEL} == 0 1103 PATH := ${PATH} 1104 .unexport-env 1105 .export PATH 1106 .endif 1107 1108 Would result in an environment containing only `PATH', which is 1109 the minimal useful environment. Actually `.MAKE.LEVEL' will also 1110 be pushed into the new environment. 1111 1112 [1m.warning [4m[22mmessage[0m 1113 The message prefixed by `[4mwarning:[24m' is printed along with the name 1114 of the makefile and line number. 1115 1116 [1m.if [22m[!][4mexpression[24m [[4moperator[24m [4mexpression[24m [4m...[24m] 1117 Test the value of an expression. 1118 1119 [1m.ifdef [22m[!][4mvariable[24m [[4moperator[24m [4mvariable[24m [4m...[24m] 1120 Test the value of a variable. 1121 1122 [1m.ifndef [22m[!][4mvariable[24m [[4moperator[24m [4mvariable[24m [4m...[24m] 1123 Test the value of a variable. 1124 1125 [1m.ifmake [22m[!][4mtarget[24m [[4moperator[24m [4mtarget[24m [4m...[24m] 1126 Test the target being built. 1127 1128 [1m.ifnmake [22m[!] [4mtarget[24m [[4moperator[24m [4mtarget[24m [4m...[24m] 1129 Test the target being built. 1130 1131 [1m.else [22mReverse the sense of the last conditional. 1132 1133 [1m.elif [22m[!] [4mexpression[24m [[4moperator[24m [4mexpression[24m [4m...[24m] 1134 A combination of `[1m.else[22m' followed by `[1m.if[22m'. 1135 1136 [1m.elifdef [22m[!][4mvariable[24m [[4moperator[24m [4mvariable[24m [4m...[24m] 1137 A combination of `[1m.else[22m' followed by `[1m.ifdef[22m'. 1138 1139 [1m.elifndef [22m[!][4mvariable[24m [[4moperator[24m [4mvariable[24m [4m...[24m] 1140 A combination of `[1m.else[22m' followed by `[1m.ifndef[22m'. 1141 1142 [1m.elifmake [22m[!][4mtarget[24m [[4moperator[24m [4mtarget[24m [4m...[24m] 1143 A combination of `[1m.else[22m' followed by `[1m.ifmake[22m'. 1144 1145 [1m.elifnmake [22m[!][4mtarget[24m [[4moperator[24m [4mtarget[24m [4m...[24m] 1146 A combination of `[1m.else[22m' followed by `[1m.ifnmake[22m'. 1147 1148 [1m.endif [22mEnd the body of the conditional. 1149 1150 The [4moperator[24m may be any one of the following: 1151 1152 [1m|| [22mLogical OR. 1153 1154 [1m&& [22mLogical AND; of higher precedence than ``||''. 1155 1156 As in C, [1mbmake [22mwill only evaluate a conditional as far as is necessary to 1157 determine its value. Parentheses may be used to change the order of 1158 evaluation. The boolean operator `[1m![22m' may be used to logically negate an 1159 entire conditional. It is of higher precedence than `[1m&&[22m'. 1160 1161 The value of [4mexpression[24m may be any of the following: 1162 1163 [1mdefined [22mTakes a variable name as an argument and evaluates to true if 1164 the variable has been defined. 1165 1166 [1mmake [22mTakes a target name as an argument and evaluates to true if the 1167 target was specified as part of [1mbmake[22m's command line or was 1168 declared the default target (either implicitly or explicitly, 1169 see [4m.MAIN[24m) before the line containing the conditional. 1170 1171 [1mempty [22mTakes a variable, with possible modifiers, and evaluates to true 1172 if the expansion of the variable would result in an empty 1173 string. 1174 1175 [1mexists [22mTakes a file name as an argument and evaluates to true if the 1176 file exists. The file is searched for on the system search path 1177 (see [4m.PATH[24m). 1178 1179 [1mtarget [22mTakes a target name as an argument and evaluates to true if the 1180 target has been defined. 1181 1182 [1mcommands[0m 1183 Takes a target name as an argument and evaluates to true if the 1184 target has been defined and has commands associated with it. 1185 1186 [4mExpression[24m may also be an arithmetic or string comparison. Variable 1187 expansion is performed on both sides of the comparison, after which the 1188 integral values are compared. A value is interpreted as hexadecimal if 1189 it is preceded by 0x, otherwise it is decimal; octal numbers are not sup- 1190 ported. The standard C relational operators are all supported. If after 1191 variable expansion, either the left or right hand side of a `[1m==[22m' or `[1m!=[22m' 1192 operator is not an integral value, then string comparison is performed 1193 between the expanded variables. If no relational operator is given, it 1194 is assumed that the expanded variable is being compared against 0 or an 1195 empty string in the case of a string comparison. 1196 1197 When [1mbmake [22mis evaluating one of these conditional expressions, and it 1198 encounters a (white-space separated) word it doesn't recognize, either 1199 the ``make'' or ``defined'' expression is applied to it, depending on the 1200 form of the conditional. If the form is `[1m.ifdef[22m', `[1m.ifndef[22m', or `[1m.if[22m' 1201 the ``defined'' expression is applied. Similarly, if the form is 1202 `[1m.ifmake[22m' or `[1m.ifnmake[22m', the ``make'' expression is applied. 1203 1204 If the conditional evaluates to true the parsing of the makefile contin- 1205 ues as before. If it evaluates to false, the following lines are 1206 skipped. In both cases this continues until a `[1m.else[22m' or `[1m.endif[22m' is 1207 found. 1208 1209 For loops are typically used to apply a set of rules to a list of files. 1210 The syntax of a for loop is: 1211 1212 [1m.for [4m[22mvariable[24m [[4mvariable[24m [4m...[24m] [1min [4m[22mexpression[0m 1213 <make-rules> 1214 [1m.endfor[0m 1215 1216 After the for [1mexpression [22mis evaluated, it is split into words. On each 1217 iteration of the loop, one word is taken and assigned to each [1mvariable[22m, 1218 in order, and these [1mvariables [22mare substituted into the [1mmake-rules [22minside 1219 the body of the for loop. The number of words must come out even; that 1220 is, if there are three iteration variables, the number of words provided 1221 must be a multiple of three. 1222 1223[1mCOMMENTS[0m 1224 Comments begin with a hash (`#') character, anywhere but in a shell com- 1225 mand line, and continue to the end of an unescaped new line. 1226 1227[1mSPECIAL SOURCES (ATTRIBUTES)[0m 1228 [1m.EXEC [22mTarget is never out of date, but always execute commands any- 1229 way. 1230 1231 [1m.IGNORE [22mIgnore any errors from the commands associated with this tar- 1232 get, exactly as if they all were preceded by a dash (`-'). 1233 1234 [1m.MADE [22mMark all sources of this target as being up-to-date. 1235 1236 [1m.MAKE [22mExecute the commands associated with this target even if the [1m-n[0m 1237 or [1m-t [22moptions were specified. Normally used to mark recursive 1238 [1mbmake[22ms. 1239 1240 [1m.META [22mCreate a meta file for the target, even if it is flagged as 1241 [1m.PHONY[22m, [1m.MAKE[22m, or [1m.SPECIAL[22m. Usage in conjunction with [1m.MAKE [22mis 1242 the most likely case. In "meta" mode, the target is out-of- 1243 date if the meta file is missing. 1244 1245 [1m.NOMETA [22mDo not create a meta file for the target. Meta files are also 1246 not created for [1m.PHONY[22m, [1m.MAKE[22m, or [1m.SPECIAL [22mtargets. 1247 1248 [1m.NOMETA_CMP[0m 1249 Ignore differences in commands when deciding if target is out 1250 of date. This is useful if the command contains a value which 1251 always changes. If the number of commands change, though, the 1252 target will still be out of date. The same effect applies to 1253 any command line that uses the variable [4m.OODATE[24m, which can be 1254 used for that purpose even when not otherwise needed or 1255 desired: 1256 1257 1258 skip-compare-for-some: 1259 @echo this will be compared 1260 @echo this will not ${.OODATE:M.NOMETA_CMP} 1261 @echo this will also be compared 1262 1263 The [1m:M [22mpattern suppresses any expansion of the unwanted vari- 1264 able. 1265 1266 [1m.NOPATH [22mDo not search for the target in the directories specified by 1267 [1m.PATH[22m. 1268 1269 [1m.NOTMAIN [22mNormally [1mbmake [22mselects the first target it encounters as the 1270 default target to be built if no target was specified. This 1271 source prevents this target from being selected. 1272 1273 [1m.OPTIONAL[0m 1274 If a target is marked with this attribute and [1mbmake [22mcan't fig- 1275 ure out how to create it, it will ignore this fact and assume 1276 the file isn't needed or already exists. 1277 1278 [1m.PHONY [22mThe target does not correspond to an actual file; it is always 1279 considered to be out of date, and will not be created with the 1280 [1m-t [22moption. Suffix-transformation rules are not applied to 1281 [1m.PHONY [22mtargets. 1282 1283 [1m.PRECIOUS[0m 1284 When [1mbmake [22mis interrupted, it normally removes any partially 1285 made targets. This source prevents the target from being 1286 removed. 1287 1288 [1m.RECURSIVE[0m 1289 Synonym for [1m.MAKE[22m. 1290 1291 [1m.SILENT [22mDo not echo any of the commands associated with this target, 1292 exactly as if they all were preceded by an at sign (`@'). 1293 1294 [1m.USE [22mTurn the target into [1mbmake[22m's version of a macro. When the tar- 1295 get is used as a source for another target, the other target 1296 acquires the commands, sources, and attributes (except for 1297 [1m.USE[22m) of the source. If the target already has commands, the 1298 [1m.USE [22mtarget's commands are appended to them. 1299 1300 [1m.USEBEFORE[0m 1301 Exactly like [1m.USE[22m, but prepend the [1m.USEBEFORE [22mtarget commands 1302 to the target. 1303 1304 [1m.WAIT [22mIf [1m.WAIT [22mappears in a dependency line, the sources that precede 1305 it are made before the sources that succeed it in the line. 1306 Since the dependents of files are not made until the file 1307 itself could be made, this also stops the dependents being 1308 built unless they are needed for another branch of the depen- 1309 dency tree. So given: 1310 1311 x: a .WAIT b 1312 echo x 1313 a: 1314 echo a 1315 b: b1 1316 echo b 1317 b1: 1318 echo b1 1319 1320 the output is always `a', `b1', `b', `x'. 1321 The ordering imposed by [1m.WAIT [22mis only relevant for parallel 1322 makes. 1323 1324[1mSPECIAL TARGETS[0m 1325 Special targets may not be included with other targets, i.e. they must be 1326 the only target specified. 1327 1328 [1m.BEGIN [22mAny command lines attached to this target are executed before 1329 anything else is done. 1330 1331 [1m.DEFAULT[0m 1332 This is sort of a [1m.USE [22mrule for any target (that was used only 1333 as a source) that [1mbmake [22mcan't figure out any other way to cre- 1334 ate. Only the shell script is used. The [1m.IMPSRC [22mvariable of a 1335 target that inherits [1m.DEFAULT[22m's commands is set to the target's 1336 own name. 1337 1338 [1m.DELETE_ON_ERROR[0m 1339 If this target is present in the makefile, it globally causes 1340 make to delete targets whose commands fail. (By default, only 1341 targets whose commands are interrupted during execution are 1342 deleted. This is the historical behavior.) This setting can be 1343 used to help prevent half-finished or malformed targets from 1344 being left around and corrupting future rebuilds. 1345 1346 [1m.END [22mAny command lines attached to this target are executed after 1347 everything else is done. 1348 1349 [1m.ERROR [22mAny command lines attached to this target are executed when 1350 another target fails. The [1m.ERROR_TARGET [22mvariable is set to the 1351 target that failed. See also [1mMAKE_PRINT_VAR_ON_ERROR[22m. 1352 1353 [1m.IGNORE [22mMark each of the sources with the [1m.IGNORE [22mattribute. If no 1354 sources are specified, this is the equivalent of specifying the 1355 [1m-i [22moption. 1356 1357 [1m.INTERRUPT[0m 1358 If [1mbmake [22mis interrupted, the commands for this target will be 1359 executed. 1360 1361 [1m.MAIN [22mIf no target is specified when [1mbmake [22mis invoked, this target 1362 will be built. 1363 1364 [1m.MAKEFLAGS[0m 1365 This target provides a way to specify flags for [1mbmake [22mwhen the 1366 makefile is used. The flags are as if typed to the shell, 1367 though the [1m-f [22moption will have no effect. 1368 1369 [1m.NOPATH [22mApply the [1m.NOPATH [22mattribute to any specified sources. 1370 1371 [1m.NOTPARALLEL[0m 1372 Disable parallel mode. 1373 1374 [1m.NO_PARALLEL[0m 1375 Synonym for [1m.NOTPARALLEL[22m, for compatibility with other pmake 1376 variants. 1377 1378 [1m.OBJDIR [22mThe source is a new value for `[4m.OBJDIR[24m'. If it exists, [1mbmake[0m 1379 will chdir(2) to it and update the value of `[4m.OBJDIR[24m'. 1380 1381 [1m.ORDER [22mThe named targets are made in sequence. This ordering does not 1382 add targets to the list of targets to be made. Since the depen- 1383 dents of a target do not get built until the target itself could 1384 be built, unless `a' is built by another part of the dependency 1385 graph, the following is a dependency loop: 1386 1387 .ORDER: b a 1388 b: a 1389 1390 The ordering imposed by [1m.ORDER [22mis only relevant for parallel 1391 makes. 1392 1393 [1m.PATH [22mThe sources are directories which are to be searched for files 1394 not found in the current directory. If no sources are speci- 1395 fied, any previously specified directories are deleted. If the 1396 source is the special [1m.DOTLAST [22mtarget, then the current working 1397 directory is searched last. 1398 1399 [1m.PATH.[4m[22msuffix[0m 1400 Like [1m.PATH [22mbut applies only to files with a particular suffix. 1401 The suffix must have been previously declared with [1m.SUFFIXES[22m. 1402 1403 [1m.PHONY [22mApply the [1m.PHONY [22mattribute to any specified sources. 1404 1405 [1m.PRECIOUS[0m 1406 Apply the [1m.PRECIOUS [22mattribute to any specified sources. If no 1407 sources are specified, the [1m.PRECIOUS [22mattribute is applied to 1408 every target in the file. 1409 1410 [1m.SHELL [22mSets the shell that [1mbmake [22mwill use to execute commands. The 1411 sources are a set of [4mfield=value[24m pairs. 1412 1413 [4mname[24m This is the minimal specification, used to select 1414 one of the built-in shell specs; [4msh[24m, [4mksh[24m, and [4mcsh[24m. 1415 1416 [4mpath[24m Specifies the path to the shell. 1417 1418 [4mhasErrCtl[24m Indicates whether the shell supports exit on error. 1419 1420 [4mcheck[24m The command to turn on error checking. 1421 1422 [4mignore[24m The command to disable error checking. 1423 1424 [4mecho[24m The command to turn on echoing of commands executed. 1425 1426 [4mquiet[24m The command to turn off echoing of commands exe- 1427 cuted. 1428 1429 [4mfilter[24m The output to filter after issuing the [4mquiet[24m com- 1430 mand. It is typically identical to [4mquiet[24m. 1431 1432 [4merrFlag[24m The flag to pass the shell to enable error checking. 1433 1434 [4mechoFlag[24m The flag to pass the shell to enable command echo- 1435 ing. 1436 1437 [4mnewline[24m The string literal to pass the shell that results in 1438 a single newline character when used outside of any 1439 quoting characters. 1440 Example: 1441 1442 .SHELL: name=ksh path=/bin/ksh hasErrCtl=true \ 1443 check="set -e" ignore="set +e" \ 1444 echo="set -v" quiet="set +v" filter="set +v" \ 1445 echoFlag=v errFlag=e newline="'\n'" 1446 1447 [1m.SILENT [22mApply the [1m.SILENT [22mattribute to any specified sources. If no 1448 sources are specified, the [1m.SILENT [22mattribute is applied to every 1449 command in the file. 1450 1451 [1m.STALE [22mThis target gets run when a dependency file contains stale 1452 entries, having [4m.ALLSRC[24m set to the name of that dependency file. 1453 1454 [1m.SUFFIXES[0m 1455 Each source specifies a suffix to [1mbmake[22m. If no sources are 1456 specified, any previously specified suffixes are deleted. It 1457 allows the creation of suffix-transformation rules. 1458 1459 Example: 1460 1461 .SUFFIXES: .o 1462 .c.o: 1463 cc -o ${.TARGET} -c ${.IMPSRC} 1464 1465[1mENVIRONMENT[0m 1466 [1mbmake [22muses the following environment variables, if they exist: MACHINE, 1467 MACHINE_ARCH, MAKE, MAKEFLAGS, MAKEOBJDIR, MAKEOBJDIRPREFIX, MAKESYSPATH, 1468 PWD, and TMPDIR. 1469 1470 MAKEOBJDIRPREFIX and MAKEOBJDIR may only be set in the environment or on 1471 the command line to [1mbmake [22mand not as makefile variables; see the descrip- 1472 tion of `[4m.OBJDIR[24m' for more details. 1473 1474[1mFILES[0m 1475 .depend list of dependencies 1476 Makefile list of dependencies 1477 makefile list of dependencies 1478 sys.mk system makefile 1479 /usr/share/mk system makefile directory 1480 1481[1mCOMPATIBILITY[0m 1482 The basic make syntax is compatible between different versions of make; 1483 however the special variables, variable modifiers and conditionals are 1484 not. 1485 1486 [1mOlder versions[0m 1487 An incomplete list of changes in older versions of [1mbmake[22m: 1488 1489 The way that .for loop variables are substituted changed after NetBSD 5.0 1490 so that they still appear to be variable expansions. In particular this 1491 stops them being treated as syntax, and removes some obscure problems 1492 using them in .if statements. 1493 1494 The way that parallel makes are scheduled changed in NetBSD 4.0 so that 1495 .ORDER and .WAIT apply recursively to the dependent nodes. The algo- 1496 rithms used may change again in the future. 1497 1498 [1mOther make dialects[0m 1499 Other make dialects (GNU make, SVR4 make, POSIX make, etc.) do not sup- 1500 port most of the features of [1mbmake [22mas described in this manual. Most 1501 notably: 1502 1503 [1m+o [22mThe [1m.WAIT [22mand [1m.ORDER [22mdeclarations and most functionality per- 1504 taining to parallelization. (GNU make supports parallelization 1505 but lacks these features needed to control it effectively.) 1506 1507 [1m+o [22mDirectives, including for loops and conditionals and most of 1508 the forms of include files. (GNU make has its own incompatible 1509 and less powerful syntax for conditionals.) 1510 1511 [1m+o [22mAll built-in variables that begin with a dot. 1512 1513 [1m+o [22mMost of the special sources and targets that begin with a dot, 1514 with the notable exception of [1m.PHONY[22m, [1m.PRECIOUS[22m, and [1m.SUFFIXES[22m. 1515 1516 [1m+o [22mVariable modifiers, except for the 1517 :old=new 1518 string substitution, which does not portably support globbing 1519 with `%' and historically only works on declared suffixes. 1520 1521 [1m+o [22mThe [1m$> [22mvariable even in its short form; most makes support this 1522 functionality but its name varies. 1523 1524 Some features are somewhat more portable, such as assignment with [1m+=[22m, [1m?=[22m, 1525 and [1m!=[22m. The [1m.PATH [22mfunctionality is based on an older feature [1mVPATH [22mfound 1526 in GNU make and many versions of SVR4 make; however, historically its 1527 behavior is too ill-defined (and too buggy) to rely upon. 1528 1529 The [1m$@ [22mand [1m$< [22mvariables are more or less universally portable, as is the 1530 [1m$(MAKE) [22mvariable. Basic use of suffix rules (for files only in the cur- 1531 rent directory, not trying to chain transformations together, etc.) is 1532 also reasonably portable. 1533 1534[1mSEE ALSO[0m 1535 mkdep(1) 1536 1537[1mHISTORY[0m 1538 [1mbmake [22mis derived from NetBSD make(1). It uses autoconf to facilitate 1539 portability to other platforms. 1540 1541 A make command appeared in Version 7 AT&T UNIX. This make implementation 1542 is based on Adam De Boor's pmake program which was written for Sprite at 1543 Berkeley. It was designed to be a parallel distributed make running jobs 1544 on different machines using a daemon called ``customs''. 1545 1546 Historically the target/dependency ``FRC'' has been used to FoRCe 1547 rebuilding (since the target/dependency does not exist... unless someone 1548 creates an ``FRC'' file). 1549 1550[1mBUGS[0m 1551 The make syntax is difficult to parse without actually acting on the 1552 data. For instance, finding the end of a variable's use should involve 1553 scanning each of the modifiers, using the correct terminator for each 1554 field. In many places make just counts {} and () in order to find the 1555 end of a variable expansion. 1556 1557 There is no way of escaping a space character in a filename. 1558 1559FreeBSD 11.3 June 5, 2020 FreeBSD 11.3 1560