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