1 .\" $NetBSD: make.1,v 1.213 2013/03/31 05:49:51 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 Run shell commands with
215 so the actual commands are printed as they are executed.
218 Specify that environment variables override macro assignments within
221 Specify a makefile to read instead of the default
227 standard input is read.
228 Multiple makefiles may be specified, and are read in the order specified.
229 .It Fl I Ar directory
230 Specify a directory in which to search for makefiles and included makefiles.
231 The system makefile directory (or directories, see the
233 option) is automatically included as part of this list.
235 Ignore non-zero exit of shell commands in the makefile.
236 Equivalent to specifying
238 before each command line in the makefile.
242 be specified by the user.
246 option is in use in a recursive build, this option is passed by a make
247 to child makes to allow all the make processes in the build to
248 cooperate to avoid overloading the system.
250 Specify the maximum number of jobs that
252 may have running at any one time.
253 The value is saved in
255 Turns compatibility mode off, unless the
257 flag is also specified.
258 When compatibility mode is off, all commands associated with a
259 target are executed in a single shell invocation as opposed to the
260 traditional one shell invocation per line.
261 This can break traditional scripts which change directories on each
262 command invocation and then expect to start with a fresh environment
264 It is more efficient to correct the scripts rather than turn backwards
267 Continue processing after errors are encountered, but only on those targets
268 that do not depend on the target whose creation caused the error.
269 .It Fl m Ar directory
270 Specify a directory in which to search for sys.mk and makefiles included
272 .Ao Ar file Ac Ns -style
276 option can be used multiple times to form a search path.
277 This path will override the default system include path: /usr/share/mk.
278 Furthermore the system include path will be appended to the search path used
280 .Qo Ar file Qc Ns -style
281 include statements (see the
285 If a file or directory name in the
289 environment variable) starts with the string
293 will search for the specified file or directory named in the remaining part
294 of the argument string.
295 The search starts with the current directory of
296 the Makefile and then works upward towards the root of the filesystem.
297 If the search is successful, then the resulting directory replaces the
302 If used, this feature allows
304 to easily search in the current source tree for customized sys.mk files
309 Display the commands that would have been executed, but do not
310 actually execute them unless the target depends on the .MAKE special
313 Display the commands which would have been executed, but do not
314 actually execute any of them; useful for debugging top-level makefiles
315 without descending into subdirectories.
317 Do not execute any commands, but exit 0 if the specified targets are
318 up-to-date and 1, otherwise.
320 Do not use the built-in rules specified in the system makefile.
322 Do not echo any commands as they are executed.
323 Equivalent to specifying
325 before each command line in the makefile.
326 .It Fl T Ar tracefile
330 append a trace record to
332 for each job started and completed.
334 Rather than re-building a target as specified in the makefile, create it
335 or update its modification time to make it appear up-to-date.
341 in the global context.
342 Do not build any targets.
343 Multiple instances of this option may be specified;
344 the variables will be printed one per line,
345 with a blank line for each null or undefined variable.
350 then the value will be expanded before printing.
352 Treat any warnings during makefile parsing as errors.
354 Don't export variables passed on the command line to the environment
356 Variables passed on the command line are still exported
359 environment variable.
360 This option may be useful on systems which have a small limit on the
361 size of command arguments.
362 .It Ar variable=value
363 Set the value of the variable
367 Normally, all values passed on the command line are also exported to
368 sub-makes in the environment.
371 flag disables this behavior.
372 Variable assignments should follow options for POSIX compatibility
373 but no ordering is enforced.
376 There are seven different types of lines in a makefile: file dependency
377 specifications, shell commands, variable assignments, include statements,
378 conditional directives, for loops, and comments.
380 In general, lines may be continued from one line to the next by ending
381 them with a backslash
383 The trailing newline character and initial whitespace on the following
384 line are compressed into a single space.
385 .Sh FILE DEPENDENCY SPECIFICATIONS
386 Dependency lines consist of one or more targets, an operator, and zero
388 This creates a relationship where the targets
391 and are usually created from them.
392 The exact relationship between the target and the source is determined
393 by the operator that separates them.
394 The three operators are as follows:
397 A target is considered out-of-date if its modification time is less than
398 those of any of its sources.
399 Sources for a target accumulate over dependency lines when this operator
401 The target is removed if
405 Targets are always re-created, but not until all sources have been
406 examined and re-created as necessary.
407 Sources for a target accumulate over dependency lines when this operator
409 The target is removed if
413 If no sources are specified, the target is always re-created.
414 Otherwise, a target is considered out-of-date if any of its sources has
415 been modified more recently than the target.
416 Sources for a target do not accumulate over dependency lines when this
418 The target will not be removed if
423 Targets and sources may contain the shell wildcard values
434 may only be used as part of the final
435 component of the target or source, and must be used to describe existing
439 need not necessarily be used to describe existing files.
440 Expansion is in directory order, not alphabetically as done in the shell.
442 Each target may have associated with it a series of shell commands, normally
443 used to create the target.
444 Each of the commands in this script
446 be preceded by a tab.
447 While any target may appear on a dependency line, only one of these
448 dependencies may be followed by a creation script, unless the
452 If the first characters of the command line are any combination of
457 the command is treated specially.
460 causes the command not to be echoed before it is executed.
463 causes the command to be executed even when
466 This is similar to the effect of the .MAKE special source,
467 except that the effect can be limited to a single line of a script.
470 causes any non-zero exit status of the command line to be ignored.
474 is run in jobs mode with
476 the entire script for the target is fed to a
477 single instance of the shell.
479 In compatibility (non-jobs) mode, each command is run in a separate process.
480 If the command contains any shell meta characters
481 .Pq Ql #=|^(){};&<>*?[]:$`\e\en
482 it will be passed to the shell, otherwise
484 will attempt direct execution.
492 before executing any targets, each child process
493 starts with that as its current working directory.
495 Makefiles should be written so that the mode of
497 operation does not change their behavior.
498 For example, any command which needs to use
502 without side-effect should be put in parenthesis:
503 .Bd -literal -offset indent
505 avoid-chdir-side-effects:
506 @echo Building $@ in `pwd`
507 @(cd ${.CURDIR} && ${.MAKE} $@)
510 ensure-one-shell-regardless-of-mode:
511 @echo Building $@ in `pwd`; \\
512 (cd ${.CURDIR} && ${.MAKE} $@); \\
515 .Sh VARIABLE ASSIGNMENTS
516 Variables in make are much like variables in the shell, and, by tradition,
517 consist of all upper-case letters.
518 .Ss Variable assignment modifiers
519 The five operators that can be used to assign values to variables are as
523 Assign the value to the variable.
524 Any previous value is overridden.
526 Append the value to the current value of the variable.
528 Assign the value to the variable if it is not already defined.
530 Assign with expansion, i.e. expand the value before assigning it
532 Normally, expansion is not done until the variable is referenced.
534 References to undefined variables are
537 This can cause problems when variable modifiers are used.
539 Expand the value and pass it to the shell for execution and assign
540 the result to the variable.
541 Any newlines in the result are replaced with spaces.
544 Any white-space before the assigned
546 is removed; if the value is being appended, a single space is inserted
547 between the previous contents of the variable and the appended value.
549 Variables are expanded by surrounding the variable name with either
554 and preceding it with
557 If the variable name contains only a single letter, the surrounding
558 braces or parentheses are not required.
559 This shorter form is not recommended.
561 If the variable name contains a dollar, then the name itself is expanded first.
562 This allows almost arbitrary variable names, however names containing dollar,
563 braces, parenthesis, or whitespace are really best avoided!
565 If the result of expanding a variable contains a dollar sign
567 the string is expanded again.
569 Variable substitution occurs at three distinct times, depending on where
570 the variable is being used.
573 Variables in dependency lines are expanded as the line is read.
575 Variables in shell commands are expanded when the shell command is
579 loop index variables are expanded on each loop iteration.
580 Note that other variables are not expanded inside loops so
581 the following example code:
582 .Bd -literal -offset indent
596 .Bd -literal -offset indent
601 Because while ${a} contains
603 after the loop is executed, ${b}
608 since after the loop completes ${j} contains
612 The four different classes of variables (in order of increasing precedence)
615 .It Environment variables
616 Variables defined as part of
620 Variables defined in the makefile or in included makefiles.
621 .It Command line variables
622 Variables defined as part of the command line.
624 Variables that are defined specific to a certain target.
625 The seven local variables are as follows:
626 .Bl -tag -width ".ARCHIVE"
628 The list of all sources for this target; also known as
631 The name of the archive file.
633 In suffix-transformation rules, the name/path of the source from which the
634 target is to be transformed (the
636 source); also known as
638 It is not defined in explicit rules.
640 The name of the archive member.
642 The list of sources for this target that were deemed out-of-date; also
646 The file prefix of the target, containing only the file portion, no suffix
647 or preceding directory components; also known as
650 The name of the target; also known as
661 are permitted for backward
662 compatibility with historical makefiles and are not recommended.
671 are permitted for compatibility with
673 makefiles and are not recommended.
675 Four of the local variables may be used in sources on dependency lines
676 because they expand to the proper value for each target on the line.
684 .Ss Additional built-in variables
687 sets or knows about the following variables:
688 .Bl -tag -width .MAKEOVERRIDES
694 expands to a single dollar
697 The list of all targets encountered in the Makefile.
699 Makefile parsing, lists only those targets encountered thus far.
701 A path to the directory where
704 Refer to the description of
717 The preferred variable to use is the environment variable
719 because it is more compatible with other versions of
721 and cannot be confused with the special target with the same name.
722 .It Va .MAKE.DEPENDFILE
723 Names the makefile (default
725 from which generated dependencies are read.
726 .It Va .MAKE.EXPAND_VARIABLES
727 A boolean that controls the default behavior of the
730 .It Va .MAKE.EXPORTED
731 The list of variables exported by
737 .It Va .MAKE.JOB.PREFIX
742 then output for each target is prefixed with a token
744 the first part of which can be controlled via
745 .Va .MAKE.JOB.PREFIX .
748 .Li .MAKE.JOB.PREFIX=${.newline}---${.MAKE:T}[${.MAKE.PID}]
749 would produce tokens like
750 .Ql ---make[1234] target ---
751 making it easier to track the degree of parallelism being achieved.
753 The environment variable
755 may contain anything that
759 Anything specified on
761 command line is appended to the
763 variable which is then
764 entered into the environment for all programs which
768 The recursion depth of
770 The initial instance of
772 will be 0, and an incremented value is put into the environment
773 to be seen by the next generation.
774 This allows tests like:
775 .Li .if ${.MAKE.LEVEL} == 0
776 to protect things which should only be evaluated in the initial instance of
778 .It Va .MAKE.MAKEFILE_PREFERENCE
779 The ordered list of makefile names
786 .It Va .MAKE.MAKEFILES
787 The list of makefiles read by
789 which is useful for tracking dependencies.
790 Each makefile is recorded only once, regardless of the number of times read.
792 Processed after reading all makefiles.
793 Can affect the mode that
796 It can contain a number of keywords:
797 .Bl -hang -width ignore-cmd
807 into "meta" mode, where meta files are created for each target
808 to capture the command run, the output generated and if
810 is available, the system calls which are of interest to
812 The captured output can be very useful when diagnosing errors.
813 .It Pa curdirOk= Ar bf
816 will not create .meta files in
818 This can be overridden by setting
820 to a value which represents True.
822 For debugging, it can be useful to inlcude the environment
825 If in "meta" mode, print a clue about the target being built.
826 This is useful if the build is otherwise running silently.
827 The message printed the value of:
828 .Va .MAKE.META.PREFIX .
830 Some makefiles have commands which are simply not stable.
831 This keyword causes them to be ignored for
832 determining whether a target is out of date in "meta" mode.
838 is True, when a .meta file is created, mark the target
841 .It Va .MAKE.META.BAILIWICK
842 In "meta" mode, provides a list of prefixes which
843 match the directories controlled by
845 If a file that was generated outside of
847 but within said bailiwick is missing,
848 the current target is considered out-of-date.
849 .It Va .MAKE.META.CREATED
850 In "meta" mode, this variable contains a list of all the meta files
852 If not empty, it can be used to trigger processing of
853 .Va .MAKE.META.FILES .
854 .It Va .MAKE.META.FILES
855 In "meta" mode, this variable contains a list of all the meta files
856 used (updated or not).
857 This list can be used to process the meta files to extract dependency
859 .It Va .MAKE.META.PREFIX
860 Defines the message printed for each meta file updated in "meta verbose" mode.
861 The default value is:
862 .Dl Building ${.TARGET:H:tA}/${.TARGET:T}
863 .It Va .MAKEOVERRIDES
864 This variable is used to record the names of variables assigned to
865 on the command line, so that they may be exported as part of
867 This behaviour can be disabled by assigning an empty value to
868 .Ql Va .MAKEOVERRIDES
870 Extra variables can be exported from a makefile
871 by appending their names to
872 .Ql Va .MAKEOVERRIDES .
874 is re-exported whenever
875 .Ql Va .MAKEOVERRIDES
877 .It Va .MAKE.PATH_FILEMON
882 support, this is set to the path of the device node.
883 This allows makefiles to test for this support.
888 The parent process-id of
890 .It Va MAKE_PRINT_VAR_ON_ERROR
893 stops due to an error, it prints its name and the value of
895 as well as the value of any variables named in
896 .Ql Va MAKE_PRINT_VAR_ON_ERROR .
898 This variable is simply assigned a newline character as its value.
899 This allows expansions using the
901 modifier to put a newline between
902 iterations of the loop rather than a space.
903 For example, the printing of
904 .Ql Va MAKE_PRINT_VAR_ON_ERROR
905 could be done as ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}.
907 A path to the directory where the targets are built.
908 Its value is determined by trying to
910 to the following directories in order and using the first match:
913 .Ev ${MAKEOBJDIRPREFIX}${.CURDIR}
916 .Ql Ev MAKEOBJDIRPREFIX
917 is set in the environment or on the command line.)
923 is set in the environment or on the command line.)
925 .Ev ${.CURDIR} Ns Pa /obj. Ns Ev ${MACHINE}
927 .Ev ${.CURDIR} Ns Pa /obj
929 .Pa /usr/obj/ Ns Ev ${.CURDIR}
934 Variable expansion is performed on the value before it's used,
935 so expressions such as
936 .Dl ${.CURDIR:S,^/usr/src,/var/obj,}
938 This is especially useful with
942 may be modified in the makefile as a global variable.
951 to that directory before executing any targets.
954 A path to the directory of the current
958 The basename of the current
963 are both set only while the
966 If you want to retain their current values, assign them to a variable
967 using assignment with expansion:
970 A variable that represents the list of directories that
972 will search for files.
973 The search list should be updated using the target
975 rather than the variable.
977 Alternate path to the current directory.
981 to the canonical path given by
983 However, if the environment variable
985 is set and gives a path to the current directory, then
992 This behaviour is disabled if
993 .Ql Ev MAKEOBJDIRPREFIX
996 contains a variable transform.
998 is set to the value of
1000 for all programs which
1004 The list of targets explicitly specified on the command line, if any.
1008 lists of directories that
1010 will search for files.
1011 The variable is supported for compatibility with old make programs only,
1016 .Ss Variable modifiers
1017 Variable expansion may be modified to select or modify each word of the
1020 is white-space delimited sequence of characters).
1021 The general format of a variable expansion is as follows:
1023 .Dl ${variable[:modifier[:...]]}
1025 Each modifier begins with a colon,
1026 which may be escaped with a backslash
1029 A set of modifiers can be specified via a variable, as follows:
1031 .Dl modifier_variable=modifier[:...]
1032 .Dl ${variable:${modifier_variable}[:...]}
1034 In this case the first modifier in the modifier_variable does not
1035 start with a colon, since that must appear in the referencing
1037 If any of the modifiers in the modifier_variable contain a dollar sign
1039 these must be doubled to avoid early expansion.
1041 The supported modifiers are:
1044 Replaces each word in the variable with its suffix.
1046 Replaces each word in the variable with everything but the last component.
1047 .It Cm \&:M Ns Ar pattern
1048 Select only those words that match
1050 The standard shell wildcard characters
1057 The wildcard characters may be escaped with a backslash
1059 .It Cm \&:N Ns Ar pattern
1060 This is identical to
1062 but selects all words which do not match
1065 Order every word in variable alphabetically.
1067 reverse order use the
1069 combination of modifiers.
1071 Randomize words in variable.
1072 The results will be different each time you are referring to the
1073 modified variable; use the assignment with expansion
1075 to prevent such behaviour.
1077 .Bd -literal -offset indent
1078 LIST= uno due tre quattro
1079 RANDOM_LIST= ${LIST:Ox}
1080 STATIC_RANDOM_LIST:= ${LIST:Ox}
1083 @echo "${RANDOM_LIST}"
1084 @echo "${RANDOM_LIST}"
1085 @echo "${STATIC_RANDOM_LIST}"
1086 @echo "${STATIC_RANDOM_LIST}"
1088 may produce output similar to:
1089 .Bd -literal -offset indent
1096 Quotes every shell meta-character in the variable, so that it can be passed
1097 safely through recursive invocations of
1100 Replaces each word in the variable with everything but its suffix.
1102 The value is a format string for
1107 Compute a 32bit hash of the value and encode it as hex digits.
1109 The value is a format string for
1114 Attempt to convert variable to an absolute path using
1116 if that fails, the value is unchanged.
1118 Converts variable to lower-case letters.
1119 .It Cm \&:ts Ns Ar c
1120 Words in the variable are normally separated by a space on expansion.
1121 This modifier sets the separator to the character
1125 is omitted, then no separator is used.
1126 The common escapes (including octal numeric codes), work as expected.
1128 Converts variable to upper-case letters.
1130 Causes the value to be treated as a single word
1131 (possibly containing embedded white space).
1135 Causes the value to be treated as a sequence of
1136 words delimited by white space.
1140 .It Cm \&:S No \&/ Ar old_string No \&/ Ar new_string No \&/ Op Cm 1gW
1142 Modify the first occurrence of
1144 in the variable's value, replacing it with
1148 is appended to the last slash of the pattern, all occurrences
1149 in each word are replaced.
1152 is appended to the last slash of the pattern, only the first word
1156 is appended to the last slash of the pattern,
1157 then the value is treated as a single word
1158 (possibly containing embedded white space).
1164 is anchored at the beginning of each word.
1167 ends with a dollar sign
1169 it is anchored at the end of each word.
1180 Any character may be used as a delimiter for the parts of the modifier
1182 The anchoring, ampersand and delimiter characters may be escaped with a
1186 Variable expansion occurs in the normal fashion inside both
1190 with the single exception that a backslash is used to prevent the expansion
1193 not a preceding dollar sign as is usual.
1195 .It Cm \&:C No \&/ Ar pattern No \&/ Ar replacement No \&/ Op Cm 1gW
1199 modifier is just like the
1201 modifier except that the old and new strings, instead of being
1202 simple strings, are a regular expression (see
1210 Normally, the first occurrence of the pattern
1212 in each word of the value is substituted with
1216 modifier causes the substitution to apply to at most one word; the
1218 modifier causes the substitution to apply to as many instances of the
1221 as occur in the word or words it is found in; the
1223 modifier causes the value to be treated as a single word
1224 (possibly containing embedded white space).
1229 are orthogonal; the former specifies whether multiple words are
1230 potentially affected, the latter whether multiple substitutions can
1231 potentially occur within each affected word.
1233 Replaces each word in the variable with its last component.
1235 Remove adjacent duplicate words (like
1238 .It Cm \&:\&? Ar true_string Cm \&: Ar false_string
1240 If the variable name (not its value), when parsed as a .if conditional
1241 expression, evaluates to true, return as its value the
1243 otherwise return the
1245 Since the variable name is used as the expression, \&:\&? must be the
1246 first modifier after the variable name itself - which will, of course,
1247 usually contain variable expansions.
1248 A common error is trying to use expressions like
1249 .Dl ${NUMBERS:M42:?match:no}
1250 which actually tests defined(NUMBERS),
1251 to determine is any words match "42" you need to use something like:
1252 .Dl ${"${NUMBERS:M42}" != \&"\&":?match:no} .
1253 .It Ar :old_string=new_string
1256 style variable substitution.
1257 It must be the last modifier specified.
1262 do not contain the pattern matching character
1264 then it is assumed that they are
1265 anchored at the end of each word, so only suffixes or entire
1266 words may be replaced.
1274 Variable expansion occurs in the normal fashion inside both
1278 with the single exception that a backslash is used to prevent the
1279 expansion of a dollar sign
1281 not a preceding dollar sign as is usual.
1283 .It Cm \&:@ Ar temp Cm @ Ar string Cm @
1285 This is the loop expansion mechanism from the OSF Development
1286 Environment (ODE) make.
1289 loops expansion occurs at the time of
1293 to each word in the variable and evaluate
1295 The ODE convention is that
1297 should start and end with a period.
1299 .Dl ${LINKS:@.LINK.@${LN} ${TARGET} ${.LINK.}@}
1301 However a single character varaiable is often more readable:
1302 .Dl ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}
1303 .It Cm \&:U Ns Ar newval
1304 If the variable is undefined
1307 If the variable is defined, the existing value is returned.
1308 This is another ODE make feature.
1309 It is handy for setting per-target CFLAGS for instance:
1310 .Dl ${_${.TARGET:T}_CFLAGS:U${DEF_CFLAGS}}
1311 If a value is only required if the variable is undefined, use:
1312 .Dl ${VAR:D:Unewval}
1313 .It Cm \&:D Ns Ar newval
1314 If the variable is defined
1318 The name of the variable is the value.
1320 The path of the node which has the same name as the variable
1322 If no such node exists or its path is null, then the
1323 name of the variable is used.
1324 In order for this modifier to work, the name (node) must at least have
1325 appeared on the rhs of a dependency.
1327 .It Cm \&:\&! Ar cmd Cm \&!
1329 The output of running
1333 If the variable is non-empty it is run as a command and the output
1334 becomes the new value.
1335 .It Cm \&::= Ns Ar str
1336 The variable is assigned the value
1339 This modifier and its variations are useful in
1340 obscure situations such as wanting to set a variable when shell commands
1342 These assignment modifiers always expand to
1343 nothing, so if appearing in a rule line by themselves should be
1344 preceded with something to keep
1350 helps avoid false matches with the
1354 modifier and since substitution always occurs the
1356 form is vaguely appropriate.
1357 .It Cm \&::?= Ns Ar str
1360 but only if the variable does not already have a value.
1361 .It Cm \&::+= Ns Ar str
1365 .It Cm \&::!= Ns Ar cmd
1366 Assign the output of
1369 .It Cm \&:\&[ Ns Ar range Ns Cm \&]
1370 Selects one or more words from the value,
1371 or performs other operations related to the way in which the
1372 value is divided into words.
1374 Ordinarily, a value is treated as a sequence of words
1375 delimited by white space.
1376 Some modifiers suppress this behaviour,
1377 causing a value to be treated as a single word
1378 (possibly containing embedded white space).
1379 An empty value, or a value that consists entirely of white-space,
1380 is treated as a single word.
1381 For the purposes of the
1383 modifier, the words are indexed both forwards using positive integers
1384 (where index 1 represents the first word),
1385 and backwards using negative integers
1386 (where index \-1 represents the last word).
1390 is subjected to variable expansion, and the expanded result is
1391 then interpreted as follows:
1392 .Bl -tag -width index
1395 Selects a single word from the value.
1397 .It Ar start Ns Cm \&.. Ns Ar end
1398 Selects all words from
1405 selects all words from the second word to the last word.
1410 then the words are output in reverse order.
1413 selects all the words from last to first.
1416 Causes subsequent modifiers to treat the value as a single word
1417 (possibly containing embedded white space).
1418 Analogous to the effect of
1427 Causes subsequent modifiers to treat the value as a sequence of words
1428 delimited by white space.
1429 Analogous to the effect of
1434 Returns the number of words in the value.
1437 .Sh INCLUDE STATEMENTS, CONDITIONALS AND FOR LOOPS
1438 Makefile inclusion, conditional structures and for loops reminiscent
1439 of the C programming language are provided in
1441 All such structures are identified by a line beginning with a single
1445 Files are included with either
1446 .Cm \&.include Aq Ar file
1448 .Cm \&.include Pf \*q Ar file Ns \*q .
1449 Variables between the angle brackets or double quotes are expanded
1450 to form the file name.
1451 If angle brackets are used, the included makefile is expected to be in
1452 the system makefile directory.
1453 If double quotes are used, the including makefile's directory and any
1454 directories specified using the
1456 option are searched before the system
1458 For compatibility with other versions of
1460 .Ql include file ...
1462 If the include statement is written as
1466 then errors locating and/or opening include files are ignored.
1468 Conditional expressions are also preceded by a single dot as the first
1469 character of a line.
1470 The possible conditionals are as follows:
1472 .It Ic .error Ar message
1473 The message is printed along with the name of the makefile and line number,
1477 .It Ic .export Ar variable ...
1478 Export the specified global variable.
1479 If no variable list is provided, all globals are exported
1480 except for internal variables (those that start with
1482 This is not affected by the
1484 flag, so should be used with caution.
1485 For compatibility with other
1488 .Ql export variable=value
1491 Appending a variable name to
1493 is equivalent to exporting a variable.
1494 .It Ic .export-env Ar variable ...
1497 except that the variable is not appended to
1498 .Va .MAKE.EXPORTED .
1499 This allows exporting a value to the environment which is different from that
1503 .It Ic .info Ar message
1504 The message is printed along with the name of the makefile and line number.
1505 .It Ic .undef Ar variable
1506 Un-define the specified global variable.
1507 Only global variables may be un-defined.
1508 .It Ic .unexport Ar variable ...
1511 The specified global
1513 will be removed from
1514 .Va .MAKE.EXPORTED .
1515 If no variable list is provided, all globals are unexported,
1519 .It Ic .unexport-env
1520 Unexport all globals previously exported and
1521 clear the environment inherited from the parent.
1522 This operation will cause a memory leak of the original environment,
1523 so should be used sparingly.
1526 being 0, would make sense.
1527 Also note that any variables which originated in the parent environment
1528 should be explicitly preserved if desired.
1530 .Bd -literal -offset indent
1531 .Li .if ${.MAKE.LEVEL} == 0
1538 Would result in an environment containing only
1540 which is the minimal useful environment.
1543 will also be pushed into the new environment.
1544 .It Ic .warning Ar message
1545 The message prefixed by
1547 is printed along with the name of the makefile and line number.
1548 .It Ic \&.if Oo \&! Oc Ns Ar expression Op Ar operator expression ...
1549 Test the value of an expression.
1550 .It Ic .ifdef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1551 Test the value of a variable.
1552 .It Ic .ifndef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1553 Test the value of a variable.
1554 .It Ic .ifmake Oo \&! Oc Ns Ar target Op Ar operator target ...
1555 Test the target being built.
1556 .It Ic .ifnmake Oo \&! Ns Oc Ar target Op Ar operator target ...
1557 Test the target being built.
1559 Reverse the sense of the last conditional.
1560 .It Ic .elif Oo \&! Ns Oc Ar expression Op Ar operator expression ...
1565 .It Ic .elifdef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1570 .It Ic .elifndef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1575 .It Ic .elifmake Oo \&! Oc Ns Ar target Op Ar operator target ...
1580 .It Ic .elifnmake Oo \&! Oc Ns Ar target Op Ar operator target ...
1586 End the body of the conditional.
1591 may be any one of the following:
1592 .Bl -tag -width "Cm XX"
1595 .It Cm \&\*[Am]\*[Am]
1598 of higher precedence than
1604 will only evaluate a conditional as far as is necessary to determine
1606 Parentheses may be used to change the order of evaluation.
1607 The boolean operator
1609 may be used to logically negate an entire
1611 It is of higher precedence than
1612 .Ql Ic \&\*[Am]\*[Am] .
1616 may be any of the following:
1617 .Bl -tag -width defined
1619 Takes a variable name as an argument and evaluates to true if the variable
1622 Takes a target name as an argument and evaluates to true if the target
1623 was specified as part of
1625 command line or was declared the default target (either implicitly or
1628 before the line containing the conditional.
1630 Takes a variable, with possible modifiers, and evaluates to true if
1631 the expansion of the variable would result in an empty string.
1633 Takes a file name as an argument and evaluates to true if the file exists.
1634 The file is searched for on the system search path (see
1637 Takes a target name as an argument and evaluates to true if the target
1640 Takes a target name as an argument and evaluates to true if the target
1641 has been defined and has commands associated with it.
1645 may also be an arithmetic or string comparison.
1646 Variable expansion is
1647 performed on both sides of the comparison, after which the integral
1648 values are compared.
1649 A value is interpreted as hexadecimal if it is
1650 preceded by 0x, otherwise it is decimal; octal numbers are not supported.
1651 The standard C relational operators are all supported.
1653 variable expansion, either the left or right hand side of a
1657 operator is not an integral value, then
1658 string comparison is performed between the expanded
1660 If no relational operator is given, it is assumed that the expanded
1661 variable is being compared against 0 or an empty string in the case
1662 of a string comparison.
1666 is evaluating one of these conditional expressions, and it encounters
1667 a (white-space separated) word it doesn't recognize, either the
1671 expression is applied to it, depending on the form of the conditional.
1679 expression is applied.
1680 Similarly, if the form is
1683 .Ql Ic .ifnmake , the
1685 expression is applied.
1687 If the conditional evaluates to true the parsing of the makefile continues
1689 If it evaluates to false, the following lines are skipped.
1690 In both cases this continues until a
1696 For loops are typically used to apply a set of rules to a list of files.
1697 The syntax of a for loop is:
1699 .Bl -tag -compact -width Ds
1700 .It Ic \&.for Ar variable Oo Ar variable ... Oc Ic in Ar expression
1707 is evaluated, it is split into words.
1708 On each iteration of the loop, one word is taken and assigned to each
1712 are substituted into the
1714 inside the body of the for loop.
1715 The number of words must come out even; that is, if there are three
1716 iteration variables, the number of words provided must be a multiple
1719 Comments begin with a hash
1721 character, anywhere but in a shell
1722 command line, and continue to the end of an unescaped new line.
1723 .Sh SPECIAL SOURCES (ATTRIBUTES)
1724 .Bl -tag -width .IGNOREx
1726 Target is never out of date, but always execute commands anyway.
1728 Ignore any errors from the commands associated with this target, exactly
1729 as if they all were preceded by a dash
1731 .\" .It Ic .INVISIBLE
1736 Mark all sources of this target as being up-to-date.
1738 Execute the commands associated with this target even if the
1742 options were specified.
1743 Normally used to mark recursive
1746 Create a meta file for the target, even if it is flagged as
1751 Usage in conjunction with
1753 is the most likely case.
1754 In "meta" mode, the target is out-of-date if the meta file is missing.
1756 Do not create a meta file for the target.
1757 Meta files are also not created for
1764 Ignore differences in commands when deciding if target is out of date.
1765 This is useful if the command contains a value which always changes.
1766 If the number of commands change, though, the target will still be out of date.
1767 The same effect applies to any command line that uses the variable
1769 which can be used for that purpose even when not otherwise needed or desired:
1770 .Bd -literal -offset indent
1772 skip-compare-for-some:
1773 @echo this will be compared
1774 @echo this will not ${.OODATE:M.NOMETA_CMP}
1775 @echo this will also be compared
1780 pattern suppresses any expansion of the unwanted variable.
1782 Do not search for the target in the directories specified by
1787 selects the first target it encounters as the default target to be built
1788 if no target was specified.
1789 This source prevents this target from being selected.
1791 If a target is marked with this attribute and
1793 can't figure out how to create it, it will ignore this fact and assume
1794 the file isn't needed or already exists.
1797 correspond to an actual file; it is always considered to be out of date,
1798 and will not be created with the
1801 Suffix-transformation rules are not applied to
1807 is interrupted, it normally removes any partially made targets.
1808 This source prevents the target from being removed.
1813 Do not echo any of the commands associated with this target, exactly
1814 as if they all were preceded by an at sign
1817 Turn the target into
1820 When the target is used as a source for another target, the other target
1821 acquires the commands, sources, and attributes (except for
1825 If the target already has commands, the
1827 target's commands are appended
1834 target commands to the target.
1838 appears in a dependency line, the sources that precede it are
1839 made before the sources that succeed it in the line.
1840 Since the dependents of files are not made until the file itself
1841 could be made, this also stops the dependents being built unless they
1842 are needed for another branch of the dependency tree.
1855 the output is always
1861 The ordering imposed by
1863 is only relevant for parallel makes.
1866 Special targets may not be included with other targets, i.e. they must be
1867 the only target specified.
1868 .Bl -tag -width .BEGINx
1870 Any command lines attached to this target are executed before anything
1875 rule for any target (that was used only as a
1878 can't figure out any other way to create.
1879 Only the shell script is used.
1882 variable of a target that inherits
1885 to the target's own name.
1887 Any command lines attached to this target are executed after everything
1890 Any command lines attached to this target are executed when another target fails.
1893 variable is set to the target that failed.
1895 .Ic MAKE_PRINT_VAR_ON_ERROR .
1897 Mark each of the sources with the
1900 If no sources are specified, this is the equivalent of specifying the
1906 is interrupted, the commands for this target will be executed.
1908 If no target is specified when
1910 is invoked, this target will be built.
1912 This target provides a way to specify flags for
1914 when the makefile is used.
1915 The flags are as if typed to the shell, though the
1919 .\" XXX: NOT YET!!!!
1920 .\" .It Ic .NOTPARALLEL
1921 .\" The named targets are executed in non parallel mode.
1922 .\" If no targets are
1923 .\" specified, then all targets are executed in non parallel mode.
1927 attribute to any specified sources.
1929 Disable parallel mode.
1933 for compatibility with other pmake variants.
1935 The named targets are made in sequence.
1936 This ordering does not add targets to the list of targets to be made.
1937 Since the dependents of a target do not get built until the target itself
1938 could be built, unless
1940 is built by another part of the dependency graph,
1941 the following is a dependency loop:
1947 The ordering imposed by
1949 is only relevant for parallel makes.
1950 .\" XXX: NOT YET!!!!
1951 .\" .It Ic .PARALLEL
1952 .\" The named targets are executed in parallel mode.
1953 .\" If no targets are
1954 .\" specified, then all targets are executed in parallel mode.
1956 The sources are directories which are to be searched for files not
1957 found in the current directory.
1958 If no sources are specified, any previously specified directories are
1960 If the source is the special
1962 target, then the current working
1963 directory is searched last.
1967 attribute to any specified sources.
1971 attribute to any specified sources.
1972 If no sources are specified, the
1974 attribute is applied to every
1979 will use to execute commands.
1980 The sources are a set of
1983 .Bl -tag -width hasErrCtls
1985 This is the minimal specification, used to select one of the builtin
1992 Specifies the path to the shell.
1994 Indicates whether the shell supports exit on error.
1996 The command to turn on error checking.
1998 The command to disable error checking.
2000 The command to turn on echoing of commands executed.
2002 The command to turn off echoing of commands executed.
2004 The output to filter after issuing the
2007 It is typically identical to
2010 The flag to pass the shell to enable error checking.
2012 The flag to pass the shell to enable command echoing.
2014 The string literal to pass the shell that results in a single newline
2015 character when used outside of any quoting characters.
2019 \&.SHELL: name=ksh path=/bin/ksh hasErrCtl=true \e
2020 check="set \-e" ignore="set +e" \e
2021 echo="set \-v" quiet="set +v" filter="set +v" \e
2022 echoFlag=v errFlag=e newline="'\en'"
2027 attribute to any specified sources.
2028 If no sources are specified, the
2030 attribute is applied to every
2031 command in the file.
2033 This target gets run when a dependency file contains stale entries, having
2035 set to the name of that dependency file.
2037 Each source specifies a suffix to
2039 If no sources are specified, any previously specified suffixes are deleted.
2040 It allows the creation of suffix-transformation rules.
2046 cc \-o ${.TARGET} \-c ${.IMPSRC}
2051 uses the following environment variables, if they exist:
2057 .Ev MAKEOBJDIRPREFIX ,
2063 .Ev MAKEOBJDIRPREFIX
2066 may only be set in the environment or on the command line to
2068 and not as makefile variables;
2069 see the description of
2073 .Bl -tag -width /usr/share/mk -compact
2075 list of dependencies
2077 list of dependencies
2079 list of dependencies
2083 system makefile directory
2086 The basic make syntax is compatible between different versions of make,
2087 however the special variables, variable modifiers and conditionals are not.
2089 The way that parallel makes are scheduled changed in
2091 so that .ORDER and .WAIT apply recursively to the dependent nodes.
2092 The algorithms used may change again in the future.
2094 The way that .for loop variables are substituted changed after
2096 so that they still appear to be variable expansions.
2097 In particular this stops them being treated as syntax, and removes some
2098 obscure problems using them in .if statements.
2103 is derived from NetBSD
2105 It uses autoconf to facilitate portability to other platforms.
2113 implementation is based on Adam De Boor's pmake program which was written
2114 for Sprite at Berkeley.
2115 It was designed to be a parallel distributed make running jobs on different
2116 machines using a daemon called
2121 syntax is difficult to parse without actually acting of the data.
2122 For instance finding the end of a variable use should involve scanning each
2123 the modifiers using the correct terminator for each field.
2126 just counts {} and () in order to find the end of a variable expansion.
2128 There is no way of escaping a space character in a filename.