1 .\" $NetBSD: make.1,v 1.266 2017/02/01 18:39:27 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 file system.
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 Print entering and leaving directory messages, pre and post processing.
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 one or more lines of shell
446 used to create the target.
447 Each of the lines in this script
449 be preceded by a tab.
450 (For historical reasons, spaces are not accepted.)
451 While targets can appear in many dependency lines if desired, by
452 default only one of these rules may be followed by a creation
456 operator is used, however, all rules may include scripts and the
457 scripts are executed in the order found.
459 Each line is treated as a separate shell command, unless the end of
460 line is escaped with a backslash
462 in which case that line and the next are combined.
463 .\" The escaped newline is retained and passed to the shell, which
464 .\" normally ignores it.
465 .\" However, the tab at the beginning of the following line is removed.
466 If the first characters of the command are any combination of
471 the command is treated specially.
474 causes the command not to be echoed before it is executed.
477 causes the command to be executed even when
480 This is similar to the effect of the .MAKE special source,
481 except that the effect can be limited to a single line of a script.
484 in compatibility mode
485 causes any non-zero exit status of the command line to be ignored.
489 is run in jobs mode with
491 the entire script for the target is fed to a
492 single instance of the shell.
493 In compatibility (non-jobs) mode, each command is run in a separate process.
494 If the command contains any shell meta characters
495 .Pq Ql #=|^(){};&<>*?[]:$`\e\en
496 it will be passed to the shell; otherwise
498 will attempt direct execution.
499 If a line starts with
501 and the shell has ErrCtl enabled then failure of the command line
502 will be ignored as in compatibility mode.
505 affects the entire job;
506 the script will stop at the first command line that fails,
507 but the target will not be deemed to have failed.
509 Makefiles should be written so that the mode of
511 operation does not change their behavior.
512 For example, any command which needs to use
516 without potentially changing the directory for subsequent commands
517 should be put in parentheses so it executes in a subshell.
518 To force the use of one shell, escape the line breaks so as to make
519 the whole script one command.
521 .Bd -literal -offset indent
522 avoid-chdir-side-effects:
523 @echo Building $@ in `pwd`
524 @(cd ${.CURDIR} && ${MAKE} $@)
527 ensure-one-shell-regardless-of-mode:
528 @echo Building $@ in `pwd`; \e
529 (cd ${.CURDIR} && ${MAKE} $@); \e
539 before executing any targets, each child process
540 starts with that as its current working directory.
541 .Sh VARIABLE ASSIGNMENTS
542 Variables in make are much like variables in the shell, and, by tradition,
543 consist of all upper-case letters.
544 .Ss Variable assignment modifiers
545 The five operators that can be used to assign values to variables are as
549 Assign the value to the variable.
550 Any previous value is overridden.
552 Append the value to the current value of the variable.
554 Assign the value to the variable if it is not already defined.
556 Assign with expansion, i.e. expand the value before assigning it
558 Normally, expansion is not done until the variable is referenced.
560 References to undefined variables are
563 This can cause problems when variable modifiers are used.
565 Expand the value and pass it to the shell for execution and assign
566 the result to the variable.
567 Any newlines in the result are replaced with spaces.
570 Any white-space before the assigned
572 is removed; if the value is being appended, a single space is inserted
573 between the previous contents of the variable and the appended value.
575 Variables are expanded by surrounding the variable name with either
580 and preceding it with
583 If the variable name contains only a single letter, the surrounding
584 braces or parentheses are not required.
585 This shorter form is not recommended.
587 If the variable name contains a dollar, then the name itself is expanded first.
588 This allows almost arbitrary variable names, however names containing dollar,
589 braces, parenthesis, or whitespace are really best avoided!
591 If the result of expanding a variable contains a dollar sign
593 the string is expanded again.
595 Variable substitution occurs at three distinct times, depending on where
596 the variable is being used.
599 Variables in dependency lines are expanded as the line is read.
601 Variables in shell commands are expanded when the shell command is
605 loop index variables are expanded on each loop iteration.
606 Note that other variables are not expanded inside loops so
607 the following example code:
608 .Bd -literal -offset indent
622 .Bd -literal -offset indent
627 Because while ${a} contains
629 after the loop is executed, ${b}
634 since after the loop completes ${j} contains
638 The four different classes of variables (in order of increasing precedence)
641 .It Environment variables
642 Variables defined as part of
646 Variables defined in the makefile or in included makefiles.
647 .It Command line variables
648 Variables defined as part of the command line.
650 Variables that are defined specific to a certain target.
653 Local variables are all built in and their values vary magically from
655 It is not currently possible to define new local variables.
656 The seven local variables are as follows:
657 .Bl -tag -width ".ARCHIVE" -offset indent
659 The list of all sources for this target; also known as
662 The name of the archive file; also known as
665 In suffix-transformation rules, the name/path of the source from which the
666 target is to be transformed (the
668 source); also known as
670 It is not defined in explicit rules.
672 The name of the archive member; also known as
675 The list of sources for this target that were deemed out-of-date; also
679 The file prefix of the target, containing only the file portion, no suffix
680 or preceding directory components; also known as
682 The suffix must be one of the known suffixes declared with
684 or it will not be recognized.
686 The name of the target; also known as
688 For compatibility with other makes this is an alias for
690 in archive member rules.
702 are permitted for backward
703 compatibility with historical makefiles and legacy POSIX make and are
706 Variants of these variables with the punctuation followed immediately by
712 are legacy forms equivalent to using the
717 These forms are accepted for compatibility with
719 makefiles and POSIX but are not recommended.
721 Four of the local variables may be used in sources on dependency lines
722 because they expand to the proper value for each target on the line.
729 .Ss Additional built-in variables
732 sets or knows about the following variables:
733 .Bl -tag -width .MAKEOVERRIDES
739 expands to a single dollar
742 The list of all targets encountered in the Makefile.
744 Makefile parsing, lists only those targets encountered thus far.
746 A path to the directory where
749 Refer to the description of
752 .It Va .INCLUDEDFROMDIR
753 The directory of the file this Makefile was included from.
754 .It Va .INCLUDEDFROMFILE
755 The filename of the file this Makefile was included from.
766 The preferred variable to use is the environment variable
768 because it is more compatible with other versions of
770 and cannot be confused with the special target with the same name.
771 .It Va .MAKE.DEPENDFILE
772 Names the makefile (default
774 from which generated dependencies are read.
775 .It Va .MAKE.EXPAND_VARIABLES
776 A boolean that controls the default behavior of the
779 .It Va .MAKE.EXPORTED
780 The list of variables exported by
786 .It Va .MAKE.JOB.PREFIX
791 then output for each target is prefixed with a token
793 the first part of which can be controlled via
794 .Va .MAKE.JOB.PREFIX .
797 is empty, no token is printed.
800 .Li .MAKE.JOB.PREFIX=${.newline}---${.MAKE:T}[${.MAKE.PID}]
801 would produce tokens like
802 .Ql ---make[1234] target ---
803 making it easier to track the degree of parallelism being achieved.
805 The environment variable
807 may contain anything that
811 Anything specified on
813 command line is appended to the
815 variable which is then
816 entered into the environment for all programs which
820 The recursion depth of
822 The initial instance of
824 will be 0, and an incremented value is put into the environment
825 to be seen by the next generation.
826 This allows tests like:
827 .Li .if ${.MAKE.LEVEL} == 0
828 to protect things which should only be evaluated in the initial instance of
830 .It Va .MAKE.MAKEFILE_PREFERENCE
831 The ordered list of makefile names
838 .It Va .MAKE.MAKEFILES
839 The list of makefiles read by
841 which is useful for tracking dependencies.
842 Each makefile is recorded only once, regardless of the number of times read.
844 Processed after reading all makefiles.
845 Can affect the mode that
848 It can contain a number of keywords:
849 .Bl -hang -width missing-filemon=bf.
859 into "meta" mode, where meta files are created for each target
860 to capture the command run, the output generated and if
862 is available, the system calls which are of interest to
864 The captured output can be very useful when diagnosing errors.
865 .It Pa curdirOk= Ar bf
868 will not create .meta files in
870 This can be overridden by setting
872 to a value which represents True.
873 .It Pa missing-meta= Ar bf
876 is True, then a missing .meta file makes the target out-of-date.
877 .It Pa missing-filemon= Ar bf
880 is True, then missing filemon data makes the target out-of-date.
885 For debugging, it can be useful to include the environment
888 If in "meta" mode, print a clue about the target being built.
889 This is useful if the build is otherwise running silently.
890 The message printed the value of:
891 .Va .MAKE.META.PREFIX .
893 Some makefiles have commands which are simply not stable.
894 This keyword causes them to be ignored for
895 determining whether a target is out of date in "meta" mode.
901 is True, when a .meta file is created, mark the target
904 .It Va .MAKE.META.BAILIWICK
905 In "meta" mode, provides a list of prefixes which
906 match the directories controlled by
908 If a file that was generated outside of
910 but within said bailiwick is missing,
911 the current target is considered out-of-date.
912 .It Va .MAKE.META.CREATED
913 In "meta" mode, this variable contains a list of all the meta files
915 If not empty, it can be used to trigger processing of
916 .Va .MAKE.META.FILES .
917 .It Va .MAKE.META.FILES
918 In "meta" mode, this variable contains a list of all the meta files
919 used (updated or not).
920 This list can be used to process the meta files to extract dependency
922 .It Va .MAKE.META.IGNORE_PATHS
923 Provides a list of path prefixes that should be ignored;
924 because the contents are expected to change over time.
925 The default list includes:
926 .Ql Pa /dev /etc /proc /tmp /var/run /var/tmp
927 .It Va .MAKE.META.IGNORE_PATTERNS
928 Provides a list of patterns to match against pathnames.
929 Ignore any that match.
930 .It Va .MAKE.META.IGNORE_FILTER
931 Provides a list of variable modifiers to apply to each pathname.
932 Ignore if the expansion is an empty string.
933 .It Va .MAKE.META.PREFIX
934 Defines the message printed for each meta file updated in "meta verbose" mode.
935 The default value is:
936 .Dl Building ${.TARGET:H:tA}/${.TARGET:T}
937 .It Va .MAKEOVERRIDES
938 This variable is used to record the names of variables assigned to
939 on the command line, so that they may be exported as part of
941 This behavior can be disabled by assigning an empty value to
942 .Ql Va .MAKEOVERRIDES
944 Extra variables can be exported from a makefile
945 by appending their names to
946 .Ql Va .MAKEOVERRIDES .
948 is re-exported whenever
949 .Ql Va .MAKEOVERRIDES
951 .It Va .MAKE.PATH_FILEMON
956 support, this is set to the path of the device node.
957 This allows makefiles to test for this support.
962 The parent process-id of
964 .It Va .MAKE.SAVE_DOLLARS
965 value should be a boolean that controls whether
967 are preserved when doing
970 The default is false, for backwards compatibility.
971 Set to true for compatability with other makes.
976 per normal evaluation rules.
977 .It Va MAKE_PRINT_VAR_ON_ERROR
980 stops due to an error, it sets
982 to the name of the target that failed,
984 to the commands of the failed target,
985 and in "meta" mode, it also sets
990 .Ql Va .ERROR_META_FILE
991 to the path of the meta file (if any) describing the failed target.
992 It then prints its name and the value of
994 as well as the value of any variables named in
995 .Ql Va MAKE_PRINT_VAR_ON_ERROR .
997 This variable is simply assigned a newline character as its value.
998 This allows expansions using the
1000 modifier to put a newline between
1001 iterations of the loop rather than a space.
1002 For example, the printing of
1003 .Ql Va MAKE_PRINT_VAR_ON_ERROR
1004 could be done as ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}.
1006 A path to the directory where the targets are built.
1007 Its value is determined by trying to
1009 to the following directories in order and using the first match:
1012 .Ev ${MAKEOBJDIRPREFIX}${.CURDIR}
1015 .Ql Ev MAKEOBJDIRPREFIX
1016 is set in the environment or on the command line.)
1022 is set in the environment or on the command line.)
1024 .Ev ${.CURDIR} Ns Pa /obj. Ns Ev ${MACHINE}
1026 .Ev ${.CURDIR} Ns Pa /obj
1028 .Pa /usr/obj/ Ns Ev ${.CURDIR}
1033 Variable expansion is performed on the value before it's used,
1034 so expressions such as
1035 .Dl ${.CURDIR:S,^/usr/src,/var/obj,}
1037 This is especially useful with
1041 may be modified in the makefile via the special target
1047 to the specified directory if it exists, and set
1051 to that directory before executing any targets.
1054 A path to the directory of the current
1058 The basename of the current
1063 are both set only while the
1066 If you want to retain their current values, assign them to a variable
1067 using assignment with expansion:
1070 A variable that represents the list of directories that
1072 will search for files.
1073 The search list should be updated using the target
1075 rather than the variable.
1077 Alternate path to the current directory.
1081 to the canonical path given by
1083 However, if the environment variable
1085 is set and gives a path to the current directory, then
1092 This behavior is disabled if
1093 .Ql Ev MAKEOBJDIRPREFIX
1096 contains a variable transform.
1098 is set to the value of
1100 for all programs which
1104 The list of targets explicitly specified on the command line, if any.
1108 lists of directories that
1110 will search for files.
1111 The variable is supported for compatibility with old make programs only,
1116 .Ss Variable modifiers
1117 Variable expansion may be modified to select or modify each word of the
1120 is white-space delimited sequence of characters).
1121 The general format of a variable expansion is as follows:
1123 .Dl ${variable[:modifier[:...]]}
1125 Each modifier begins with a colon,
1126 which may be escaped with a backslash
1129 A set of modifiers can be specified via a variable, as follows:
1131 .Dl modifier_variable=modifier[:...]
1132 .Dl ${variable:${modifier_variable}[:...]}
1134 In this case the first modifier in the modifier_variable does not
1135 start with a colon, since that must appear in the referencing
1137 If any of the modifiers in the modifier_variable contain a dollar sign
1139 these must be doubled to avoid early expansion.
1141 The supported modifiers are:
1144 Replaces each word in the variable with its suffix.
1146 Replaces each word in the variable with everything but the last component.
1147 .It Cm \&:M Ns Ar pattern
1148 Select only those words that match
1150 The standard shell wildcard characters
1157 The wildcard characters may be escaped with a backslash
1159 As a consequence of the way values are split into words, matched,
1160 and then joined, a construct like
1162 will normalize the inter-word spacing, removing all leading and
1163 trailing space, and converting multiple consecutive spaces
1166 .It Cm \&:N Ns Ar pattern
1167 This is identical to
1169 but selects all words which do not match
1172 Order every word in variable alphabetically.
1174 reverse order use the
1176 combination of modifiers.
1178 Randomize words in variable.
1179 The results will be different each time you are referring to the
1180 modified variable; use the assignment with expansion
1182 to prevent such behavior.
1184 .Bd -literal -offset indent
1185 LIST= uno due tre quattro
1186 RANDOM_LIST= ${LIST:Ox}
1187 STATIC_RANDOM_LIST:= ${LIST:Ox}
1190 @echo "${RANDOM_LIST}"
1191 @echo "${RANDOM_LIST}"
1192 @echo "${STATIC_RANDOM_LIST}"
1193 @echo "${STATIC_RANDOM_LIST}"
1195 may produce output similar to:
1196 .Bd -literal -offset indent
1203 Quotes every shell meta-character in the variable, so that it can be passed
1204 safely through recursive invocations of
1207 Replaces each word in the variable with everything but its suffix.
1208 .It Cm \&:range[=count]
1209 The value is an integer sequence representing the words of the original
1210 value, or the supplied
1212 .It Cm \&:gmtime[=utc]
1213 The value is a format string for
1219 value is not provided or is 0, the current time is used.
1221 Compute a 32-bit hash of the value and encode it as hex digits.
1222 .It Cm \&:localtime[=utc]
1223 The value is a format string for
1229 value is not provided or is 0, the current time is used.
1231 Attempt to convert variable to an absolute path using
1233 if that fails, the value is unchanged.
1235 Converts variable to lower-case letters.
1236 .It Cm \&:ts Ns Ar c
1237 Words in the variable are normally separated by a space on expansion.
1238 This modifier sets the separator to the character
1242 is omitted, then no separator is used.
1243 The common escapes (including octal numeric codes), work as expected.
1245 Converts variable to upper-case letters.
1247 Causes the value to be treated as a single word
1248 (possibly containing embedded white space).
1252 Causes the value to be treated as a sequence of
1253 words delimited by white space.
1257 .It Cm \&:S No \&/ Ar old_string No \&/ Ar new_string No \&/ Op Cm 1gW
1259 Modify the first occurrence of
1261 in the variable's value, replacing it with
1265 is appended to the last slash of the pattern, all occurrences
1266 in each word are replaced.
1269 is appended to the last slash of the pattern, only the first word
1273 is appended to the last slash of the pattern,
1274 then the value is treated as a single word
1275 (possibly containing embedded white space).
1281 is anchored at the beginning of each word.
1284 ends with a dollar sign
1286 it is anchored at the end of each word.
1297 Any character may be used as a delimiter for the parts of the modifier
1299 The anchoring, ampersand and delimiter characters may be escaped with a
1303 Variable expansion occurs in the normal fashion inside both
1307 with the single exception that a backslash is used to prevent the expansion
1310 not a preceding dollar sign as is usual.
1312 .It Cm \&:C No \&/ Ar pattern No \&/ Ar replacement No \&/ Op Cm 1gW
1316 modifier is just like the
1318 modifier except that the old and new strings, instead of being
1319 simple strings, are an extended regular expression (see
1327 Normally, the first occurrence of the pattern
1329 in each word of the value is substituted with
1333 modifier causes the substitution to apply to at most one word; the
1335 modifier causes the substitution to apply to as many instances of the
1338 as occur in the word or words it is found in; the
1340 modifier causes the value to be treated as a single word
1341 (possibly containing embedded white space).
1346 are orthogonal; the former specifies whether multiple words are
1347 potentially affected, the latter whether multiple substitutions can
1348 potentially occur within each affected word.
1356 are subjected to variable expansion before being parsed as
1357 regular expressions.
1359 Replaces each word in the variable with its last component.
1361 Remove adjacent duplicate words (like
1364 .It Cm \&:\&? Ar true_string Cm \&: Ar false_string
1366 If the variable name (not its value), when parsed as a .if conditional
1367 expression, evaluates to true, return as its value the
1369 otherwise return the
1371 Since the variable name is used as the expression, \&:\&? must be the
1372 first modifier after the variable name itself - which will, of course,
1373 usually contain variable expansions.
1374 A common error is trying to use expressions like
1375 .Dl ${NUMBERS:M42:?match:no}
1376 which actually tests defined(NUMBERS),
1377 to determine is any words match "42" you need to use something like:
1378 .Dl ${"${NUMBERS:M42}" != \&"\&":?match:no} .
1379 .It Ar :old_string=new_string
1382 style variable substitution.
1383 It must be the last modifier specified.
1388 do not contain the pattern matching character
1390 then it is assumed that they are
1391 anchored at the end of each word, so only suffixes or entire
1392 words may be replaced.
1400 Variable expansion occurs in the normal fashion inside both
1404 with the single exception that a backslash is used to prevent the
1405 expansion of a dollar sign
1407 not a preceding dollar sign as is usual.
1409 .It Cm \&:@ Ar temp Cm @ Ar string Cm @
1411 This is the loop expansion mechanism from the OSF Development
1412 Environment (ODE) make.
1415 loops expansion occurs at the time of
1419 to each word in the variable and evaluate
1421 The ODE convention is that
1423 should start and end with a period.
1425 .Dl ${LINKS:@.LINK.@${LN} ${TARGET} ${.LINK.}@}
1427 However a single character variable is often more readable:
1428 .Dl ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}
1430 Save the current variable value in
1434 for later reference.
1436 .Bd -literal -offset indent
1437 M_cmpv.units = 1 1000 1000000
1438 M_cmpv = S,., ,g:_:range:@i@+ $${_:[-$$i]} \&\\
1439 \\* $${M_cmpv.units:[$$i]}@:S,^,expr 0 ,1:sh
1441 .Dv .if ${VERSION:${M_cmpv}} < ${3.1.12:L:${M_cmpv}}
1446 is used to save the result of the
1448 modifier which is later referenced using the index values from
1450 .It Cm \&:U Ns Ar newval
1451 If the variable is undefined
1454 If the variable is defined, the existing value is returned.
1455 This is another ODE make feature.
1456 It is handy for setting per-target CFLAGS for instance:
1457 .Dl ${_${.TARGET:T}_CFLAGS:U${DEF_CFLAGS}}
1458 If a value is only required if the variable is undefined, use:
1459 .Dl ${VAR:D:Unewval}
1460 .It Cm \&:D Ns Ar newval
1461 If the variable is defined
1465 The name of the variable is the value.
1467 The path of the node which has the same name as the variable
1469 If no such node exists or its path is null, then the
1470 name of the variable is used.
1471 In order for this modifier to work, the name (node) must at least have
1472 appeared on the rhs of a dependency.
1474 .It Cm \&:\&! Ar cmd Cm \&!
1476 The output of running
1480 If the variable is non-empty it is run as a command and the output
1481 becomes the new value.
1482 .It Cm \&::= Ns Ar str
1483 The variable is assigned the value
1486 This modifier and its variations are useful in
1487 obscure situations such as wanting to set a variable when shell commands
1489 These assignment modifiers always expand to
1490 nothing, so if appearing in a rule line by themselves should be
1491 preceded with something to keep
1497 helps avoid false matches with the
1501 modifier and since substitution always occurs the
1503 form is vaguely appropriate.
1504 .It Cm \&::?= Ns Ar str
1507 but only if the variable does not already have a value.
1508 .It Cm \&::+= Ns Ar str
1512 .It Cm \&::!= Ns Ar cmd
1513 Assign the output of
1516 .It Cm \&:\&[ Ns Ar range Ns Cm \&]
1517 Selects one or more words from the value,
1518 or performs other operations related to the way in which the
1519 value is divided into words.
1521 Ordinarily, a value is treated as a sequence of words
1522 delimited by white space.
1523 Some modifiers suppress this behavior,
1524 causing a value to be treated as a single word
1525 (possibly containing embedded white space).
1526 An empty value, or a value that consists entirely of white-space,
1527 is treated as a single word.
1528 For the purposes of the
1530 modifier, the words are indexed both forwards using positive integers
1531 (where index 1 represents the first word),
1532 and backwards using negative integers
1533 (where index \-1 represents the last word).
1537 is subjected to variable expansion, and the expanded result is
1538 then interpreted as follows:
1539 .Bl -tag -width index
1542 Selects a single word from the value.
1544 .It Ar start Ns Cm \&.. Ns Ar end
1545 Selects all words from
1552 selects all words from the second word to the last word.
1557 then the words are output in reverse order.
1560 selects all the words from last to first.
1563 Causes subsequent modifiers to treat the value as a single word
1564 (possibly containing embedded white space).
1565 Analogous to the effect of
1574 Causes subsequent modifiers to treat the value as a sequence of words
1575 delimited by white space.
1576 Analogous to the effect of
1581 Returns the number of words in the value.
1584 .Sh INCLUDE STATEMENTS, CONDITIONALS AND FOR LOOPS
1585 Makefile inclusion, conditional structures and for loops reminiscent
1586 of the C programming language are provided in
1588 All such structures are identified by a line beginning with a single
1592 Files are included with either
1593 .Cm \&.include Aq Ar file
1595 .Cm \&.include Pf \*q Ar file Ns \*q .
1596 Variables between the angle brackets or double quotes are expanded
1597 to form the file name.
1598 If angle brackets are used, the included makefile is expected to be in
1599 the system makefile directory.
1600 If double quotes are used, the including makefile's directory and any
1601 directories specified using the
1603 option are searched before the system
1605 For compatibility with other versions of
1607 .Ql include file ...
1610 If the include statement is written as
1614 then errors locating and/or opening include files are ignored.
1616 If the include statement is written as
1618 not only are errors locating and/or opening include files ignored,
1619 but stale dependencies within the included file will be ignored
1621 .Va .MAKE.DEPENDFILE .
1623 Conditional expressions are also preceded by a single dot as the first
1624 character of a line.
1625 The possible conditionals are as follows:
1627 .It Ic .error Ar message
1628 The message is printed along with the name of the makefile and line number,
1632 .It Ic .export Ar variable ...
1633 Export the specified global variable.
1634 If no variable list is provided, all globals are exported
1635 except for internal variables (those that start with
1637 This is not affected by the
1639 flag, so should be used with caution.
1640 For compatibility with other
1643 .Ql export variable=value
1646 Appending a variable name to
1648 is equivalent to exporting a variable.
1649 .It Ic .export-env Ar variable ...
1652 except that the variable is not appended to
1653 .Va .MAKE.EXPORTED .
1654 This allows exporting a value to the environment which is different from that
1658 .It Ic .export-literal Ar variable ...
1661 except that variables in the value are not expanded.
1662 .It Ic .info Ar message
1663 The message is printed along with the name of the makefile and line number.
1664 .It Ic .undef Ar variable
1665 Un-define the specified global variable.
1666 Only global variables may be un-defined.
1667 .It Ic .unexport Ar variable ...
1670 The specified global
1672 will be removed from
1673 .Va .MAKE.EXPORTED .
1674 If no variable list is provided, all globals are unexported,
1678 .It Ic .unexport-env
1679 Unexport all globals previously exported and
1680 clear the environment inherited from the parent.
1681 This operation will cause a memory leak of the original environment,
1682 so should be used sparingly.
1685 being 0, would make sense.
1686 Also note that any variables which originated in the parent environment
1687 should be explicitly preserved if desired.
1689 .Bd -literal -offset indent
1690 .Li .if ${.MAKE.LEVEL} == 0
1697 Would result in an environment containing only
1699 which is the minimal useful environment.
1702 will also be pushed into the new environment.
1703 .It Ic .warning Ar message
1704 The message prefixed by
1706 is printed along with the name of the makefile and line number.
1707 .It Ic \&.if Oo \&! Oc Ns Ar expression Op Ar operator expression ...
1708 Test the value of an expression.
1709 .It Ic .ifdef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1710 Test the value of a variable.
1711 .It Ic .ifndef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1712 Test the value of a variable.
1713 .It Ic .ifmake Oo \&! Oc Ns Ar target Op Ar operator target ...
1714 Test the target being built.
1715 .It Ic .ifnmake Oo \&! Ns Oc Ar target Op Ar operator target ...
1716 Test the target being built.
1718 Reverse the sense of the last conditional.
1719 .It Ic .elif Oo \&! Ns Oc Ar expression Op Ar operator expression ...
1724 .It Ic .elifdef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1729 .It Ic .elifndef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1734 .It Ic .elifmake Oo \&! Oc Ns Ar target Op Ar operator target ...
1739 .It Ic .elifnmake Oo \&! Oc Ns Ar target Op Ar operator target ...
1745 End the body of the conditional.
1750 may be any one of the following:
1751 .Bl -tag -width "Cm XX"
1754 .It Cm \&\*[Am]\*[Am]
1757 of higher precedence than
1763 will only evaluate a conditional as far as is necessary to determine
1765 Parentheses may be used to change the order of evaluation.
1766 The boolean operator
1768 may be used to logically negate an entire
1770 It is of higher precedence than
1771 .Ql Ic \&\*[Am]\*[Am] .
1775 may be any of the following:
1776 .Bl -tag -width defined
1778 Takes a variable name as an argument and evaluates to true if the variable
1781 Takes a target name as an argument and evaluates to true if the target
1782 was specified as part of
1784 command line or was declared the default target (either implicitly or
1787 before the line containing the conditional.
1789 Takes a variable, with possible modifiers, and evaluates to true if
1790 the expansion of the variable would result in an empty string.
1792 Takes a file name as an argument and evaluates to true if the file exists.
1793 The file is searched for on the system search path (see
1796 Takes a target name as an argument and evaluates to true if the target
1799 Takes a target name as an argument and evaluates to true if the target
1800 has been defined and has commands associated with it.
1804 may also be an arithmetic or string comparison.
1805 Variable expansion is
1806 performed on both sides of the comparison, after which the integral
1807 values are compared.
1808 A value is interpreted as hexadecimal if it is
1809 preceded by 0x, otherwise it is decimal; octal numbers are not supported.
1810 The standard C relational operators are all supported.
1812 variable expansion, either the left or right hand side of a
1816 operator is not an integral value, then
1817 string comparison is performed between the expanded
1819 If no relational operator is given, it is assumed that the expanded
1820 variable is being compared against 0 or an empty string in the case
1821 of a string comparison.
1825 is evaluating one of these conditional expressions, and it encounters
1826 a (white-space separated) word it doesn't recognize, either the
1830 expression is applied to it, depending on the form of the conditional.
1838 expression is applied.
1839 Similarly, if the form is
1842 .Ql Ic .ifnmake , the
1844 expression is applied.
1846 If the conditional evaluates to true the parsing of the makefile continues
1848 If it evaluates to false, the following lines are skipped.
1849 In both cases this continues until a
1855 For loops are typically used to apply a set of rules to a list of files.
1856 The syntax of a for loop is:
1858 .Bl -tag -compact -width Ds
1859 .It Ic \&.for Ar variable Oo Ar variable ... Oc Ic in Ar expression
1866 is evaluated, it is split into words.
1867 On each iteration of the loop, one word is taken and assigned to each
1871 are substituted into the
1873 inside the body of the for loop.
1874 The number of words must come out even; that is, if there are three
1875 iteration variables, the number of words provided must be a multiple
1878 Comments begin with a hash
1880 character, anywhere but in a shell
1881 command line, and continue to the end of an unescaped new line.
1882 .Sh SPECIAL SOURCES (ATTRIBUTES)
1883 .Bl -tag -width .IGNOREx
1885 Target is never out of date, but always execute commands anyway.
1887 Ignore any errors from the commands associated with this target, exactly
1888 as if they all were preceded by a dash
1890 .\" .It Ic .INVISIBLE
1895 Mark all sources of this target as being up-to-date.
1897 Execute the commands associated with this target even if the
1901 options were specified.
1902 Normally used to mark recursive
1905 Create a meta file for the target, even if it is flagged as
1910 Usage in conjunction with
1912 is the most likely case.
1913 In "meta" mode, the target is out-of-date if the meta file is missing.
1915 Do not create a meta file for the target.
1916 Meta files are also not created for
1923 Ignore differences in commands when deciding if target is out of date.
1924 This is useful if the command contains a value which always changes.
1925 If the number of commands change, though, the target will still be out of date.
1926 The same effect applies to any command line that uses the variable
1928 which can be used for that purpose even when not otherwise needed or desired:
1929 .Bd -literal -offset indent
1931 skip-compare-for-some:
1932 @echo this will be compared
1933 @echo this will not ${.OODATE:M.NOMETA_CMP}
1934 @echo this will also be compared
1939 pattern suppresses any expansion of the unwanted variable.
1941 Do not search for the target in the directories specified by
1946 selects the first target it encounters as the default target to be built
1947 if no target was specified.
1948 This source prevents this target from being selected.
1950 If a target is marked with this attribute and
1952 can't figure out how to create it, it will ignore this fact and assume
1953 the file isn't needed or already exists.
1956 correspond to an actual file; it is always considered to be out of date,
1957 and will not be created with the
1960 Suffix-transformation rules are not applied to
1966 is interrupted, it normally removes any partially made targets.
1967 This source prevents the target from being removed.
1972 Do not echo any of the commands associated with this target, exactly
1973 as if they all were preceded by an at sign
1976 Turn the target into
1979 When the target is used as a source for another target, the other target
1980 acquires the commands, sources, and attributes (except for
1984 If the target already has commands, the
1986 target's commands are appended
1993 target commands to the target.
1997 appears in a dependency line, the sources that precede it are
1998 made before the sources that succeed it in the line.
1999 Since the dependents of files are not made until the file itself
2000 could be made, this also stops the dependents being built unless they
2001 are needed for another branch of the dependency tree.
2014 the output is always
2020 The ordering imposed by
2022 is only relevant for parallel makes.
2025 Special targets may not be included with other targets, i.e. they must be
2026 the only target specified.
2027 .Bl -tag -width .BEGINx
2029 Any command lines attached to this target are executed before anything
2034 rule for any target (that was used only as a
2037 can't figure out any other way to create.
2038 Only the shell script is used.
2041 variable of a target that inherits
2044 to the target's own name.
2045 .It Ic .DELETE_ON_ERROR
2046 If this target is present in the makefile, it globally causes make to
2047 delete targets whose commands fail.
2048 (By default, only targets whose commands are interrupted during
2049 execution are deleted.
2050 This is the historical behavior.)
2051 This setting can be used to help prevent half-finished or malformed
2052 targets from being left around and corrupting future rebuilds.
2054 Any command lines attached to this target are executed after everything
2057 Any command lines attached to this target are executed when another target fails.
2060 variable is set to the target that failed.
2062 .Ic MAKE_PRINT_VAR_ON_ERROR .
2064 Mark each of the sources with the
2067 If no sources are specified, this is the equivalent of specifying the
2073 is interrupted, the commands for this target will be executed.
2075 If no target is specified when
2077 is invoked, this target will be built.
2079 This target provides a way to specify flags for
2081 when the makefile is used.
2082 The flags are as if typed to the shell, though the
2086 .\" XXX: NOT YET!!!!
2087 .\" .It Ic .NOTPARALLEL
2088 .\" The named targets are executed in non parallel mode.
2089 .\" If no targets are
2090 .\" specified, then all targets are executed in non parallel mode.
2094 attribute to any specified sources.
2096 Disable parallel mode.
2100 for compatibility with other pmake variants.
2102 The source is a new value for
2108 to it and update the value of
2111 The named targets are made in sequence.
2112 This ordering does not add targets to the list of targets to be made.
2113 Since the dependents of a target do not get built until the target itself
2114 could be built, unless
2116 is built by another part of the dependency graph,
2117 the following is a dependency loop:
2123 The ordering imposed by
2125 is only relevant for parallel makes.
2126 .\" XXX: NOT YET!!!!
2127 .\" .It Ic .PARALLEL
2128 .\" The named targets are executed in parallel mode.
2129 .\" If no targets are
2130 .\" specified, then all targets are executed in parallel mode.
2132 The sources are directories which are to be searched for files not
2133 found in the current directory.
2134 If no sources are specified, any previously specified directories are
2136 If the source is the special
2138 target, then the current working
2139 directory is searched last.
2140 .It Ic .PATH. Ns Va suffix
2143 but applies only to files with a particular suffix.
2144 The suffix must have been previously declared with
2149 attribute to any specified sources.
2153 attribute to any specified sources.
2154 If no sources are specified, the
2156 attribute is applied to every
2161 will use to execute commands.
2162 The sources are a set of
2165 .Bl -tag -width hasErrCtls
2167 This is the minimal specification, used to select one of the built-in
2174 Specifies the path to the shell.
2176 Indicates whether the shell supports exit on error.
2178 The command to turn on error checking.
2180 The command to disable error checking.
2182 The command to turn on echoing of commands executed.
2184 The command to turn off echoing of commands executed.
2186 The output to filter after issuing the
2189 It is typically identical to
2192 The flag to pass the shell to enable error checking.
2194 The flag to pass the shell to enable command echoing.
2196 The string literal to pass the shell that results in a single newline
2197 character when used outside of any quoting characters.
2201 \&.SHELL: name=ksh path=/bin/ksh hasErrCtl=true \e
2202 check="set \-e" ignore="set +e" \e
2203 echo="set \-v" quiet="set +v" filter="set +v" \e
2204 echoFlag=v errFlag=e newline="'\en'"
2209 attribute to any specified sources.
2210 If no sources are specified, the
2212 attribute is applied to every
2213 command in the file.
2215 This target gets run when a dependency file contains stale entries, having
2217 set to the name of that dependency file.
2219 Each source specifies a suffix to
2221 If no sources are specified, any previously specified suffixes are deleted.
2222 It allows the creation of suffix-transformation rules.
2228 cc \-o ${.TARGET} \-c ${.IMPSRC}
2233 uses the following environment variables, if they exist:
2239 .Ev MAKEOBJDIRPREFIX ,
2245 .Ev MAKEOBJDIRPREFIX
2248 may only be set in the environment or on the command line to
2250 and not as makefile variables;
2251 see the description of
2255 .Bl -tag -width /usr/share/mk -compact
2257 list of dependencies
2259 list of dependencies
2261 list of dependencies
2265 system makefile directory
2268 The basic make syntax is compatible between different versions of make;
2269 however the special variables, variable modifiers and conditionals are not.
2271 An incomplete list of changes in older versions of
2274 The way that .for loop variables are substituted changed after
2276 so that they still appear to be variable expansions.
2277 In particular this stops them being treated as syntax, and removes some
2278 obscure problems using them in .if statements.
2280 The way that parallel makes are scheduled changed in
2282 so that .ORDER and .WAIT apply recursively to the dependent nodes.
2283 The algorithms used may change again in the future.
2284 .Ss Other make dialects
2285 Other make dialects (GNU make, SVR4 make, POSIX make, etc.) do not
2286 support most of the features of
2288 as described in this manual.
2290 .Bl -bullet -offset indent
2296 declarations and most functionality pertaining to parallelization.
2297 (GNU make supports parallelization but lacks these features needed to
2298 control it effectively.)
2300 Directives, including for loops and conditionals and most of the
2301 forms of include files.
2302 (GNU make has its own incompatible and less powerful syntax for
2305 All built-in variables that begin with a dot.
2307 Most of the special sources and targets that begin with a dot,
2308 with the notable exception of
2314 Variable modifiers, except for the
2316 string substitution, which does not portably support globbing with
2318 and historically only works on declared suffixes.
2322 variable even in its short form; most makes support this functionality
2323 but its name varies.
2326 Some features are somewhat more portable, such as assignment with
2333 functionality is based on an older feature
2335 found in GNU make and many versions of SVR4 make; however,
2336 historically its behavior is too ill-defined (and too buggy) to rely
2343 variables are more or less universally portable, as is the
2346 Basic use of suffix rules (for files only in the current directory,
2347 not trying to chain transformations together, etc.) is also reasonably
2353 is derived from NetBSD
2355 It uses autoconf to facilitate portability to other platforms.
2363 implementation is based on Adam De Boor's pmake program which was written
2364 for Sprite at Berkeley.
2365 It was designed to be a parallel distributed make running jobs on different
2366 machines using a daemon called
2369 Historically the target/dependency
2371 has been used to FoRCe rebuilding (since the target/dependency
2372 does not exist... unless someone creates an
2378 syntax is difficult to parse without actually acting of the data.
2379 For instance finding the end of a variable use should involve scanning each
2380 the modifiers using the correct terminator for each field.
2383 just counts {} and () in order to find the end of a variable expansion.
2385 There is no way of escaping a space character in a filename.