]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - contrib/bmake/bmake.1
sqlite3: Vendor import of sqlite3 3.40.0
[FreeBSD/FreeBSD.git] / contrib / bmake / bmake.1
1 .\"     $NetBSD: make.1,v 1.315 2022/07/12 23:47:00 rillig Exp $
2 .\"
3 .\" Copyright (c) 1990, 1993
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the University nor the names of its contributors
15 .\"    may be used to endorse or promote products derived from this software
16 .\"    without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\"     from: @(#)make.1        8.4 (Berkeley) 3/19/94
31 .\"
32 .Dd July 12, 2022
33 .Dt BMAKE 1
34 .Os
35 .Sh NAME
36 .Nm bmake
37 .Nd maintain program dependencies
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl BeikNnqrSstWwX
41 .Op Fl C Ar directory
42 .Op Fl D Ar variable
43 .Op Fl d Ar flags
44 .Op Fl f Ar makefile
45 .Op Fl I Ar directory
46 .Op Fl J Ar private
47 .Op Fl j Ar max_jobs
48 .Op Fl m Ar directory
49 .Op Fl T Ar file
50 .Op Fl V Ar variable
51 .Op Fl v Ar variable
52 .Op Ar variable=value
53 .Op Ar target ...
54 .Sh DESCRIPTION
55 .Nm
56 is a program designed to simplify the maintenance of other programs.
57 Its input is a list of specifications as to the files upon which programs
58 and other files depend.
59 If no
60 .Fl f Ar makefile
61 makefile option is given,
62 .Nm
63 will try to open
64 .Sq Pa makefile
65 then
66 .Sq Pa Makefile
67 in order to find the specifications.
68 If the file
69 .Sq Pa .depend
70 exists, it is read (see
71 .Xr mkdep 1 ) .
72 .Pp
73 This manual page is intended as a reference document only.
74 For a more thorough description of
75 .Nm
76 and makefiles, please refer to
77 .%T "PMake \- A Tutorial" .
78 .Pp
79 .Nm
80 will prepend the contents of the
81 .Va MAKEFLAGS
82 environment variable to the command line arguments before parsing them.
83 .Pp
84 The options are as follows:
85 .Bl -tag -width Ds
86 .It Fl B
87 Try to be backwards compatible by executing a single shell per command and
88 by executing the commands to make the sources of a dependency line in sequence.
89 .It Fl C Ar directory
90 Change to
91 .Ar directory
92 before reading the makefiles or doing anything else.
93 If multiple
94 .Fl C
95 options are specified, each is interpreted relative to the previous one:
96 .Fl C Pa / Fl C Pa etc
97 is equivalent to
98 .Fl C Pa /etc .
99 .It Fl D Ar variable
100 Define
101 .Ar variable
102 to be 1, in the global scope.
103 .It Fl d Ar [-]flags
104 Turn on debugging, and specify which portions of
105 .Nm
106 are to print debugging information.
107 Unless the flags are preceded by
108 .Ql \-
109 they are added to the
110 .Va MAKEFLAGS
111 environment variable and will be processed by any child make processes.
112 By default, debugging information is printed to standard error,
113 but this can be changed using the
114 .Ar F
115 debugging flag.
116 The debugging output is always unbuffered; in addition, if debugging
117 is enabled but debugging output is not directed to standard output,
118 then the standard output is line buffered.
119 .Ar Flags
120 is one or more of the following:
121 .Bl -tag -width Ds
122 .It Ar A
123 Print all possible debugging information;
124 equivalent to specifying all of the debugging flags.
125 .It Ar a
126 Print debugging information about archive searching and caching.
127 .It Ar C
128 Print debugging information about current working directory.
129 .It Ar c
130 Print debugging information about conditional evaluation.
131 .It Ar d
132 Print debugging information about directory searching and caching.
133 .It Ar e
134 Print debugging information about failed commands and targets.
135 .It Ar F Ns Oo Sy \&+ Oc Ns Ar filename
136 Specify where debugging output is written.
137 This must be the last flag, because it consumes the remainder of
138 the argument.
139 If the character immediately after the
140 .Ql F
141 flag is
142 .Ql \&+ ,
143 then the file will be opened in append mode;
144 otherwise the file will be overwritten.
145 If the file name is
146 .Ql stdout
147 or
148 .Ql stderr
149 then debugging output will be written to the
150 standard output or standard error output file descriptors respectively
151 (and the
152 .Ql \&+
153 option has no effect).
154 Otherwise, the output will be written to the named file.
155 If the file name ends
156 .Ql .%d
157 then the
158 .Ql %d
159 is replaced by the pid.
160 .It Ar f
161 Print debugging information about loop evaluation.
162 .It Ar "g1"
163 Print the input graph before making anything.
164 .It Ar "g2"
165 Print the input graph after making everything, or before exiting
166 on error.
167 .It Ar "g3"
168 Print the input graph before exiting on error.
169 .It Ar h
170 Print debugging information about hash table operations.
171 .It Ar j
172 Print debugging information about running multiple shells.
173 .It Ar L
174 Turn on lint checks.
175 This will throw errors for variable assignments that do not parse
176 correctly, at the time of assignment so the file and line number
177 are available.
178 .It Ar l
179 Print commands in Makefiles regardless of whether or not they are prefixed by
180 .Ql @
181 or other "quiet" flags.
182 Also known as "loud" behavior.
183 .It Ar M
184 Print debugging information about "meta" mode decisions about targets.
185 .It Ar m
186 Print debugging information about making targets, including modification
187 dates.
188 .It Ar n
189 Don't delete the temporary command scripts created when running commands.
190 These temporary scripts are created in the directory
191 referred to by the
192 .Ev TMPDIR
193 environment variable, or in
194 .Pa /tmp
195 if
196 .Ev TMPDIR
197 is unset or set to the empty string.
198 The temporary scripts are created by
199 .Xr mkstemp 3 ,
200 and have names of the form
201 .Pa makeXXXXXX .
202 .Em NOTE :
203 This can create many files in
204 .Ev TMPDIR
205 or
206 .Pa /tmp ,
207 so use with care.
208 .It Ar p
209 Print debugging information about makefile parsing.
210 .It Ar s
211 Print debugging information about suffix-transformation rules.
212 .It Ar t
213 Print debugging information about target list maintenance.
214 .It Ar V
215 Force the
216 .Fl V
217 option to print raw values of variables, overriding the default behavior
218 set via
219 .Va .MAKE.EXPAND_VARIABLES .
220 .It Ar v
221 Print debugging information about variable assignment.
222 .It Ar x
223 Run shell commands with
224 .Fl x
225 so the actual commands are printed as they are executed.
226 .El
227 .It Fl e
228 Specify that environment variables override macro assignments within
229 makefiles.
230 .It Fl f Ar makefile
231 Specify a makefile to read instead of the default
232 .Sq Pa makefile .
233 If
234 .Ar makefile
235 is
236 .Sq Fl ,
237 standard input is read.
238 Multiple makefiles may be specified, and are read in the order specified.
239 .It Fl I Ar directory
240 Specify a directory in which to search for makefiles and included makefiles.
241 The system makefile directory (or directories, see the
242 .Fl m
243 option) is automatically included as part of this list.
244 .It Fl i
245 Ignore non-zero exit of shell commands in the makefile.
246 Equivalent to specifying
247 .Sq Fl
248 before each command line in the makefile.
249 .It Fl J Ar private
250 This option should
251 .Em not
252 be specified by the user.
253 .Pp
254 When the
255 .Fl j
256 option is in use in a recursive build, this option is passed by a make
257 to child makes to allow all the make processes in the build to
258 cooperate to avoid overloading the system.
259 .It Fl j Ar max_jobs
260 Specify the maximum number of jobs that
261 .Nm
262 may have running at any one time.
263 The value is saved in
264 .Va .MAKE.JOBS .
265 Turns compatibility mode off, unless the
266 .Fl B
267 option is also specified.
268 When compatibility mode is off, all commands associated with a
269 target are executed in a single shell invocation as opposed to the
270 traditional one shell invocation per line.
271 This can break traditional scripts which change directories on each
272 command invocation and then expect to start with a fresh environment
273 on the next line.
274 It is more efficient to correct the scripts rather than turn backwards
275 compatibility on.
276 .It Fl k
277 Continue processing after errors are encountered, but only on those targets
278 that do not depend on the target whose creation caused the error.
279 .It Fl m Ar directory
280 Specify a directory in which to search for sys.mk and makefiles included
281 via the
282 .Li \&< Ns Ar file Ns Li \&> Ns -style
283 include statement.
284 The
285 .Fl m
286 option can be used multiple times to form a search path.
287 This path will override the default system include path: /usr/share/mk.
288 Furthermore the system include path will be appended to the search path used
289 for
290 .Li \*q Ns Ar file Ns Li \*q Ns -style
291 include statements (see the
292 .Fl I
293 option).
294 .Pp
295 If a file or directory name in the
296 .Fl m
297 argument (or the
298 .Ev MAKESYSPATH
299 environment variable) starts with the string
300 .Qq \&.../
301 then
302 .Nm
303 will search for the specified file or directory named in the remaining part
304 of the argument string.
305 The search starts with the current directory of
306 the Makefile and then works upward towards the root of the file system.
307 If the search is successful, then the resulting directory replaces the
308 .Qq \&.../
309 specification in the
310 .Fl m
311 argument.
312 If used, this feature allows
313 .Nm
314 to easily search in the current source tree for customized sys.mk files
315 (e.g., by using
316 .Qq \&.../mk/sys.mk
317 as an argument).
318 .It Fl n
319 Display the commands that would have been executed, but do not
320 actually execute them unless the target depends on the .MAKE special
321 source (see below) or the command is prefixed with
322 .Sq Ic + .
323 .It Fl N
324 Display the commands which would have been executed, but do not
325 actually execute any of them; useful for debugging top-level makefiles
326 without descending into subdirectories.
327 .It Fl q
328 Do not execute any commands, but exit 0 if the specified targets are
329 up-to-date and 1, otherwise.
330 .It Fl r
331 Do not use the built-in rules specified in the system makefile.
332 .It Fl S
333 Stop processing if an error is encountered.
334 This is the default behavior and the opposite of
335 .Fl k .
336 .It Fl s
337 Do not echo any commands as they are executed.
338 Equivalent to specifying
339 .Sq Ic @
340 before each command line in the makefile.
341 .It Fl T Ar tracefile
342 When used with the
343 .Fl j
344 flag,
345 append a trace record to
346 .Ar tracefile
347 for each job started and completed.
348 .It Fl t
349 Rather than re-building a target as specified in the makefile, create it
350 or update its modification time to make it appear up-to-date.
351 .It Fl V Ar variable
352 Print the value of
353 .Ar variable .
354 Do not build any targets.
355 Multiple instances of this option may be specified;
356 the variables will be printed one per line,
357 with a blank line for each null or undefined variable.
358 The value printed is extracted from the global scope after all
359 makefiles have been read.
360 By default, the raw variable contents (which may
361 include additional unexpanded variable references) are shown.
362 If
363 .Ar variable
364 contains a
365 .Ql \&$
366 then the value will be recursively expanded to its complete resultant
367 text before printing.
368 The expanded value will also be printed if
369 .Va .MAKE.EXPAND_VARIABLES
370 is set to true and
371 the
372 .Fl dV
373 option has not been used to override it.
374 Note that loop-local and target-local variables, as well as values
375 taken temporarily by global variables during makefile processing, are
376 not accessible via this option.
377 The
378 .Fl dv
379 debug mode can be used to see these at the cost of generating
380 substantial extraneous output.
381 .It Fl v Ar variable
382 Like
383 .Fl V
384 but the variable is always expanded to its complete value.
385 .It Fl W
386 Treat any warnings during makefile parsing as errors.
387 .It Fl w
388 Print entering and leaving directory messages, pre and post processing.
389 .It Fl X
390 Don't export variables passed on the command line to the environment
391 individually.
392 Variables passed on the command line are still exported
393 via the
394 .Va MAKEFLAGS
395 environment variable.
396 This option may be useful on systems which have a small limit on the
397 size of command arguments.
398 .It Ar variable=value
399 Set the value of the variable
400 .Ar variable
401 to
402 .Ar value .
403 Normally, all values passed on the command line are also exported to
404 sub-makes in the environment.
405 The
406 .Fl X
407 flag disables this behavior.
408 Variable assignments should follow options for POSIX compatibility
409 but no ordering is enforced.
410 .El
411 .Pp
412 There are seven different types of lines in a makefile: file dependency
413 specifications, shell commands, variable assignments, include statements,
414 conditional directives, for loops, and comments.
415 .Pp
416 In general, lines may be continued from one line to the next by ending
417 them with a backslash
418 .Pq Ql \e .
419 The trailing newline character and initial whitespace on the following
420 line are compressed into a single space.
421 .Sh FILE DEPENDENCY SPECIFICATIONS
422 Dependency lines consist of one or more targets, an operator, and zero
423 or more sources.
424 This creates a relationship where the targets
425 .Dq depend
426 on the sources
427 and are customarily created from them.
428 A target is considered out-of-date if it does not exist, or if its
429 modification time is less than that of any of its sources.
430 An out-of-date target will be re-created, but not until all sources
431 have been examined and themselves re-created as needed.
432 Three operators may be used:
433 .Bl -tag -width flag
434 .It Ic \&:
435 Many dependency lines may name this target but only one may have
436 attached shell commands.
437 All sources named in all dependency lines are considered together,
438 and if needed the attached shell commands are run to create or
439 re-create the target.
440 If
441 .Nm
442 is interrupted, the target is removed.
443 .It Ic \&!
444 The same, but the target is always re-created whether or not it is out
445 of date.
446 .It Ic \&::
447 Any dependency line may have attached shell commands, but each one
448 is handled independently: its sources are considered and the attached
449 shell commands are run if the target is out of date with respect to
450 (only) those sources.
451 Thus, different groups of the attached shell commands may be run
452 depending on the circumstances.
453 Furthermore, unlike
454 .Ic \&:,
455 for dependency lines with no sources, the attached shell
456 commands are always run.
457 Also unlike
458 .Ic \&:,
459 the target will not be removed if
460 .Nm
461 is interrupted.
462 .El
463 All dependency lines mentioning a particular target must use the same
464 operator.
465 .Pp
466 Targets and sources may contain the shell wildcard values
467 .Ql \&? ,
468 .Ql * ,
469 .Ql [] ,
470 and
471 .Ql {} .
472 The values
473 .Ql \&? ,
474 .Ql * ,
475 and
476 .Ql []
477 may only be used as part of the final
478 component of the target or source, and must be used to describe existing
479 files.
480 The value
481 .Ql {}
482 need not necessarily be used to describe existing files.
483 Expansion is in directory order, not alphabetically as done in the shell.
484 .Sh SHELL COMMANDS
485 Each target may have associated with it one or more lines of shell
486 commands, normally
487 used to create the target.
488 Each of the lines in this script
489 .Em must
490 be preceded by a tab.
491 (For historical reasons, spaces are not accepted.)
492 While targets can appear in many dependency lines if desired, by
493 default only one of these rules may be followed by a creation
494 script.
495 If the
496 .Sq Ic \&::
497 operator is used, however, all rules may include scripts and the
498 scripts are executed in the order found.
499 .Pp
500 Each line is treated as a separate shell command, unless the end of
501 line is escaped with a backslash
502 .Pq Ql \e
503 in which case that line and the next are combined.
504 .\" The escaped newline is retained and passed to the shell, which
505 .\" normally ignores it.
506 .\" However, the tab at the beginning of the following line is removed.
507 If the first characters of the command are any combination of
508 .Sq Ic @ ,
509 .Sq Ic + ,
510 or
511 .Sq Ic \- ,
512 the command is treated specially.
513 A
514 .Sq Ic @
515 causes the command not to be echoed before it is executed.
516 A
517 .Sq Ic +
518 causes the command to be executed even when
519 .Fl n
520 is given.
521 This is similar to the effect of the .MAKE special source,
522 except that the effect can be limited to a single line of a script.
523 A
524 .Sq Ic \-
525 in compatibility mode
526 causes any non-zero exit status of the command line to be ignored.
527 .Pp
528 When
529 .Nm
530 is run in jobs mode with
531 .Fl j Ar max_jobs ,
532 the entire script for the target is fed to a
533 single instance of the shell.
534 In compatibility (non-jobs) mode, each command is run in a separate process.
535 If the command contains any shell meta characters
536 .Pq Ql #=|^(){};&<>*?[]:$`\e\en
537 it will be passed to the shell; otherwise
538 .Nm
539 will attempt direct execution.
540 If a line starts with
541 .Sq Ic \-
542 and the shell has ErrCtl enabled then failure of the command line
543 will be ignored as in compatibility mode.
544 Otherwise
545 .Sq Ic \-
546 affects the entire job;
547 the script will stop at the first command line that fails,
548 but the target will not be deemed to have failed.
549 .Pp
550 Makefiles should be written so that the mode of
551 .Nm
552 operation does not change their behavior.
553 For example, any command which needs to use
554 .Dq cd
555 or
556 .Dq chdir
557 without potentially changing the directory for subsequent commands
558 should be put in parentheses so it executes in a subshell.
559 To force the use of one shell, escape the line breaks so as to make
560 the whole script one command.
561 For example:
562 .Bd -literal -offset indent
563 avoid-chdir-side-effects:
564         @echo Building $@ in `pwd`
565         @(cd ${.CURDIR} && ${MAKE} $@)
566         @echo Back in `pwd`
567
568 ensure-one-shell-regardless-of-mode:
569         @echo Building $@ in `pwd`; \e
570         (cd ${.CURDIR} && ${MAKE} $@); \e
571         echo Back in `pwd`
572 .Ed
573 .Pp
574 Since
575 .Nm
576 will
577 .Xr chdir 2
578 to
579 .Sq Va .OBJDIR
580 before executing any targets, each child process
581 starts with that as its current working directory.
582 .Sh VARIABLE ASSIGNMENTS
583 Variables in make behave much like macros in the C preprocessor.
584 .Pp
585 Variable assignments have the form
586 .Sq Ar NAME Ar op Ar value ,
587 where:
588 .Bl -tag -width Ds
589 .It Ar NAME
590 is a single-word variable name,
591 consisting, by tradition, of all upper-case letters,
592 .It Ar op
593 is one of the five variable assignment operators described below, and
594 .It Ar value
595 is interpreted according to the variable assignment operator.
596 .El
597 .Pp
598 Whitespace around
599 .Ar NAME ,
600 .Ar op
601 and
602 .Ar value
603 is discarded.
604 .Ss Variable assignment operators
605 The five operators that can be used to assign values to variables are:
606 .Bl -tag -width Ds
607 .It Ic \&=
608 Assign the value to the variable.
609 Any previous value is overwritten.
610 .It Ic \&+=
611 Append the value to the current value of the variable,
612 separating them by a single space.
613 .It Ic \&?=
614 Assign the value to the variable if it is not already defined.
615 .It Ic \&:=
616 Assign with expansion, i.e. expand the value before assigning it
617 to the variable.
618 Normally, expansion is not done until the variable is referenced.
619 .Pp
620 .Em NOTE :
621 References to undefined variables are
622 .Em not
623 expanded.
624 This can cause problems when variable modifiers are used.
625 .It Ic \&!=
626 Expand the value and pass it to the shell for execution and assign
627 the result to the variable.
628 Any newlines in the result are replaced with spaces.
629 .El
630 .Ss Expansion of variables
631 In contexts where variables are expanded,
632 .Ql \&$$
633 expands to a single dollar sign.
634 References to variables have the form
635 .Ql \&${ Ns Ar name Ns Oo \&: Ns Ar modifiers Oc Ns }
636 or
637 .Ql \&$( Ns Ar name Ns Oo \&: Ns Ar modifiers Oc Ns ) .
638 If the variable name contains only a single character,
639 the surrounding curly braces or parentheses are not required.
640 This shorter form is not recommended.
641 .Pp
642 If the variable name contains a dollar, then the name itself is expanded first.
643 This allows almost arbitrary variable names, however names containing dollar,
644 braces, parentheses, or whitespace are really best avoided.
645 .Pp
646 If the result of expanding a variable contains a dollar sign
647 .Pq Ql \&$ ,
648 the string is expanded again.
649 .Pp
650 Variable substitution occurs at four distinct times, depending on where
651 the variable is being used.
652 .Bl -enum
653 .It
654 Variables in dependency lines are expanded as the line is read.
655 .It
656 Variables in conditionals are expanded individually,
657 but only as far as necessary to determine the result of the conditional.
658 .It
659 Variables in shell commands are expanded when the shell command is
660 executed.
661 .It
662 .Dq .for
663 loop index variables are expanded on each loop iteration.
664 Note that other variables are not expanded when composing the body of a loop,
665 so the following example code:
666 .Bd -literal -offset indent
667
668 .Dv .for i in 1 2 3
669 a+=     ${i}
670 j=      ${i}
671 b+=     ${j}
672 .Dv .endfor
673
674 all:
675         @echo ${a}
676         @echo ${b}
677
678 .Ed
679 will print:
680 .Bd -literal -offset indent
681 1 2 3
682 3 3 3
683
684 .Ed
685 Because while ${a} contains
686 .Dq 1 2 3
687 after the loop is executed, ${b}
688 contains
689 .Dq ${j} ${j} ${j}
690 which expands to
691 .Dq 3 3 3
692 since after the loop completes ${j} contains
693 .Dq 3 .
694 .El
695 .Ss Variable classes
696 The four different classes of variables (in order of increasing precedence)
697 are:
698 .Bl -tag -width Ds
699 .It Environment variables
700 Variables defined as part of
701 .Nm Ns 's
702 environment.
703 .It Global variables
704 Variables defined in the makefile or in included makefiles.
705 .It Command line variables
706 Variables defined as part of the command line.
707 .It Local variables
708 Variables that are defined specific to a certain target.
709 .El
710 .Pp
711 Local variables can be set on a dependency line, if
712 .Va .MAKE.TARGET_LOCAL_VARIABLES
713 is not set to
714 .Ql false .
715 The rest of the line
716 (which will already have had global variables expanded)
717 is the variable value.
718 For example:
719 .Bd -literal -offset indent
720 COMPILER_WRAPPERS= ccache distcc icecc
721
722 ${OBJS}: .MAKE.META.CMP_FILTER=${COMPILER_WRAPPERS:S,^,N,}
723 .Ed
724 .Pp
725 Only the targets
726 .Ql ${OBJS}
727 will be impacted by that filter (in "meta" mode) and
728 simply enabling/disabling any of the compiler wrappers will not render all
729 of those targets out-of-date.
730 .Pp
731 .Em NOTE :
732 target-local variable assignments behave differently in that;
733 .Bl -tag -width Ds -offset indent
734 .It Ic \&+=
735 Only appends to a previous local assignment
736 for the same target and variable.
737 .It Ic \&:=
738 Is redundant with respect to global variables,
739 which have already been expanded.
740 .El
741 .Pp
742 The seven built-in local variables are as follows:
743 .Bl -tag -width ".ARCHIVE" -offset indent
744 .It Va .ALLSRC
745 The list of all sources for this target; also known as
746 .Sq Va \&> .
747 .It Va .ARCHIVE
748 The name of the archive file; also known as
749 .Sq Va \&! .
750 .It Va .IMPSRC
751 In suffix-transformation rules, the name/path of the source from which the
752 target is to be transformed (the
753 .Dq implied
754 source); also known as
755 .Sq Va \&< .
756 It is not defined in explicit rules.
757 .It Va .MEMBER
758 The name of the archive member; also known as
759 .Sq Va % .
760 .It Va .OODATE
761 The list of sources for this target that were deemed out-of-date; also
762 known as
763 .Sq Va \&? .
764 .It Va .PREFIX
765 The file prefix of the target, containing only the file portion, no suffix
766 or preceding directory components; also known as
767 .Sq Va * .
768 The suffix must be one of the known suffixes declared with
769 .Ic .SUFFIXES
770 or it will not be recognized.
771 .It Va .TARGET
772 The name of the target; also known as
773 .Sq Va @ .
774 For compatibility with other makes this is an alias for
775 .Ic .ARCHIVE
776 in archive member rules.
777 .El
778 .Pp
779 The shorter forms
780 .Ql ( Va > ,
781 .Sq Va \&! ,
782 .Sq Va < ,
783 .Sq Va % ,
784 .Sq Va \&? ,
785 .Sq Va * ,
786 and
787 .Sq Va @ )
788 are permitted for backward
789 compatibility with historical makefiles and legacy POSIX make and are
790 not recommended.
791 .Pp
792 Variants of these variables with the punctuation followed immediately by
793 .Ql D
794 or
795 .Ql F ,
796 e.g.\&
797 .Sq Va $(@D) ,
798 are legacy forms equivalent to using the
799 .Ql :H
800 and
801 .Ql :T
802 modifiers.
803 These forms are accepted for compatibility with
804 .At V
805 makefiles and POSIX but are not recommended.
806 .Pp
807 Four of the local variables may be used in sources on dependency lines
808 because they expand to the proper value for each target on the line.
809 These variables are
810 .Sq Va .TARGET ,
811 .Sq Va .PREFIX ,
812 .Sq Va .ARCHIVE ,
813 and
814 .Sq Va .MEMBER .
815 .Ss Additional built-in variables
816 In addition,
817 .Nm
818 sets or knows about the following variables:
819 .Bl -tag -width .MAKEOVERRIDES
820 .It Va .ALLTARGETS
821 The list of all targets encountered in the Makefile.
822 If evaluated during
823 Makefile parsing, lists only those targets encountered thus far.
824 .It Va .CURDIR
825 A path to the directory where
826 .Nm
827 was executed.
828 Refer to the description of
829 .Sq Ev PWD
830 for more details.
831 .It Va .INCLUDEDFROMDIR
832 The directory of the file this Makefile was included from.
833 .It Va .INCLUDEDFROMFILE
834 The filename of the file this Makefile was included from.
835 .It Ev MAKE
836 The name that
837 .Nm
838 was executed with
839 .Pq Va argv[0] .
840 For compatibility
841 .Nm
842 also sets
843 .Va .MAKE
844 with the same value.
845 The preferred variable to use is the environment variable
846 .Ev MAKE
847 because it is more compatible with other versions of
848 .Nm
849 and cannot be confused with the special target with the same name.
850 .It Va .MAKE.DEPENDFILE
851 Names the makefile (default
852 .Sq Pa .depend )
853 from which generated dependencies are read.
854 .It Va .MAKE.EXPAND_VARIABLES
855 A boolean that controls the default behavior of the
856 .Fl V
857 option.
858 If true, variable values printed with
859 .Fl V
860 are fully expanded; if false, the raw variable contents (which may
861 include additional unexpanded variable references) are shown.
862 .It Va .MAKE.EXPORTED
863 The list of variables exported by
864 .Nm .
865 .It Va .MAKE.JOBS
866 The argument to the
867 .Fl j
868 option.
869 .It Va .MAKE.JOB.PREFIX
870 If
871 .Nm
872 is run with
873 .Fl j ,
874 the output for each target is prefixed with a token
875 .Ql --- target ---
876 the first part of which can be controlled via
877 .Va .MAKE.JOB.PREFIX .
878 If
879 .Va .MAKE.JOB.PREFIX
880 is empty, no token is printed.
881 For example, setting
882 .Va .MAKE.JOB.PREFIX
883 to
884 .Li ${.newline}---${.MAKE:T}[${.MAKE.PID}]
885 would produce tokens like
886 .Ql ---make[1234] target ---
887 making it easier to track the degree of parallelism being achieved.
888 .It .MAKE.TARGET_LOCAL_VARIABLES
889 If set to
890 .Ql false ,
891 apparent variable assignments in dependency lines are
892 treated as normal sources.
893 .It Ev MAKEFLAGS
894 The environment variable
895 .Sq Ev MAKEFLAGS
896 may contain anything that
897 may be specified on
898 .Nm Ns 's
899 command line.
900 Anything specified on
901 .Nm Ns 's
902 command line is appended to the
903 .Sq Ev MAKEFLAGS
904 variable which is then
905 entered into the environment for all programs which
906 .Nm
907 executes.
908 .It Va .MAKE.LEVEL
909 The recursion depth of
910 .Nm .
911 The initial instance of
912 .Nm
913 will be 0, and an incremented value is put into the environment
914 to be seen by the next generation.
915 This allows tests like:
916 .Li .if ${.MAKE.LEVEL} == 0
917 to protect things which should only be evaluated in the initial instance of
918 .Nm .
919 .It Va .MAKE.MAKEFILE_PREFERENCE
920 The ordered list of makefile names
921 (default
922 .Sq Pa makefile ,
923 .Sq Pa Makefile )
924 that
925 .Nm
926 will look for.
927 .It Va .MAKE.MAKEFILES
928 The list of makefiles read by
929 .Nm ,
930 which is useful for tracking dependencies.
931 Each makefile is recorded only once, regardless of the number of times read.
932 .It Va .MAKE.MODE
933 Processed after reading all makefiles.
934 Can affect the mode that
935 .Nm
936 runs in.
937 It can contain a number of keywords:
938 .Bl -hang -width missing-filemon=bf.
939 .It Pa compat
940 Like
941 .Fl B ,
942 puts
943 .Nm
944 into "compat" mode.
945 .It Pa meta
946 Puts
947 .Nm
948 into "meta" mode, where meta files are created for each target
949 to capture the command run, the output generated and if
950 .Xr filemon 4
951 is available, the system calls which are of interest to
952 .Nm .
953 The captured output can be very useful when diagnosing errors.
954 .It Pa curdirOk= Ar bf
955 Normally
956 .Nm
957 will not create .meta files in
958 .Sq Va .CURDIR .
959 This can be overridden by setting
960 .Va bf
961 to a value which represents True.
962 .It Pa missing-meta= Ar bf
963 If
964 .Va bf
965 is True, then a missing .meta file makes the target out-of-date.
966 .It Pa missing-filemon= Ar bf
967 If
968 .Va bf
969 is True, then missing filemon data makes the target out-of-date.
970 .It Pa nofilemon
971 Do not use
972 .Xr filemon 4 .
973 .It Pa env
974 For debugging, it can be useful to include the environment
975 in the .meta file.
976 .It Pa verbose
977 If in "meta" mode, print a clue about the target being built.
978 This is useful if the build is otherwise running silently.
979 The message printed the value of:
980 .Va .MAKE.META.PREFIX .
981 .It Pa ignore-cmd
982 Some makefiles have commands which are simply not stable.
983 This keyword causes them to be ignored for
984 determining whether a target is out of date in "meta" mode.
985 See also
986 .Ic .NOMETA_CMP .
987 .It Pa silent= Ar bf
988 If
989 .Va bf
990 is True, when a .meta file is created, mark the target
991 .Ic .SILENT .
992 .It Pa randomize-targets
993 In both compat and parallel mode, do not make the targets in the usual order,
994 but instead randomize their order.
995 This mode can be used to detect undeclared dependencies between files.
996 .El
997 .It Va .MAKE.META.BAILIWICK
998 In "meta" mode, provides a list of prefixes which
999 match the directories controlled by
1000 .Nm .
1001 If a file that was generated outside of
1002 .Va .OBJDIR
1003 but within said bailiwick is missing,
1004 the current target is considered out-of-date.
1005 .It Va .MAKE.META.CMP_FILTER
1006 In "meta" mode, it can (very rarely!) be useful to filter command
1007 lines before comparison.
1008 This variable can be set to a set of modifiers that will be applied to
1009 each line of the old and new command that differ, if the filtered
1010 commands still differ, the target is considered out-of-date.
1011 .It Va .MAKE.META.CREATED
1012 In "meta" mode, this variable contains a list of all the meta files
1013 updated.
1014 If not empty, it can be used to trigger processing of
1015 .Va .MAKE.META.FILES .
1016 .It Va .MAKE.META.FILES
1017 In "meta" mode, this variable contains a list of all the meta files
1018 used (updated or not).
1019 This list can be used to process the meta files to extract dependency
1020 information.
1021 .It Va .MAKE.META.IGNORE_PATHS
1022 Provides a list of path prefixes that should be ignored;
1023 because the contents are expected to change over time.
1024 The default list includes:
1025 .Sq Pa /dev /etc /proc /tmp /var/run /var/tmp
1026 .It Va .MAKE.META.IGNORE_PATTERNS
1027 Provides a list of patterns to match against pathnames.
1028 Ignore any that match.
1029 .It Va .MAKE.META.IGNORE_FILTER
1030 Provides a list of variable modifiers to apply to each pathname.
1031 Ignore if the expansion is an empty string.
1032 .It Va .MAKE.META.PREFIX
1033 Defines the message printed for each meta file updated in "meta verbose" mode.
1034 The default value is:
1035 .Dl Building ${.TARGET:H:tA}/${.TARGET:T}
1036 .It Va .MAKEOVERRIDES
1037 This variable is used to record the names of variables assigned to
1038 on the command line, so that they may be exported as part of
1039 .Sq Ev MAKEFLAGS .
1040 This behavior can be disabled by assigning an empty value to
1041 .Sq Va .MAKEOVERRIDES
1042 within a makefile.
1043 Extra variables can be exported from a makefile
1044 by appending their names to
1045 .Sq Va .MAKEOVERRIDES .
1046 .Sq Ev MAKEFLAGS
1047 is re-exported whenever
1048 .Sq Va .MAKEOVERRIDES
1049 is modified.
1050 .It Va .MAKE.PATH_FILEMON
1051 If
1052 .Nm
1053 was built with
1054 .Xr filemon 4
1055 support, this is set to the path of the device node.
1056 This allows makefiles to test for this support.
1057 .It Va .MAKE.PID
1058 The process-id of
1059 .Nm .
1060 .It Va .MAKE.PPID
1061 The parent process-id of
1062 .Nm .
1063 .It Va .MAKE.SAVE_DOLLARS
1064 value should be a boolean that controls whether
1065 .Ql $$
1066 are preserved when doing
1067 .Ql :=
1068 assignments.
1069 The default is false, for backwards compatibility.
1070 Set to true for compatability with other makes.
1071 If set to false,
1072 .Ql $$
1073 becomes
1074 .Ql $
1075 per normal evaluation rules.
1076 .It Va .MAKE.UID
1077 The user-id running
1078 .Nm .
1079 .It Va .MAKE.GID
1080 The group-id running
1081 .Nm .
1082 .It Va MAKE_PRINT_VAR_ON_ERROR
1083 When
1084 .Nm
1085 stops due to an error, it sets
1086 .Sq Va .ERROR_TARGET
1087 to the name of the target that failed,
1088 .Sq Va .ERROR_CMD
1089 to the commands of the failed target,
1090 and in "meta" mode, it also sets
1091 .Sq Va .ERROR_CWD
1092 to the
1093 .Xr getcwd 3 ,
1094 and
1095 .Sq Va .ERROR_META_FILE
1096 to the path of the meta file (if any) describing the failed target.
1097 It then prints its name and the value of
1098 .Sq Va .CURDIR
1099 as well as the value of any variables named in
1100 .Sq Va MAKE_PRINT_VAR_ON_ERROR .
1101 .It Va .newline
1102 This variable is simply assigned a newline character as its value.
1103 This allows expansions using the
1104 .Cm \&:@
1105 modifier to put a newline between
1106 iterations of the loop rather than a space.
1107 For example, the printing of
1108 .Sq Va MAKE_PRINT_VAR_ON_ERROR
1109 could be done as ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}.
1110 .It Va .OBJDIR
1111 A path to the directory where the targets are built.
1112 Its value is determined by trying to
1113 .Xr chdir 2
1114 to the following directories in order and using the first match:
1115 .Bl -enum
1116 .It
1117 .Ev ${MAKEOBJDIRPREFIX}${.CURDIR}
1118 .Pp
1119 (Only if
1120 .Sq Ev MAKEOBJDIRPREFIX
1121 is set in the environment or on the command line.)
1122 .It
1123 .Ev ${MAKEOBJDIR}
1124 .Pp
1125 (Only if
1126 .Sq Ev MAKEOBJDIR
1127 is set in the environment or on the command line.)
1128 .It
1129 .Ev ${.CURDIR} Ns Pa /obj. Ns Ev ${MACHINE}
1130 .It
1131 .Ev ${.CURDIR} Ns Pa /obj
1132 .It
1133 .Pa /usr/obj/ Ns Ev ${.CURDIR}
1134 .It
1135 .Ev ${.CURDIR}
1136 .El
1137 .Pp
1138 Variable expansion is performed on the value before it's used,
1139 so expressions such as
1140 .Dl ${.CURDIR:S,^/usr/src,/var/obj,}
1141 may be used.
1142 This is especially useful with
1143 .Sq Ev MAKEOBJDIR .
1144 .Pp
1145 .Sq Va .OBJDIR
1146 may be modified in the makefile via the special target
1147 .Sq Ic .OBJDIR .
1148 In all cases,
1149 .Nm
1150 will
1151 .Xr chdir 2
1152 to the specified directory if it exists, and set
1153 .Sq Va .OBJDIR
1154 and
1155 .Sq Ev PWD
1156 to that directory before executing any targets.
1157 .Pp
1158 Except in the case of an explicit
1159 .Sq Ic .OBJDIR
1160 target,
1161 .Nm
1162 will check that the specified directory is writable and ignore it if not.
1163 This check can be skipped by setting the environment variable
1164 .Sq Ev MAKE_OBJDIR_CHECK_WRITABLE
1165 to "no".
1166 .
1167 .It Va .PARSEDIR
1168 A path to the directory of the current
1169 .Sq Pa Makefile
1170 being parsed.
1171 .It Va .PARSEFILE
1172 The basename of the current
1173 .Sq Pa Makefile
1174 being parsed.
1175 This variable and
1176 .Sq Va .PARSEDIR
1177 are both set only while the
1178 .Sq Pa Makefiles
1179 are being parsed.
1180 If you want to retain their current values, assign them to a variable
1181 using assignment with expansion
1182 .Sq Cm \&:= .
1183 .It Va .PATH
1184 A variable that represents the list of directories that
1185 .Nm
1186 will search for files.
1187 The search list should be updated using the target
1188 .Sq Va .PATH
1189 rather than the variable.
1190 .It Ev PWD
1191 Alternate path to the current directory.
1192 .Nm
1193 normally sets
1194 .Sq Va .CURDIR
1195 to the canonical path given by
1196 .Xr getcwd 3 .
1197 However, if the environment variable
1198 .Sq Ev PWD
1199 is set and gives a path to the current directory, then
1200 .Nm
1201 sets
1202 .Sq Va .CURDIR
1203 to the value of
1204 .Sq Ev PWD
1205 instead.
1206 This behavior is disabled if
1207 .Sq Ev MAKEOBJDIRPREFIX
1208 is set or
1209 .Sq Ev MAKEOBJDIR
1210 contains a variable transform.
1211 .Sq Ev PWD
1212 is set to the value of
1213 .Sq Va .OBJDIR
1214 for all programs which
1215 .Nm
1216 executes.
1217 .It Ev .SHELL
1218 The pathname of the shell used to run target scripts.
1219 It is read-only.
1220 .It Ev .SUFFIXES
1221 The list of known suffixes.
1222 It is read-only.
1223 .It Ev .TARGETS
1224 The list of targets explicitly specified on the command line, if any.
1225 .It Ev VPATH
1226 Colon-separated
1227 .Pq Dq \&:
1228 lists of directories that
1229 .Nm
1230 will search for files.
1231 The variable is supported for compatibility with old make programs only,
1232 use
1233 .Sq Va .PATH
1234 instead.
1235 .El
1236 .Ss Variable modifiers
1237 Variable expansion may be modified to select or modify each word of the
1238 variable (where a
1239 .Dq word
1240 is white-space delimited sequence of characters).
1241 The general format of a variable expansion is as follows:
1242 .Pp
1243 .Dl ${variable[:modifier[:...]]}
1244 .Pp
1245 Each modifier begins with a colon,
1246 which may be escaped with a backslash
1247 .Pq Ql \e .
1248 .Pp
1249 A set of modifiers can be specified via a variable, as follows:
1250 .Pp
1251 .Dl modifier_variable=modifier[:...]
1252 .Dl ${variable:${modifier_variable}[:...]}
1253 .Pp
1254 In this case the first modifier in the modifier_variable does not
1255 start with a colon, since that must appear in the referencing
1256 variable.
1257 If any of the modifiers in the modifier_variable contain a dollar sign
1258 .Pq Ql $ ,
1259 these must be doubled to avoid early expansion.
1260 .Pp
1261 The supported modifiers are:
1262 .Bl -tag -width EEE
1263 .It Cm \&:E
1264 Replaces each word in the variable with its suffix.
1265 .It Cm \&:H
1266 Replaces each word in the variable with everything but the last component.
1267 .It Cm \&:M\| Ns Ar pattern
1268 Selects only those words that match
1269 .Ar pattern .
1270 The standard shell wildcard characters
1271 .Pf ( Ql * ,
1272 .Ql \&? ,
1273 and
1274 .Ql \&[] )
1275 may
1276 be used.
1277 The wildcard characters may be escaped with a backslash
1278 .Pq Ql \e .
1279 As a consequence of the way values are split into words, matched,
1280 and then joined, a construct like
1281 .Dl ${VAR:M*}
1282 will normalize the inter-word spacing, removing all leading and
1283 trailing space, and converting multiple consecutive spaces
1284 to single spaces.
1285 .
1286 .It Cm \&:N\| Ns Ar pattern
1287 This is identical to
1288 .Sq Cm \&:M ,
1289 but selects all words which do not match
1290 .Ar pattern .
1291 .It Cm \&:O
1292 Orders every word in variable alphabetically.
1293 .It Cm \&:On
1294 Orders every word in variable numerically.
1295 A number followed by one of
1296 .Ql k ,
1297 .Ql M
1298 or
1299 .Ql G
1300 is multiplied by the appropriate factor (1024 (k), 1048576 (M), or
1301 1073741824 (G)).
1302 Both upper- and lower-case letters are accepted.
1303 .It Cm \&:Or
1304 Orders every word in variable in reverse alphabetical order.
1305 .It Cm \&:Orn
1306 Orders every word in variable in reverse numerical order.
1307 .It Cm \&:Ox
1308 Shuffles the words in variable.
1309 The results will be different each time you are referring to the
1310 modified variable; use the assignment with expansion
1311 .Sq Cm \&:=
1312 to prevent such behavior.
1313 For example,
1314 .Bd -literal -offset indent
1315 LIST=                   uno due tre quattro
1316 RANDOM_LIST=            ${LIST:Ox}
1317 STATIC_RANDOM_LIST:=    ${LIST:Ox}
1318
1319 all:
1320         @echo "${RANDOM_LIST}"
1321         @echo "${RANDOM_LIST}"
1322         @echo "${STATIC_RANDOM_LIST}"
1323         @echo "${STATIC_RANDOM_LIST}"
1324 .Ed
1325 may produce output similar to:
1326 .Bd -literal -offset indent
1327 quattro due tre uno
1328 tre due quattro uno
1329 due uno quattro tre
1330 due uno quattro tre
1331 .Ed
1332 .It Cm \&:Q
1333 Quotes every shell meta-character in the variable, so that it can be passed
1334 safely to the shell.
1335 .It Cm \&:q
1336 Quotes every shell meta-character in the variable, and also doubles
1337 .Sq $
1338 characters so that it can be passed
1339 safely through recursive invocations of
1340 .Nm .
1341 This is equivalent to:
1342 .Sq \&:S/\e\&$/&&/g:Q .
1343 .It Cm \&:R
1344 Replaces each word in the variable with everything but its suffix.
1345 .It Cm \&:range Ns Oo = Ns Ar count Oc
1346 The value is an integer sequence representing the words of the original
1347 value, or the supplied
1348 .Va count .
1349 .It Cm \&:gmtime Ns Oo = Ns Ar utc Oc
1350 The value is a format string for
1351 .Xr strftime 3 ,
1352 using
1353 .Xr gmtime 3 .
1354 If a
1355 .Va utc
1356 value is not provided or is 0, the current time is used.
1357 .It Cm \&:hash
1358 Computes a 32-bit hash of the value and encode it as hex digits.
1359 .It Cm \&:localtime Ns Oo = Ns Ar utc Oc
1360 The value is a format string for
1361 .Xr strftime 3 ,
1362 using
1363 .Xr localtime 3 .
1364 If a
1365 .Va utc
1366 value is not provided or is 0, the current time is used.
1367 .It Cm \&:tA
1368 Attempts to convert variable to an absolute path using
1369 .Xr realpath 3 ,
1370 if that fails, the value is unchanged.
1371 .It Cm \&:tl
1372 Converts variable to lower-case letters.
1373 .It Cm \&:ts Ns Ar c
1374 Words in the variable are normally separated by a space on expansion.
1375 This modifier sets the separator to the character
1376 .Ar c .
1377 If
1378 .Ar c
1379 is omitted, then no separator is used.
1380 The common escapes (including octal numeric codes) work as expected.
1381 .It Cm \&:tu
1382 Converts variable to upper-case letters.
1383 .It Cm \&:tW
1384 Causes the value to be treated as a single word
1385 (possibly containing embedded white space).
1386 See also
1387 .Sq Cm \&:[*] .
1388 .It Cm \&:tw
1389 Causes the value to be treated as a sequence of
1390 words delimited by white space.
1391 See also
1392 .Sq Cm \&:[@] .
1393 .Sm off
1394 .It Cm \&:S\| No \&/ Ar old_string\| No \&/ Ar new_string\| No \&/ Op Cm 1gW
1395 .Sm on
1396 Modifies the first occurrence of
1397 .Ar old_string
1398 in each word of the variable's value, replacing it with
1399 .Ar new_string .
1400 If a
1401 .Ql g
1402 is appended to the last delimiter of the pattern, all occurrences
1403 in each word are replaced.
1404 If a
1405 .Ql 1
1406 is appended to the last delimiter of the pattern, only the first occurrence
1407 is affected.
1408 If a
1409 .Ql W
1410 is appended to the last delimiter of the pattern,
1411 then the value is treated as a single word
1412 (possibly containing embedded white space).
1413 If
1414 .Ar old_string
1415 begins with a caret
1416 .Pq Ql ^ ,
1417 .Ar old_string
1418 is anchored at the beginning of each word.
1419 If
1420 .Ar old_string
1421 ends with a dollar sign
1422 .Pq Ql \&$ ,
1423 it is anchored at the end of each word.
1424 Inside
1425 .Ar new_string ,
1426 an ampersand
1427 .Pq Ql &
1428 is replaced by
1429 .Ar old_string
1430 (without any
1431 .Ql ^
1432 or
1433 .Ql \&$ ) .
1434 Any character may be used as a delimiter for the parts of the modifier
1435 string.
1436 The anchoring, ampersand and delimiter characters may be escaped with a
1437 backslash
1438 .Pq Ql \e .
1439 .Pp
1440 Variable expansion occurs in the normal fashion inside both
1441 .Ar old_string
1442 and
1443 .Ar new_string
1444 with the single exception that a backslash is used to prevent the expansion
1445 of a dollar sign
1446 .Pq Ql \&$ ,
1447 not a preceding dollar sign as is usual.
1448 .Sm off
1449 .It Cm \&:C\| No \&/ Ar pattern\| No \&/ Ar replacement\| No \&/ Op Cm 1gW
1450 .Sm on
1451 The
1452 .Cm \&:C
1453 modifier is just like the
1454 .Cm \&:S
1455 modifier except that the old and new strings, instead of being
1456 simple strings, are an extended regular expression (see
1457 .Xr regex 3 )
1458 string
1459 .Ar pattern
1460 and an
1461 .Xr ed 1 Ns \-style
1462 string
1463 .Ar replacement .
1464 Normally, the first occurrence of the pattern
1465 .Ar pattern
1466 in each word of the value is substituted with
1467 .Ar replacement .
1468 The
1469 .Ql 1
1470 modifier causes the substitution to apply to at most one word; the
1471 .Ql g
1472 modifier causes the substitution to apply to as many instances of the
1473 search pattern
1474 .Ar pattern
1475 as occur in the word or words it is found in; the
1476 .Ql W
1477 modifier causes the value to be treated as a single word
1478 (possibly containing embedded white space).
1479 .Pp
1480 As for the
1481 .Cm \&:S
1482 modifier, the
1483 .Ar pattern
1484 and
1485 .Ar replacement
1486 are subjected to variable expansion before being parsed as
1487 regular expressions.
1488 .It Cm \&:T
1489 Replaces each word in the variable with its last path component.
1490 .It Cm \&:u
1491 Removes adjacent duplicate words (like
1492 .Xr uniq 1 ) .
1493 .Sm off
1494 .It Cm \&:\&?\| Ar true_string\| Cm \&: Ar false_string
1495 .Sm on
1496 If the variable name (not its value), when parsed as a .if conditional
1497 expression, evaluates to true, return as its value the
1498 .Ar true_string ,
1499 otherwise return the
1500 .Ar false_string .
1501 Since the variable name is used as the expression, \&:\&? must be the
1502 first modifier after the variable name itself - which will, of course,
1503 usually contain variable expansions.
1504 A common error is trying to use expressions like
1505 .Dl ${NUMBERS:M42:?match:no}
1506 which actually tests defined(NUMBERS),
1507 to determine if any words match "42" you need to use something like:
1508 .Dl ${"${NUMBERS:M42}" != \&"\&":?match:no} .
1509 .It Cm :\| Ns Ar old_string\| Ns Cm = Ns Ar new_string
1510 This is the
1511 .At V
1512 style variable substitution.
1513 It must be the last modifier specified.
1514 If
1515 .Ar old_string
1516 or
1517 .Ar new_string
1518 do not contain the pattern matching character
1519 .Ar %
1520 then it is assumed that they are
1521 anchored at the end of each word, so only suffixes or entire
1522 words may be replaced.
1523 Otherwise
1524 .Ar %
1525 is the substring of
1526 .Ar old_string
1527 to be replaced in
1528 .Ar new_string .
1529 If only
1530 .Ar old_string
1531 contains the pattern matching character
1532 .Ar % ,
1533 and
1534 .Ar old_string
1535 matches, then the result is the
1536 .Ar new_string .
1537 If only the
1538 .Ar new_string
1539 contains the pattern matching character
1540 .Ar % ,
1541 then it is not treated specially and it is printed as a literal
1542 .Ar %
1543 on match.
1544 If there is more than one pattern matching character
1545 .Ar ( % )
1546 in either the
1547 .Ar new_string
1548 or
1549 .Ar old_string ,
1550 only the first instance is treated specially (as the pattern character);
1551 all subsequent instances are treated as regular characters.
1552 .Pp
1553 Variable expansion occurs in the normal fashion inside both
1554 .Ar old_string
1555 and
1556 .Ar new_string
1557 with the single exception that a backslash is used to prevent the
1558 expansion of a dollar sign
1559 .Pq Ql \&$ ,
1560 not a preceding dollar sign as is usual.
1561 .Sm off
1562 .It Cm \&:@ Ar temp\| Cm @ Ar string\| Cm @
1563 .Sm on
1564 This is the loop expansion mechanism from the OSF Development
1565 Environment (ODE) make.
1566 Unlike
1567 .Cm \&.for
1568 loops, expansion occurs at the time of reference.
1569 Assigns
1570 .Ar temp
1571 to each word in the variable and evaluates
1572 .Ar string .
1573 The ODE convention is that
1574 .Ar temp
1575 should start and end with a period.
1576 For example.
1577 .Dl ${LINKS:@.LINK.@${LN} ${TARGET} ${.LINK.}@}
1578 .Pp
1579 However a single character variable is often more readable:
1580 .Dl ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}
1581 .It Cm \&:_ Ns Oo Cm = Ns Ar var Oc
1582 Saves the current variable value in
1583 .Ql $_
1584 or the named
1585 .Va var
1586 for later reference.
1587 Example usage:
1588 .Bd -literal -offset indent
1589 M_cmpv.units = 1 1000 1000000
1590 M_cmpv = S,., ,g:_:range:@i@+ $${_:[-$$i]} \&\\
1591 \\* $${M_cmpv.units:[$$i]}@:S,^,expr 0 ,1:sh
1592
1593 .Dv .if ${VERSION:${M_cmpv}} < ${3.1.12:L:${M_cmpv}}
1594
1595 .Ed
1596 Here
1597 .Ql $_
1598 is used to save the result of the
1599 .Ql :S
1600 modifier which is later referenced using the index values from
1601 .Ql :range .
1602 .It Cm \&:U\| Ns Ar newval
1603 If the variable is undefined,
1604 .Ar newval
1605 is the value.
1606 If the variable is defined, the existing value is returned.
1607 This is another ODE make feature.
1608 It is handy for setting per-target CFLAGS for instance:
1609 .Dl ${_${.TARGET:T}_CFLAGS:U${DEF_CFLAGS}}
1610 If a value is only required if the variable is undefined, use:
1611 .Dl ${VAR:D:Unewval}
1612 .It Cm \&:D\| Ns Ar newval
1613 If the variable is defined,
1614 .Ar newval
1615 is the value.
1616 .It Cm \&:L
1617 The name of the variable is the value.
1618 .It Cm \&:P
1619 The path of the node which has the same name as the variable
1620 is the value.
1621 If no such node exists or its path is null, then the
1622 name of the variable is used.
1623 In order for this modifier to work, the name (node) must at least have
1624 appeared on the rhs of a dependency.
1625 .Sm off
1626 .It Cm \&:\&! Ar cmd\| Cm \&!
1627 .Sm on
1628 The output of running
1629 .Ar cmd
1630 is the value.
1631 .It Cm \&:sh
1632 If the variable is non-empty it is run as a command and the output
1633 becomes the new value.
1634 .It Cm \&::= Ns Ar str
1635 The variable is assigned the value
1636 .Ar str
1637 after substitution.
1638 This modifier and its variations are useful in
1639 obscure situations such as wanting to set a variable when shell commands
1640 are being parsed.
1641 These assignment modifiers always expand to
1642 nothing, so if appearing in a rule line by themselves should be
1643 preceded with something to keep
1644 .Nm
1645 happy.
1646 .Pp
1647 The
1648 .Sq Cm \&::
1649 helps avoid false matches with the
1650 .At V
1651 style
1652 .Cm \&:=
1653 modifier and since substitution always occurs the
1654 .Cm \&::=
1655 form is vaguely appropriate.
1656 .It Cm \&::?= Ns Ar str
1657 As for
1658 .Cm \&::=
1659 but only if the variable does not already have a value.
1660 .It Cm \&::+= Ns Ar str
1661 Append
1662 .Ar str
1663 to the variable.
1664 .It Cm \&::!= Ns Ar cmd
1665 Assign the output of
1666 .Ar cmd
1667 to the variable.
1668 .It Cm \&:\&[ Ns Ar range Ns Cm \&]
1669 Selects one or more words from the value,
1670 or performs other operations related to the way in which the
1671 value is divided into words.
1672 .Pp
1673 Ordinarily, a value is treated as a sequence of words
1674 delimited by white space.
1675 Some modifiers suppress this behavior,
1676 causing a value to be treated as a single word
1677 (possibly containing embedded white space).
1678 An empty value, or a value that consists entirely of white-space,
1679 is treated as a single word.
1680 For the purposes of the
1681 .Sq Cm \&:[]
1682 modifier, the words are indexed both forwards using positive integers
1683 (where index 1 represents the first word),
1684 and backwards using negative integers
1685 (where index \-1 represents the last word).
1686 .Pp
1687 The
1688 .Ar range
1689 is subjected to variable expansion, and the expanded result is
1690 then interpreted as follows:
1691 .Bl -tag -width index
1692 .\" :[n]
1693 .It Ar index
1694 Selects a single word from the value.
1695 .\" :[start..end]
1696 .It Ar start Ns Cm \&.. Ns Ar end
1697 Selects all words from
1698 .Ar start
1699 to
1700 .Ar end ,
1701 inclusive.
1702 For example,
1703 .Sq Cm \&:[2..-1]
1704 selects all words from the second word to the last word.
1705 If
1706 .Ar start
1707 is greater than
1708 .Ar end ,
1709 then the words are output in reverse order.
1710 For example,
1711 .Sq Cm \&:[-1..1]
1712 selects all the words from last to first.
1713 If the list is already ordered, then this effectively reverses
1714 the list, but it is more efficient to use
1715 .Sq Cm \&:Or
1716 instead of
1717 .Sq Cm \&:O:[-1..1] .
1718 .\" :[*]
1719 .It Cm \&*
1720 Causes subsequent modifiers to treat the value as a single word
1721 (possibly containing embedded white space).
1722 Analogous to the effect of
1723 \&"$*\&"
1724 in Bourne shell.
1725 .\" :[0]
1726 .It 0
1727 Means the same as
1728 .Sq Cm \&:[*] .
1729 .\" :[*]
1730 .It Cm \&@
1731 Causes subsequent modifiers to treat the value as a sequence of words
1732 delimited by white space.
1733 Analogous to the effect of
1734 \&"$@\&"
1735 in Bourne shell.
1736 .\" :[#]
1737 .It Cm \&#
1738 Returns the number of words in the value.
1739 .El \" :[range]
1740 .El
1741 .Sh INCLUDE STATEMENTS, CONDITIONALS AND FOR LOOPS
1742 Makefile inclusion, conditional structures and for loops reminiscent
1743 of the C programming language are provided in
1744 .Nm .
1745 All such structures are identified by a line beginning with a single
1746 dot
1747 .Pq Ql \&.
1748 character.
1749 Files are included with either
1750 .Cm \&.include \&< Ns Ar file Ns Cm \&>
1751 or
1752 .Cm \&.include \&\*q Ns Ar file Ns Cm \&\*q .
1753 Variables between the angle brackets or double quotes are expanded
1754 to form the file name.
1755 If angle brackets are used, the included makefile is expected to be in
1756 the system makefile directory.
1757 If double quotes are used, the including makefile's directory and any
1758 directories specified using the
1759 .Fl I
1760 option are searched before the system
1761 makefile directory.
1762 For compatibility with other versions of
1763 .Nm
1764 .Ql include file ...
1765 is also accepted.
1766 .Pp
1767 If the include statement is written as
1768 .Cm .-include
1769 or as
1770 .Cm .sinclude
1771 then errors locating and/or opening include files are ignored.
1772 .Pp
1773 If the include statement is written as
1774 .Cm .dinclude
1775 not only are errors locating and/or opening include files ignored,
1776 but stale dependencies within the included file will be ignored
1777 just like
1778 .Va .MAKE.DEPENDFILE .
1779 .Pp
1780 Conditional expressions are also preceded by a single dot as the first
1781 character of a line.
1782 The possible conditionals are as follows:
1783 .Bl -tag -width Ds
1784 .It Ic .error Ar message
1785 The message is printed along with the name of the makefile and line number,
1786 then
1787 .Nm
1788 will exit immediately.
1789 .It Ic .export Ar variable ...
1790 Export the specified global variable.
1791 If no variable list is provided, all globals are exported
1792 except for internal variables (those that start with
1793 .Ql \&. ) .
1794 This is not affected by the
1795 .Fl X
1796 flag, so should be used with caution.
1797 For compatibility with other
1798 .Nm
1799 programs
1800 .Ql export variable=value
1801 is also accepted.
1802 .Pp
1803 Appending a variable name to
1804 .Va .MAKE.EXPORTED
1805 is equivalent to exporting a variable.
1806 .It Ic .export-env Ar variable ...
1807 The same as
1808 .Ql .export ,
1809 except that the variable is not appended to
1810 .Va .MAKE.EXPORTED .
1811 This allows exporting a value to the environment which is different from that
1812 used by
1813 .Nm
1814 internally.
1815 .It Ic .export-literal Ar variable ...
1816 The same as
1817 .Ql .export-env ,
1818 except that variables in the value are not expanded.
1819 .It Ic .info Ar message
1820 The message is printed along with the name of the makefile and line number.
1821 .It Ic .undef Ar variable ...
1822 Un-define the specified global variables.
1823 Only global variables can be un-defined.
1824 .It Ic .unexport Ar variable ...
1825 The opposite of
1826 .Ql .export .
1827 The specified global
1828 .Va variable
1829 will be removed from
1830 .Va .MAKE.EXPORTED .
1831 If no variable list is provided, all globals are unexported,
1832 and
1833 .Va .MAKE.EXPORTED
1834 deleted.
1835 .It Ic .unexport-env
1836 Unexport all globals previously exported and
1837 clear the environment inherited from the parent.
1838 This operation will cause a memory leak of the original environment,
1839 so should be used sparingly.
1840 Testing for
1841 .Va .MAKE.LEVEL
1842 being 0, would make sense.
1843 Also note that any variables which originated in the parent environment
1844 should be explicitly preserved if desired.
1845 For example:
1846 .Bd -literal -offset indent
1847 .Li .if ${.MAKE.LEVEL} == 0
1848 PATH := ${PATH}
1849 .Li .unexport-env
1850 .Li .export PATH
1851 .Li .endif
1852 .Pp
1853 .Ed
1854 Would result in an environment containing only
1855 .Sq Ev PATH ,
1856 which is the minimal useful environment.
1857 Actually
1858 .Sq Ev .MAKE.LEVEL
1859 will also be pushed into the new environment.
1860 .It Ic .warning Ar message
1861 The message prefixed by
1862 .Sq Pa warning:
1863 is printed along with the name of the makefile and line number.
1864 .It Ic \&.if Oo \&! Oc Ns Ar expression Op Ar operator expression ...
1865 Test the value of an expression.
1866 .It Ic .ifdef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1867 Test the value of a variable.
1868 .It Ic .ifndef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1869 Test the value of a variable.
1870 .It Ic .ifmake Oo \&! Oc Ns Ar target Op Ar operator target ...
1871 Test the target being built.
1872 .It Ic .ifnmake Oo \&! Ns Oc Ar target Op Ar operator target ...
1873 Test the target being built.
1874 .It Ic .else
1875 Reverse the sense of the last conditional.
1876 .It Ic .elif Oo \&! Ns Oc Ar expression Op Ar operator expression ...
1877 A combination of
1878 .Sq Ic .else
1879 followed by
1880 .Sq Ic .if .
1881 .It Ic .elifdef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1882 A combination of
1883 .Sq Ic .else
1884 followed by
1885 .Sq Ic .ifdef .
1886 .It Ic .elifndef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1887 A combination of
1888 .Sq Ic .else
1889 followed by
1890 .Sq Ic .ifndef .
1891 .It Ic .elifmake Oo \&! Oc Ns Ar target Op Ar operator target ...
1892 A combination of
1893 .Sq Ic .else
1894 followed by
1895 .Sq Ic .ifmake .
1896 .It Ic .elifnmake Oo \&! Oc Ns Ar target Op Ar operator target ...
1897 A combination of
1898 .Sq Ic .else
1899 followed by
1900 .Sq Ic .ifnmake .
1901 .It Ic .endif
1902 End the body of the conditional.
1903 .El
1904 .Pp
1905 The
1906 .Ar operator
1907 may be any one of the following:
1908 .Bl -tag -width "Cm XX"
1909 .It Cm \&|\&|
1910 Logical OR.
1911 .It Cm \&&&
1912 Logical
1913 .Tn AND ;
1914 of higher precedence than
1915 .Dq \&|\&| .
1916 .El
1917 .Pp
1918 As in C,
1919 .Nm
1920 will only evaluate a conditional as far as is necessary to determine
1921 its value.
1922 Parentheses may be used to change the order of evaluation.
1923 The boolean operator
1924 .Sq Ic \&!
1925 may be used to logically negate an entire
1926 conditional.
1927 It is of higher precedence than
1928 .Sq Ic \&&& .
1929 .Pp
1930 The value of
1931 .Ar expression
1932 may be any of the following:
1933 .Bl -tag -width defined
1934 .It Ic defined
1935 Takes a variable name as an argument and evaluates to true if the variable
1936 has been defined.
1937 .It Ic make
1938 Takes a target name as an argument and evaluates to true if the target
1939 was specified as part of
1940 .Nm Ns 's
1941 command line or was declared the default target (either implicitly or
1942 explicitly, see
1943 .Va .MAIN )
1944 before the line containing the conditional.
1945 .It Ic empty
1946 Takes a variable, with possible modifiers, and evaluates to true if
1947 the expansion of the variable would result in an empty string.
1948 .It Ic exists
1949 Takes a file name as an argument and evaluates to true if the file exists.
1950 The file is searched for on the system search path (see
1951 .Va .PATH ) .
1952 .It Ic target
1953 Takes a target name as an argument and evaluates to true if the target
1954 has been defined.
1955 .It Ic commands
1956 Takes a target name as an argument and evaluates to true if the target
1957 has been defined and has commands associated with it.
1958 .El
1959 .Pp
1960 .Ar Expression
1961 may also be an arithmetic or string comparison.
1962 Variable expansion is
1963 performed on both sides of the comparison, after which the numerical
1964 values are compared.
1965 A value is interpreted as hexadecimal if it is
1966 preceded by 0x, otherwise it is decimal; octal numbers are not supported.
1967 The standard C relational operators are all supported.
1968 If after
1969 variable expansion, either the left or right hand side of a
1970 .Sq Ic ==
1971 or
1972 .Sq Ic "!="
1973 operator is not a numerical value, then
1974 string comparison is performed between the expanded
1975 variables.
1976 If no relational operator is given, it is assumed that the expanded
1977 variable is being compared against 0, or an empty string in the case
1978 of a string comparison.
1979 .Pp
1980 When
1981 .Nm
1982 is evaluating one of these conditional expressions, and it encounters
1983 a (white-space separated) word it doesn't recognize, either the
1984 .Dq make
1985 or
1986 .Dq defined
1987 expression is applied to it, depending on the form of the conditional.
1988 If the form is
1989 .Sq Ic .ifdef ,
1990 .Sq Ic .ifndef ,
1991 or
1992 .Sq Ic .if
1993 the
1994 .Dq defined
1995 expression is applied.
1996 Similarly, if the form is
1997 .Sq Ic .ifmake
1998 or
1999 .Sq Ic .ifnmake ,
2000 the
2001 .Dq make
2002 expression is applied.
2003 .Pp
2004 If the conditional evaluates to true the parsing of the makefile continues
2005 as before.
2006 If it evaluates to false, the following lines are skipped.
2007 In both cases this continues until a
2008 .Sq Ic .else
2009 or
2010 .Sq Ic .endif
2011 is found.
2012 .Pp
2013 For loops are typically used to apply a set of rules to a list of files.
2014 The syntax of a for loop is:
2015 .Pp
2016 .Bl -tag -compact -width Ds
2017 .It Ic \&.for Ar variable Oo Ar variable ... Oc Ic in Ar expression
2018 .It Aq make-lines
2019 .It Ic \&.endfor
2020 .El
2021 .Pp
2022 After the for
2023 .Ic expression
2024 is evaluated, it is split into words.
2025 On each iteration of the loop, one word is taken and assigned to each
2026 .Ic variable ,
2027 in order, and these
2028 .Ic variables
2029 are substituted into the
2030 .Ic make-lines
2031 inside the body of the for loop.
2032 The number of words must come out even; that is, if there are three
2033 iteration variables, the number of words provided must be a multiple
2034 of three.
2035 .Sh COMMENTS
2036 Comments begin with a hash
2037 .Pq Ql \&#
2038 character, anywhere but in a shell
2039 command line, and continue to the end of an unescaped new line.
2040 .Sh SPECIAL SOURCES (ATTRIBUTES)
2041 .Bl -tag -width .IGNOREx
2042 .It Ic .EXEC
2043 Target is never out of date, but always execute commands anyway.
2044 .It Ic .IGNORE
2045 Ignore any errors from the commands associated with this target, exactly
2046 as if they all were preceded by a dash
2047 .Pq Ql \- .
2048 .\" .It Ic .INVISIBLE
2049 .\" XXX
2050 .\" .It Ic .JOIN
2051 .\" XXX
2052 .It Ic .MADE
2053 Mark all sources of this target as being up-to-date.
2054 .It Ic .MAKE
2055 Execute the commands associated with this target even if the
2056 .Fl n
2057 or
2058 .Fl t
2059 options were specified.
2060 Normally used to mark recursive
2061 .Nm Ns s .
2062 .It Ic .META
2063 Create a meta file for the target, even if it is flagged as
2064 .Ic .PHONY ,
2065 .Ic .MAKE ,
2066 or
2067 .Ic .SPECIAL .
2068 Usage in conjunction with
2069 .Ic .MAKE
2070 is the most likely case.
2071 In "meta" mode, the target is out-of-date if the meta file is missing.
2072 .It Ic .NOMETA
2073 Do not create a meta file for the target.
2074 Meta files are also not created for
2075 .Ic .PHONY ,
2076 .Ic .MAKE ,
2077 or
2078 .Ic .SPECIAL
2079 targets.
2080 .It Ic .NOMETA_CMP
2081 Ignore differences in commands when deciding if target is out of date.
2082 This is useful if the command contains a value which always changes.
2083 If the number of commands change, though, the target will still be out of date.
2084 The same effect applies to any command line that uses the variable
2085 .Va .OODATE ,
2086 which can be used for that purpose even when not otherwise needed or desired:
2087 .Bd -literal -offset indent
2088
2089 skip-compare-for-some:
2090         @echo this will be compared
2091         @echo this will not ${.OODATE:M.NOMETA_CMP}
2092         @echo this will also be compared
2093
2094 .Ed
2095 The
2096 .Cm \&:M
2097 pattern suppresses any expansion of the unwanted variable.
2098 .It Ic .NOPATH
2099 Do not search for the target in the directories specified by
2100 .Ic .PATH .
2101 .It Ic .NOTMAIN
2102 Normally
2103 .Nm
2104 selects the first target it encounters as the default target to be built
2105 if no target was specified.
2106 This source prevents this target from being selected.
2107 .It Ic .OPTIONAL
2108 If a target is marked with this attribute and
2109 .Nm
2110 can't figure out how to create it, it will ignore this fact and assume
2111 the file isn't needed or already exists.
2112 .It Ic .PHONY
2113 The target does not
2114 correspond to an actual file; it is always considered to be out of date,
2115 and will not be created with the
2116 .Fl t
2117 option.
2118 Suffix-transformation rules are not applied to
2119 .Ic .PHONY
2120 targets.
2121 .It Ic .PRECIOUS
2122 When
2123 .Nm
2124 is interrupted, it normally removes any partially made targets.
2125 This source prevents the target from being removed.
2126 .It Ic .RECURSIVE
2127 Synonym for
2128 .Ic .MAKE .
2129 .It Ic .SILENT
2130 Do not echo any of the commands associated with this target, exactly
2131 as if they all were preceded by an at sign
2132 .Pq Ql @ .
2133 .It Ic .USE
2134 Turn the target into
2135 .Nm Ns 's
2136 version of a macro.
2137 When the target is used as a source for another target, the other target
2138 acquires the commands, sources, and attributes (except for
2139 .Ic .USE )
2140 of the
2141 source.
2142 If the target already has commands, the
2143 .Ic .USE
2144 target's commands are appended
2145 to them.
2146 .It Ic .USEBEFORE
2147 Exactly like
2148 .Ic .USE ,
2149 but prepend the
2150 .Ic .USEBEFORE
2151 target commands to the target.
2152 .It Ic .WAIT
2153 If
2154 .Ic .WAIT
2155 appears in a dependency line, the sources that precede it are
2156 made before the sources that succeed it in the line.
2157 Since the dependents of files are not made until the file itself
2158 could be made, this also stops the dependents being built unless they
2159 are needed for another branch of the dependency tree.
2160 So given:
2161 .Bd -literal
2162 x: a .WAIT b
2163         echo x
2164 a:
2165         echo a
2166 b: b1
2167         echo b
2168 b1:
2169         echo b1
2170
2171 .Ed
2172 the output is always
2173 .Ql a ,
2174 .Ql b1 ,
2175 .Ql b ,
2176 .Ql x .
2177 .br
2178 The ordering imposed by
2179 .Ic .WAIT
2180 is only relevant for parallel makes.
2181 .El
2182 .Sh SPECIAL TARGETS
2183 Special targets may not be included with other targets, i.e. they must be
2184 the only target specified.
2185 .Bl -tag -width .BEGINx
2186 .It Ic .BEGIN
2187 Any command lines attached to this target are executed before anything
2188 else is done.
2189 .It Ic .DEFAULT
2190 This is sort of a
2191 .Ic .USE
2192 rule for any target (that was used only as a
2193 source) that
2194 .Nm
2195 can't figure out any other way to create.
2196 Only the shell script is used.
2197 The
2198 .Ic .IMPSRC
2199 variable of a target that inherits
2200 .Ic .DEFAULT Ns 's
2201 commands is set
2202 to the target's own name.
2203 .It Ic .DELETE_ON_ERROR
2204 If this target is present in the makefile, it globally causes make to
2205 delete targets whose commands fail.
2206 (By default, only targets whose commands are interrupted during
2207 execution are deleted.
2208 This is the historical behavior.)
2209 This setting can be used to help prevent half-finished or malformed
2210 targets from being left around and corrupting future rebuilds.
2211 .It Ic .END
2212 Any command lines attached to this target are executed after everything
2213 else is done.
2214 .It Ic .ERROR
2215 Any command lines attached to this target are executed when another target fails.
2216 The
2217 .Ic .ERROR_TARGET
2218 variable is set to the target that failed.
2219 See also
2220 .Ic MAKE_PRINT_VAR_ON_ERROR .
2221 .It Ic .IGNORE
2222 Mark each of the sources with the
2223 .Ic .IGNORE
2224 attribute.
2225 If no sources are specified, this is the equivalent of specifying the
2226 .Fl i
2227 option.
2228 .It Ic .INTERRUPT
2229 If
2230 .Nm
2231 is interrupted, the commands for this target will be executed.
2232 .It Ic .MAIN
2233 If no target is specified when
2234 .Nm
2235 is invoked, this target will be built.
2236 .It Ic .MAKEFLAGS
2237 This target provides a way to specify flags for
2238 .Nm
2239 when the makefile is used.
2240 The flags are as if typed to the shell, though the
2241 .Fl f
2242 option will have
2243 no effect.
2244 .\" XXX: NOT YET!!!!
2245 .\" .It Ic .NOTPARALLEL
2246 .\" The named targets are executed in non parallel mode.
2247 .\" If no targets are
2248 .\" specified, then all targets are executed in non parallel mode.
2249 .It Ic .NOPATH
2250 Apply the
2251 .Ic .NOPATH
2252 attribute to any specified sources.
2253 .It Ic .NOTPARALLEL
2254 Disable parallel mode.
2255 .It Ic .NO_PARALLEL
2256 Synonym for
2257 .Ic .NOTPARALLEL ,
2258 for compatibility with other pmake variants.
2259 .It Ic .OBJDIR
2260 The source is a new value for
2261 .Sq Va .OBJDIR .
2262 If it exists,
2263 .Nm
2264 will
2265 .Xr chdir 2
2266 to it and update the value of
2267 .Sq Va .OBJDIR .
2268 .It Ic .ORDER
2269 In parallel mode, the named targets are made in sequence.
2270 This ordering does not add targets to the list of targets to be made.
2271 .Pp
2272 Since the dependents of a target do not get built until the target itself
2273 could be built, unless
2274 .Ql a
2275 is built by another part of the dependency graph,
2276 the following is a dependency loop:
2277 .Bd -literal
2278 \&.ORDER: b a
2279 b: a
2280 .Ed
2281 .Pp
2282 .\" XXX: NOT YET!!!!
2283 .\" .It Ic .PARALLEL
2284 .\" The named targets are executed in parallel mode.
2285 .\" If no targets are
2286 .\" specified, then all targets are executed in parallel mode.
2287 .It Ic .PATH
2288 The sources are directories which are to be searched for files not
2289 found in the current directory.
2290 If no sources are specified, any previously specified directories are
2291 deleted.
2292 If the source is the special
2293 .Ic .DOTLAST
2294 target, then the current working
2295 directory is searched last.
2296 .It Ic .PATH. Ns Va suffix
2297 Like
2298 .Ic .PATH
2299 but applies only to files with a particular suffix.
2300 The suffix must have been previously declared with
2301 .Ic .SUFFIXES .
2302 .It Ic .PHONY
2303 Apply the
2304 .Ic .PHONY
2305 attribute to any specified sources.
2306 .It Ic .POSIX
2307 If this is the first non-comment line in the main makefile,
2308 the variable
2309 .Va %POSIX
2310 is set to the value
2311 .Ql 1003.2
2312 and the makefile
2313 .Ql <posix.mk>
2314 is included if it exists,
2315 to provide POSIX-compatible default rules.
2316 If
2317 .Nm
2318 is run with the
2319 .Fl r
2320 flag, then only
2321 .Ql posix.mk
2322 will contribute to the default rules.
2323 .It Ic .PRECIOUS
2324 Apply the
2325 .Ic .PRECIOUS
2326 attribute to any specified sources.
2327 If no sources are specified, the
2328 .Ic .PRECIOUS
2329 attribute is applied to every
2330 target in the file.
2331 .It Ic .SHELL
2332 Sets the shell that
2333 .Nm
2334 will use to execute commands.
2335 The sources are a set of
2336 .Ar field=value
2337 pairs.
2338 .Bl -tag -width hasErrCtls
2339 .It Ar name
2340 This is the minimal specification, used to select one of the built-in
2341 shell specs;
2342 .Ar sh ,
2343 .Ar ksh ,
2344 and
2345 .Ar csh .
2346 .It Ar path
2347 Specifies the path to the shell.
2348 .It Ar hasErrCtl
2349 Indicates whether the shell supports exit on error.
2350 .It Ar check
2351 The command to turn on error checking.
2352 .It Ar ignore
2353 The command to disable error checking.
2354 .It Ar echo
2355 The command to turn on echoing of commands executed.
2356 .It Ar quiet
2357 The command to turn off echoing of commands executed.
2358 .It Ar filter
2359 The output to filter after issuing the
2360 .Ar quiet
2361 command.
2362 It is typically identical to
2363 .Ar quiet .
2364 .It Ar errFlag
2365 The flag to pass the shell to enable error checking.
2366 .It Ar echoFlag
2367 The flag to pass the shell to enable command echoing.
2368 .It Ar newline
2369 The string literal to pass the shell that results in a single newline
2370 character when used outside of any quoting characters.
2371 .El
2372 Example:
2373 .Bd -literal
2374 \&.SHELL: name=ksh path=/bin/ksh hasErrCtl=true \e
2375         check="set \-e" ignore="set +e" \e
2376         echo="set \-v" quiet="set +v" filter="set +v" \e
2377         echoFlag=v errFlag=e newline="'\en'"
2378 .Ed
2379 .It Ic .SILENT
2380 Apply the
2381 .Ic .SILENT
2382 attribute to any specified sources.
2383 If no sources are specified, the
2384 .Ic .SILENT
2385 attribute is applied to every
2386 command in the file.
2387 .It Ic .STALE
2388 This target gets run when a dependency file contains stale entries, having
2389 .Va .ALLSRC
2390 set to the name of that dependency file.
2391 .It Ic .SUFFIXES
2392 Each source specifies a suffix to
2393 .Nm .
2394 If no sources are specified, any previously specified suffixes are deleted.
2395 It allows the creation of suffix-transformation rules.
2396 .Pp
2397 Example:
2398 .Bd -literal
2399 \&.SUFFIXES: .o
2400 \&.c.o:
2401         cc \-o ${.TARGET} \-c ${.IMPSRC}
2402 .Ed
2403 .El
2404 .Sh ENVIRONMENT
2405 .Nm
2406 uses the following environment variables, if they exist:
2407 .Ev MACHINE ,
2408 .Ev MACHINE_ARCH ,
2409 .Ev MAKE ,
2410 .Ev MAKEFLAGS ,
2411 .Ev MAKEOBJDIR ,
2412 .Ev MAKEOBJDIRPREFIX ,
2413 .Ev MAKESYSPATH ,
2414 .Ev PWD ,
2415 and
2416 .Ev TMPDIR .
2417 .Pp
2418 .Ev MAKEOBJDIRPREFIX
2419 and
2420 .Ev MAKEOBJDIR
2421 may only be set in the environment or on the command line to
2422 .Nm
2423 and not as makefile variables;
2424 see the description of
2425 .Sq Va .OBJDIR
2426 for more details.
2427 .Sh FILES
2428 .Bl -tag -width /usr/share/mk -compact
2429 .It .depend
2430 list of dependencies
2431 .It Makefile
2432 list of dependencies
2433 .It makefile
2434 list of dependencies
2435 .It sys.mk
2436 system makefile
2437 .It /usr/share/mk
2438 system makefile directory
2439 .El
2440 .Sh COMPATIBILITY
2441 The basic make syntax is compatible between different versions of make;
2442 however the special variables, variable modifiers and conditionals are not.
2443 .Ss Older versions
2444 An incomplete list of changes in older versions of
2445 .Nm :
2446 .Pp
2447 The way that .for loop variables are substituted changed after
2448 NetBSD 5.0
2449 so that they still appear to be variable expansions.
2450 In particular this stops them being treated as syntax, and removes some
2451 obscure problems using them in .if statements.
2452 .Pp
2453 The way that parallel makes are scheduled changed in
2454 NetBSD 4.0
2455 so that .ORDER and .WAIT apply recursively to the dependent nodes.
2456 The algorithms used may change again in the future.
2457 .Ss Other make dialects
2458 Other make dialects (GNU make, SVR4 make, POSIX make, etc.) do not
2459 support most of the features of
2460 .Nm
2461 as described in this manual.
2462 Most notably:
2463 .Bl -bullet -offset indent
2464 .It
2465 The
2466 .Ic .WAIT
2467 and
2468 .Ic .ORDER
2469 declarations and most functionality pertaining to parallelization.
2470 (GNU make supports parallelization but lacks these features needed to
2471 control it effectively.)
2472 .It
2473 Directives, including for loops and conditionals and most of the
2474 forms of include files.
2475 (GNU make has its own incompatible and less powerful syntax for
2476 conditionals.)
2477 .It
2478 All built-in variables that begin with a dot.
2479 .It
2480 Most of the special sources and targets that begin with a dot,
2481 with the notable exception of
2482 .Ic .PHONY ,
2483 .Ic .PRECIOUS ,
2484 and
2485 .Ic .SUFFIXES .
2486 .It
2487 Variable modifiers, except for the
2488 .Dl :old=new
2489 string substitution, which does not portably support globbing with
2490 .Ql %
2491 and historically only works on declared suffixes.
2492 .It
2493 The
2494 .Ic $>
2495 variable even in its short form; most makes support this functionality
2496 but its name varies.
2497 .El
2498 .Pp
2499 Some features are somewhat more portable, such as assignment with
2500 .Ic += ,
2501 .Ic ?= ,
2502 and
2503 .Ic != .
2504 The
2505 .Ic .PATH
2506 functionality is based on an older feature
2507 .Ic VPATH
2508 found in GNU make and many versions of SVR4 make; however,
2509 historically its behavior is too ill-defined (and too buggy) to rely
2510 upon.
2511 .Pp
2512 The
2513 .Ic $@
2514 and
2515 .Ic $<
2516 variables are more or less universally portable, as is the
2517 .Ic $(MAKE)
2518 variable.
2519 Basic use of suffix rules (for files only in the current directory,
2520 not trying to chain transformations together, etc.) is also reasonably
2521 portable.
2522 .Sh SEE ALSO
2523 .Xr mkdep 1
2524 .Sh HISTORY
2525 .Nm
2526 is derived from NetBSD
2527 .Xr make 1 .
2528 It uses autoconf to facilitate portability to other platforms.
2529 .Pp
2530 A
2531 make
2532 command appeared in
2533 .At v7 .
2534 This
2535 make
2536 implementation is based on Adam De Boor's pmake program which was written
2537 for Sprite at Berkeley.
2538 It was designed to be a parallel distributed make running jobs on different
2539 machines using a daemon called
2540 .Dq customs .
2541 .Pp
2542 Historically the target/dependency
2543 .Dq FRC
2544 has been used to FoRCe rebuilding (since the target/dependency
2545 does not exist... unless someone creates an
2546 .Dq FRC
2547 file).
2548 .Sh BUGS
2549 The
2550 make
2551 syntax is difficult to parse without actually acting on the data.
2552 For instance, finding the end of a variable's use should involve scanning
2553 each of the modifiers, using the correct terminator for each field.
2554 In many places
2555 make
2556 just counts {} and () in order to find the end of a variable expansion.
2557 .Pp
2558 There is no way of escaping a space character in a filename.