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.9 2004/11/30 15:22:46 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 or first two characters of the command line are
328 the command is treated specially.
331 causes the command not to be echoed before it is executed.
334 causes any non-zero exit status of the command line to be ignored.
335 .Sh VARIABLE ASSIGNMENTS
338 are much like variables in the shell, and, by tradition,
339 consist of all upper-case letters.
340 The five operators that can be used to assign values to variables are as
344 Assign the value to the variable.
345 Any previous value is overridden.
347 Append the value to the current value of the variable.
349 Assign the value to the variable if it is not already defined.
351 Assign with expansion, i.e. expand the value before assigning it
353 Normally, expansion is not done until the variable is referenced.
355 Expand the value and pass it to the shell for execution and assign
356 the result to the variable.
357 Any newlines in the result are replaced with spaces.
360 Any whitespace before the assigned
362 is removed; if the value is being appended, a single space is inserted
363 between the previous contents of the variable and the appended value.
365 Variables are expanded by surrounding the variable name with either
370 and preceding it with
373 If the variable name contains only a single letter, the surrounding
374 braces or parentheses are not required.
375 This shorter form is not recommended.
377 Variable substitution occurs at two distinct times, depending on where
378 the variable is being used.
379 Variables in dependency lines are expanded as the line is read.
380 Variables in shell commands are expanded when the shell command is
383 The four different classes of variables (in order of increasing precedence)
386 .It Environment variables
387 Variables defined as part of
391 Variables defined in the makefile or in included makefiles.
392 .It Command line variables
393 Variables defined as part of the command line.
395 Variables that are defined specific to a certain target.
396 The seven local variables are as follows:
397 .Bl -tag -width ".ARCHIVE"
399 The list of all sources for this target; also known as
402 The name of the archive file; also known as
405 The name/path of the source from which the target is to be transformed
408 source); also known as
411 The name of the archive member; also known as
414 The list of sources for this target that were deemed out-of-date; also
418 The file prefix of the file, containing only the file portion, no suffix
419 or preceding directory components; also known as
422 The name of the target; also known as
435 are permitted for backward
436 compatibility and are not recommended.
446 permitted for compatibility with
448 makefiles and are not recommended.
450 Four of the local variables may be used in sources on dependency lines
451 because they expand to the proper value for each target on the line.
462 sets or knows about the following internal variables or environment
464 .Bl -tag -width ".Va MAKEFILE_LIST"
470 expands to a single dollar
476 .Pq Va argv Ns Op 0 .
478 A path to the directory where
485 to the canonical path given by
488 A path to the directory where the targets are built.
491 searches for an alternate directory to place target files.
492 It will attempt to change into this special directory
493 and will search this directory for makefiles
494 not found in the current directory.
495 The following directories are tried in order:
499 ${MAKEOBJDIRPREFIX}/`pwd`
510 The first directory that
512 successfully changes into is used.
517 is set in the environment but
519 is unable to change into the corresponding directory,
520 then the current directory is used
521 without checking the remainder of the list.
522 If they are undefined and
524 is unable to change into any of the remaining three directories,
525 then the current directory is used.
530 to the canonical path given by
532 .It Va .MAKEFILE_LIST
535 reads various makefiles, including the default files and any
536 obtained from the command line and
538 directives, their names will be automatically appended to the
541 They are added right before
543 begins to parse them, so that the name of the current makefile is the
544 last word in this variable.
546 The environment variable
548 may contain anything that
552 Its contents are stored in
556 Anything specified on
558 command line is appended to the
560 variable which is then
561 entered into the environment as
563 for all programs which
569 provided for backward compatibility.
573 is currently building.
583 Name of the machine architecture
585 is running on, obtained from the
587 environment variable, or through
591 Name of the machine architecture
593 was compiled for, defined at compilation time.
595 Makefiles may assign a colon-delimited list of directories to
597 These directories will be searched for source files by
599 after it has finished parsing all input makefiles.
602 Variable expansion may be modified to select or modify each word of the
605 is whitespace-delimited sequence of characters).
606 The general format of a variable expansion is as follows:
608 .Dl {variable[:modifier[:...]]}
610 Each modifier begins with a colon and one of the following
612 The colon may be escaped with a backslash
616 .It Cm C No \&/ Ar pattern Xo
617 .No \&/ Ar replacement
623 modifier is just like the
625 modifier except that the old and new strings, instead of being
626 simple strings, are an extended regular expression (see
631 Normally, the first occurrence of the pattern in
632 each word of the value is changed.
635 modifier causes the substitution to apply to at most one word; the
637 modifier causes the substitution to apply to as many instances of the
638 search pattern as occur in the word or words it is found in.
643 are orthogonal; the former specifies whether multiple words are
644 potentially affected, the latter whether multiple substitutions can
645 potentially occur within each affected word.
647 Replaces each word in the variable with its suffix.
649 Replaces each word in the variable with everything but the last component.
651 Converts variable to lower-case letters.
652 .It Cm M Ns Ar pattern
653 Select only those words that match the rest of the modifier.
654 The standard shell wildcard characters
661 The wildcard characters may be escaped with a backslash
663 .It Cm N Ns Ar pattern
666 but selects all words which do not match
667 the rest of the modifier.
669 Quotes every shell meta-character in the variable, so that it can be passed
670 safely through recursive invocations of
673 Replaces each word in the variable with everything but its suffix.
675 .It Cm S No \&/ Ar old_string Xo
676 .No \&/ Ar new_string
680 Modify the first occurrence of
682 in each word of the variable's value, replacing it with
686 is appended to the last slash of the pattern, all occurrences
687 in each word are replaced.
693 is anchored at the beginning of each word.
696 ends with a dollar sign
698 it is anchored at the end of each word.
705 Any character may be used as a delimiter for the parts of the modifier
707 The anchoring, ampersand, and delimiter characters may be escaped with a
711 Variable expansion occurs in the normal fashion inside both
715 with the single exception that a backslash is used to prevent the expansion
718 not a preceding dollar sign as is usual.
719 .It Ar old_string=new_string
722 style variable substitution.
723 It must be the last modifier specified.
728 do not contain the pattern matching character
730 then it is assumed that they are
731 anchored at the end of each word, so only suffixes or entire
732 words may be replaced.
740 Replaces each word in the variable with its last component.
742 Converts variable to upper-case letters.
744 .Sh DIRECTIVES, CONDITIONALS, AND FOR LOOPS
745 Directives, conditionals, and for loops reminiscent
746 of the C programming language are provided in
748 All such structures are identified by a line beginning with a single
752 The following directives are supported:
754 .It Ic \&.include Ar <file>
755 .It Ic \&.include Ar \*qfile\*q
756 Include the specified makefile.
757 Variables between the angle brackets
758 or double quotes are expanded to form the file name.
760 are used, the included makefile is expected to be in the system
762 If double quotes are used, the including
763 makefile's directory and any directories specified using the
765 option are searched before the system
767 .It Ic \&.undef Ar variable
768 Un-define the specified global variable.
769 Only global variables may be un-defined.
770 .It Ic \&.makeenv Ar variable
771 Set the environment flag for a preexisting global variable. The current
772 and future contents of the variable will be exported to the environment.
773 .It Ic \&.error Ar message
774 Terminate processing of the makefile immediately.
776 makefile, the line on which the error was encountered and the specified
777 message are printed to standard output and
779 terminates with exit code 1.
780 Variables in the message are expanded.
783 Conditionals are used to determine which parts of the Makefile
785 They are used similarly to the conditionals supported
786 by the C pre-processor.
787 The following conditionals are supported:
791 .Oo \&! Oc Ns Ar expression
792 .Op Ar operator expression ...
794 Test the value of an expression.
797 .Oo \&! Oc Ns Ar variable
798 .Op Ar operator variable ...
800 Test the value of a variable.
803 .Oo \&! Oc Ns Ar variable
804 .Op Ar operator variable ...
806 Test the value of a variable.
809 .Oo \&! Oc Ns Ar target
810 .Op Ar operator target ...
812 Test the target being built.
815 .Oo \&! Oc Ns Ar target
816 .Op Ar operator target ...
818 Test the target being built.
820 Reverse the sense of the last conditional.
823 .Oo \&! Oc Ns Ar expression
824 .Op Ar operator expression ...
832 .Oo \&! Oc Ns Ar variable
833 .Op Ar operator variable ...
841 .Oo \&! Oc Ns Ar variable
842 .Op Ar operator variable ...
850 .Oo \&! Oc Ns Ar target
851 .Op Ar operator target ...
859 .Oo \&! Oc Ns Ar target
860 .Op Ar operator target ...
867 End the body of the conditional.
872 may be any one of the following:
873 .Bl -tag -width "Cm XX"
880 of higher precedence than
886 will only evaluate a conditional as far as is necessary to determine
888 Parentheses may be used to change the order of evaluation.
891 may be used to logically negate an entire
893 It is of higher precedence than
898 may be any of the following:
901 Takes a variable name as an argument and evaluates to true if the variable
904 Takes a target name as an argument and evaluates to true if the target
905 was specified as part of
907 command line or was declared the default target (either implicitly or
910 before the line containing the conditional.
912 Takes a variable, with possible modifiers, and evaluates to true if
913 the expansion of the variable would result in an empty string.
915 Takes a file name as an argument and evaluates to true if the file exists.
916 The file is searched for on the system search path (see
919 Takes a target name as an argument and evaluates to true if the target
925 may also be an arithmetic or string comparison, with the left-hand side
926 being a variable expansion.
927 Variable expansion is
928 performed on both sides of the comparison, after which the integral
930 A value is interpreted as hexadecimal if it is
931 preceded by 0x, otherwise it is decimal; octal numbers are not supported.
932 The standard C relational operators are all supported.
934 variable expansion, either the left or right hand side of a
938 operator is not an integral value, then
939 string comparison is performed between the expanded
941 If no relational operator is given, it is assumed that the expanded
942 variable is being compared against 0.
946 is evaluating one of these conditional expressions, and it encounters
947 a word it doesn't recognize, either the
951 expression is applied to it, depending on the form of the conditional.
959 expression is applied.
960 Similarly, if the form is
966 expression is applied.
968 If the conditional evaluates to true the parsing of the makefile continues
970 If it evaluates to false, the following lines are skipped.
971 In both cases this continues until a
977 For loops are typically used to apply a set of rules to a list of files.
978 The syntax of a for loop is:
980 .Bl -tag -width indent -compact
981 .It Ic .for Ar variable Ic in Ar expression
988 is evaluated, it is split into words.
992 is successively set to each word, and substituted in the
994 inside the body of the for loop.
996 Comments begin with a hash
998 character, anywhere but in a shell
999 command line, and continue to the end of the line.
1003 Ignore any errors from the commands associated with this target, exactly
1004 as if they all were preceded by a dash
1007 Execute the commands associated with this target even if the
1011 options were specified.
1012 Normally used to mark recursive
1017 selects the first target it encounters as the default target to be built
1018 if no target was specified.
1019 This source prevents this target from being selected.
1021 If a target is marked with this attribute and
1023 can't figure out how to create it, it will ignore this fact and assume
1024 the file isn't needed or already exists.
1028 is interrupted, it removes any partially made targets.
1029 This source prevents the target from being removed.
1031 Do not echo any of the commands associated with this target, exactly
1032 as if they all were preceded by an at sign
1035 Turn the target into
1038 When the target is used as a source for another target, the other target
1039 acquires the commands, sources, and attributes (except for
1043 If the target already has commands, the
1045 target's commands are appended
1050 source is appears in a dependency line, the sources that precede it are
1051 made before the sources that succeed it in the line.
1053 detected and targets that form loops will be silently ignored.
1055 .Sh "SPECIAL TARGETS"
1056 Special targets may not be included with other targets, i.e. they must be
1057 the only target specified.
1060 Any command lines attached to this target are executed before anything
1065 rule for any target (that was used only as a
1068 can't figure out any other way to create.
1069 Only the shell script is used.
1072 variable of a target that inherits
1075 to the target's own name.
1077 Any command lines attached to this target are executed after everything
1080 Mark each of the sources with the
1083 If no sources are specified, this is the equivalent of specifying the
1087 A list of suffixes that indicate files that can be included in a source
1089 The suffix must have already been declared with
1091 any suffix so declared will have the directories on its search path (see
1095 special variable, each preceded by a
1101 is interrupted, the commands for this target will be executed.
1103 This does for libraries what
1105 does for include files, except that the flag used is
1108 If no target is specified when
1110 is invoked, this target will be built.
1111 This is always set, either
1112 explicitly, or implicitly when
1114 selects the default target, to give the user a way to refer to the default
1115 target on the command line.
1117 This target provides a way to specify flags for
1119 when the makefile is used.
1120 The flags are as if typed to the shell, though the
1124 .\" XXX: NOT YET!!!!
1125 .\" .It Ic .NOTPARALLEL
1126 .\" The named targets are executed in non parallel mode. If no targets are
1127 .\" specified, then all targets are executed in non parallel mode.
1129 Disable parallel mode.
1131 Same as above, for compatibility with other
1135 The named targets are made in sequence.
1136 .\" XXX: NOT YET!!!!
1137 .\" .It Ic .PARALLEL
1138 .\" The named targets are executed in parallel mode. If no targets are
1139 .\" specified, then all targets are executed in parallel mode.
1141 The sources are directories which are to be searched for files not
1142 found in the current directory.
1143 If no sources are specified, any previously specified directories are
1145 Where possible, use of
1147 is preferred over use of the
1150 .It Ic .PATH\fIsuffix\fR
1151 The sources are directories which are to be searched for suffixed files
1152 not found in the current directory.
1156 first searches the suffixed search path, before reverting to the default
1157 path if the file is not found there.
1158 This form is required for
1166 attribute to any specified sources.
1167 Targets with this attribute are always
1168 considered to be out of date.
1172 attribute to any specified sources.
1173 If no sources are specified, the
1175 attribute is applied to every
1180 attribute to any specified sources.
1181 If no sources are specified, the
1183 attribute is applied to every
1184 command in the file.
1186 Each source specifies a suffix to
1188 If no sources are specified, any previous specified suffices are deleted.
1197 This was removed for POSIX compatibility.
1198 The internal variable
1200 is set to the same value as
1202 support for this may be removed in the future.
1204 Most of the more esoteric features of
1206 should probably be avoided for greater compatibility.
1210 utility uses the following environment variables, if they exist:
1216 .Ev MAKEOBJDIRPREFIX .
1218 .Bl -tag -width /usr/share/doc/psd/12.make -compact
1220 list of dependencies
1222 list of dependencies
1224 list of dependencies
1228 system makefile (processed before any other file, including
1232 .It Pa /usr/share/mk
1233 system makefile directory
1234 .It /usr/share/doc/psd/12.make
1238 .Ev MAKEOBJDIRPREFIX
1242 List all included makefiles in order visited:
1244 .Dl "make -V .MAKEFILE_LIST | tr \e\ \e\en"
1246 The determination of
1248 is contorted to the point of absurdity.
1250 In the presence of several
1254 silently ignores all but the first.
1257 is not set to the default target when
1259 is invoked without a target name and no
1261 special target exists.
1265 in a test is very simple-minded.
1266 Currently, the only form that works is
1267 .Ql .if ${VAR} op something
1268 For instance, you should write tests as
1269 .Ql .if ${VAR} = "string"
1270 not the other way around, which doesn't work.
1272 For loops are expanded before tests, so a fragment such as:
1273 .Bd -literal -offset indent
1274 \&.for TMACHINE in ${SHARED_ARCHS}
1275 \&.if ${TMACHINE} = ${MACHINE}
1281 won't work, and should be rewritten the other way around.
1283 The parsing code is broken with respect to handling a semicolon
1284 after a colon, so a fragment like this will fail:
1285 .Bd -literal -offset indent
1289 \&.for h in ${HDRS:S;^;${.CURDIR}/;}
1297 .%T "PMake - A Tutorial"
1300 .Pa /usr/share/doc/psd/12.make
1304 command appeared in PWB UNIX.
projects / dragonfly.git / blob