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