1 .\" Copyright (c) 1990, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" from: @(#)make.1 8.4 (Berkeley) 3/19/94
33 .\" $FreeBSD: src/usr.bin/make/make.1,v 1.29.2.15 2002/12/17 19:01:18 seanc Exp $
34 .\" $DragonFly: src/usr.bin/make/make.1,v 1.13 2004/12/01 01:10:17 joerg Exp $
41 .Nd maintain program dependencies
56 .Op Ar variable Ns No = Ns Ar value
61 utility is a program designed to simplify the maintenance of other programs.
62 Its input is a list of specifications
63 describing dependency relationships between the generation of
70 that can be found in either the current directory or a special object directory
73 will be read for this list of specifications.
76 can be found, it is also read (see
79 This manual page is intended as a reference document only.
80 For a more thorough introduction to
82 and makefiles, please refer to
83 .%T "Make \- A Tutorial" .
85 The options are as follows:
88 Try to be backwards compatible by executing a single shell per command and
89 by executing the commands to make the sources of a dependency line in sequence.
90 This is turned on by default unless
96 before reading the makefiles or doing anything else.
99 options are specified, each is interpreted relative to the previous one:
100 .Fl C Pa / Fl C Pa etc
106 to be 1, in the global context.
108 Turn on debugging, and specify which portions of
110 are to print debugging information.
113 is one or more of the following:
116 Print all possible debugging information;
117 equivalent to specifying all of the debugging flags.
119 Print debugging information about archive searching and caching.
121 Print debugging information about conditional evaluation.
123 Print debugging information about directory searching and caching.
125 Print debugging information about the execution of for loops.
127 Print the input graph before making anything.
129 Print the input graph after making everything, or before exiting
132 Print debugging information about running multiple shells.
134 Print commands in Makefiles regardless of whether or not they are prefixed
135 by @ or other "quiet" flags.
136 Also known as "loud" behavior.
138 Print debugging information about making targets, including modification
141 Print debugging information about suffix-transformation rules.
143 Print debugging information about target list maintenance.
145 Print debugging information about variable assignment.
148 Specify a variable whose environment value (if any) will override
149 macro assignments within makefiles.
151 Specify that environment values override macro assignments within
152 makefiles for all variables.
154 Specify a makefile to read instead of the default
162 standard input is read.
163 Multiple makefiles may be specified, and are read in the order specified.
164 .It Fl I Ar directory
165 Specify a directory in which to search for makefiles and included makefiles.
166 The system makefile directory (or directories, see the
168 option) is automatically included as part of this list.
170 Ignore non-zero exit of shell commands in the makefile.
171 Equivalent to specifying
173 before each command line in the makefile.
175 Specify the maximum number of jobs that
177 may have running at any one time.
178 Turns compatibility mode off, unless the
180 flag is also specified.
182 Continue processing after errors are encountered, but only on those targets
183 that do not depend on the target whose creation caused the error.
184 .It Fl m Ar directory
185 Specify a directory in which to search for
187 and makefiles included via the <...> style.
188 Multiple directories can be added to form a search path.
189 This path will override the default system include path:
191 Furthermore, the system include path will be appended to the search path used
192 for "..."-style inclusions (see the
196 Display the commands that would have been executed, but do not actually
199 Collate the output of a given job and display it only when the job finishes,
200 instead of mixing the output of parallel jobs together.
201 This option has no effect unless
205 Do not execute any commands, but exit 0 if the specified targets are
206 up-to-date and 1, otherwise.
208 Do not use the built-in rules specified in the system makefile.
210 Stop processing when an error is encountered.
212 This is needed to negate the
214 option during recursive builds.
216 Do not echo any commands as they are executed.
217 Equivalent to specifying
219 before each command line in the makefile.
221 Rather than re-building a target as specified in the makefile, create it
222 or update its modification time to make it appear up-to-date.
228 in the global context.
229 Do not build any targets.
230 Multiple instances of this option may be specified;
231 the variables will be printed one per line,
232 with a blank line for each null or undefined variable.
235 For multi-job makes, this will cause file banners to be generated.
239 option to print the values of variables,
240 do not recursively expand the values.
241 .It Ar variable Ns No = Ns Ar value
242 Set the value of the variable
248 There are seven different types of lines in a makefile: file dependency
249 specifications, shell commands, variable assignments, include statements,
250 conditional directives, for loops, and comments.
252 In general, lines may be continued from one line to the next by ending
253 them with a backslash
255 The trailing newline character and initial whitespace on the following
256 line are compressed into a single space.
257 .Sh FILE DEPENDENCY SPECIFICATIONS
258 Dependency lines consist of one or more targets, an operator, and zero
260 This creates a relationship where the targets
263 and are usually created from them.
264 The exact relationship between the target and the source is determined
265 by the operator that separates them.
266 The three operators are as follows:
269 A target is considered out-of-date if its modification time is less than
270 those of any of its sources.
271 Sources for a target accumulate over dependency lines when this operator
273 The target is removed if
277 Targets are always re-created, but not until all sources have been
278 examined and re-created as necessary.
279 Sources for a target accumulate over dependency lines when this operator
281 The target is removed if
285 If no sources are specified, the target is always re-created.
286 Otherwise, a target is considered out-of-date if any of its sources has
287 been modified more recently than the target.
288 Sources for a target do not accumulate over dependency lines when this
290 The target will not be removed if
295 Targets and sources may contain the shell wildcard expressions
306 may only be used as part of the final
307 component of the target or source, and must be used to describe existing
311 need not necessarily be used to describe existing files.
312 Expansion is in directory order, not alphabetically as done in the shell.
314 Each target may have associated with it a series of shell commands, normally
315 used to create the target.
316 Each of the commands in this script
318 be preceded by a tab.
319 While any target may appear on a dependency line, only one of these
320 dependencies may be followed by a creation script, unless the
324 If the first characters of the command line are
329 the command is treated specially.
332 causes the command not to be echoed before it is executed.
335 causes any non-zero exit status of the command line to be ignored.
338 causes the command to be executed even if
340 is specified on the command line.
341 .Sh VARIABLE ASSIGNMENTS
344 are much like variables in the shell, and, by tradition,
345 consist of all upper-case letters.
346 The five operators that can be used to assign values to variables are as
350 Assign the value to the variable.
351 Any previous value is overridden.
353 Append the value to the current value of the variable.
355 Assign the value to the variable if it is not already defined.
357 Assign with expansion, i.e., expand the value before assigning it
359 Normally, expansion is not done until the variable is referenced.
361 Expand the value and pass it to the shell for execution and assign
362 the result to the variable.
363 Any newlines in the result are replaced with spaces.
366 Any whitespace before the assigned
368 is removed; if the value is being appended, a single space is inserted
369 between the previous contents of the variable and the appended value.
371 Variables are expanded by surrounding the variable name with either
376 and preceding it with
379 If the variable name contains only a single letter, the surrounding
380 braces or parentheses are not required.
381 This shorter form is not recommended.
383 Variable substitution occurs at two distinct times, depending on where
384 the variable is being used.
385 Variables in dependency lines are expanded as the line is read.
386 Variables in shell commands are expanded when the shell command is
389 The four different classes of variables (in order of increasing precedence)
392 .It Environment variables
393 Variables defined as part of
397 Variables defined in the makefile or in included makefiles.
398 .It Command line variables
399 Variables defined as part of the command line and variables
402 environment variable or the
406 Variables that are defined specific to a certain target.
407 The seven local variables are as follows:
408 .Bl -tag -width ".ARCHIVE"
410 The list of all sources for this target; also known as
413 The name of the archive file; also known as
416 The name/path of the source from which the target is to be transformed
419 source); also known as
422 The name of the archive member; also known as
425 The list of sources for this target that were deemed out-of-date; also
429 The file prefix of the file, containing only the file portion, no suffix
430 or preceding directory components; also known as
433 The name of the target; also known as
446 are permitted for backward
447 compatibility and are not recommended.
457 permitted for compatibility with
459 makefiles and are not recommended.
461 Four of the local variables may be used in sources on dependency lines
462 because they expand to the proper value for each target on the line.
473 sets or knows about the following internal variables or environment
475 .Bl -tag -width ".Va MAKEFILE_LIST"
481 expands to a single dollar
487 .Pq Va argv Ns Op 0 .
489 A path to the directory where
496 to the canonical path given by
499 A path to the directory where the targets are built.
502 searches for an alternate directory to place target files.
503 It will attempt to change into this special directory
504 and will search this directory for makefiles
505 not found in the current directory.
506 The following directories are tried in order:
510 ${MAKEOBJDIRPREFIX}/`pwd`
521 The first directory that
523 successfully changes into is used.
528 is set in the environment but
530 is unable to change into the corresponding directory,
531 then the current directory is used
532 without checking the remainder of the list.
533 If they are undefined and
535 is unable to change into any of the remaining three directories,
536 then the current directory is used.
541 to the canonical path given by
543 .It Va .MAKEFILE_LIST
546 reads various makefiles, including the default files and any
547 obtained from the command line and
549 directives, their names will be automatically appended to the
552 They are added right before
554 begins to parse them, so that the name of the current makefile is the
555 last word in this variable.
557 The environment variable
559 may contain anything that
563 Its contents are stored in
567 All options and variable assignments specified on
569 command line are appended to the
571 variable which is then
572 entered into the environment as
574 for all programs which
578 is provided for backward compatibility and
579 contains all the options from the
581 environment variable plus any options specified on
587 is currently building.
597 Name of the machine architecture
599 is running on, obtained from the
601 environment variable, or through
605 Name of the machine architecture
607 was compiled for, defined at compilation time.
609 Makefiles may assign a colon-delimited list of directories to
611 These directories will be searched for source files by
613 after it has finished parsing all input makefiles.
616 Variable expansion may be modified to select or modify each word of the
619 is whitespace-delimited sequence of characters).
620 The general format of a variable expansion is as follows:
622 .Dl {variable[:modifier[:...]]}
624 Each modifier begins with a colon and one of the following
626 The colon may be escaped with a backslash
630 .It Cm C No \&/ Ar pattern Xo
631 .No \&/ Ar replacement
635 Modify each word of the value,
636 substituting every match of the extended regular expression
644 Normally, the first occurrence of the pattern in
645 each word of the value is changed.
648 modifier causes the substitution to apply to at most one word; the
650 modifier causes the substitution to apply to as many instances of the
651 search pattern as occur in the word or words it is found in.
656 are orthogonal; the former specifies whether multiple words are
657 potentially affected, the latter whether multiple substitutions can
658 potentially occur within each affected word.
660 Replaces each word in the variable with its suffix.
662 Replaces each word in the variable with everything but the last component.
664 Converts variable to lower-case letters.
665 .It Cm M Ns Ar pattern
666 Select only those words that match the rest of the modifier.
667 The standard shell wildcard characters
674 The wildcard characters may be escaped with a backslash
676 .It Cm N Ns Ar pattern
679 but selects all words which do not match
680 the rest of the modifier.
682 Quotes every shell meta-character in the variable, so that it can be passed
683 safely through recursive invocations of
686 Replaces each word in the variable with everything but its suffix.
688 .It Cm S No \&/ Ar old_string Xo
689 .No \&/ Ar new_string
693 Modify the first occurrence of
695 in each word of the variable's value, replacing it with
699 is appended to the last slash of the pattern, all occurrences
700 in each word are replaced.
706 is anchored at the beginning of each word.
709 ends with a dollar sign
711 it is anchored at the end of each word.
718 Any character may be used as a delimiter for the parts of the modifier
720 The anchoring, ampersand, and delimiter characters may be escaped with a
724 Variable expansion occurs in the normal fashion inside both
728 with the single exception that a backslash is used to prevent the expansion
731 not a preceding dollar sign as is usual.
732 .It Ar old_string=new_string
735 style variable substitution.
736 It must be the last modifier specified.
741 do not contain the pattern matching character
743 then it is assumed that they are
744 anchored at the end of each word, so only suffixes or entire
745 words may be replaced.
753 Replaces each word in the variable with its last component.
755 Converts variable to upper-case letters.
757 .Sh DIRECTIVES, CONDITIONALS, AND FOR LOOPS
758 Directives, conditionals, and for loops reminiscent
759 of the C programming language are provided in
761 All such structures are identified by a line beginning with a single
765 The following directives are supported:
767 .It Ic \&.include Ar <file>
768 .It Ic \&.include Ar \*qfile\*q
769 Include the specified makefile.
770 Variables between the angle brackets
771 or double quotes are expanded to form the file name.
773 are used, the included makefile is expected to be in the system
775 If double quotes are used, the including
776 makefile's directory and any directories specified using the
778 option are searched before the system
780 .It Ic .undef Ar variable
781 Un-define the specified global variable.
782 Only global variables may be un-defined.
783 .It Ic \&.makeenv Ar variable
784 Set the environment flag for a preexisting global variable. The current
785 and future contents of the variable will be exported to the environment.
786 .It Ic .error Ar message
787 Terminate processing of the makefile immediately.
789 makefile, the line on which the error was encountered and the specified
790 message are printed to the standard error output and
792 terminates with exit code 1.
793 Variables in the message are expanded.
794 .It Ic .warning Ar message
795 Emit a warning message.
796 The filename of the makefile,
797 the line on which the warning was encountered,
798 and the specified message are printed to the standard error output.
799 Variables in the message are expanded.
802 Conditionals are used to determine which parts of the Makefile
804 They are used similarly to the conditionals supported
805 by the C pre-processor.
806 The following conditionals are supported:
810 .Oo \&! Oc Ns Ar expression
811 .Op Ar operator expression ...
813 Test the value of an expression.
816 .Oo \&! Oc Ns Ar variable
817 .Op Ar operator variable ...
819 Test the value of a variable.
822 .Oo \&! Oc Ns Ar variable
823 .Op Ar operator variable ...
825 Test the value of a variable.
828 .Oo \&! Oc Ns Ar target
829 .Op Ar operator target ...
831 Test the target being built.
834 .Oo \&! Oc Ns Ar target
835 .Op Ar operator target ...
837 Test the target being built.
839 Reverse the sense of the last conditional.
842 .Oo \&! Oc Ns Ar expression
843 .Op Ar operator expression ...
851 .Oo \&! Oc Ns Ar variable
852 .Op Ar operator variable ...
860 .Oo \&! Oc Ns Ar variable
861 .Op Ar operator variable ...
869 .Oo \&! Oc Ns Ar target
870 .Op Ar operator target ...
878 .Oo \&! Oc Ns Ar target
879 .Op Ar operator target ...
886 End the body of the conditional.
891 may be any one of the following:
892 .Bl -tag -width "Cm XX"
899 of higher precedence than
905 will only evaluate a conditional as far as is necessary to determine
907 Parentheses may be used to change the order of evaluation.
910 may be used to logically negate an entire
912 It is of higher precedence than
917 may be any of the following:
920 Takes a variable name as an argument and evaluates to true if the variable
923 Takes a target name as an argument and evaluates to true if the target
924 was specified as part of
926 command line or was declared the default target (either implicitly or
929 before the line containing the conditional.
931 Takes a variable, with possible modifiers, and evaluates to true if
932 the expansion of the variable would result in an empty string.
934 Takes a file name as an argument and evaluates to true if the file exists.
935 The file is searched for on the system search path (see
938 Takes a target name as an argument and evaluates to true if the target
944 may also be an arithmetic or string comparison, with the left-hand side
945 being a variable expansion.
946 Variable expansion is
947 performed on both sides of the comparison, after which the integral
949 A value is interpreted as hexadecimal if it is
950 preceded by 0x, otherwise it is decimal; octal numbers are not supported.
951 The standard C relational operators are all supported.
953 variable expansion, either the left or right hand side of a
957 operator is not an integral value, then
958 string comparison is performed between the expanded
960 If no relational operator is given, it is assumed that the expanded
961 variable is being compared against 0.
965 is evaluating one of these conditional expressions, and it encounters
966 a word it doesn't recognize, either the
970 expression is applied to it, depending on the form of the conditional.
978 expression is applied.
979 Similarly, if the form is
985 expression is applied.
987 If the conditional evaluates to true the parsing of the makefile continues
989 If it evaluates to false, the following lines are skipped.
990 In both cases this continues until a
996 For loops are typically used to apply a set of rules to a list of files.
997 The syntax of a for loop is:
999 .Bl -tag -width indent -compact
1000 .It Ic .for Ar variable Ic in Ar expression
1007 is evaluated, it is split into words.
1011 is successively set to each word, and substituted in the
1013 inside the body of the for loop.
1015 Comments begin with a hash
1017 character, anywhere but in a shell
1018 command line, and continue to the end of the line.
1022 Ignore any errors from the commands associated with this target, exactly
1023 as if they all were preceded by a dash
1026 Execute the commands associated with this target even if the
1030 options were specified.
1031 Normally used to mark recursive
1036 selects the first target it encounters as the default target to be built
1037 if no target was specified.
1038 This source prevents this target from being selected.
1040 If a target is marked with this attribute and
1042 can't figure out how to create it, it will ignore this fact and assume
1043 the file isn't needed or already exists.
1047 is interrupted, it removes any partially made targets.
1048 This source prevents the target from being removed.
1050 Do not echo any of the commands associated with this target, exactly
1051 as if they all were preceded by an at sign
1054 Turn the target into
1057 When the target is used as a source for another target, the other target
1058 acquires the commands, sources, and attributes (except for
1062 If the target already has commands, the
1064 target's commands are appended
1069 source is appears in a dependency line, the sources that precede it are
1070 made before the sources that succeed it in the line.
1072 detected and targets that form loops will be silently ignored.
1074 .Sh "SPECIAL TARGETS"
1075 Special targets may not be included with other targets, i.e., they must be
1076 the only target specified.
1079 Any command lines attached to this target are executed before anything
1084 rule for any target (that was used only as a
1087 can't figure out any other way to create.
1088 Only the shell script is used.
1091 variable of a target that inherits
1094 to the target's own name.
1096 Any command lines attached to this target are executed after everything
1099 Mark each of the sources with the
1102 If no sources are specified, this is the equivalent of specifying the
1106 A list of suffixes that indicate files that can be included in a source
1108 The suffix must have already been declared with
1110 any suffix so declared will have the directories on its search path (see
1114 special variable, each preceded by a
1120 is interrupted, the commands for this target will be executed.
1122 This does for libraries what
1124 does for include files, except that the flag used is
1127 If no target is specified when
1129 is invoked, this target will be built.
1130 This is always set, either
1131 explicitly, or implicitly when
1133 selects the default target, to give the user a way to refer to the default
1134 target on the command line.
1136 This target provides a way to specify flags for
1138 when the makefile is used.
1139 The flags are as if typed to the shell, though the
1144 Same as above, for backward compatibility.
1145 .\" XXX: NOT YET!!!!
1146 .\" .It Ic .NOTPARALLEL
1147 .\" The named targets are executed in non parallel mode. If no targets are
1148 .\" specified, then all targets are executed in non parallel mode.
1150 Disable parallel mode.
1152 Same as above, for compatibility with other
1156 The named targets are made in sequence.
1157 .\" XXX: NOT YET!!!!
1158 .\" .It Ic .PARALLEL
1159 .\" The named targets are executed in parallel mode. If no targets are
1160 .\" specified, then all targets are executed in parallel mode.
1162 The sources are directories which are to be searched for files not
1163 found in the current directory.
1164 If no sources are specified, any previously specified directories are
1166 Where possible, use of
1168 is preferred over use of the
1171 .It Ic .PATH\fIsuffix\fR
1172 The sources are directories which are to be searched for suffixed files
1173 not found in the current directory.
1177 first searches the suffixed search path, before reverting to the default
1178 path if the file is not found there.
1179 This form is required for
1187 attribute to any specified sources.
1188 Targets with this attribute are always
1189 considered to be out of date.
1193 attribute to any specified sources.
1194 If no sources are specified, the
1196 attribute is applied to every
1201 attribute to any specified sources.
1202 If no sources are specified, the
1204 attribute is applied to every
1205 command in the file.
1207 Each source specifies a suffix to
1209 If no sources are specified, any previous specified suffices are deleted.
1218 This was removed for POSIX compatibility.
1219 The internal variable
1221 is set to the same value as
1223 support for this may be removed in the future.
1225 Most of the more esoteric features of
1227 should probably be avoided for greater compatibility.
1231 utility uses the following environment variables, if they exist:
1237 .Ev MAKEOBJDIRPREFIX .
1239 .Bl -tag -width /usr/share/doc/psd/12.make -compact
1241 list of dependencies
1243 list of dependencies
1245 list of dependencies
1249 system makefile (processed before any other file, including
1253 .It Pa /usr/share/mk
1254 system makefile directory
1255 .It /usr/share/doc/psd/12.make
1259 .Ev MAKEOBJDIRPREFIX
1263 List all included makefiles in order visited:
1265 .Dl "make -V .MAKEFILE_LIST | tr \e\ \e\en"
1267 The determination of
1269 is contorted to the point of absurdity.
1271 In the presence of several
1275 silently ignores all but the first.
1278 is not set to the default target when
1280 is invoked without a target name and no
1282 special target exists.
1286 in a test is very simple-minded.
1287 Currently, the only form that works is
1288 .Ql .if ${VAR} op something
1289 For instance, you should write tests as
1290 .Ql .if ${VAR} == "string"
1291 not the other way around, which would give you an error.
1293 For loops are expanded before tests, so a fragment such as:
1294 .Bd -literal -offset indent
1295 \&.for ARCH in ${SHARED_ARCHS}
1296 \&.if ${ARCH} == ${MACHINE}
1302 won't work, and should be rewritten as:
1303 .Bd -literal -offset indent
1304 \&.for ARCH in ${SHARED_ARCHS}
1305 \&.if ${MACHINE} == ${ARCH}
1311 The parsing code is broken with respect to handling a semicolon
1312 after a colon, so a fragment like this will fail:
1313 .Bd -literal -offset indent
1317 \&.for h in ${HDRS:S;^;${.CURDIR}/;}
1325 .%T "PMake - A Tutorial"
1328 .Pa /usr/share/doc/psd/12.make
1332 command appeared in PWB UNIX.
projects / dragonfly.git / blob