1 BMAKE(1) FreeBSD General Commands Manual BMAKE(1)
4 \e[1mbmake
\e[22m-- maintain program dependencies
7 \e[1mbmake
\e[22m[
\e[1m-BeikNnqrSstWwX
\e[22m] [
\e[1m-C
\e[4m
\e[22mdirectory
\e[24m] [
\e[1m-D
\e[4m
\e[22mvariable
\e[24m] [
\e[1m-d
\e[4m
\e[22mflags
\e[24m]
8 [
\e[1m-f
\e[4m
\e[22mmakefile
\e[24m] [
\e[1m-I
\e[4m
\e[22mdirectory
\e[24m] [
\e[1m-J
\e[4m
\e[22mprivate
\e[24m] [
\e[1m-j
\e[4m
\e[22mmax_jobs
\e[24m]
9 [
\e[1m-m
\e[4m
\e[22mdirectory
\e[24m] [
\e[1m-T
\e[4m
\e[22mfile
\e[24m] [
\e[1m-V
\e[4m
\e[22mvariable
\e[24m] [
\e[1m-v
\e[4m
\e[22mvariable
\e[24m]
10 [
\e[4mvariable
\e[24m
\e[1m=
\e[4m
\e[22mvalue
\e[24m] [
\e[4mtarget
\e[24m ...]
13 \e[1mbmake
\e[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
\e[1m-f
\e[4m
\e[22mmakefile
\e[24m option is given,
16 \e[1mbmake
\e[22mtries to open `
\e[4mmakefile
\e[24m' then `
\e[4mMakefile
\e[24m' in order to find the spec-
17 ifications. If the file `
\e[4m.depend
\e[24m' exists, it is read, see mkdep(1).
19 This manual page is intended as a reference document only. For a more
20 thorough description of
\e[1mbmake
\e[22mand makefiles, please refer to
\e[4mPMake
\e[24m
\e[4m-
\e[24m
\e[4mA
\e[0m
21 \e[4mTutorial
\e[24m (from 1993).
23 \e[1mbmake
\e[22mprepends the contents of the MAKEFLAGS environment variable to the
24 command line arguments before parsing them.
26 The options are as follows:
28 \e[1m-B
\e[22mTry to be backwards compatible by executing a single shell per
29 command and by making the sources of a dependency line in se-
32 \e[1m-C
\e[4m
\e[22mdirectory
\e[0m
33 Change to
\e[4mdirectory
\e[24m before reading the makefiles or doing any-
34 thing else. If multiple
\e[1m-C
\e[22moptions are specified, each is inter-
35 preted relative to the previous one:
\e[1m-C
\e[4m
\e[22m/
\e[24m
\e[1m-C
\e[4m
\e[22metc
\e[24m is equivalent to
36 \e[1m-C
\e[4m
\e[22m/etc
\e[24m.
38 \e[1m-D
\e[4m
\e[22mvariable
\e[0m
39 Define
\e[4mvariable
\e[24m to be 1, in the global scope.
41 \e[1m-d
\e[22m[
\e[1m-
\e[22m]
\e[4mflags
\e[0m
42 Turn on debugging, and specify which portions of
\e[1mbmake
\e[22mare to
43 print debugging information. Unless the flags are preceded by
44 `-', they are added to the MAKEFLAGS environment variable and are
45 passed on to any child make processes. By default, debugging in-
46 formation is printed to standard error, but this can be changed
47 using the
\e[1mF
\e[22mdebugging flag. The debugging output is always un-
48 buffered; in addition, if debugging is enabled but debugging out-
49 put is not directed to standard output, the standard output is
50 line buffered. The available
\e[4mflags
\e[24m are:
52 \e[1mA
\e[22mPrint all possible debugging information; equivalent to
53 specifying all of the debugging flags.
55 \e[1ma
\e[22mPrint debugging information about archive searching and
58 \e[1mC
\e[22mPrint debugging information about the current working di-
61 \e[1mc
\e[22mPrint debugging information about conditional evaluation.
63 \e[1md
\e[22mPrint debugging information about directory searching and
66 \e[1me
\e[22mPrint debugging information about failed commands and
69 \e[1mF
\e[22m[
\e[1m+
\e[22m]
\e[4mfilename
\e[0m
70 Specify where debugging output is written. This must be
71 the last flag, because it consumes the remainder of the
72 argument. If the character immediately after the
\e[1mF
\e[22mflag
73 is `+', the file is opened in append mode; otherwise the
74 file is overwritten. If the file name is `stdout' or
75 `stderr', debugging output is written to the standard
76 output or standard error output respectively (and the `+'
77 option has no effect). Otherwise, the output is written
78 to the named file. If the file name ends with `.%d', the
79 `%d' is replaced by the pid.
81 \e[1mf
\e[22mPrint debugging information about loop evaluation.
83 \e[1mg1
\e[22mPrint the input graph before making anything.
85 \e[1mg2
\e[22mPrint the input graph after making everything, or before
88 \e[1mg3
\e[22mPrint the input graph before exiting on error.
90 \e[1mh
\e[22mPrint debugging information about hash table operations.
92 \e[1mj
\e[22mPrint debugging information about running multiple
95 \e[1mL
\e[22mTurn on lint checks. This throws errors for variable as-
96 signments that do not parse correctly, at the time of as-
97 signment, so the file and line number are available.
99 \e[1ml
\e[22mPrint commands in Makefiles regardless of whether or not
100 they are prefixed by `@' or other "quiet" flags. Also
101 known as "loud" behavior.
103 \e[1mM
\e[22mPrint debugging information about "meta" mode decisions
106 \e[1mm
\e[22mPrint debugging information about making targets, includ-
107 ing modification dates.
109 \e[1mn
\e[22mDon't delete the temporary command scripts created when
110 running commands. These temporary scripts are created in
111 the directory referred to by the TMPDIR environment vari-
112 able, or in
\e[4m/tmp
\e[24m if TMPDIR is unset or set to the empty
113 string. The temporary scripts are created by mkstemp(3),
114 and have names of the form
\e[4mmakeXXXXXX
\e[24m.
\e[4mNOTE
\e[24m: This can
115 create many files in TMPDIR or
\e[4m/tmp
\e[24m, so use with care.
117 \e[1mp
\e[22mPrint debugging information about makefile parsing.
119 \e[1ms
\e[22mPrint debugging information about suffix-transformation
122 \e[1mt
\e[22mPrint debugging information about target list mainte-
125 \e[1mV
\e[22mForce the
\e[1m-V
\e[22moption to print raw values of variables,
126 overriding the default behavior set via
127 \e[4m.MAKE.EXPAND_VARIABLES
\e[24m.
129 \e[1mv
\e[22mPrint debugging information about variable assignment and
132 \e[1mx
\e[22mRun shell commands with
\e[1m-x
\e[22mso the actual commands are
133 printed as they are executed.
135 \e[1m-e
\e[22mLet environment variables override global variables within make-
138 \e[1m-f
\e[4m
\e[22mmakefile
\e[0m
139 Specify a makefile to read instead of the default
\e[4mmakefile
\e[24m or
140 \e[4mMakefile
\e[24m. If
\e[4mmakefile
\e[24m is `-', standard input is read. Multiple
141 makefiles may be specified, and are read in the order specified.
143 \e[1m-I
\e[4m
\e[22mdirectory
\e[0m
144 Specify a directory in which to search for makefiles and included
145 makefiles. The system makefile directory (or directories, see
146 the
\e[1m-m
\e[22moption) is automatically included as part of this list.
148 \e[1m-i
\e[22mIgnore non-zero exit of shell commands in the makefile. Equiva-
149 lent to specifying `-' before each command line in the makefile.
151 \e[1m-J
\e[4m
\e[22mprivate
\e[0m
152 This option should
\e[4mnot
\e[24m be specified by the user.
154 When the
\e[1m-j
\e[22moption is in use in a recursive build, this option is
155 passed by a make to child makes to allow all the make processes
156 in the build to cooperate to avoid overloading the system.
158 \e[1m-j
\e[4m
\e[22mmax_jobs
\e[0m
159 Specify the maximum number of jobs that
\e[1mbmake
\e[22mmay have running at
160 any one time. The value is saved in
\e[4m.MAKE.JOBS
\e[24m. Turns compati-
161 bility mode off, unless the
\e[1m-B
\e[22moption is also specified. When
162 compatibility mode is off, all commands associated with a target
163 are executed in a single shell invocation as opposed to the tra-
164 ditional one shell invocation per line. This can break tradi-
165 tional scripts which change directories on each command invoca-
166 tion and then expect to start with a fresh environment on the
167 next line. It is more efficient to correct the scripts rather
168 than turn backwards compatibility on.
170 \e[1m-k
\e[22mContinue processing after errors are encountered, but only on
171 those targets that do not depend on the target whose creation
174 \e[1m-m
\e[4m
\e[22mdirectory
\e[0m
175 Specify a directory in which to search for
\e[4msys.mk
\e[24m and makefiles
176 included via the <
\e[4mfile
\e[24m>-style include statement. The
\e[1m-m
\e[22moption
177 can be used multiple times to form a search path. This path
178 overrides the default system include path
\e[4m/usr/share/mk
\e[24m. Fur-
179 thermore, the system include path is appended to the search path
180 used for "
\e[4mfile
\e[24m"-style include statements (see the
\e[1m-I
\e[22moption).
181 The system include path can be referenced via the read-only vari-
182 able
\e[4m.SYSPATH
\e[24m.
184 If a directory name in the
\e[1m-m
\e[22margument (or the MAKESYSPATH envi-
185 ronment variable) starts with the string `.../',
\e[1mbmake
\e[22msearches
186 for the specified file or directory named in the remaining part
187 of the argument string. The search starts with the current di-
188 rectory and then works upward towards the root of the file sys-
189 tem. If the search is successful, the resulting directory re-
190 places the `.../' specification in the
\e[1m-m
\e[22margument. This feature
191 allows
\e[1mbmake
\e[22mto easily search in the current source tree for cus-
192 tomized
\e[4msys.mk
\e[24m files (e.g., by using `.../mk/sys.mk' as an argu-
195 \e[1m-n
\e[22mDisplay the commands that would have been executed, but do not
196 actually execute them unless the target depends on the
\e[4m.MAKE
\e[24m spe-
197 cial source (see below) or the command is prefixed with `
\e[1m+
\e[22m'.
199 \e[1m-N
\e[22mDisplay the commands that would have been executed, but do not
200 actually execute any of them; useful for debugging top-level
201 makefiles without descending into subdirectories.
203 \e[1m-q
\e[22mDo not execute any commands, instead exit 0 if the specified tar-
204 gets are up to date, and 1 otherwise.
206 \e[1m-r
\e[22mDo not use the built-in rules specified in the system makefile.
208 \e[1m-S
\e[22mStop processing if an error is encountered. This is the default
209 behavior and the opposite of
\e[1m-k
\e[22m.
211 \e[1m-s
\e[22mDo not echo any commands as they are executed. Equivalent to
212 specifying `
\e[1m@
\e[22m' before each command line in the makefile.
214 \e[1m-T
\e[4m
\e[22mtracefile
\e[0m
215 When used with the
\e[1m-j
\e[22mflag, append a trace record to
\e[4mtracefile
\e[0m
216 for each job started and completed.
218 \e[1m-t
\e[22mRather than re-building a target as specified in the makefile,
219 create it or update its modification time to make it appear up-
222 \e[1m-V
\e[4m
\e[22mvariable
\e[0m
223 Print the value of
\e[4mvariable
\e[24m. Do not build any targets. Multiple
224 instances of this option may be specified; the variables are
225 printed one per line, with a blank line for each null or unde-
226 fined variable. The value printed is extracted from the global
227 scope after all makefiles have been read.
229 By default, the raw variable contents (which may include addi-
230 tional unexpanded variable references) are shown. If
\e[4mvariable
\e[0m
231 contains a `$', it is not interpreted as a variable name but
232 rather as an expression. Its value is expanded before printing.
233 The value is also expanded before printing if
234 \e[4m.MAKE.EXPAND_VARIABLES
\e[24m is set to true and the
\e[1m-dV
\e[22moption has not
235 been used to override it.
237 Note that loop-local and target-local variables, as well as val-
238 ues taken temporarily by global variables during makefile pro-
239 cessing, are not accessible via this option. The
\e[1m-dv
\e[22mdebug mode
240 can be used to see these at the cost of generating substantial
243 \e[1m-v
\e[4m
\e[22mvariable
\e[0m
244 Like
\e[1m-V
\e[22m, but all printed variables are always expanded to their
245 complete value. The last occurrence of
\e[1m-V
\e[22mor
\e[1m-v
\e[22mdecides whether
246 all variables are expanded or not.
248 \e[1m-W
\e[22mTreat any warnings during makefile parsing as errors.
250 \e[1m-w
\e[22mPrint entering and leaving directory messages, pre and post pro-
253 \e[1m-X
\e[22mDon't export variables passed on the command line to the environ-
254 ment individually. Variables passed on the command line are
255 still exported via the MAKEFLAGS environment variable. This op-
256 tion may be useful on systems which have a small limit on the
257 size of command arguments.
259 \e[4mvariable
\e[24m
\e[1m=
\e[4m
\e[22mvalue
\e[0m
260 Set the value of the variable
\e[4mvariable
\e[24m to
\e[4mvalue
\e[24m. Normally, all
261 values passed on the command line are also exported to sub-makes
262 in the environment. The
\e[1m-X
\e[22mflag disables this behavior. Vari-
263 able assignments should follow options for POSIX compatibility
264 but no ordering is enforced.
266 There are several different types of lines in a makefile: dependency
267 specifications, shell commands, variable assignments, include statements,
268 conditional directives, for loops, other directives, and comments.
270 Lines may be continued from one line to the next by ending them with a
271 backslash (`\'). The trailing newline character and initial whitespace
272 on the following line are compressed into a single space.
274 \e[1mFILE DEPENDENCY SPECIFICATIONS
\e[0m
275 Dependency lines consist of one or more targets, an operator, and zero or
276 more sources. This creates a relationship where the targets "depend" on
277 the sources and are customarily created from them. A target is consid-
278 ered out of date if it does not exist, or if its modification time is
279 less than that of any of its sources. An out-of-date target is re-cre-
280 ated, but not until all sources have been examined and themselves re-cre-
281 ated as needed. Three operators may be used:
283 \e[1m:
\e[22mMany dependency lines may name this target but only one may have
284 attached shell commands. All sources named in all dependency lines
285 are considered together, and if needed the attached shell commands
286 are run to create or re-create the target. If
\e[1mbmake
\e[22mis inter-
287 rupted, the target is removed.
289 \e[1m!
\e[22mThe same, but the target is always re-created whether or not it is
292 \e[1m::
\e[22mAny dependency line may have attached shell commands, but each one
293 is handled independently: its sources are considered and the at-
294 tached shell commands are run if the target is out of date with re-
295 spect to (only) those sources. Thus, different groups of the at-
296 tached shell commands may be run depending on the circumstances.
297 Furthermore, unlike
\e[1m:
\e[22m, for dependency lines with no sources, the
298 attached shell commands are always run. Also unlike
\e[1m:
\e[22m, the target
299 is not removed if
\e[1mbmake
\e[22mis interrupted.
301 All dependency lines mentioning a particular target must use the same op-
304 Targets and sources may contain the shell wildcard values `?', `*', `[]',
305 and `{}'. The values `?', `*', and `[]' may only be used as part of the
306 final component of the target or source, and only match existing files.
307 The value `{}' need not necessarily be used to describe existing files.
308 Expansion is in directory order, not alphabetically as done in the shell.
310 \e[1mSHELL COMMANDS
\e[0m
311 Each target may have associated with it one or more lines of shell com-
312 mands, normally used to create the target. Each of the lines in this
313 script
\e[4mmust
\e[24m be preceded by a tab. (For historical reasons, spaces are
314 not accepted.) While targets can occur in many dependency lines if de-
315 sired, by default only one of these rules may be followed by a creation
316 script. If the `
\e[1m::
\e[22m' operator is used, however, all rules may include
317 scripts, and the respective scripts are executed in the order found.
319 Each line is treated as a separate shell command, unless the end of line
320 is escaped with a backslash `\', in which case that line and the next are
321 combined. If the first characters of the command are any combination of
322 `
\e[1m@
\e[22m', `
\e[1m+
\e[22m', or `
\e[1m-
\e[22m', the command is treated specially.
324 \e[1m@
\e[22mcauses the command not to be echoed before it is executed.
326 \e[1m+
\e[22mcauses the command to be executed even when
\e[1m-n
\e[22mis given.
327 This is similar to the effect of the
\e[4m.MAKE
\e[24m special source,
328 except that the effect can be limited to a single line of a
331 \e[1m-
\e[22min compatibility mode causes any non-zero exit status of
332 the command line to be ignored.
334 When
\e[1mbmake
\e[22mis run in jobs mode with
\e[1m-j
\e[4m
\e[22mmax_jobs
\e[24m, the entire script for
335 the target is fed to a single instance of the shell. In compatibility
336 (non-jobs) mode, each command is run in a separate process. If the com-
337 mand contains any shell meta characters (`#=|^(){};&<>*?[]:$`\\n'), it is
338 passed to the shell; otherwise
\e[1mbmake
\e[22mattempts direct execution. If a
339 line starts with `
\e[1m-
\e[22m' and the shell has ErrCtl enabled, failure of the
340 command line is ignored as in compatibility mode. Otherwise `
\e[1m-
\e[22m' affects
341 the entire job; the script stops at the first command line that fails,
342 but the target is not deemed to have failed.
344 Makefiles should be written so that the mode of
\e[1mbmake
\e[22moperation does not
345 change their behavior. For example, any command which uses "cd" or
346 "chdir" without the intention of changing the directory for subsequent
347 commands should be put in parentheses so it executes in a subshell. To
348 force the use of a single shell, escape the line breaks so as to make the
349 whole script one command. For example:
351 avoid-chdir-side-effects:
352 @echo "Building $@ in $$(pwd)"
353 @(cd ${.CURDIR} && ${MAKE} $@)
354 @echo "Back in $$(pwd)"
356 ensure-one-shell-regardless-of-mode:
357 @echo "Building $@ in $$(pwd)"; \
358 (cd ${.CURDIR} && ${MAKE} $@); \
359 echo "Back in $$(pwd)"
361 Since
\e[1mbmake
\e[22mchanges the current working directory to `
\e[4m.OBJDIR
\e[24m' before ex-
362 ecuting any targets, each child process starts with that as its current
365 \e[1mVARIABLE ASSIGNMENTS
\e[0m
366 Variables in make behave much like macros in the C preprocessor.
368 Variable assignments have the form `
\e[4mNAME
\e[24m
\e[4mop
\e[24m
\e[4mvalue
\e[24m', where:
370 \e[4mNAME
\e[24m is a single-word variable name, consisting, by tradition,
371 of all upper-case letters,
373 \e[4mop
\e[24m is one of the variable assignment operators described be-
376 \e[4mvalue
\e[24m is interpreted according to the variable assignment opera-
379 Whitespace around
\e[4mNAME
\e[24m,
\e[4mop
\e[24m and
\e[4mvalue
\e[24m is discarded.
381 \e[1mVariable assignment operators
\e[0m
382 The five operators that assign values to variables are:
384 \e[1m=
\e[22mAssign the value to the variable. Any previous value is over-
387 \e[1m+=
\e[22mAppend the value to the current value of the variable, separating
388 them by a single space.
390 \e[1m?=
\e[22mAssign the value to the variable if it is not already defined.
392 \e[1m:=
\e[22mExpand the value, then assign it to the variable.
394 \e[4mNOTE
\e[24m: References to undefined variables are
\e[4mnot
\e[24m expanded. This
395 can cause problems when variable modifiers are used.
397 \e[1m!=
\e[22mExpand the value and pass it to the shell for execution, then as-
398 sign the output from the child's standard output to the variable.
399 Any newlines in the result are replaced with spaces.
401 \e[1mExpansion of variables
\e[0m
402 In most contexts where variables are expanded, `$$' expands to a single
403 dollar sign. In other contexts (most variable modifiers, string literals
404 in conditions), `\$' expands to a single dollar sign.
406 References to variables have the form
\e[1m${
\e[4m
\e[22mname
\e[24m[
\e[1m:
\e[4m
\e[22mmodifiers
\e[24m]
\e[1m}
\e[22mor
407 \e[1m$(
\e[4m
\e[22mname
\e[24m[
\e[1m:
\e[4m
\e[22mmodifiers
\e[24m]
\e[1m)
\e[22m. If the variable name consists of only a single
408 character and the expression contains no modifiers, the surrounding curly
409 braces or parentheses are not required. This shorter form is not recom-
412 If the variable name contains a dollar, the name itself is expanded
413 first. This allows almost arbitrary variable names, however names con-
414 taining dollar, braces, parentheses or whitespace are really best
417 If the result of expanding a nested variable expression contains a dollar
418 sign (`$'), the result is subject to further expansion.
420 Variable substitution occurs at four distinct times, depending on where
421 the variable is being used.
423 1. Variables in dependency lines are expanded as the line is read.
425 2. Variables in conditionals are expanded individually, but only as far
426 as necessary to determine the result of the conditional.
428 3. Variables in shell commands are expanded when the shell command is
431 4.
\e[1m.for
\e[22mloop index variables are expanded on each loop iteration. Note
432 that other variables are not expanded when composing the body of a
433 loop, so the following example code:
450 After the loop is executed:
452 \e[4ma
\e[24m contains `${:U1} ${:U2} ${:U3}', which expands to `1 2
455 \e[4mj
\e[24m contains `${:U3}', which expands to `3'.
457 \e[4mb
\e[24m contains `${j} ${j} ${j}', which expands to `${:U3}
458 ${:U3} ${:U3}' and further to `3 3 3'.
460 \e[1mVariable classes
\e[0m
461 The four different classes of variables (in order of increasing prece-
464 Environment variables
465 Variables defined as part of
\e[1mbmake
\e[22m's environment.
468 Variables defined in the makefile or in included makefiles.
470 Command line variables
471 Variables defined as part of the command line.
474 Variables that are defined specific to a certain target.
476 Local variables can be set on a dependency line, unless
477 \e[4m.MAKE.TARGET_LOCAL_VARIABLES
\e[24m is set to `false'. The rest of the line
478 (which already has had global variables expanded) is the variable value.
481 COMPILER_WRAPPERS= ccache distcc icecc
483 ${OBJS}: .MAKE.META.CMP_FILTER=${COMPILER_WRAPPERS:S,^,N,}
485 Only the targets `${OBJS}' are impacted by that filter (in "meta" mode)
486 and simply enabling/disabling any of the compiler wrappers does not ren-
487 der all of those targets out-of-date.
489 \e[4mNOTE
\e[24m: target-local variable assignments behave differently in that;
491 \e[1m+=
\e[22mOnly appends to a previous local assignment for the same
494 \e[1m:=
\e[22mIs redundant with respect to global variables, which have
495 already been expanded.
497 The seven built-in local variables are:
499 \e[4m.ALLSRC
\e[24m The list of all sources for this target; also known as
502 \e[4m.ARCHIVE
\e[24m The name of the archive file; also known as `
\e[4m!
\e[24m'.
504 \e[4m.IMPSRC
\e[24m In suffix-transformation rules, the name/path of the
505 source from which the target is to be transformed (the
506 "implied" source); also known as `
\e[4m<
\e[24m'. It is not defined
509 \e[4m.MEMBER
\e[24m The name of the archive member; also known as `
\e[4m%
\e[24m'.
511 \e[4m.OODATE
\e[24m The list of sources for this target that were deemed out-
512 of-date; also known as `
\e[4m?
\e[24m'.
514 \e[4m.PREFIX
\e[24m The file prefix of the target, containing only the file
515 portion, no suffix or preceding directory components;
516 also known as `
\e[4m*
\e[24m'. The suffix must be one of the known
517 suffixes declared with
\e[1m.SUFFIXES
\e[22m, or it is not recog-
520 \e[4m.TARGET
\e[24m The name of the target; also known as `
\e[4m@
\e[24m'. For compati-
521 bility with other makes this is an alias for
\e[4m.ARCHIVE
\e[24m in
522 archive member rules.
524 The shorter forms (`
\e[4m>
\e[24m', `
\e[4m!
\e[24m', `
\e[4m<
\e[24m', `
\e[4m%
\e[24m', `
\e[4m?
\e[24m', `
\e[4m*
\e[24m', and `
\e[4m@
\e[24m') are permitted
525 for backward compatibility with historical makefiles and legacy POSIX
526 make and are not recommended.
528 Variants of these variables with the punctuation followed immediately by
529 `D' or `F', e.g. `$(@D)', are legacy forms equivalent to using the `:H'
530 and `:T' modifiers. These forms are accepted for compatibility with AT&T
531 System V UNIX makefiles and POSIX but are not recommended.
533 Four of the local variables may be used in sources on dependency lines
534 because they expand to the proper value for each target on the line.
535 These variables are `
\e[4m.TARGET
\e[24m', `
\e[4m.PREFIX
\e[24m', `
\e[4m.ARCHIVE
\e[24m', and `
\e[4m.MEMBER
\e[24m'.
537 \e[1mAdditional built-in variables
\e[0m
538 In addition,
\e[1mbmake
\e[22msets or knows about the following variables:
540 \e[4m.ALLTARGETS
\e[0m
541 The list of all targets encountered in the makefiles. If evalu-
542 ated during makefile parsing, lists only those targets encoun-
546 A path to the directory where
\e[1mbmake
\e[22mwas executed. Refer to the
547 description of `
\e[4mPWD
\e[24m' for more details.
550 Is used in error handling, see
\e[4mMAKE_PRINT_VAR_ON_ERROR
\e[24m.
553 Is used in error handling, see
\e[4mMAKE_PRINT_VAR_ON_ERROR
\e[24m.
555 \e[4m.ERROR_META_FILE
\e[0m
556 Is used in error handling in "meta" mode, see
557 \e[4mMAKE_PRINT_VAR_ON_ERROR
\e[24m.
559 \e[4m.ERROR_TARGET
\e[0m
560 Is used in error handling, see
\e[4mMAKE_PRINT_VAR_ON_ERROR
\e[24m.
562 \e[4m.INCLUDEDFROMDIR
\e[0m
563 The directory of the file this makefile was included from.
565 \e[4m.INCLUDEDFROMFILE
\e[0m
566 The filename of the file this makefile was included from.
569 The machine hardware name, see uname(1).
571 \e[4mMACHINE_ARCH
\e[0m
572 The machine processor architecture name, see uname(1).
574 \e[4mMAKE
\e[24m The name that
\e[1mbmake
\e[22mwas executed with (
\e[4margv[0]
\e[24m).
576 \e[4m.MAKE
\e[24m The same as
\e[4mMAKE
\e[24m, for compatibility. The preferred variable to
577 use is the environment variable MAKE because it is more compati-
578 ble with other make variants and cannot be confused with the spe-
579 cial target with the same name.
581 \e[4m.MAKE.DEPENDFILE
\e[0m
582 Names the makefile (default `
\e[4m.depend
\e[24m') from which generated de-
585 \e[4m.MAKE.DIE_QUIETLY
\e[0m
586 If set to `true', do not print error information at the end.
588 \e[4m.MAKE.EXPAND_VARIABLES
\e[0m
589 A boolean that controls the default behavior of the
\e[1m-V
\e[22moption.
590 If true, variable values printed with
\e[1m-V
\e[22mare fully expanded; if
591 false, the raw variable contents (which may include additional
592 unexpanded variable references) are shown.
594 \e[4m.MAKE.EXPORTED
\e[0m
595 The list of variables exported by
\e[1mbmake
\e[22m.
598 The top-level makefile that is currently read, as given in the
602 The environment variable `MAKEFLAGS' may contain anything that
603 may be specified on
\e[1mbmake
\e[22m's command line. Anything specified on
604 \e[1mbmake
\e[22m's command line is appended to the
\e[4m.MAKEFLAGS
\e[24m variable,
605 which is then added to the environment for all programs that
606 \e[1mbmake
\e[22mexecutes.
609 The numeric group ID of the user running
\e[1mbmake
\e[22m. It is read-only.
611 \e[4m.MAKE.JOB.PREFIX
\e[0m
612 If
\e[1mbmake
\e[22mis run with
\e[1m-j
\e[22m, the output for each target is prefixed
614 ---
\e[4mtarget
\e[24m ---
615 the first part of which can be controlled via
\e[4m.MAKE.JOB.PREFIX
\e[24m.
616 If
\e[4m.MAKE.JOB.PREFIX
\e[24m is empty, no token is printed. For example,
617 setting
\e[4m.MAKE.JOB.PREFIX
\e[24m to
618 `${.newline}---${.MAKE:T}[${.MAKE.PID}]' would produce tokens
620 ---make[1234]
\e[4mtarget
\e[24m ---
621 making it easier to track the degree of parallelism being
625 The argument to the
\e[1m-j
\e[22moption.
627 \e[4m.MAKE.LEVEL
\e[0m
628 The recursion depth of
\e[1mbmake
\e[22m. The top-level instance of
\e[1mbmake
\e[0m
629 has level 0, and each child make has its parent level plus 1.
630 This allows tests like: .if ${.MAKE.LEVEL} == 0 to protect things
631 which should only be evaluated in the top-level instance of
634 \e[4m.MAKE.LEVEL.ENV
\e[0m
635 The name of the environment variable that stores the level of
636 nested calls to
\e[1mbmake
\e[22m.
638 \e[4m.MAKE.MAKEFILE_PREFERENCE
\e[0m
639 The ordered list of makefile names (default `
\e[4mmakefile
\e[24m',
640 `
\e[4mMakefile
\e[24m') that
\e[1mbmake
\e[22mlooks for.
642 \e[4m.MAKE.MAKEFILES
\e[0m
643 The list of makefiles read by
\e[1mbmake
\e[22m, which is useful for tracking
644 dependencies. Each makefile is recorded only once, regardless of
645 the number of times read.
647 \e[4m.MAKE.META.BAILIWICK
\e[0m
648 In "meta" mode, provides a list of prefixes which match the di-
649 rectories controlled by
\e[1mbmake
\e[22m. If a file that was generated out-
650 side of
\e[4m.OBJDIR
\e[24m but within said bailiwick is missing, the current
651 target is considered out-of-date.
653 \e[4m.MAKE.META.CMP_FILTER
\e[0m
654 In "meta" mode, it can (very rarely!) be useful to filter command
655 lines before comparison. This variable can be set to a set of
656 modifiers that are applied to each line of the old and new com-
657 mand that differ, if the filtered commands still differ, the tar-
658 get is considered out-of-date.
660 \e[4m.MAKE.META.CREATED
\e[0m
661 In "meta" mode, this variable contains a list of all the meta
662 files updated. If not empty, it can be used to trigger process-
663 ing of
\e[4m.MAKE.META.FILES
\e[24m.
665 \e[4m.MAKE.META.FILES
\e[0m
666 In "meta" mode, this variable contains a list of all the meta
667 files used (updated or not). This list can be used to process
668 the meta files to extract dependency information.
670 \e[4m.MAKE.META.IGNORE_FILTER
\e[0m
671 Provides a list of variable modifiers to apply to each pathname.
672 Ignore if the expansion is an empty string.
674 \e[4m.MAKE.META.IGNORE_PATHS
\e[0m
675 Provides a list of path prefixes that should be ignored; because
676 the contents are expected to change over time. The default list
677 includes: `
\e[4m/dev
\e[24m
\e[4m/etc
\e[24m
\e[4m/proc
\e[24m
\e[4m/tmp
\e[24m
\e[4m/var/run
\e[24m
\e[4m/var/tmp
\e[24m'
679 \e[4m.MAKE.META.IGNORE_PATTERNS
\e[0m
680 Provides a list of patterns to match against pathnames. Ignore
683 \e[4m.MAKE.META.PREFIX
\e[0m
684 Defines the message printed for each meta file updated in "meta
685 verbose" mode. The default value is:
686 Building ${.TARGET:H:tA}/${.TARGET:T}
689 Processed after reading all makefiles. Affects the mode that
690 \e[1mbmake
\e[22mruns in. It can contain these keywords:
692 \e[1mcompat
\e[22mLike
\e[1m-B
\e[22m, puts
\e[1mbmake
\e[22minto "compat" mode.
694 \e[1mmeta
\e[22mPuts
\e[1mbmake
\e[22minto "meta" mode, where meta files are created
695 for each target to capture the command run, the output
696 generated, and if filemon(4) is available, the system
697 calls which are of interest to
\e[1mbmake
\e[22m. The captured out-
698 put can be useful when diagnosing errors.
700 \e[1mcurdirOk=
\e[4m
\e[22mbf
\e[0m
701 By default,
\e[1mbmake
\e[22mdoes not create
\e[4m.meta
\e[24m files in
702 `
\e[4m.CURDIR
\e[24m'. This can be overridden by setting
\e[4mbf
\e[24m to a
703 value which represents true.
705 \e[1mmissing-meta=
\e[4m
\e[22mbf
\e[0m
706 If
\e[4mbf
\e[24m is true, a missing
\e[4m.meta
\e[24m file makes the target out-
709 \e[1mmissing-filemon=
\e[4m
\e[22mbf
\e[0m
710 If
\e[4mbf
\e[24m is true, missing filemon data makes the target out-
714 Do not use filemon(4).
716 \e[1menv
\e[22mFor debugging, it can be useful to include the environ-
717 ment in the
\e[4m.meta
\e[24m file.
720 If in "meta" mode, print a clue about the target being
721 built. This is useful if the build is otherwise running
722 silently. The message printed is the expanded value of
723 \e[4m.MAKE.META.PREFIX
\e[24m.
726 Some makefiles have commands which are simply not stable.
727 This keyword causes them to be ignored for determining
728 whether a target is out of date in "meta" mode. See also
729 \e[1m.NOMETA_CMP
\e[22m.
731 \e[1msilent=
\e[4m
\e[22mbf
\e[0m
732 If
\e[4mbf
\e[24m is true, when a .meta file is created, mark the
733 target
\e[1m.SILENT
\e[22m.
735 \e[1mrandomize-targets
\e[0m
736 In both compat and parallel mode, do not make the targets
737 in the usual order, but instead randomize their order.
738 This mode can be used to detect undeclared dependencies
742 Used to create files in a separate directory, see
\e[4m.OBJDIR
\e[24m.
744 \e[4mMAKE_OBJDIR_CHECK_WRITABLE
\e[0m
745 Used to force a separate directory for the created files, even if
746 that directory is not writable, see
\e[4m.OBJDIR
\e[24m.
748 \e[4mMAKEOBJDIRPREFIX
\e[0m
749 Used to create files in a separate directory, see
\e[4m.OBJDIR
\e[24m.
752 The name of the operating system, see uname(1). It is read-only.
754 \e[4m.MAKEOVERRIDES
\e[0m
755 This variable is used to record the names of variables assigned
756 to on the command line, so that they may be exported as part of
757 `MAKEFLAGS'. This behavior can be disabled by assigning an empty
758 value to `
\e[4m.MAKEOVERRIDES
\e[24m' within a makefile. Extra variables can
759 be exported from a makefile by appending their names to
760 `
\e[4m.MAKEOVERRIDES
\e[24m'. `MAKEFLAGS' is re-exported whenever
761 `
\e[4m.MAKEOVERRIDES
\e[24m' is modified.
763 \e[4m.MAKE.PATH_FILEMON
\e[0m
764 If
\e[1mbmake
\e[22mwas built with filemon(4) support, this is set to the
765 path of the device node. This allows makefiles to test for this
769 The process ID of
\e[1mbmake
\e[22m. It is read-only.
772 The parent process ID of
\e[1mbmake
\e[22m. It is read-only.
774 \e[4mMAKE_PRINT_VAR_ON_ERROR
\e[0m
775 When
\e[1mbmake
\e[22mstops due to an error, it sets `
\e[4m.ERROR_TARGET
\e[24m' to the
776 name of the target that failed, `
\e[4m.ERROR_CMD
\e[24m' to the commands of
777 the failed target, and in "meta" mode, it also sets `
\e[4m.ERROR_CWD
\e[24m'
778 to the getcwd(3), and `
\e[4m.ERROR_META_FILE
\e[24m' to the path of the meta
779 file (if any) describing the failed target. It then prints its
780 name and the value of `
\e[4m.CURDIR
\e[24m' as well as the value of any vari-
781 ables named in `
\e[4mMAKE_PRINT_VAR_ON_ERROR
\e[24m'.
783 \e[4m.MAKE.SAVE_DOLLARS
\e[0m
784 If true, `$$' are preserved when doing `:=' assignments. The de-
785 fault is false, for backwards compatibility. Set to true for
786 compatability with other makes. If set to false, `$$' becomes
787 `$' per normal evaluation rules.
789 \e[4m.MAKE.TARGET_LOCAL_VARIABLES
\e[0m
790 If set to `false', apparent variable assignments in dependency
791 lines are treated as normal sources.
794 The numeric ID of the user running
\e[1mbmake
\e[22m. It is read-only.
797 This variable is simply assigned a newline character as its
798 value. It is read-only. This allows expansions using the
\e[1m:@
\e[0m
799 modifier to put a newline between iterations of the loop rather
800 than a space. For example, in case of an error,
\e[1mbmake
\e[22mprints the
801 variable names and their values using:
802 ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}
805 A path to the directory where the targets are built. Its value
806 is determined by trying to chdir(2) to the following directories
807 in order and using the first match:
809 1.
\e[1m${MAKEOBJDIRPREFIX}${.CURDIR}
\e[0m
811 (Only if `MAKEOBJDIRPREFIX' is set in the environment or on
814 2.
\e[1m${MAKEOBJDIR}
\e[0m
816 (Only if `MAKEOBJDIR' is set in the environment or on the
819 3.
\e[1m${.CURDIR}
\e[4m
\e[22m/obj.
\e[24m
\e[1m${MACHINE}
\e[0m
821 4.
\e[1m${.CURDIR}
\e[4m
\e[22m/obj
\e[0m
823 5.
\e[4m/usr/obj/
\e[24m
\e[1m${.CURDIR}
\e[0m
825 6.
\e[1m${.CURDIR}
\e[0m
827 Variable expansion is performed on the value before it is used,
828 so expressions such as
\e[1m${.CURDIR:S,^/usr/src,/var/obj,}
\e[22mmay be
829 used. This is especially useful with `MAKEOBJDIR'.
831 `
\e[4m.OBJDIR
\e[24m' may be modified in the makefile via the special target
832 `
\e[1m.OBJDIR
\e[22m'. In all cases,
\e[1mbmake
\e[22mchanges to the specified direc-
833 tory if it exists, and sets `
\e[4m.OBJDIR
\e[24m' and `
\e[4mPWD
\e[24m' to that directory
834 before executing any targets.
836 Except in the case of an explicit `
\e[1m.OBJDIR
\e[22m' target,
\e[1mbmake
\e[22mchecks
837 that the specified directory is writable and ignores it if not.
838 This check can be skipped by setting the environment variable
839 `MAKE_OBJDIR_CHECK_WRITABLE' to "no".
842 The directory name of the current makefile being parsed.
845 The basename of the current makefile being parsed. This variable
846 and `
\e[4m.PARSEDIR
\e[24m' are both set only while the makefiles are being
847 parsed. To retain their current values, assign them to a vari-
848 able using assignment with expansion `
\e[1m:=
\e[22m'.
850 \e[4m.PATH
\e[24m The space-separated list of directories that
\e[1mbmake
\e[22msearches for
851 files. To update this search list, use the special target
852 `
\e[1m.PATH
\e[22m' rather than modifying the variable directly.
854 \e[4m%POSIX
\e[24m Is set in POSIX mode, see the special `
\e[4m.POSIX
\e[24m' target.
856 \e[4mPWD
\e[24m Alternate path to the current directory.
\e[1mbmake
\e[22mnormally sets
857 `
\e[4m.CURDIR
\e[24m' to the canonical path given by getcwd(3). However, if
858 the environment variable `PWD' is set and gives a path to the
859 current directory,
\e[1mbmake
\e[22msets `
\e[4m.CURDIR
\e[24m' to the value of `PWD' in-
860 stead. This behavior is disabled if `MAKEOBJDIRPREFIX' is set or
861 `MAKEOBJDIR' contains a variable transform. `
\e[4mPWD
\e[24m' is set to the
862 value of `
\e[4m.OBJDIR
\e[24m' for all programs which
\e[1mbmake
\e[22mexecutes.
864 \e[4m.SHELL
\e[24m The pathname of the shell used to run target scripts. It is
868 The list of known suffixes. It is read-only.
871 The space-separated list of directories that
\e[1mbmake
\e[22msearches for
872 makefiles, referred to as the system include path. To update
873 this search list, use the special target `
\e[1m.SYSPATH
\e[22m' rather than
874 modifying the variable which is read-only.
877 The list of targets explicitly specified on the command line, if
880 \e[4mVPATH
\e[24m The colon-separated (":") list of directories that
\e[1mbmake
\e[22msearches
881 for files. This variable is supported for compatibility with old
882 make programs only, use `
\e[4m.PATH
\e[24m' instead.
884 \e[1mVariable modifiers
\e[0m
885 The general format of a variable expansion is:
887 \e[1m${
\e[4m
\e[22mvariable
\e[24m[
\e[1m:
\e[4m
\e[22mmodifier
\e[24m[
\e[1m:
\e[22m...]]
\e[1m}
\e[0m
889 Each modifier begins with a colon. To escape a colon, precede it with a
892 A list of indirect modifiers can be specified via a variable, as follows:
894 \e[4mmodifier_variable
\e[24m =
\e[4mmodifier
\e[24m[
\e[1m:
\e[22m...]
896 \e[1m${
\e[4m
\e[22mvariable
\e[24m
\e[1m:${
\e[4m
\e[22mmodifier_variable
\e[24m
\e[1m}
\e[22m[
\e[1m:
\e[22m...]
\e[1m}
\e[0m
898 In this case, the first modifier in the
\e[4mmodifier_variable
\e[24m does not start
899 with a colon, since that colon already occurs in the referencing vari-
900 able. If any of the modifiers in the
\e[4mmodifier_variable
\e[24m contains a dollar
901 sign (`$'), these must be doubled to avoid early expansion.
903 Some modifiers interpret the expression value as a single string, others
904 treat the expression value as a whitespace-separated list of words. When
905 splitting a string into words, whitespace can be escaped using double
906 quotes, single quotes and backslashes, like in the shell. The quotes and
907 backslashes are retained in the words.
909 The supported modifiers are:
911 \e[1m:E
\e[22mReplaces each word with its suffix.
913 \e[1m:H
\e[22mReplaces each word with its dirname.
915 \e[1m:M
\e[4m
\e[22mpattern
\e[0m
916 Selects only those words that match
\e[4mpattern
\e[24m. The standard shell
917 wildcard characters (`*', `?', and `[]') may be used. The wildcard
918 characters may be escaped with a backslash (`\'). As a consequence
919 of the way values are split into words, matched, and then joined,
920 the construct `${VAR:M*}' removes all leading and trailing white-
921 space and normalizes the inter-word spacing to a single space.
923 \e[1m:N
\e[4m
\e[22mpattern
\e[0m
924 This is the opposite of `
\e[1m:M
\e[22m', selecting all words which do
\e[4mnot
\e[24m match
927 \e[1m:O
\e[22mOrders the words lexicographically.
929 \e[1m:On
\e[22mOrders the words numerically. A number followed by one of `k', `M'
930 or `G' is multiplied by the appropriate factor, which is 1024 for
931 `k', 1048576 for `M', or 1073741824 for `G'. Both upper- and lower-
932 case letters are accepted.
934 \e[1m:Or
\e[22mOrders the words in reverse lexicographical order.
937 Orders the words in reverse numerical order.
939 \e[1m:Ox
\e[22mShuffles the words. The results are different each time you are re-
940 ferring to the modified variable; use the assignment with expansion
941 `
\e[1m:=
\e[22m' to prevent such behavior. For example,
943 LIST= uno due tre quattro
944 RANDOM_LIST= ${LIST:Ox}
945 STATIC_RANDOM_LIST:= ${LIST:Ox}
948 @echo "${RANDOM_LIST}"
949 @echo "${RANDOM_LIST}"
950 @echo "${STATIC_RANDOM_LIST}"
951 @echo "${STATIC_RANDOM_LIST}"
952 may produce output similar to:
959 \e[1m:Q
\e[22mQuotes every shell meta-character in the value, so that it can be
960 passed safely to the shell.
962 \e[1m:q
\e[22mQuotes every shell meta-character in the value, and also doubles `$'
963 characters so that it can be passed safely through recursive invoca-
964 tions of
\e[1mbmake
\e[22m. This is equivalent to `
\e[1m:S/\$/&&/g:Q
\e[22m'.
966 \e[1m:R
\e[22mReplaces each word with everything but its suffix.
968 \e[1m:range
\e[22m[
\e[1m=
\e[4m
\e[22mcount
\e[24m]
969 The value is an integer sequence representing the words of the orig-
970 inal value, or the supplied
\e[4mcount
\e[24m.
972 \e[1m:gmtime
\e[22m[
\e[1m=
\e[4m
\e[22mtimestamp
\e[24m]
973 The value is interpreted as a format string for strftime(3), using
974 gmtime(3), producing the formatted timestamp. If a
\e[4mtimestamp
\e[24m value
975 is not provided or is 0, the current time is used.
978 Computes a 32-bit hash of the value and encodes it as 8 hex digits.
980 \e[1m:localtime
\e[22m[
\e[1m=
\e[4m
\e[22mtimestamp
\e[24m]
981 The value is interpreted as a format string for strftime(3), using
982 localtime(3), producing the formatted timestamp. If a
\e[4mtimestamp
\e[0m
983 value is not provided or is 0, the current time is used.
985 \e[1m:tA
\e[22mAttempts to convert the value to an absolute path using realpath(3).
986 If that fails, the value is unchanged.
988 \e[1m:tl
\e[22mConverts the value to lower-case letters.
990 \e[1m:ts
\e[4m
\e[22mc
\e[0m
991 When joining the words after a modifier that treats the value as
992 words, the words are normally separated by a space. This modifier
993 changes the separator to the character
\e[4mc
\e[24m. If
\e[4mc
\e[24m is omitted, no sepa-
994 rator is used. The common escapes (including octal numeric codes)
997 \e[1m:tu
\e[22mConverts the value to upper-case letters.
999 \e[1m:tW
\e[22mCauses subsequent modifiers to treat the value as a single word
1000 (possibly containing embedded whitespace). See also `
\e[1m:[*]
\e[22m'.
1002 \e[1m:tw
\e[22mCauses the value to be treated as a list of words. See also `
\e[1m:[@]
\e[22m'.
1004 \e[1m:S
\e[22m/
\e[4mold_string
\e[24m/
\e[4mnew_string
\e[24m/[
\e[1m1gW
\e[22m]
1005 Modifies the first occurrence of
\e[4mold_string
\e[24m in each word of the
1006 value, replacing it with
\e[4mnew_string
\e[24m. If a `g' is appended to the
1007 last delimiter of the pattern, all occurrences in each word are re-
1008 placed. If a `1' is appended to the last delimiter of the pattern,
1009 only the first occurrence is affected. If a `W' is appended to the
1010 last delimiter of the pattern, the value is treated as a single
1011 word. If
\e[4mold_string
\e[24m begins with a caret (`^'),
\e[4mold_string
\e[24m is an-
1012 chored at the beginning of each word. If
\e[4mold_string
\e[24m ends with a
1013 dollar sign (`$'), it is anchored at the end of each word. Inside
1014 \e[4mnew_string
\e[24m, an ampersand (`&') is replaced by
\e[4mold_string
\e[24m (without
1015 the anchoring `^' or `$'). Any character may be used as the delim-
1016 iter for the parts of the modifier string. The anchoring, ampersand
1017 and delimiter characters can be escaped with a backslash (`\').
1019 Both
\e[4mold_string
\e[24m and
\e[4mnew_string
\e[24m may contain nested expressions. To
1020 prevent a dollar sign from starting a nested expression, escape it
1023 \e[1m:C
\e[22m/
\e[4mpattern
\e[24m/
\e[4mreplacement
\e[24m/[
\e[1m1gW
\e[22m]
1024 The
\e[1m:C
\e[22mmodifier works like the
\e[1m:S
\e[22mmodifier except that the old and
1025 new strings, instead of being simple strings, are an extended regu-
1026 lar expression
\e[4mpattern
\e[24m (see regex(3)) and an ed(1)-style
1027 \e[4mreplacement
\e[24m. Normally, the first occurrence of the pattern
\e[4mpattern
\e[0m
1028 in each word of the value is substituted with
\e[4mreplacement
\e[24m. The `1'
1029 modifier causes the substitution to apply to at most one word; the
1030 `g' modifier causes the substitution to apply to as many instances
1031 of the search pattern
\e[4mpattern
\e[24m as occur in the word or words it is
1032 found in; the `W' modifier causes the value to be treated as a sin-
1033 gle word (possibly containing embedded whitespace).
1035 As for the
\e[1m:S
\e[22mmodifier, the
\e[4mpattern
\e[24m and
\e[4mreplacement
\e[24m are subjected to
1036 variable expansion before being parsed as regular expressions.
1038 \e[1m:T
\e[22mReplaces each word with its last path component (basename).
1040 \e[1m:u
\e[22mRemoves adjacent duplicate words (like uniq(1)).
1042 \e[1m:?
\e[4m
\e[22mtrue_string
\e[24m
\e[1m:
\e[4m
\e[22mfalse_string
\e[0m
1043 If the variable name (not its value), when parsed as a
\e[1m.if
\e[22mcondi-
1044 tional expression, evaluates to true, return as its value the
1045 \e[4mtrue_string
\e[24m, otherwise return the
\e[4mfalse_string
\e[24m. Since the variable
1046 name is used as the expression, :? must be the first modifier after
1047 the variable name itself--which, of course, usually contains vari-
1048 able expansions. A common error is trying to use expressions like
1049 ${NUMBERS:M42:?match:no}
1050 which actually tests defined(NUMBERS). To determine if any words
1051 match "42", you need to use something like:
1052 ${"${NUMBERS:M42}" != "":?match:no}.
1054 \e[1m:
\e[4m
\e[22mold_string
\e[24m
\e[1m=
\e[4m
\e[22mnew_string
\e[0m
1055 This is the AT&T System V UNIX style substitution. It can only be
1056 the last modifier specified, as a `:' in either
\e[4mold_string
\e[24m or
1057 \e[4mnew_string
\e[24m is treated as a regular character, not as the end of the
1060 If
\e[4mold_string
\e[24m does not contain the pattern matching character `%',
1061 and the word ends with
\e[4mold_string
\e[24m or equals it, that suffix is re-
1062 placed with
\e[4mnew_string
\e[24m.
1064 Otherwise, the first `%' in
\e[4mold_string
\e[24m matches a possibly empty sub-
1065 string of arbitrary characters, and if the whole pattern is found in
1066 the word, the matching part is replaced with
\e[4mnew_string
\e[24m, and the
1067 first occurrence of `%' in
\e[4mnew_string
\e[24m (if any) is replaced with the
1068 substring matched by the `%'.
1070 Both
\e[4mold_string
\e[24m and
\e[4mnew_string
\e[24m may contain nested expressions. To
1071 prevent a dollar sign from starting a nested expression, escape it
1074 \e[1m:@
\e[4m
\e[22mvarname
\e[24m
\e[1m@
\e[4m
\e[22mstring
\e[24m
\e[1m@
\e[0m
1075 This is the loop expansion mechanism from the OSF Development Envi-
1076 ronment (ODE) make. Unlike
\e[1m.for
\e[22mloops, expansion occurs at the time
1077 of reference. For each word in the value, assign the word to the
1078 variable named
\e[4mvarname
\e[24m and evaluate
\e[4mstring
\e[24m. The ODE convention is
1079 that
\e[4mvarname
\e[24m should start and end with a period, for example:
1080 ${LINKS:@.LINK.@${LN} ${TARGET} ${.LINK.}@}
1082 However, a single-letter variable is often more readable:
1083 ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}
1085 \e[1m:_
\e[22m[
\e[1m=
\e[4m
\e[22mvar
\e[24m]
1086 Saves the current variable value in `$_' or the named
\e[4mvar
\e[24m for later
1087 reference. Example usage:
1089 M_cmpv.units = 1 1000 1000000
1090 M_cmpv = S,., ,g:_:range:@i@+ $${_:[-$$i]} \
1091 \* $${M_cmpv.units:[$$i]}@:S,^,expr 0 ,1:sh
1093 .if ${VERSION:${M_cmpv}} < ${3.1.12:L:${M_cmpv}}
1095 Here `$_' is used to save the result of the `:S' modifier which is
1096 later referenced using the index values from `:range'.
1098 \e[1m:U
\e[4m
\e[22mnewval
\e[0m
1099 If the variable is undefined,
\e[4mnewval
\e[24m is the value. If the variable
1100 is defined, the existing value is returned. This is another ODE
1101 make feature. It is handy for setting per-target CFLAGS for in-
1103 ${_${.TARGET:T}_CFLAGS:U${DEF_CFLAGS}}
1104 If a value is only required if the variable is undefined, use:
1107 \e[1m:D
\e[4m
\e[22mnewval
\e[0m
1108 If the variable is defined,
\e[4mnewval
\e[24m is the value.
1110 \e[1m:L
\e[22mThe name of the variable is the value.
1112 \e[1m:P
\e[22mThe path of the node which has the same name as the variable is the
1113 value. If no such node exists or its path is null, the name of the
1114 variable is used. In order for this modifier to work, the name
1115 (node) must at least have appeared on the right-hand side of a de-
1118 \e[1m:!
\e[4m
\e[22mcmd
\e[24m
\e[1m!
\e[0m
1119 The output of running
\e[4mcmd
\e[24m is the value.
1121 \e[1m:sh
\e[22mThe value is run as a command, and the output becomes the new value.
1123 \e[1m::=
\e[4m
\e[22mstr
\e[0m
1124 The variable is assigned the value
\e[4mstr
\e[24m after substitution. This
1125 modifier and its variations are useful in obscure situations such as
1126 wanting to set a variable at a point where a target's shell commands
1127 are being parsed. These assignment modifiers always expand to noth-
1130 The `
\e[1m::
\e[22m' helps avoid false matches with the AT&T System V UNIX style
1131 `:=' modifier and since substitution always occurs, the `::=' form
1132 is vaguely appropriate.
1134 \e[1m::?=
\e[4m
\e[22mstr
\e[0m
1135 As for
\e[1m::=
\e[22mbut only if the variable does not already have a value.
1137 \e[1m::+=
\e[4m
\e[22mstr
\e[0m
1138 Append
\e[4mstr
\e[24m to the variable.
1140 \e[1m::!=
\e[4m
\e[22mcmd
\e[0m
1141 Assign the output of
\e[4mcmd
\e[24m to the variable.
1143 \e[1m:[
\e[4m
\e[22mrange
\e[24m
\e[1m]
\e[0m
1144 Selects one or more words from the value, or performs other opera-
1145 tions related to the way in which the value is split into words.
1147 An empty value, or a value that consists entirely of white-space, is
1148 treated as a single word. For the purposes of the `
\e[1m:[]
\e[22m' modifier,
1149 the words are indexed both forwards using positive integers (where
1150 index 1 represents the first word), and backwards using negative in-
1151 tegers (where index -1 represents the last word).
1153 The
\e[4mrange
\e[24m is subjected to variable expansion, and the expanded re-
1154 sult is then interpreted as follows:
1156 \e[4mindex
\e[24m Selects a single word from the value.
1158 \e[4mstart
\e[24m
\e[1m..
\e[4m
\e[22mend
\e[0m
1159 Selects all words from
\e[4mstart
\e[24m to
\e[4mend
\e[24m, inclusive. For example,
1160 `
\e[1m:[2..-1]
\e[22m' selects all words from the second word to the last
1161 word. If
\e[4mstart
\e[24m is greater than
\e[4mend
\e[24m, the words are output in
1162 reverse order. For example, `
\e[1m:[-1..1]
\e[22m' selects all the words
1163 from last to first. If the list is already ordered, this ef-
1164 fectively reverses the list, but it is more efficient to use
1165 `
\e[1m:Or
\e[22m' instead of `
\e[1m:O:[-1..1]
\e[22m'.
1167 \e[1m*
\e[22mCauses subsequent modifiers to treat the value as a single
1168 word (possibly containing embedded whitespace). Analogous to
1169 the effect of $* in Bourne shell.
1171 0 Means the same as `
\e[1m:[*]
\e[22m'.
1173 \e[1m@
\e[22mCauses subsequent modifiers to treat the value as a sequence
1174 of words delimited by whitespace. Analogous to the effect of
1177 \e[1m#
\e[22mReturns the number of words in the value.
1179 \e[1mDIRECTIVES
\e[0m
1180 \e[1mbmake
\e[22moffers directives for including makefiles, conditionals and for
1181 loops. All these directives are identified by a line beginning with a
1182 single dot (`.') character, followed by the keyword of the directive,
1183 such as
\e[1minclude
\e[22mor
\e[1mif
\e[22m.
1185 \e[1mFile inclusion
\e[0m
1186 Files are included with either
\e[1m.include <
\e[4m
\e[22mfile
\e[24m
\e[1m>
\e[22mor
\e[1m.include "
\e[4m
\e[22mfile
\e[24m
\e[1m"
\e[22m. Vari-
1187 ables between the angle brackets or double quotes are expanded to form
1188 the file name. If angle brackets are used, the included makefile is ex-
1189 pected to be in the system makefile directory. If double quotes are
1190 used, the including makefile's directory and any directories specified
1191 using the
\e[1m-I
\e[22moption are searched before the system makefile directory.
1193 For compatibility with other make variants, `
\e[1minclude
\e[4m
\e[22mfile
\e[24m ...' (without
1194 leading dot) is also accepted.
1196 If the include statement is written as
\e[1m.-include
\e[22mor as
\e[1m.sinclude
\e[22m, errors
1197 locating and/or opening include files are ignored.
1199 If the include statement is written as
\e[1m.dinclude
\e[22m, not only are errors lo-
1200 cating and/or opening include files ignored, but stale dependencies
1201 within the included file are ignored just like in
\e[4m.MAKE.DEPENDFILE
\e[24m.
1203 \e[1mExporting variables
\e[0m
1204 The directives for exporting and unexporting variables are:
1206 \e[1m.export
\e[4m
\e[22mvariable
\e[24m ...
1207 Export the specified global variable. If no variable list is
1208 provided, all globals are exported except for internal variables
1209 (those that start with `.'). This is not affected by the
\e[1m-X
\e[0m
1210 flag, so should be used with caution. For compatibility with
1211 other make programs,
\e[1mexport
\e[4m
\e[22mvariable
\e[24m
\e[1m=
\e[4m
\e[22mvalue
\e[24m (without leading dot)
1214 Appending a variable name to
\e[4m.MAKE.EXPORTED
\e[24m is equivalent to ex-
1217 \e[1m.export-env
\e[4m
\e[22mvariable
\e[24m ...
1218 The same as `.export', except that the variable is not appended
1219 to
\e[4m.MAKE.EXPORTED
\e[24m. This allows exporting a value to the environ-
1220 ment which is different from that used by
\e[1mbmake
\e[22minternally.
1222 \e[1m.export-literal
\e[4m
\e[22mvariable
\e[24m ...
1223 The same as `.export-env', except that variables in the value are
1226 \e[1m.unexport
\e[4m
\e[22mvariable
\e[24m ...
1227 The opposite of `.export'. The specified global
\e[4mvariable
\e[24m is re-
1228 moved from
\e[4m.MAKE.EXPORTED
\e[24m. If no variable list is provided, all
1229 globals are unexported, and
\e[4m.MAKE.EXPORTED
\e[24m deleted.
1231 \e[1m.unexport-env
\e[0m
1232 Unexport all globals previously exported and clear the environ-
1233 ment inherited from the parent. This operation causes a memory
1234 leak of the original environment, so should be used sparingly.
1235 Testing for
\e[4m.MAKE.LEVEL
\e[24m being 0 would make sense. Also note that
1236 any variables which originated in the parent environment should
1237 be explicitly preserved if desired. For example:
1239 .if ${.MAKE.LEVEL} == 0
1245 Would result in an environment containing only `PATH', which is
1246 the minimal useful environment. Actually `
\e[4m.MAKE.LEVEL
\e[24m' is also
1247 pushed into the new environment.
1250 The directives for printing messages to the output are:
1252 \e[1m.info
\e[4m
\e[22mmessage
\e[0m
1253 The message is printed along with the name of the makefile and
1256 \e[1m.warning
\e[4m
\e[22mmessage
\e[0m
1257 The message prefixed by `warning:' is printed along with the name
1258 of the makefile and line number.
1260 \e[1m.error
\e[4m
\e[22mmessage
\e[0m
1261 The message is printed along with the name of the makefile and
1262 line number,
\e[1mbmake
\e[22mexits immediately.
1264 \e[1mConditionals
\e[0m
1265 The directives for conditionals are:
1267 \e[1m.if
\e[22m[
\e[1m!
\e[22m]
\e[4mexpression
\e[24m [
\e[4moperator
\e[24m
\e[4mexpression
\e[24m ...]
1268 Test the value of an expression.
1270 \e[1m.ifdef
\e[22m[
\e[1m!
\e[22m]
\e[4mvariable
\e[24m [
\e[4moperator
\e[24m
\e[4mvariable
\e[24m ...]
1271 Test whether a variable is defined.
1273 \e[1m.ifndef
\e[22m[
\e[1m!
\e[22m]
\e[4mvariable
\e[24m [
\e[4moperator
\e[24m
\e[4mvariable
\e[24m ...]
1274 Test whether a variable is not defined.
1276 \e[1m.ifmake
\e[22m[
\e[1m!
\e[22m]
\e[4mtarget
\e[24m [
\e[4moperator
\e[24m
\e[4mtarget
\e[24m ...]
1277 Test the target being requested.
1279 \e[1m.ifnmake
\e[22m[
\e[1m!
\e[22m]
\e[4mtarget
\e[24m [
\e[4moperator
\e[24m
\e[4mtarget
\e[24m ...]
1280 Test the target being requested.
1282 \e[1m.else
\e[22mReverse the sense of the last conditional.
1284 \e[1m.elif
\e[22m[
\e[1m!
\e[22m]
\e[4mexpression
\e[24m [
\e[4moperator
\e[24m
\e[4mexpression
\e[24m ...]
1285 A combination of `
\e[1m.else
\e[22m' followed by `
\e[1m.if
\e[22m'.
1287 \e[1m.elifdef
\e[22m[
\e[1m!
\e[22m]
\e[4mvariable
\e[24m [
\e[4moperator
\e[24m
\e[4mvariable
\e[24m ...]
1288 A combination of `
\e[1m.else
\e[22m' followed by `
\e[1m.ifdef
\e[22m'.
1290 \e[1m.elifndef
\e[22m[
\e[1m!
\e[22m]
\e[4mvariable
\e[24m [
\e[4moperator
\e[24m
\e[4mvariable
\e[24m ...]
1291 A combination of `
\e[1m.else
\e[22m' followed by `
\e[1m.ifndef
\e[22m'.
1293 \e[1m.elifmake
\e[22m[
\e[1m!
\e[22m]
\e[4mtarget
\e[24m [
\e[4moperator
\e[24m
\e[4mtarget
\e[24m ...]
1294 A combination of `
\e[1m.else
\e[22m' followed by `
\e[1m.ifmake
\e[22m'.
1296 \e[1m.elifnmake
\e[22m[
\e[1m!
\e[22m]
\e[4mtarget
\e[24m [
\e[4moperator
\e[24m
\e[4mtarget
\e[24m ...]
1297 A combination of `
\e[1m.else
\e[22m' followed by `
\e[1m.ifnmake
\e[22m'.
1299 \e[1m.endif
\e[22mEnd the body of the conditional.
1301 The
\e[4moperator
\e[24m may be any one of the following:
1303 \e[1m||
\e[22mLogical OR.
1305 \e[1m&&
\e[22mLogical AND; of higher precedence than `
\e[1m||
\e[22m'.
1307 \e[1mbmake
\e[22monly evaluates a conditional as far as is necessary to determine
1308 its value. Parentheses can be used to override the operator precedence.
1309 The boolean operator `
\e[1m!
\e[22m' may be used to logically negate an entire condi-
1310 tional. It is of higher precedence than `
\e[1m&&
\e[22m'.
1312 The value of
\e[4mexpression
\e[24m may be any of the following function call expres-
1315 \e[1mdefined
\e[22m(
\e[4mvarname
\e[24m)
1316 Evaluates to true if the variable
\e[4mvarname
\e[24m has been defined.
1318 \e[1mmake
\e[22m(
\e[4mtarget
\e[24m)
1319 Evaluates to true if the target was specified as part of
\e[1mbmake
\e[22m's
1320 command line or was declared the default target (either implic-
1321 itly or explicitly, see
\e[4m.MAIN
\e[24m) before the line containing the
1324 \e[1mempty
\e[22m(
\e[4mvarname
\e[24m[:
\e[4mmodifiers
\e[24m])
1325 Evaluates to true if the expansion of the variable, after apply-
1326 ing the modifiers, results in an empty string.
1328 \e[1mexists
\e[22m(
\e[4mpathname
\e[24m)
1329 Evaluates to true if the given pathname exists. If relative, the
1330 pathname is searched for on the system search path (see
\e[4m.PATH
\e[24m).
1332 \e[1mtarget
\e[22m(
\e[4mtarget
\e[24m)
1333 Evaluates to true if the target has been defined.
1335 \e[1mcommands
\e[22m(
\e[4mtarget
\e[24m)
1336 Evaluates to true if the target has been defined and has commands
1339 \e[4mExpression
\e[24m may also be an arithmetic or string comparison. Variable ex-
1340 pansion is performed on both sides of the comparison. If both sides are
1341 numeric and neither is enclosed in quotes, the comparison is done numeri-
1342 cally, otherwise lexicographically. A string is interpreted as hexadeci-
1343 mal integer if it is preceded by 0x, otherwise it is a decimal floating-
1344 point number; octal numbers are not supported.
1346 All comparisons may use the operators `
\e[1m==
\e[22m' and `
\e[1m!=
\e[22m'. Numeric comparisons
1347 may also use the operators `
\e[1m<
\e[22m', `
\e[1m<=
\e[22m', `
\e[1m>
\e[22m' and `
\e[1m>=
\e[22m'.
1349 If the comparison has neither a comparison operator nor a right side, the
1350 expression evaluates to true if it is nonempty and its numeric value (if
1353 When
\e[1mbmake
\e[22mis evaluating one of these conditional expressions, and it en-
1354 counters a (whitespace separated) word it doesn't recognize, either the
1355 "make" or "defined" function is applied to it, depending on the form of
1356 the conditional. If the form is `
\e[1m.ifdef
\e[22m', `
\e[1m.ifndef
\e[22m' or `
\e[1m.if
\e[22m', the
1357 "defined" function is applied. Similarly, if the form is `
\e[1m.ifmake
\e[22m' or
1358 `
\e[1m.ifnmake
\e[22m', the "make" function is applied.
1360 If the conditional evaluates to true, parsing of the makefile continues
1361 as before. If it evaluates to false, the following lines are skipped.
1362 In both cases, this continues until the corresponding `
\e[1m.else
\e[22m' or `
\e[1m.endif
\e[22m'
1366 For loops are typically used to apply a set of rules to a list of files.
1367 The syntax of a for loop is:
1369 \e[1m.for
\e[4m
\e[22mvariable
\e[24m [
\e[4mvariable
\e[24m ...]
\e[1min
\e[4m
\e[22mexpression
\e[0m
1370 <
\e[4mmake-lines
\e[24m>
1373 The
\e[4mexpression
\e[24m is expanded and then split into words. On each iteration
1374 of the loop, one word is taken and assigned to each
\e[4mvariable
\e[24m, in order,
1375 and these
\e[4mvariables
\e[24m are substituted into the
\e[4mmake-lines
\e[24m inside the body
1376 of the for loop. The number of words must come out even; that is, if
1377 there are three iteration variables, the number of words provided must be
1378 a multiple of three.
1380 If `
\e[1m.break
\e[22m' is encountered within a
\e[1m.for
\e[22mloop, it causes early termina-
1381 tion of the loop, otherwise a parse error.
1383 \e[1mOther directives
\e[0m
1384 \e[1m.undef
\e[4m
\e[22mvariable
\e[24m ...
1385 Un-define the specified global variables. Only global variables
1389 Comments begin with a hash (`#') character, anywhere but in a shell com-
1390 mand line, and continue to the end of an unescaped new line.
1392 \e[1mSPECIAL SOURCES (ATTRIBUTES)
\e[0m
1393 \e[1m.EXEC
\e[22mTarget is never out of date, but always execute commands any-
1396 \e[1m.IGNORE
\e[22mIgnore any errors from the commands associated with this tar-
1397 get, exactly as if they all were preceded by a dash (`-').
1399 \e[1m.MADE
\e[22mMark all sources of this target as being up to date.
1401 \e[1m.MAKE
\e[22mExecute the commands associated with this target even if the
\e[1m-n
\e[0m
1402 or
\e[1m-t
\e[22moptions were specified. Normally used to mark recursive
1405 \e[1m.META
\e[22mCreate a meta file for the target, even if it is flagged as
1406 \e[1m.PHONY
\e[22m,
\e[1m.MAKE
\e[22m, or
\e[1m.SPECIAL
\e[22m. Usage in conjunction with
\e[1m.MAKE
\e[22mis
1407 the most likely case. In "meta" mode, the target is out-of-
1408 date if the meta file is missing.
1410 \e[1m.NOMETA
\e[22mDo not create a meta file for the target. Meta files are also
1411 not created for
\e[1m.PHONY
\e[22m,
\e[1m.MAKE
\e[22m, or
\e[1m.SPECIAL
\e[22mtargets.
1413 \e[1m.NOMETA_CMP
\e[0m
1414 Ignore differences in commands when deciding if target is out
1415 of date. This is useful if the command contains a value which
1416 always changes. If the number of commands change, though, the
1417 target is still considered out of date. The same effect ap-
1418 plies to any command line that uses the variable
\e[4m.OODATE
\e[24m, which
1419 can be used for that purpose even when not otherwise needed or
1423 skip-compare-for-some:
1424 @echo this is compared
1425 @echo this is not ${.OODATE:M.NOMETA_CMP}
1426 @echo this is also compared
1428 The
\e[1m:M
\e[22mpattern suppresses any expansion of the unwanted vari-
1431 \e[1m.NOPATH
\e[22mDo not search for the target in the directories specified by
1434 \e[1m.NOTMAIN
\e[22mNormally
\e[1mbmake
\e[22mselects the first target it encounters as the
1435 default target to be built if no target was specified. This
1436 source prevents this target from being selected.
1439 If a target is marked with this attribute and
\e[1mbmake
\e[22mcan't fig-
1440 ure out how to create it, it ignores this fact and assumes the
1441 file isn't needed or already exists.
1443 \e[1m.PHONY
\e[22mThe target does not correspond to an actual file; it is always
1444 considered to be out of date, and is not created with the
\e[1m-t
\e[0m
1445 option. Suffix-transformation rules are not applied to
\e[1m.PHONY
\e[0m
1449 When
\e[1mbmake
\e[22mis interrupted, it normally removes any partially
1450 made targets. This source prevents the target from being re-
1453 \e[1m.RECURSIVE
\e[0m
1454 Synonym for
\e[1m.MAKE
\e[22m.
1456 \e[1m.SILENT
\e[22mDo not echo any of the commands associated with this target,
1457 exactly as if they all were preceded by an at sign (`@').
1459 \e[1m.USE
\e[22mTurn the target into
\e[1mbmake
\e[22m's version of a macro. When the tar-
1460 get is used as a source for another target, the other target
1461 acquires the commands, sources, and attributes (except for
1462 \e[1m.USE
\e[22m) of the source. If the target already has commands, the
1463 \e[1m.USE
\e[22mtarget's commands are appended to them.
1465 \e[1m.USEBEFORE
\e[0m
1466 Like
\e[1m.USE
\e[22m, but instead of appending, prepend the
\e[1m.USEBEFORE
\e[0m
1467 target commands to the target.
1469 \e[1m.WAIT
\e[22mIf
\e[1m.WAIT
\e[22mappears in a dependency line, the sources that precede
1470 it are made before the sources that succeed it in the line.
1471 Since the dependents of files are not made until the file it-
1472 self could be made, this also stops the dependents being built
1473 unless they are needed for another branch of the dependency
1485 the output is always `a', `b1', `b', `x'.
1487 The ordering imposed by
\e[1m.WAIT
\e[22mis only relevant for parallel
1490 \e[1mSPECIAL TARGETS
\e[0m
1491 Special targets may not be included with other targets, i.e. they must be
1492 the only target specified.
1494 \e[1m.BEGIN
\e[22mAny command lines attached to this target are executed before
1495 anything else is done.
1498 This is sort of a
\e[1m.USE
\e[22mrule for any target (that was used only
1499 as a source) that
\e[1mbmake
\e[22mcan't figure out any other way to cre-
1500 ate. Only the shell script is used. The
\e[4m.IMPSRC
\e[24m variable of a
1501 target that inherits
\e[1m.DEFAULT
\e[22m's commands is set to the target's
1504 \e[1m.DELETE_ON_ERROR
\e[0m
1505 If this target is present in the makefile, it globally causes
1506 make to delete targets whose commands fail. (By default, only
1507 targets whose commands are interrupted during execution are
1508 deleted. This is the historical behavior.) This setting can be
1509 used to help prevent half-finished or malformed targets from be-
1510 ing left around and corrupting future rebuilds.
1512 \e[1m.END
\e[22mAny command lines attached to this target are executed after ev-
1513 erything else is done successfully.
1515 \e[1m.ERROR
\e[22mAny command lines attached to this target are executed when an-
1516 other target fails. The
\e[4m.ERROR_TARGET
\e[24m variable is set to the
1517 target that failed. See also
\e[4mMAKE_PRINT_VAR_ON_ERROR
\e[24m.
1519 \e[1m.IGNORE
\e[22mMark each of the sources with the
\e[1m.IGNORE
\e[22mattribute. If no
1520 sources are specified, this is the equivalent of specifying the
1521 \e[1m-i
\e[22moption.
1523 \e[1m.INTERRUPT
\e[0m
1524 If
\e[1mbmake
\e[22mis interrupted, the commands for this target are exe-
1527 \e[1m.MAIN
\e[22mIf no target is specified when
\e[1mbmake
\e[22mis invoked, this target is
1530 \e[1m.MAKEFLAGS
\e[0m
1531 This target provides a way to specify flags for
\e[1mbmake
\e[22mat the
1532 time when the makefiles are read. The flags are as if typed to
1533 the shell, though the
\e[1m-f
\e[22moption has no effect.
1535 \e[1m.NOPATH
\e[22mApply the
\e[1m.NOPATH
\e[22mattribute to any specified sources.
1537 \e[1m.NOTPARALLEL
\e[0m
1538 Disable parallel mode.
1540 \e[1m.NO_PARALLEL
\e[0m
1541 Synonym for
\e[1m.NOTPARALLEL
\e[22m, for compatibility with other pmake
1544 \e[1m.NOREADONLY
\e[0m
1545 clear the read-only attribute from the global variables speci-
1548 \e[1m.OBJDIR
\e[22mThe source is a new value for `
\e[4m.OBJDIR
\e[24m'. If it exists,
\e[1mbmake
\e[0m
1549 changes the current working directory to it and updates the
1550 value of `
\e[4m.OBJDIR
\e[24m'.
1552 \e[1m.ORDER
\e[22mIn parallel mode, the named targets are made in sequence. This
1553 ordering does not add targets to the list of targets to be made.
1555 Since the dependents of a target do not get built until the tar-
1556 get itself could be built, unless `a' is built by another part
1557 of the dependency graph, the following is a dependency loop:
1562 \e[1m.PATH
\e[22mThe sources are directories which are to be searched for files
1563 not found in the current directory. If no sources are speci-
1564 fied, any previously specified directories are removed from the
1565 search path. If the source is the special
\e[1m.DOTLAST
\e[22mtarget, the
1566 current working directory is searched last.
1568 \e[1m.PATH.
\e[4m
\e[22msuffix
\e[0m
1569 Like
\e[1m.PATH
\e[22mbut applies only to files with a particular suffix.
1570 The suffix must have been previously declared with
\e[1m.SUFFIXES
\e[22m.
1572 \e[1m.PHONY
\e[22mApply the
\e[1m.PHONY
\e[22mattribute to any specified sources.
1574 \e[1m.POSIX
\e[22mIf this is the first non-comment line in the main makefile, the
1575 variable
\e[4m%POSIX
\e[24m is set to the value `1003.2' and the makefile
1576 `<posix.mk>' is included if it exists, to provide POSIX-compati-
1577 ble default rules. If
\e[1mbmake
\e[22mis run with the
\e[1m-r
\e[22mflag, only
1578 `posix.mk' contributes to the default rules.
1581 Apply the
\e[1m.PRECIOUS
\e[22mattribute to any specified sources. If no
1582 sources are specified, the
\e[1m.PRECIOUS
\e[22mattribute is applied to ev-
1583 ery target in the file.
1586 set the read-only attribute on the global variables specified as
1589 \e[1m.SHELL
\e[22mSets the shell that
\e[1mbmake
\e[22muses to execute commands in jobs mode.
1590 The sources are a set of
\e[4mfield
\e[24m
\e[1m=
\e[4m
\e[22mvalue
\e[24m pairs.
1592 name This is the minimal specification, used to select
1593 one of the built-in shell specs; sh, ksh, and csh.
1595 path Specifies the absolute path to the shell.
1597 hasErrCtl Indicates whether the shell supports exit on error.
1599 check The command to turn on error checking.
1601 ignore The command to disable error checking.
1603 echo The command to turn on echoing of commands executed.
1605 quiet The command to turn off echoing of commands exe-
1608 filter The output to filter after issuing the quiet com-
1609 mand. It is typically identical to quiet.
1611 errFlag The flag to pass the shell to enable error checking.
1613 echoFlag The flag to pass the shell to enable command echo-
1616 newline The string literal to pass the shell that results in
1617 a single newline character when used outside of any
1621 .SHELL: name=ksh path=/bin/ksh hasErrCtl=true \
1622 check="set -e" ignore="set +e" \
1623 echo="set -v" quiet="set +v" filter="set +v" \
1624 echoFlag=v errFlag=e newline="'\n'"
1626 \e[1m.SILENT
\e[22mApply the
\e[1m.SILENT
\e[22mattribute to any specified sources. If no
1627 sources are specified, the
\e[1m.SILENT
\e[22mattribute is applied to every
1628 command in the file.
1630 \e[1m.STALE
\e[22mThis target gets run when a dependency file contains stale en-
1631 tries, having
\e[4m.ALLSRC
\e[24m set to the name of that dependency file.
1634 Each source specifies a suffix to
\e[1mbmake
\e[22m. If no sources are
1635 specified, any previously specified suffixes are deleted. It
1636 allows the creation of suffix-transformation rules.
1642 cc -o ${.TARGET} -c ${.IMPSRC}
1645 The sources are directories which are to be added to the system
1646 include path which
\e[1mbmake
\e[22msearches for makefiles. If no sources
1647 are specified, any previously specified directories are removed
1648 from the system include path.
1650 \e[1mENVIRONMENT
\e[0m
1651 \e[1mbmake
\e[22muses the following environment variables, if they exist: MACHINE,
1652 MACHINE_ARCH, MAKE, MAKEFLAGS, MAKEOBJDIR, MAKEOBJDIRPREFIX, MAKESYSPATH,
1655 MAKEOBJDIRPREFIX and MAKEOBJDIR may only be set in the environment or on
1656 the command line to
\e[1mbmake
\e[22mand not as makefile variables; see the descrip-
1657 tion of `
\e[4m.OBJDIR
\e[24m' for more details.
1660 .depend list of dependencies
1661 makefile first default makefile if no makefile is specified on the
1663 Makefile second default makefile if no makefile is specified on the
1665 sys.mk system makefile
1666 /usr/share/mk system makefile directory
1668 \e[1mCOMPATIBILITY
\e[0m
1669 The basic make syntax is compatible between different make variants; how-
1670 ever the special variables, variable modifiers and conditionals are not.
1672 \e[1mOlder versions
\e[0m
1673 An incomplete list of changes in older versions of
\e[1mbmake
\e[22m:
1675 The way that .for loop variables are substituted changed after NetBSD 5.0
1676 so that they still appear to be variable expansions. In particular this
1677 stops them being treated as syntax, and removes some obscure problems us-
1678 ing them in .if statements.
1680 The way that parallel makes are scheduled changed in NetBSD 4.0 so that
1681 .ORDER and .WAIT apply recursively to the dependent nodes. The algo-
1682 rithms used may change again in the future.
1684 \e[1mOther make dialects
\e[0m
1685 Other make dialects (GNU make, SVR4 make, POSIX make, etc.) do not sup-
1686 port most of the features of
\e[1mbmake
\e[22mas described in this manual. Most no-
1689 \e[1m+
\bo
\e[22mThe
\e[1m.WAIT
\e[22mand
\e[1m.ORDER
\e[22mdeclarations and most functionality per-
1690 taining to parallelization. (GNU make supports parallelization
1691 but lacks the features needed to control it effectively.)
1693 \e[1m+
\bo
\e[22mDirectives, including for loops and conditionals and most of
1694 the forms of include files. (GNU make has its own incompatible
1695 and less powerful syntax for conditionals.)
1697 \e[1m+
\bo
\e[22mAll built-in variables that begin with a dot.
1699 \e[1m+
\bo
\e[22mMost of the special sources and targets that begin with a dot,
1700 with the notable exception of
\e[1m.PHONY
\e[22m,
\e[1m.PRECIOUS
\e[22m, and
\e[1m.SUFFIXES
\e[22m.
1702 \e[1m+
\bo
\e[22mVariable modifiers, except for the `:old=new' string substitu-
1703 tion, which does not portably support globbing with `%' and
1704 historically only works on declared suffixes.
1706 \e[1m+
\bo
\e[22mThe
\e[1m$>
\e[22mvariable even in its short form; most makes support this
1707 functionality but its name varies.
1709 Some features are somewhat more portable, such as assignment with
\e[1m+=
\e[22m,
\e[1m?=
\e[22m,
1710 and
\e[1m!=
\e[22m. The
\e[4m.PATH
\e[24m functionality is based on an older feature
\e[1mVPATH
\e[22mfound
1711 in GNU make and many versions of SVR4 make; however, historically its be-
1712 havior is too ill-defined (and too buggy) to rely upon.
1714 The
\e[1m$@
\e[22mand
\e[1m$<
\e[22mvariables are more or less universally portable, as is the
1715 \e[1m$(MAKE)
\e[22mvariable. Basic use of suffix rules (for files only in the cur-
1716 rent directory, not trying to chain transformations together, etc.) is
1717 also reasonably portable.
1723 \e[1mbmake
\e[22mis derived from NetBSD make(1). It uses autoconf to facilitate
1724 portability to other platforms.
1726 A make command appeared in Version 7 AT&T UNIX. This make implementation
1727 is based on Adam de Boor's pmake program, which was written for Sprite at
1728 Berkeley. It was designed to be a parallel distributed make running jobs
1729 on different machines using a daemon called "customs".
1731 Historically the target/dependency
\e[1mFRC
\e[22mhas been used to FoRCe rebuilding
1732 (since the target/dependency does not exist ... unless someone creates an
1733 \e[4mFRC
\e[24m file).
1736 The make syntax is difficult to parse. For instance, finding the end of
1737 a variable's use should involve scanning each of the modifiers, using the
1738 correct terminator for each field. In many places make just counts {}
1739 and () in order to find the end of a variable expansion.
1741 There is no way of escaping a space character in a filename.
1743 FreeBSD 13.0 January 26, 2023 FreeBSD 13.0