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.4 2004/11/08 16:16:44 dillon 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
69 that can be found in either the current directory or a special object directory
72 will be read for this list of specifications.
75 can be found, it is also read (see
78 This manual page is intended as a reference document only.
79 For a more thorough introduction to
81 and makefiles, please refer to
82 .%T "Make \- A Tutorial" .
84 The options are as follows:
87 Try to be backwards compatible by executing a single shell per command and
88 by executing the commands to make the sources of a dependency line in sequence.
89 This is turned on by default unless
99 to be 1, in the global context.
101 Turn on debugging, and specify which portions of
103 are to print debugging information.
106 is one or more of the following:
109 Print all possible debugging information;
110 equivalent to specifying all of the debugging flags.
112 Print debugging information about archive searching and caching.
114 Print debugging information about conditional evaluation.
116 Print debugging information about directory searching and caching.
118 Print debugging information about the execution of for loops.
122 Print the input graph before making anything.
124 Print the input graph after making everything, or before exiting
127 Print debugging information about running multiple shells.
129 Print commands in Makefiles regardless of whether or not they are prefixed
130 by @ or other "quiet" flags.
131 Also known as "loud" behavior.
133 Print debugging information about making targets, including modification
136 Print debugging information about suffix-transformation rules.
138 Print debugging information about target list maintenance.
140 Print debugging information about variable assignment.
143 Specify a variable whose environment value (if any) will override
144 macro assignments within makefiles.
146 Specify that environment values override macro assignments within
147 makefiles for all variables.
149 Specify a makefile to read instead of the default
157 standard input is read.
158 Multiple makefiles may be specified, and are read in the order specified.
159 .It Fl I Ar directory
160 Specify a directory in which to search for makefiles and included makefiles.
161 The system makefile directory (or directories, see the
163 option) is automatically included as part of this list.
165 Ignore non-zero exit of shell commands in the makefile.
166 Equivalent to specifying
168 before each command line in the makefile.
170 Specify the maximum number of jobs that
172 may have running at any one time.
173 Turns compatibility mode off, unless the
175 flag is also specified.
177 Continue processing after errors are encountered, but only on those targets
178 that do not depend on the target whose creation caused the error.
179 .It Fl m Ar directory
180 Specify a directory in which to search for sys.mk and makefiles included
182 Multiple directories can be added to form a search path.
183 This path will override the default system include path:
185 Furthermore, the system include path will be appended to the search path used
186 for "..."-style inclusions (see the
190 Display the commands that would have been executed, but do not actually
193 Collate the output of a given job and display it only when the job finishes,
194 instead of mixing the output of parallel jobs together.
195 This option has no effect unless
199 Do not execute any commands, but exit 0 if the specified targets are
200 up-to-date and 1, otherwise.
202 Do not use the built-in rules specified in the system makefile.
204 Stop processing when an error is encountered.
206 This is needed to negate the
208 option during recursive builds.
210 Do not echo any commands as they are executed.
211 Equivalent to specifying
213 before each command line in the makefile.
215 Rather than re-building a target as specified in the makefile, create it
216 or update its modification time to make it appear up-to-date.
222 in the global context.
223 Do not build any targets.
224 Multiple instances of this option may be specified;
225 the variables will be printed one per line,
226 with a blank line for each null or undefined variable.
229 For multi-job makes, this will cause file banners to be generated.
233 option to print the values of variables,
234 do not recursively expand the values.
235 .It Ar variable Ns No = Ns Ar value
236 Set the value of the variable
242 There are seven different types of lines in a makefile: file dependency
243 specifications, shell commands, variable assignments, include statements,
244 conditional directives, for loops, and comments.
246 In general, lines may be continued from one line to the next by ending
247 them with a backslash
249 The trailing newline character and initial whitespace on the following
250 line are compressed into a single space.
251 .Sh FILE DEPENDENCY SPECIFICATIONS
252 Dependency lines consist of one or more targets, an operator, and zero
254 This creates a relationship where the targets
257 and are usually created from them.
258 The exact relationship between the target and the source is determined
259 by the operator that separates them.
260 The three operators are as follows:
263 A target is considered out-of-date if its modification time is less than
264 those of any of its sources.
265 Sources for a target accumulate over dependency lines when this operator
267 The target is removed if
271 Targets are always re-created, but not until all sources have been
272 examined and re-created as necessary.
273 Sources for a target accumulate over dependency lines when this operator
275 The target is removed if
279 If no sources are specified, the target is always re-created.
280 Otherwise, a target is considered out-of-date if any of its sources has
281 been modified more recently than the target.
282 Sources for a target do not accumulate over dependency lines when this
284 The target will not be removed if
289 Targets and sources may contain the shell wildcard expressions
300 may only be used as part of the final
301 component of the target or source, and must be used to describe existing
305 need not necessarily be used to describe existing files.
306 Expansion is in directory order, not alphabetically as done in the shell.
308 Each target may have associated with it a series of shell commands, normally
309 used to create the target.
310 Each of the commands in this script
312 be preceded by a tab.
313 While any target may appear on a dependency line, only one of these
314 dependencies may be followed by a creation script, unless the
318 If the first or first two characters of the command line are
322 the command is treated specially.
325 causes the command not to be echoed before it is executed.
328 causes any non-zero exit status of the command line to be ignored.
329 .Sh VARIABLE ASSIGNMENTS
332 are much like variables in the shell, and, by tradition,
333 consist of all upper-case letters.
334 The five operators that can be used to assign values to variables are as
338 Assign the value to the variable.
339 Any previous value is overridden.
341 Append the value to the current value of the variable.
343 Assign the value to the variable if it is not already defined.
345 Assign with expansion, i.e. expand the value before assigning it
347 Normally, expansion is not done until the variable is referenced.
349 Expand the value and pass it to the shell for execution and assign
350 the result to the variable.
351 Any newlines in the result are replaced with spaces.
354 Any whitespace before the assigned
356 is removed; if the value is being appended, a single space is inserted
357 between the previous contents of the variable and the appended value.
359 Variables are expanded by surrounding the variable name with either
364 and preceding it with
367 If the variable name contains only a single letter, the surrounding
368 braces or parentheses are not required.
369 This shorter form is not recommended.
371 Variable substitution occurs at two distinct times, depending on where
372 the variable is being used.
373 Variables in dependency lines are expanded as the line is read.
374 Variables in shell commands are expanded when the shell command is
377 The four different classes of variables (in order of increasing precedence)
380 .It Environment variables
381 Variables defined as part of
385 Variables defined in the makefile or in included makefiles.
386 .It Command line variables
387 Variables defined as part of the command line.
389 Variables that are defined specific to a certain target.
390 The seven local variables are as follows:
391 .Bl -tag -width ".ARCHIVE"
393 The list of all sources for this target; also known as
396 The name of the archive file; also known as
399 The name/path of the source from which the target is to be transformed
402 source); also known as
405 The name of the archive member; also known as
408 The list of sources for this target that were deemed out-of-date; also
412 The file prefix of the file, containing only the file portion, no suffix
413 or preceding directory components; also known as
416 The name of the target; also known as
429 are permitted for backward
430 compatibility and are not recommended.
440 permitted for compatibility with
442 makefiles and are not recommended.
444 Four of the local variables may be used in sources on dependency lines
445 because they expand to the proper value for each target on the line.
456 sets or knows about the following internal variables or environment
458 .Bl -tag -width ".Va MAKEFILE_LIST"
464 expands to a single dollar
470 .Pq Va argv Ns Op 0 .
472 A path to the directory where
479 to the canonical path given by
482 A path to the directory where the targets are built.
485 searches for an alternate directory to place target files.
486 It will attempt to change into this special directory
487 and will search this directory for makefiles
488 not found in the current directory.
489 The following directories are tried in order:
493 ${MAKEOBJDIRPREFIX}/`pwd`
504 The first directory that
506 successfully changes into is used.
511 is set in the environment but
513 is unable to change into the corresponding directory,
514 then the current directory is used
515 without checking the remainder of the list.
516 If they are undefined and
518 is unable to change into any of the remaining three directories,
519 then the current directory is used.
520 .It Va .MAKEFILE_LIST
523 reads various makefiles, including the default files and any
524 obtained from the command line and
526 directives, their names will be automatically appended to the
529 They are added right before
531 begins to parse them, so that the name of the current makefile is the
532 last word in this variable.
534 The environment variable
536 may contain anything that
540 Its contents are stored in
544 Anything specified on
546 command line is appended to the
548 variable which is then
549 entered into the environment as
551 for all programs which
557 provided for backward compatibility.
559 Alternate path to the current directory.
560 Supported if built with WANT_ENV_PWD defined.
564 to the canonical path given by
566 However, if the environment variable
568 is set and gives a path to the current directory, then
576 is always set to the value of
578 for all programs which
584 is currently building.
594 Name of the machine architecture
596 is running on, obtained from the
598 environment variable, or through
602 Name of the machine architecture
604 was compiled for, defined at compilation time.
606 Makefiles may assign a colon-delimited list of directories to
608 These directories will be searched for source files by
612 has finished parsing all input makefiles.
615 Variable expansion may be modified to select or modify each word of the
618 is whitespace-delimited sequence of characters).
619 The general format of a variable expansion is as follows:
621 .Dl {variable[:modifier[:...]]}
623 Each modifier begins with a colon and one of the following
625 The colon may be escaped with a backslash
629 .It Cm C No \&/ Ar pattern Xo
630 .No \&/ Ar replacement
636 modifier is just like the
638 modifier except that the old and new strings, instead of being
639 simple strings, are an extended regular expression (see
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.
733 Replaces each word in the variable with its last component.
734 .It Ar old_string=new_string
737 style variable substitution.
738 It must be the last modifier specified.
743 do not contain the pattern matching character
745 then it is assumed that they are
746 anchored at the end of each word, so only suffixes or entire
747 words may be replaced.
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 standard output and
792 terminates with exit code 1.
793 Variables in the message are expanded.
796 Conditionals are used to determine which parts of the Makefile
798 They are used similarly to the conditionals supported
799 by the C pre-processor.
800 The following conditionals are supported:
804 .Oo \&! Oc Ns Ar expression
805 .Op Ar operator expression ...
807 Test the value of an expression.
810 .Oo \&! Oc Ns Ar variable
811 .Op Ar operator variable ...
813 Test the value of a variable.
816 .Oo \&! Oc Ns Ar variable
817 .Op Ar operator variable ...
819 Test the value of a variable.
822 .Oo \&! Oc Ns Ar target
823 .Op Ar operator target ...
825 Test the target being built.
828 .Oo \&! Oc Ns Ar target
829 .Op Ar operator target ...
831 Test the target being built.
833 Reverse the sense of the last conditional.
836 .Oo \&! Oc Ns Ar expression
837 .Op Ar operator expression ...
845 .Oo \&! Oc Ns Ar variable
846 .Op Ar operator variable ...
854 .Oo \&! Oc Ns Ar variable
855 .Op Ar operator variable ...
863 .Oo \&! Oc Ns Ar target
864 .Op Ar operator target ...
872 .Oo \&! Oc Ns Ar target
873 .Op Ar operator target ...
880 End the body of the conditional.
885 may be any one of the following:
886 .Bl -tag -width "Cm XX"
892 of higher precedence than
898 will only evaluate a conditional as far as is necessary to determine
900 Parentheses may be used to change the order of evaluation.
903 may be used to logically negate an entire
905 It is of higher precedence than
910 may be any of the following:
913 Takes a variable name as an argument and evaluates to true if the variable
916 Takes a target name as an argument and evaluates to true if the target
917 was specified as part of
919 command line or was declared the default target (either implicitly or
922 before the line containing the conditional.
924 Takes a variable, with possible modifiers, and evaluates to true if
925 the expansion of the variable would result in an empty string.
927 Takes a file name as an argument and evaluates to true if the file exists.
928 The file is searched for on the system search path (see
931 Takes a target name as an argument and evaluates to true if the target
937 may also be an arithmetic or string comparison.
938 Variable expansion is
939 performed on both sides of the comparison, after which the integral
941 A value is interpreted as hexadecimal if it is
942 preceded by 0x, otherwise it is decimal; octal numbers are not supported.
943 The standard C relational operators are all supported.
945 variable expansion, either the left or right hand side of a
949 operator is not an integral value, then
950 string comparison is performed between the expanded
952 If no relational operator is given, it is assumed that the expanded
953 variable is being compared against 0.
957 is evaluating one of these conditional expressions, and it encounters
958 a word it doesn't recognize, either the
962 expression is applied to it, depending on the form of the conditional.
969 expression is applied.
970 Similarly, if the form is
976 expression is applied.
978 If the conditional evaluates to true the parsing of the makefile continues
980 If it evaluates to false, the following lines are skipped.
981 In both cases this continues until a
987 For loops are typically used to apply a set of rules to a list of files.
988 The syntax of a for loop is:
990 .Bl -tag -width indent -compact
991 .It Ic .for Ar variable Ic in Ar expression
998 is evaluated, it is split into words.
1002 is successively set to each word, and substituted in the
1004 inside the body of the for loop.
1006 Comments begin with a hash
1008 character, anywhere but in a shell
1009 command line, and continue to the end of the line.
1013 Ignore any errors from the commands associated with this target, exactly
1014 as if they all were preceded by a dash
1017 Execute the commands associated with this target even if the
1021 options were specified.
1022 Normally used to mark recursive
1027 selects the first target it encounters as the default target to be built
1028 if no target was specified.
1029 This source prevents this target from being selected.
1031 If a target is marked with this attribute and
1033 can't figure out how to create it, it will ignore this fact and assume
1034 the file isn't needed or already exists.
1038 is interrupted, it removes any partially made targets.
1039 This source prevents the target from being removed.
1041 Do not echo any of the commands associated with this target, exactly
1042 as if they all were preceded by an at sign
1045 Turn the target into
1048 When the target is used as a source for another target, the other target
1049 acquires the commands, sources, and attributes (except for
1053 If the target already has commands, the
1055 target's commands are appended
1060 source is appears in a dependency line, the sources that precede it are
1061 made before the sources that succeed it in the line.
1063 detected and targets that form loops will be silently ignored.
1065 .Sh "SPECIAL TARGETS"
1066 Special targets may not be included with other targets, i.e. they must be
1067 the only target specified.
1070 Any command lines attached to this target are executed before anything
1075 rule for any target (that was used only as a
1078 can't figure out any other way to create.
1079 Only the shell script is used.
1082 variable of a target that inherits
1085 to the target's own name.
1087 Any command lines attached to this target are executed after everything
1090 Mark each of the sources with the
1093 If no sources are specified, this is the equivalent of specifying the
1097 A list of suffixes that indicate files that can be included in a source
1099 The suffix must have already been declared with
1101 any suffix so declared will have the directories on its search path (see
1105 special variable, each preceded by a
1111 is interrupted, the commands for this target will be executed.
1113 This does for libraries what
1115 does for include files, except that the flag used is
1118 If no target is specified when
1120 is invoked, this target will be built.
1121 This is always set, either
1122 explicitly, or implicitly when
1124 selects the default target, to give the user a way to refer to the default
1125 target on the command line.
1127 This target provides a way to specify flags for
1129 when the makefile is used.
1130 The flags are as if typed to the shell, though the
1134 .\" XXX: NOT YET!!!!
1135 .\" .It Ic .NOTPARALLEL
1136 .\" The named targets are executed in non parallel mode. If no targets are
1137 .\" specified, then all targets are executed in non parallel mode.
1139 Disable parallel mode.
1141 Same as above, for compatibility with other pmake variants.
1143 The named targets are made in sequence.
1144 .\" XXX: NOT YET!!!!
1145 .\" .It Ic .PARALLEL
1146 .\" The named targets are executed in parallel mode. If no targets are
1147 .\" specified, then all targets are executed in parallel mode.
1149 The sources are directories which are to be searched for files not
1150 found in the current directory.
1151 If no sources are specified, any previously specified directories are
1153 Where possible, use of
1155 is preferred over use of the
1158 .It Ic .PATH\fIsuffix\fR
1159 The sources are directories which are to be searched for suffixed files
1160 not found in the current directory.
1164 first searches the suffixed search path, before reverting to the default
1165 path if the file is not found there.
1166 This form is required for
1174 attribute to any specified sources.
1175 Targets with this attribute are always
1176 considered to be out of date.
1180 attribute to any specified sources.
1181 If no sources are specified, the
1183 attribute is applied to every
1188 attribute to any specified sources.
1189 If no sources are specified, the
1191 attribute is applied to every
1192 command in the file.
1194 Each source specifies a suffix to
1196 If no sources are specified, any previous specified suffices are deleted.
1205 This was removed for POSIX compatibility.
1206 The internal variable
1208 is set to the same value as
1210 support for this may be removed in the future.
1212 Most of the more esoteric features of
1214 should probably be avoided for greater compatibility.
1218 utility uses the following environment variables, if they exist:
1223 .Ev MAKEOBJDIRPREFIX ,
1227 .Bl -tag -width /usr/share/doc/psd/12.make -compact
1229 list of dependencies
1231 list of dependencies
1233 list of dependencies
1237 system makefile (processed before any other file, including
1241 .It Pa /usr/share/mk
1242 system makefile directory
1243 .It /usr/share/doc/psd/12.make
1247 .Ev MAKEOBJDIRPREFIX
1251 List all included makefiles in order visited:
1253 .Dl "make -V .MAKEFILE_LIST | tr \e\ \e\en"
1255 The determination of
1257 is contorted to the point of absurdity.
1259 In the presence of several
1263 silently ignores all but the first.
1266 is not set to the default target when
1268 is invoked without a target name and no
1270 special target exists.
1274 in a test is very simple-minded.
1275 Currently, the only form that works is
1276 .Ql .if ${VAR} op something
1277 For instance, you should write tests as
1278 .Ql .if ${VAR} = "string"
1279 not the other way around, which doesn't work.
1281 For loops are expanded before tests, so a fragment such as:
1283 \&.for TMACHINE in ${SHARED_ARCHS}
1284 \&.if ${TMACHINE} = ${MACHINE}
1289 won't work, and should be rewritten the other way around.
1294 .%T "PMake - A Tutorial"
1297 .Pa /usr/share/doc/psd/12.make
projects / dragonfly.git / blob