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