1 .\" $NetBSD: make.1,v 1.230 2014/02/15 18:55:30 sjg Exp $
3 .\" Copyright (c) 1990, 1993
4 .\" The Regents of the University of California. All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
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.
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
30 .\" from: @(#)make.1 8.4 (Berkeley) 3/19/94
37 .Nd maintain program dependencies
55 is a program designed to simplify the maintenance of other programs.
56 Its input is a list of specifications as to the files upon which programs
57 and other files depend.
60 makefile option is given,
66 in order to find the specifications.
69 exists, it is read (see
72 This manual page is intended as a reference document only.
73 For a more thorough description of
75 and makefiles, please refer to
76 .%T "PMake \- A Tutorial" .
79 will prepend the contents of the
81 environment variable to the command line arguments before parsing them.
83 The options are as follows:
86 Try to be backwards compatible by executing a single shell per command and
87 by executing the commands to make the sources of a dependency line in sequence.
91 before reading the makefiles or doing anything else.
94 options are specified, each is interpreted relative to the previous one:
95 .Fl C Pa / Fl C Pa etc
101 to be 1, in the global context.
103 Turn on debugging, and specify which portions of
105 are to print debugging information.
106 Unless the flags are preceded by
108 they are added to the
110 environment variable and will be processed by any child make processes.
111 By default, debugging information is printed to standard error,
112 but this can be changed using the
115 The debugging output is always unbuffered; in addition, if debugging
116 is enabled but debugging output is not directed to standard output,
117 then the standard output is line buffered.
119 is one or more of the following:
122 Print all possible debugging information;
123 equivalent to specifying all of the debugging flags.
125 Print debugging information about archive searching and caching.
127 Print debugging information about current working directory.
129 Print debugging information about conditional evaluation.
131 Print debugging information about directory searching and caching.
133 Print debugging information about failed commands and targets.
134 .It Ar F Ns Oo Sy \&+ Oc Ns Ar filename
135 Specify where debugging output is written.
136 This must be the last flag, because it consumes the remainder of
138 If the character immediately after the
142 then the file will be opened in append mode;
143 otherwise the file will be overwritten.
148 then debugging output will be written to the
149 standard output or standard error output file descriptors respectively
152 option has no effect).
153 Otherwise, the output will be written to the named file.
154 If the file name ends
158 is replaced by the pid.
160 Print debugging information about loop evaluation.
162 Print the input graph before making anything.
164 Print the input graph after making everything, or before exiting
167 Print the input graph before exiting on error.
169 Print debugging information about running multiple shells.
171 Print commands in Makefiles regardless of whether or not they are prefixed by
173 or other "quiet" flags.
174 Also known as "loud" behavior.
176 Print debugging information about "meta" mode decisions about targets.
178 Print debugging information about making targets, including modification
181 Don't delete the temporary command scripts created when running commands.
182 These temporary scripts are created in the directory
185 environment variable, or in
189 is unset or set to the empty string.
190 The temporary scripts are created by
192 and have names of the form
195 This can create many files in
201 Print debugging information about makefile parsing.
203 Print debugging information about suffix-transformation rules.
205 Print debugging information about target list maintenance.
209 option to print raw values of variables.
211 Print debugging information about variable assignment.
213 Print entering and leaving directory messages, pre and post processing.
215 Run shell commands with
217 so the actual commands are printed as they are executed.
220 Specify that environment variables override macro assignments within
223 Specify a makefile to read instead of the default
229 standard input is read.
230 Multiple makefiles may be specified, and are read in the order specified.
231 .It Fl I Ar directory
232 Specify a directory in which to search for makefiles and included makefiles.
233 The system makefile directory (or directories, see the
235 option) is automatically included as part of this list.
237 Ignore non-zero exit of shell commands in the makefile.
238 Equivalent to specifying
240 before each command line in the makefile.
244 be specified by the user.
248 option is in use in a recursive build, this option is passed by a make
249 to child makes to allow all the make processes in the build to
250 cooperate to avoid overloading the system.
252 Specify the maximum number of jobs that
254 may have running at any one time.
255 The value is saved in
257 Turns compatibility mode off, unless the
259 flag is also specified.
260 When compatibility mode is off, all commands associated with a
261 target are executed in a single shell invocation as opposed to the
262 traditional one shell invocation per line.
263 This can break traditional scripts which change directories on each
264 command invocation and then expect to start with a fresh environment
266 It is more efficient to correct the scripts rather than turn backwards
269 Continue processing after errors are encountered, but only on those targets
270 that do not depend on the target whose creation caused the error.
271 .It Fl m Ar directory
272 Specify a directory in which to search for sys.mk and makefiles included
274 .Ao Ar file Ac Ns -style
278 option can be used multiple times to form a search path.
279 This path will override the default system include path: /usr/share/mk.
280 Furthermore the system include path will be appended to the search path used
282 .Qo Ar file Qc Ns -style
283 include statements (see the
287 If a file or directory name in the
291 environment variable) starts with the string
295 will search for the specified file or directory named in the remaining part
296 of the argument string.
297 The search starts with the current directory of
298 the Makefile and then works upward towards the root of the filesystem.
299 If the search is successful, then the resulting directory replaces the
304 If used, this feature allows
306 to easily search in the current source tree for customized sys.mk files
311 Display the commands that would have been executed, but do not
312 actually execute them unless the target depends on the .MAKE special
315 Display the commands which would have been executed, but do not
316 actually execute any of them; useful for debugging top-level makefiles
317 without descending into subdirectories.
319 Do not execute any commands, but exit 0 if the specified targets are
320 up-to-date and 1, otherwise.
322 Do not use the built-in rules specified in the system makefile.
324 Do not echo any commands as they are executed.
325 Equivalent to specifying
327 before each command line in the makefile.
328 .It Fl T Ar tracefile
332 append a trace record to
334 for each job started and completed.
336 Rather than re-building a target as specified in the makefile, create it
337 or update its modification time to make it appear up-to-date.
343 in the global context.
344 Do not build any targets.
345 Multiple instances of this option may be specified;
346 the variables will be printed one per line,
347 with a blank line for each null or undefined variable.
352 then the value will be expanded before printing.
354 Treat any warnings during makefile parsing as errors.
356 Don't export variables passed on the command line to the environment
358 Variables passed on the command line are still exported
361 environment variable.
362 This option may be useful on systems which have a small limit on the
363 size of command arguments.
364 .It Ar variable=value
365 Set the value of the variable
369 Normally, all values passed on the command line are also exported to
370 sub-makes in the environment.
373 flag disables this behavior.
374 Variable assignments should follow options for POSIX compatibility
375 but no ordering is enforced.
378 There are seven different types of lines in a makefile: file dependency
379 specifications, shell commands, variable assignments, include statements,
380 conditional directives, for loops, and comments.
382 In general, lines may be continued from one line to the next by ending
383 them with a backslash
385 The trailing newline character and initial whitespace on the following
386 line are compressed into a single space.
387 .Sh FILE DEPENDENCY SPECIFICATIONS
388 Dependency lines consist of one or more targets, an operator, and zero
390 This creates a relationship where the targets
393 and are usually created from them.
394 The exact relationship between the target and the source is determined
395 by the operator that separates them.
396 The three operators are as follows:
399 A target is considered out-of-date if its modification time is less than
400 those of any of its sources.
401 Sources for a target accumulate over dependency lines when this operator
403 The target is removed if
407 Targets are always re-created, but not until all sources have been
408 examined and re-created as necessary.
409 Sources for a target accumulate over dependency lines when this operator
411 The target is removed if
415 If no sources are specified, the target is always re-created.
416 Otherwise, a target is considered out-of-date if any of its sources has
417 been modified more recently than the target.
418 Sources for a target do not accumulate over dependency lines when this
420 The target will not be removed if
425 Targets and sources may contain the shell wildcard values
436 may only be used as part of the final
437 component of the target or source, and must be used to describe existing
441 need not necessarily be used to describe existing files.
442 Expansion is in directory order, not alphabetically as done in the shell.
444 Each target may have associated with it a series of shell commands, normally
445 used to create the target.
446 Each of the commands in this script
448 be preceded by a tab.
449 While any target may appear on a dependency line, only one of these
450 dependencies may be followed by a creation script, unless the
454 If the first characters of the command line are any combination of
459 the command is treated specially.
462 causes the command not to be echoed before it is executed.
465 causes the command to be executed even when
468 This is similar to the effect of the .MAKE special source,
469 except that the effect can be limited to a single line of a script.
472 causes any non-zero exit status of the command line to be ignored.
476 is run in jobs mode with
478 the entire script for the target is fed to a
479 single instance of the shell.
481 In compatibility (non-jobs) mode, each command is run in a separate process.
482 If the command contains any shell meta characters
483 .Pq Ql #=|^(){};&<>*?[]:$`\e\en
484 it will be passed to the shell, otherwise
486 will attempt direct execution.
494 before executing any targets, each child process
495 starts with that as its current working directory.
497 Makefiles should be written so that the mode of
499 operation does not change their behavior.
500 For example, any command which needs to use
504 without side-effect should be put in parenthesis:
505 .Bd -literal -offset indent
507 avoid-chdir-side-effects:
508 @echo Building $@ in `pwd`
509 @(cd ${.CURDIR} && ${.MAKE} $@)
512 ensure-one-shell-regardless-of-mode:
513 @echo Building $@ in `pwd`; \\
514 (cd ${.CURDIR} && ${.MAKE} $@); \\
517 .Sh VARIABLE ASSIGNMENTS
518 Variables in make are much like variables in the shell, and, by tradition,
519 consist of all upper-case letters.
520 .Ss Variable assignment modifiers
521 The five operators that can be used to assign values to variables are as
525 Assign the value to the variable.
526 Any previous value is overridden.
528 Append the value to the current value of the variable.
530 Assign the value to the variable if it is not already defined.
532 Assign with expansion, i.e. expand the value before assigning it
534 Normally, expansion is not done until the variable is referenced.
536 References to undefined variables are
539 This can cause problems when variable modifiers are used.
541 Expand the value and pass it to the shell for execution and assign
542 the result to the variable.
543 Any newlines in the result are replaced with spaces.
546 Any white-space before the assigned
548 is removed; if the value is being appended, a single space is inserted
549 between the previous contents of the variable and the appended value.
551 Variables are expanded by surrounding the variable name with either
556 and preceding it with
559 If the variable name contains only a single letter, the surrounding
560 braces or parentheses are not required.
561 This shorter form is not recommended.
563 If the variable name contains a dollar, then the name itself is expanded first.
564 This allows almost arbitrary variable names, however names containing dollar,
565 braces, parenthesis, or whitespace are really best avoided!
567 If the result of expanding a variable contains a dollar sign
569 the string is expanded again.
571 Variable substitution occurs at three distinct times, depending on where
572 the variable is being used.
575 Variables in dependency lines are expanded as the line is read.
577 Variables in shell commands are expanded when the shell command is
581 loop index variables are expanded on each loop iteration.
582 Note that other variables are not expanded inside loops so
583 the following example code:
584 .Bd -literal -offset indent
598 .Bd -literal -offset indent
603 Because while ${a} contains
605 after the loop is executed, ${b}
610 since after the loop completes ${j} contains
614 The four different classes of variables (in order of increasing precedence)
617 .It Environment variables
618 Variables defined as part of
622 Variables defined in the makefile or in included makefiles.
623 .It Command line variables
624 Variables defined as part of the command line.
626 Variables that are defined specific to a certain target.
627 The seven local variables are as follows:
628 .Bl -tag -width ".ARCHIVE"
630 The list of all sources for this target; also known as
633 The name of the archive file.
635 In suffix-transformation rules, the name/path of the source from which the
636 target is to be transformed (the
638 source); also known as
640 It is not defined in explicit rules.
642 The name of the archive member.
644 The list of sources for this target that were deemed out-of-date; also
648 The file prefix of the target, containing only the file portion, no suffix
649 or preceding directory components; also known as
652 The name of the target; also known as
663 are permitted for backward
664 compatibility with historical makefiles and are not recommended.
673 are permitted for compatibility with
675 makefiles and are not recommended.
677 Four of the local variables may be used in sources on dependency lines
678 because they expand to the proper value for each target on the line.
686 .Ss Additional built-in variables
689 sets or knows about the following variables:
690 .Bl -tag -width .MAKEOVERRIDES
696 expands to a single dollar
699 The list of all targets encountered in the Makefile.
701 Makefile parsing, lists only those targets encountered thus far.
703 A path to the directory where
706 Refer to the description of
709 .It Va .INCLUDEDFROMDIR
710 The directory of the file this Makefile was included from.
711 .It Va .INCLUDEDFROMFILE
712 The filename of the file this Makefile was included from.
723 The preferred variable to use is the environment variable
725 because it is more compatible with other versions of
727 and cannot be confused with the special target with the same name.
728 .It Va .MAKE.ALWAYS_PASS_JOB_QUEUE
731 whether to pass the descriptors of the job token queue
732 even if the target is not tagged with
736 for backwards compatability with
739 .It Va .MAKE.DEPENDFILE
740 Names the makefile (default
742 from which generated dependencies are read.
743 .It Va .MAKE.EXPAND_VARIABLES
744 A boolean that controls the default behavior of the
747 .It Va .MAKE.EXPORTED
748 The list of variables exported by
754 .It Va .MAKE.JOB.PREFIX
759 then output for each target is prefixed with a token
761 the first part of which can be controlled via
762 .Va .MAKE.JOB.PREFIX .
765 is empty, no token is printed.
768 .Li .MAKE.JOB.PREFIX=${.newline}---${.MAKE:T}[${.MAKE.PID}]
769 would produce tokens like
770 .Ql ---make[1234] target ---
771 making it easier to track the degree of parallelism being achieved.
773 The environment variable
775 may contain anything that
779 Anything specified on
781 command line is appended to the
783 variable which is then
784 entered into the environment for all programs which
788 The recursion depth of
790 The initial instance of
792 will be 0, and an incremented value is put into the environment
793 to be seen by the next generation.
794 This allows tests like:
795 .Li .if ${.MAKE.LEVEL} == 0
796 to protect things which should only be evaluated in the initial instance of
798 .It Va .MAKE.MAKEFILE_PREFERENCE
799 The ordered list of makefile names
806 .It Va .MAKE.MAKEFILES
807 The list of makefiles read by
809 which is useful for tracking dependencies.
810 Each makefile is recorded only once, regardless of the number of times read.
812 Processed after reading all makefiles.
813 Can affect the mode that
816 It can contain a number of keywords:
817 .Bl -hang -width ignore-cmd
827 into "meta" mode, where meta files are created for each target
828 to capture the command run, the output generated and if
830 is available, the system calls which are of interest to
832 The captured output can be very useful when diagnosing errors.
833 .It Pa curdirOk= Ar bf
836 will not create .meta files in
838 This can be overridden by setting
840 to a value which represents True.
842 For debugging, it can be useful to inlcude the environment
845 If in "meta" mode, print a clue about the target being built.
846 This is useful if the build is otherwise running silently.
847 The message printed the value of:
848 .Va .MAKE.META.PREFIX .
850 Some makefiles have commands which are simply not stable.
851 This keyword causes them to be ignored for
852 determining whether a target is out of date in "meta" mode.
858 is True, when a .meta file is created, mark the target
861 .It Va .MAKE.META.BAILIWICK
862 In "meta" mode, provides a list of prefixes which
863 match the directories controlled by
865 If a file that was generated outside of
867 but within said bailiwick is missing,
868 the current target is considered out-of-date.
869 .It Va .MAKE.META.CREATED
870 In "meta" mode, this variable contains a list of all the meta files
872 If not empty, it can be used to trigger processing of
873 .Va .MAKE.META.FILES .
874 .It Va .MAKE.META.FILES
875 In "meta" mode, this variable contains a list of all the meta files
876 used (updated or not).
877 This list can be used to process the meta files to extract dependency
879 .It Va .MAKE.META.IGNORE_PATHS
880 Provides a list of path prefixes that should be ignored;
881 because the contents are expected to change over time.
882 The default list includes:
883 .Ql Pa /dev /etc /proc /tmp /var/run /var/tmp
884 .It Va .MAKE.META.PREFIX
885 Defines the message printed for each meta file updated in "meta verbose" mode.
886 The default value is:
887 .Dl Building ${.TARGET:H:tA}/${.TARGET:T}
888 .It Va .MAKEOVERRIDES
889 This variable is used to record the names of variables assigned to
890 on the command line, so that they may be exported as part of
892 This behaviour can be disabled by assigning an empty value to
893 .Ql Va .MAKEOVERRIDES
895 Extra variables can be exported from a makefile
896 by appending their names to
897 .Ql Va .MAKEOVERRIDES .
899 is re-exported whenever
900 .Ql Va .MAKEOVERRIDES
902 .It Va .MAKE.PATH_FILEMON
907 support, this is set to the path of the device node.
908 This allows makefiles to test for this support.
913 The parent process-id of
915 .It Va MAKE_PRINT_VAR_ON_ERROR
918 stops due to an error, it prints its name and the value of
920 as well as the value of any variables named in
921 .Ql Va MAKE_PRINT_VAR_ON_ERROR .
923 This variable is simply assigned a newline character as its value.
924 This allows expansions using the
926 modifier to put a newline between
927 iterations of the loop rather than a space.
928 For example, the printing of
929 .Ql Va MAKE_PRINT_VAR_ON_ERROR
930 could be done as ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}.
932 A path to the directory where the targets are built.
933 Its value is determined by trying to
935 to the following directories in order and using the first match:
938 .Ev ${MAKEOBJDIRPREFIX}${.CURDIR}
941 .Ql Ev MAKEOBJDIRPREFIX
942 is set in the environment or on the command line.)
948 is set in the environment or on the command line.)
950 .Ev ${.CURDIR} Ns Pa /obj. Ns Ev ${MACHINE}
952 .Ev ${.CURDIR} Ns Pa /obj
954 .Pa /usr/obj/ Ns Ev ${.CURDIR}
959 Variable expansion is performed on the value before it's used,
960 so expressions such as
961 .Dl ${.CURDIR:S,^/usr/src,/var/obj,}
963 This is especially useful with
967 may be modified in the makefile as a global variable.
976 to that directory before executing any targets.
979 A path to the directory of the current
983 The basename of the current
988 are both set only while the
991 If you want to retain their current values, assign them to a variable
992 using assignment with expansion:
995 A variable that represents the list of directories that
997 will search for files.
998 The search list should be updated using the target
1000 rather than the variable.
1002 Alternate path to the current directory.
1006 to the canonical path given by
1008 However, if the environment variable
1010 is set and gives a path to the current directory, then
1017 This behaviour is disabled if
1018 .Ql Ev MAKEOBJDIRPREFIX
1021 contains a variable transform.
1023 is set to the value of
1025 for all programs which
1029 The list of targets explicitly specified on the command line, if any.
1033 lists of directories that
1035 will search for files.
1036 The variable is supported for compatibility with old make programs only,
1041 .Ss Variable modifiers
1042 Variable expansion may be modified to select or modify each word of the
1045 is white-space delimited sequence of characters).
1046 The general format of a variable expansion is as follows:
1048 .Dl ${variable[:modifier[:...]]}
1050 Each modifier begins with a colon,
1051 which may be escaped with a backslash
1054 A set of modifiers can be specified via a variable, as follows:
1056 .Dl modifier_variable=modifier[:...]
1057 .Dl ${variable:${modifier_variable}[:...]}
1059 In this case the first modifier in the modifier_variable does not
1060 start with a colon, since that must appear in the referencing
1062 If any of the modifiers in the modifier_variable contain a dollar sign
1064 these must be doubled to avoid early expansion.
1066 The supported modifiers are:
1069 Replaces each word in the variable with its suffix.
1071 Replaces each word in the variable with everything but the last component.
1072 .It Cm \&:M Ns Ar pattern
1073 Select only those words that match
1075 The standard shell wildcard characters
1082 The wildcard characters may be escaped with a backslash
1084 As a consequence of the way values are split into words, matched,
1085 and then joined, a construct like
1087 will normalise the inter-word spacing, removing all leading and
1088 trailing space, and converting multiple consecutive spaces
1091 .It Cm \&:N Ns Ar pattern
1092 This is identical to
1094 but selects all words which do not match
1097 Order every word in variable alphabetically.
1099 reverse order use the
1101 combination of modifiers.
1103 Randomize words in variable.
1104 The results will be different each time you are referring to the
1105 modified variable; use the assignment with expansion
1107 to prevent such behaviour.
1109 .Bd -literal -offset indent
1110 LIST= uno due tre quattro
1111 RANDOM_LIST= ${LIST:Ox}
1112 STATIC_RANDOM_LIST:= ${LIST:Ox}
1115 @echo "${RANDOM_LIST}"
1116 @echo "${RANDOM_LIST}"
1117 @echo "${STATIC_RANDOM_LIST}"
1118 @echo "${STATIC_RANDOM_LIST}"
1120 may produce output similar to:
1121 .Bd -literal -offset indent
1128 Quotes every shell meta-character in the variable, so that it can be passed
1129 safely through recursive invocations of
1132 Replaces each word in the variable with everything but its suffix.
1134 The value is a format string for
1139 Compute a 32bit hash of the value and encode it as hex digits.
1141 The value is a format string for
1146 Attempt to convert variable to an absolute path using
1148 if that fails, the value is unchanged.
1150 Converts variable to lower-case letters.
1151 .It Cm \&:ts Ns Ar c
1152 Words in the variable are normally separated by a space on expansion.
1153 This modifier sets the separator to the character
1157 is omitted, then no separator is used.
1158 The common escapes (including octal numeric codes), work as expected.
1160 Converts variable to upper-case letters.
1162 Causes the value to be treated as a single word
1163 (possibly containing embedded white space).
1167 Causes the value to be treated as a sequence of
1168 words delimited by white space.
1172 .It Cm \&:S No \&/ Ar old_string No \&/ Ar new_string No \&/ Op Cm 1gW
1174 Modify the first occurrence of
1176 in the variable's value, replacing it with
1180 is appended to the last slash of the pattern, all occurrences
1181 in each word are replaced.
1184 is appended to the last slash of the pattern, only the first word
1188 is appended to the last slash of the pattern,
1189 then the value is treated as a single word
1190 (possibly containing embedded white space).
1196 is anchored at the beginning of each word.
1199 ends with a dollar sign
1201 it is anchored at the end of each word.
1212 Any character may be used as a delimiter for the parts of the modifier
1214 The anchoring, ampersand and delimiter characters may be escaped with a
1218 Variable expansion occurs in the normal fashion inside both
1222 with the single exception that a backslash is used to prevent the expansion
1225 not a preceding dollar sign as is usual.
1227 .It Cm \&:C No \&/ Ar pattern No \&/ Ar replacement No \&/ Op Cm 1gW
1231 modifier is just like the
1233 modifier except that the old and new strings, instead of being
1234 simple strings, are an extended regular expression (see
1242 Normally, the first occurrence of the pattern
1244 in each word of the value is substituted with
1248 modifier causes the substitution to apply to at most one word; the
1250 modifier causes the substitution to apply to as many instances of the
1253 as occur in the word or words it is found in; the
1255 modifier causes the value to be treated as a single word
1256 (possibly containing embedded white space).
1261 are orthogonal; the former specifies whether multiple words are
1262 potentially affected, the latter whether multiple substitutions can
1263 potentially occur within each affected word.
1271 are subjected to variable expansion before being parsed as
1272 regular expressions.
1274 Replaces each word in the variable with its last component.
1276 Remove adjacent duplicate words (like
1279 .It Cm \&:\&? Ar true_string Cm \&: Ar false_string
1281 If the variable name (not its value), when parsed as a .if conditional
1282 expression, evaluates to true, return as its value the
1284 otherwise return the
1286 Since the variable name is used as the expression, \&:\&? must be the
1287 first modifier after the variable name itself - which will, of course,
1288 usually contain variable expansions.
1289 A common error is trying to use expressions like
1290 .Dl ${NUMBERS:M42:?match:no}
1291 which actually tests defined(NUMBERS),
1292 to determine is any words match "42" you need to use something like:
1293 .Dl ${"${NUMBERS:M42}" != \&"\&":?match:no} .
1294 .It Ar :old_string=new_string
1297 style variable substitution.
1298 It must be the last modifier specified.
1303 do not contain the pattern matching character
1305 then it is assumed that they are
1306 anchored at the end of each word, so only suffixes or entire
1307 words may be replaced.
1315 Variable expansion occurs in the normal fashion inside both
1319 with the single exception that a backslash is used to prevent the
1320 expansion of a dollar sign
1322 not a preceding dollar sign as is usual.
1324 .It Cm \&:@ Ar temp Cm @ Ar string Cm @
1326 This is the loop expansion mechanism from the OSF Development
1327 Environment (ODE) make.
1330 loops expansion occurs at the time of
1334 to each word in the variable and evaluate
1336 The ODE convention is that
1338 should start and end with a period.
1340 .Dl ${LINKS:@.LINK.@${LN} ${TARGET} ${.LINK.}@}
1342 However a single character variable is often more readable:
1343 .Dl ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}
1344 .It Cm \&:U Ns Ar newval
1345 If the variable is undefined
1348 If the variable is defined, the existing value is returned.
1349 This is another ODE make feature.
1350 It is handy for setting per-target CFLAGS for instance:
1351 .Dl ${_${.TARGET:T}_CFLAGS:U${DEF_CFLAGS}}
1352 If a value is only required if the variable is undefined, use:
1353 .Dl ${VAR:D:Unewval}
1354 .It Cm \&:D Ns Ar newval
1355 If the variable is defined
1359 The name of the variable is the value.
1361 The path of the node which has the same name as the variable
1363 If no such node exists or its path is null, then the
1364 name of the variable is used.
1365 In order for this modifier to work, the name (node) must at least have
1366 appeared on the rhs of a dependency.
1368 .It Cm \&:\&! Ar cmd Cm \&!
1370 The output of running
1374 If the variable is non-empty it is run as a command and the output
1375 becomes the new value.
1376 .It Cm \&::= Ns Ar str
1377 The variable is assigned the value
1380 This modifier and its variations are useful in
1381 obscure situations such as wanting to set a variable when shell commands
1383 These assignment modifiers always expand to
1384 nothing, so if appearing in a rule line by themselves should be
1385 preceded with something to keep
1391 helps avoid false matches with the
1395 modifier and since substitution always occurs the
1397 form is vaguely appropriate.
1398 .It Cm \&::?= Ns Ar str
1401 but only if the variable does not already have a value.
1402 .It Cm \&::+= Ns Ar str
1406 .It Cm \&::!= Ns Ar cmd
1407 Assign the output of
1410 .It Cm \&:\&[ Ns Ar range Ns Cm \&]
1411 Selects one or more words from the value,
1412 or performs other operations related to the way in which the
1413 value is divided into words.
1415 Ordinarily, a value is treated as a sequence of words
1416 delimited by white space.
1417 Some modifiers suppress this behaviour,
1418 causing a value to be treated as a single word
1419 (possibly containing embedded white space).
1420 An empty value, or a value that consists entirely of white-space,
1421 is treated as a single word.
1422 For the purposes of the
1424 modifier, the words are indexed both forwards using positive integers
1425 (where index 1 represents the first word),
1426 and backwards using negative integers
1427 (where index \-1 represents the last word).
1431 is subjected to variable expansion, and the expanded result is
1432 then interpreted as follows:
1433 .Bl -tag -width index
1436 Selects a single word from the value.
1438 .It Ar start Ns Cm \&.. Ns Ar end
1439 Selects all words from
1446 selects all words from the second word to the last word.
1451 then the words are output in reverse order.
1454 selects all the words from last to first.
1457 Causes subsequent modifiers to treat the value as a single word
1458 (possibly containing embedded white space).
1459 Analogous to the effect of
1468 Causes subsequent modifiers to treat the value as a sequence of words
1469 delimited by white space.
1470 Analogous to the effect of
1475 Returns the number of words in the value.
1478 .Sh INCLUDE STATEMENTS, CONDITIONALS AND FOR LOOPS
1479 Makefile inclusion, conditional structures and for loops reminiscent
1480 of the C programming language are provided in
1482 All such structures are identified by a line beginning with a single
1486 Files are included with either
1487 .Cm \&.include Aq Ar file
1489 .Cm \&.include Pf \*q Ar file Ns \*q .
1490 Variables between the angle brackets or double quotes are expanded
1491 to form the file name.
1492 If angle brackets are used, the included makefile is expected to be in
1493 the system makefile directory.
1494 If double quotes are used, the including makefile's directory and any
1495 directories specified using the
1497 option are searched before the system
1499 For compatibility with other versions of
1501 .Ql include file ...
1503 If the include statement is written as
1507 then errors locating and/or opening include files are ignored.
1509 Conditional expressions are also preceded by a single dot as the first
1510 character of a line.
1511 The possible conditionals are as follows:
1513 .It Ic .error Ar message
1514 The message is printed along with the name of the makefile and line number,
1518 .It Ic .export Ar variable ...
1519 Export the specified global variable.
1520 If no variable list is provided, all globals are exported
1521 except for internal variables (those that start with
1523 This is not affected by the
1525 flag, so should be used with caution.
1526 For compatibility with other
1529 .Ql export variable=value
1532 Appending a variable name to
1534 is equivalent to exporting a variable.
1535 .It Ic .export-env Ar variable ...
1538 except that the variable is not appended to
1539 .Va .MAKE.EXPORTED .
1540 This allows exporting a value to the environment which is different from that
1544 .It Ic .info Ar message
1545 The message is printed along with the name of the makefile and line number.
1546 .It Ic .undef Ar variable
1547 Un-define the specified global variable.
1548 Only global variables may be un-defined.
1549 .It Ic .unexport Ar variable ...
1552 The specified global
1554 will be removed from
1555 .Va .MAKE.EXPORTED .
1556 If no variable list is provided, all globals are unexported,
1560 .It Ic .unexport-env
1561 Unexport all globals previously exported and
1562 clear the environment inherited from the parent.
1563 This operation will cause a memory leak of the original environment,
1564 so should be used sparingly.
1567 being 0, would make sense.
1568 Also note that any variables which originated in the parent environment
1569 should be explicitly preserved if desired.
1571 .Bd -literal -offset indent
1572 .Li .if ${.MAKE.LEVEL} == 0
1579 Would result in an environment containing only
1581 which is the minimal useful environment.
1584 will also be pushed into the new environment.
1585 .It Ic .warning Ar message
1586 The message prefixed by
1588 is printed along with the name of the makefile and line number.
1589 .It Ic \&.if Oo \&! Oc Ns Ar expression Op Ar operator expression ...
1590 Test the value of an expression.
1591 .It Ic .ifdef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1592 Test the value of a variable.
1593 .It Ic .ifndef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1594 Test the value of a variable.
1595 .It Ic .ifmake Oo \&! Oc Ns Ar target Op Ar operator target ...
1596 Test the target being built.
1597 .It Ic .ifnmake Oo \&! Ns Oc Ar target Op Ar operator target ...
1598 Test the target being built.
1600 Reverse the sense of the last conditional.
1601 .It Ic .elif Oo \&! Ns Oc Ar expression Op Ar operator expression ...
1606 .It Ic .elifdef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1611 .It Ic .elifndef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1616 .It Ic .elifmake Oo \&! Oc Ns Ar target Op Ar operator target ...
1621 .It Ic .elifnmake Oo \&! Oc Ns Ar target Op Ar operator target ...
1627 End the body of the conditional.
1632 may be any one of the following:
1633 .Bl -tag -width "Cm XX"
1636 .It Cm \&\*[Am]\*[Am]
1639 of higher precedence than
1645 will only evaluate a conditional as far as is necessary to determine
1647 Parentheses may be used to change the order of evaluation.
1648 The boolean operator
1650 may be used to logically negate an entire
1652 It is of higher precedence than
1653 .Ql Ic \&\*[Am]\*[Am] .
1657 may be any of the following:
1658 .Bl -tag -width defined
1660 Takes a variable name as an argument and evaluates to true if the variable
1663 Takes a target name as an argument and evaluates to true if the target
1664 was specified as part of
1666 command line or was declared the default target (either implicitly or
1669 before the line containing the conditional.
1671 Takes a variable, with possible modifiers, and evaluates to true if
1672 the expansion of the variable would result in an empty string.
1674 Takes a file name as an argument and evaluates to true if the file exists.
1675 The file is searched for on the system search path (see
1678 Takes a target name as an argument and evaluates to true if the target
1681 Takes a target name as an argument and evaluates to true if the target
1682 has been defined and has commands associated with it.
1686 may also be an arithmetic or string comparison.
1687 Variable expansion is
1688 performed on both sides of the comparison, after which the integral
1689 values are compared.
1690 A value is interpreted as hexadecimal if it is
1691 preceded by 0x, otherwise it is decimal; octal numbers are not supported.
1692 The standard C relational operators are all supported.
1694 variable expansion, either the left or right hand side of a
1698 operator is not an integral value, then
1699 string comparison is performed between the expanded
1701 If no relational operator is given, it is assumed that the expanded
1702 variable is being compared against 0 or an empty string in the case
1703 of a string comparison.
1707 is evaluating one of these conditional expressions, and it encounters
1708 a (white-space separated) word it doesn't recognize, either the
1712 expression is applied to it, depending on the form of the conditional.
1720 expression is applied.
1721 Similarly, if the form is
1724 .Ql Ic .ifnmake , the
1726 expression is applied.
1728 If the conditional evaluates to true the parsing of the makefile continues
1730 If it evaluates to false, the following lines are skipped.
1731 In both cases this continues until a
1737 For loops are typically used to apply a set of rules to a list of files.
1738 The syntax of a for loop is:
1740 .Bl -tag -compact -width Ds
1741 .It Ic \&.for Ar variable Oo Ar variable ... Oc Ic in Ar expression
1748 is evaluated, it is split into words.
1749 On each iteration of the loop, one word is taken and assigned to each
1753 are substituted into the
1755 inside the body of the for loop.
1756 The number of words must come out even; that is, if there are three
1757 iteration variables, the number of words provided must be a multiple
1760 Comments begin with a hash
1762 character, anywhere but in a shell
1763 command line, and continue to the end of an unescaped new line.
1764 .Sh SPECIAL SOURCES (ATTRIBUTES)
1765 .Bl -tag -width .IGNOREx
1767 Target is never out of date, but always execute commands anyway.
1769 Ignore any errors from the commands associated with this target, exactly
1770 as if they all were preceded by a dash
1772 .\" .It Ic .INVISIBLE
1777 Mark all sources of this target as being up-to-date.
1779 Execute the commands associated with this target even if the
1783 options were specified.
1784 Normally used to mark recursive
1787 Create a meta file for the target, even if it is flagged as
1792 Usage in conjunction with
1794 is the most likely case.
1795 In "meta" mode, the target is out-of-date if the meta file is missing.
1797 Do not create a meta file for the target.
1798 Meta files are also not created for
1805 Ignore differences in commands when deciding if target is out of date.
1806 This is useful if the command contains a value which always changes.
1807 If the number of commands change, though, the target will still be out of date.
1808 The same effect applies to any command line that uses the variable
1810 which can be used for that purpose even when not otherwise needed or desired:
1811 .Bd -literal -offset indent
1813 skip-compare-for-some:
1814 @echo this will be compared
1815 @echo this will not ${.OODATE:M.NOMETA_CMP}
1816 @echo this will also be compared
1821 pattern suppresses any expansion of the unwanted variable.
1823 Do not search for the target in the directories specified by
1828 selects the first target it encounters as the default target to be built
1829 if no target was specified.
1830 This source prevents this target from being selected.
1832 If a target is marked with this attribute and
1834 can't figure out how to create it, it will ignore this fact and assume
1835 the file isn't needed or already exists.
1838 correspond to an actual file; it is always considered to be out of date,
1839 and will not be created with the
1842 Suffix-transformation rules are not applied to
1848 is interrupted, it normally removes any partially made targets.
1849 This source prevents the target from being removed.
1854 Do not echo any of the commands associated with this target, exactly
1855 as if they all were preceded by an at sign
1858 Turn the target into
1861 When the target is used as a source for another target, the other target
1862 acquires the commands, sources, and attributes (except for
1866 If the target already has commands, the
1868 target's commands are appended
1875 target commands to the target.
1879 appears in a dependency line, the sources that precede it are
1880 made before the sources that succeed it in the line.
1881 Since the dependents of files are not made until the file itself
1882 could be made, this also stops the dependents being built unless they
1883 are needed for another branch of the dependency tree.
1896 the output is always
1902 The ordering imposed by
1904 is only relevant for parallel makes.
1907 Special targets may not be included with other targets, i.e. they must be
1908 the only target specified.
1909 .Bl -tag -width .BEGINx
1911 Any command lines attached to this target are executed before anything
1916 rule for any target (that was used only as a
1919 can't figure out any other way to create.
1920 Only the shell script is used.
1923 variable of a target that inherits
1926 to the target's own name.
1928 Any command lines attached to this target are executed after everything
1931 Any command lines attached to this target are executed when another target fails.
1934 variable is set to the target that failed.
1936 .Ic MAKE_PRINT_VAR_ON_ERROR .
1938 Mark each of the sources with the
1941 If no sources are specified, this is the equivalent of specifying the
1947 is interrupted, the commands for this target will be executed.
1949 If no target is specified when
1951 is invoked, this target will be built.
1953 This target provides a way to specify flags for
1955 when the makefile is used.
1956 The flags are as if typed to the shell, though the
1960 .\" XXX: NOT YET!!!!
1961 .\" .It Ic .NOTPARALLEL
1962 .\" The named targets are executed in non parallel mode.
1963 .\" If no targets are
1964 .\" specified, then all targets are executed in non parallel mode.
1968 attribute to any specified sources.
1970 Disable parallel mode.
1974 for compatibility with other pmake variants.
1976 The named targets are made in sequence.
1977 This ordering does not add targets to the list of targets to be made.
1978 Since the dependents of a target do not get built until the target itself
1979 could be built, unless
1981 is built by another part of the dependency graph,
1982 the following is a dependency loop:
1988 The ordering imposed by
1990 is only relevant for parallel makes.
1991 .\" XXX: NOT YET!!!!
1992 .\" .It Ic .PARALLEL
1993 .\" The named targets are executed in parallel mode.
1994 .\" If no targets are
1995 .\" specified, then all targets are executed in parallel mode.
1997 The sources are directories which are to be searched for files not
1998 found in the current directory.
1999 If no sources are specified, any previously specified directories are
2001 If the source is the special
2003 target, then the current working
2004 directory is searched last.
2005 .It Ic .PATH. Ns Va suffix
2008 but applies only to files with a particular suffix.
2009 The suffix must have been previously declared with
2014 attribute to any specified sources.
2018 attribute to any specified sources.
2019 If no sources are specified, the
2021 attribute is applied to every
2026 will use to execute commands.
2027 The sources are a set of
2030 .Bl -tag -width hasErrCtls
2032 This is the minimal specification, used to select one of the builtin
2039 Specifies the path to the shell.
2041 Indicates whether the shell supports exit on error.
2043 The command to turn on error checking.
2045 The command to disable error checking.
2047 The command to turn on echoing of commands executed.
2049 The command to turn off echoing of commands executed.
2051 The output to filter after issuing the
2054 It is typically identical to
2057 The flag to pass the shell to enable error checking.
2059 The flag to pass the shell to enable command echoing.
2061 The string literal to pass the shell that results in a single newline
2062 character when used outside of any quoting characters.
2066 \&.SHELL: name=ksh path=/bin/ksh hasErrCtl=true \e
2067 check="set \-e" ignore="set +e" \e
2068 echo="set \-v" quiet="set +v" filter="set +v" \e
2069 echoFlag=v errFlag=e newline="'\en'"
2074 attribute to any specified sources.
2075 If no sources are specified, the
2077 attribute is applied to every
2078 command in the file.
2080 This target gets run when a dependency file contains stale entries, having
2082 set to the name of that dependency file.
2084 Each source specifies a suffix to
2086 If no sources are specified, any previously specified suffixes are deleted.
2087 It allows the creation of suffix-transformation rules.
2093 cc \-o ${.TARGET} \-c ${.IMPSRC}
2098 uses the following environment variables, if they exist:
2104 .Ev MAKEOBJDIRPREFIX ,
2110 .Ev MAKEOBJDIRPREFIX
2113 may only be set in the environment or on the command line to
2115 and not as makefile variables;
2116 see the description of
2120 .Bl -tag -width /usr/share/mk -compact
2122 list of dependencies
2124 list of dependencies
2126 list of dependencies
2130 system makefile directory
2133 The basic make syntax is compatible between different versions of make,
2134 however the special variables, variable modifiers and conditionals are not.
2136 The way that parallel makes are scheduled changed in
2138 so that .ORDER and .WAIT apply recursively to the dependent nodes.
2139 The algorithms used may change again in the future.
2141 The way that .for loop variables are substituted changed after
2143 so that they still appear to be variable expansions.
2144 In particular this stops them being treated as syntax, and removes some
2145 obscure problems using them in .if statements.
2155 implementation is based on Adam De Boor's pmake program which was written
2156 for Sprite at Berkeley.
2157 It was designed to be a parallel distributed make running jobs on different
2158 machines using a daemon called
2161 Historically the target/dependency
2163 has been used to FoRCe rebuilding (since the target/dependency
2164 does not exist... unless someone creates an
2170 syntax is difficult to parse without actually acting of the data.
2171 For instance finding the end of a variable use should involve scanning each
2172 the modifiers using the correct terminator for each field.
2175 just counts {} and () in order to find the end of a variable expansion.
2177 There is no way of escaping a space character in a filename.