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 .\" @(#)make.1 8.8 (Berkeley) 6/13/95
40 .Nd maintain program dependencies
55 .Op Ar variable Ns No = Ns Ar value
60 utility is a program designed to simplify the maintenance of other programs.
61 Its input is a list of specifications
62 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
95 before reading the makefiles or doing anything else.
98 options are specified, each is interpreted relative to the previous one:
99 .Fl C Pa / Fl C Pa etc
105 to be 1, in the global context.
107 Turn on debugging, and specify which portions of
109 are to print debugging information.
112 is one or more of the following:
115 Print all possible debugging information;
116 equivalent to specifying all of the debugging flags.
118 Print debugging information about archive searching and caching.
120 Print debugging information about conditional evaluation.
122 Print debugging information about directory searching and caching.
124 Print debugging information about the execution of for loops.
126 Print the input graph before making anything.
128 Print the input graph after making everything, or before exiting
131 Print debugging information about running multiple shells.
133 Print commands in Makefiles regardless of whether or not they are prefixed
134 by @ or other "quiet" flags.
135 Also known as "loud" behavior.
137 Print debugging information about making targets, including modification
140 Print debugging information about suffix-transformation rules.
142 Print debugging information about target list maintenance.
144 Print debugging information about variable assignment.
147 Specify a variable whose environment value (if any) will override
148 macro assignments within makefiles.
150 Specify that environment values override macro assignments within
151 makefiles for all variables.
153 Specify a makefile to read instead of the default
161 standard input is read.
162 Multiple makefiles may be specified, and are read in the order specified.
163 .It Fl I Ar directory
164 Specify a directory in which to search for makefiles and included makefiles.
165 The system makefile directory (or directories, see the
167 option) is automatically included as part of this list.
169 Ignore non-zero exit of shell commands in the makefile.
170 Equivalent to specifying
172 before each command line in the makefile.
174 Specify the maximum number of jobs that
176 may have running at any one time.
177 Turns compatibility mode off, unless the
179 flag is also specified.
181 Continue processing after errors are encountered, but only on those targets
182 that do not depend on the target whose creation caused the error.
183 .It Fl m Ar directory
184 Specify a directory in which to search for
186 and makefiles included via the <...> style.
187 Multiple directories can be added to form a search path.
188 This path will override the default system include path:
190 Furthermore, the system include path will be appended to the search path used
191 for "..."-style inclusions (see the
195 Display the commands that would have been executed, but do not actually
198 Collate the output of a given job and display it only when the job finishes,
199 instead of mixing the output of parallel jobs together.
200 This option has no effect unless
204 Do not execute any commands, but exit 0 if the specified targets are
205 up-to-date and 1, otherwise.
207 Do not use the built-in rules specified in the system makefile.
209 Stop processing when an error is encountered.
211 This is needed to negate the
213 option during recursive builds.
215 Do not echo any commands as they are executed.
216 Equivalent to specifying
218 before each command line in the makefile.
220 Rather than re-building a target as specified in the makefile, create it
221 or update its modification time to make it appear up-to-date.
227 in the global context.
228 Do not build any targets.
229 Multiple instances of this option may be specified;
230 the variables will be printed one per line,
231 with a blank line for each null or undefined variable.
234 For multi-job makes, this will cause file banners to be generated.
238 option to print the values of variables,
239 do not recursively expand the values.
240 .It Ar variable Ns No = Ns Ar value
241 Set the value of the variable
247 There are seven different types of lines in a makefile: file dependency
248 specifications, shell commands, variable assignments, include statements,
249 conditional directives, for loops, and comments.
251 In general, lines may be continued from one line to the next by ending
252 them with a backslash
254 The trailing newline character and initial whitespace on the following
255 line are compressed into a single space.
256 .Sh FILE DEPENDENCY SPECIFICATIONS
257 Dependency lines consist of one or more targets, an operator, and zero
259 This creates a relationship where the targets
262 and are usually created from them.
263 The exact relationship between the target and the source is determined
264 by the operator that separates them.
265 The three operators are as follows:
268 A target is considered out-of-date if its modification time is less than
269 those of any of its sources.
270 Sources for a target accumulate over dependency lines when this operator
272 The target is removed if
276 Targets are always re-created, but not until all sources have been
277 examined and re-created as necessary.
278 Sources for a target accumulate over dependency lines when this operator
280 The target is removed if
284 If no sources are specified, the target is always re-created.
285 Otherwise, a target is considered out-of-date if any of its sources has
286 been modified more recently than the target.
287 Sources for a target do not accumulate over dependency lines when this
289 The target will not be removed if
294 Targets and sources may contain the shell wildcard expressions
305 may only be used as part of the final
306 component of the target or source, and must be used to describe existing
310 need not necessarily be used to describe existing files.
311 Expansion is in directory order, not alphabetically as done in the shell.
313 Each target may have associated with it a series of shell commands, normally
314 used to create the target.
315 Each of the commands in this script
317 be preceded by a tab.
318 While any target may appear on a dependency line, only one of these
319 dependencies may be followed by a creation script, unless the
323 If the first or first two characters of the command line are
327 the command is treated specially.
330 causes the command not to be echoed before it is executed.
333 causes any non-zero exit status of the command line to be ignored.
334 .Sh VARIABLE ASSIGNMENTS
337 are much like variables in the shell, and, by tradition,
338 consist of all upper-case letters.
339 The five operators that can be used to assign values to variables are as
343 Assign the value to the variable.
344 Any previous value is overridden.
346 Append the value to the current value of the variable.
348 Assign the value to the variable if it is not already defined.
350 Assign with expansion, i.e., expand the value before assigning it
352 Normally, expansion is not done until the variable is referenced.
354 Expand the value and pass it to the shell for execution and assign
355 the result to the variable.
356 Any newlines in the result are replaced with spaces.
359 Any whitespace before the assigned
361 is removed; if the value is being appended, a single space is inserted
362 between the previous contents of the variable and the appended value.
364 Variables are expanded by surrounding the variable name with either
369 and preceding it with
372 If the variable name contains only a single letter, the surrounding
373 braces or parentheses are not required.
374 This shorter form is not recommended.
376 Variable substitution occurs at two distinct times, depending on where
377 the variable is being used.
378 Variables in dependency lines are expanded as the line is read.
379 Variables in shell commands are expanded when the shell command is
382 The four different classes of variables (in order of increasing precedence)
385 .It Environment variables
386 Variables defined as part of
390 Variables defined in the makefile or in included makefiles.
391 .It Command line variables
392 Variables defined as part of the command line.
394 Variables that are defined specific to a certain target.
395 The seven local variables are as follows:
396 .Bl -tag -width ".ARCHIVE"
398 The list of all sources for this target; also known as
401 The name of the archive file; also known as
404 The name/path of the source from which the target is to be transformed
407 source); also known as
410 The name of the archive member; also known as
413 The list of sources for this target that were deemed out-of-date; also
417 The file prefix of the file, containing only the file portion, no suffix
418 or preceding directory components; also known as
421 The name of the target; also known as
434 are permitted for backward
435 compatibility and are not recommended.
445 permitted for compatibility with
447 makefiles and are not recommended.
449 Four of the local variables may be used in sources on dependency lines
450 because they expand to the proper value for each target on the line.
461 sets or knows about the following internal variables or environment
463 .Bl -tag -width ".Va MAKEFILE_LIST"
469 expands to a single dollar
475 .Pq Va argv Ns Op 0 .
477 A path to the directory where
484 to the canonical path given by
487 A path to the directory where the targets are built.
490 searches for an alternate directory to place target files.
491 It will attempt to change into this special directory
492 and will search this directory for makefiles
493 not found in the current directory.
494 The following directories are tried in order:
498 ${MAKEOBJDIRPREFIX}/`pwd`
509 The first directory that
511 successfully changes into is used.
516 is set in the environment but
518 is unable to change into the corresponding directory,
519 then the current directory is used
520 without checking the remainder of the list.
521 If they are undefined and
523 is unable to change into any of the remaining three directories,
524 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 Order every word in the variable alphabetically.
671 Quotes every shell meta-character in the variable, so that it can be passed
672 safely through recursive invocations of
675 Replaces each word in the variable with everything but its suffix.
677 .It Cm S No \&/ Ar old_string Xo
678 .No \&/ Ar new_string
682 Modify the first occurrence of
684 in each word of the variable's value, replacing it with
688 is appended to the last slash of the pattern, all occurrences
689 in each word are replaced.
695 is anchored at the beginning of each word.
698 ends with a dollar sign
700 it is anchored at the end of each word.
707 Any character may be used as a delimiter for the parts of the modifier
709 The anchoring, ampersand, and delimiter characters may be escaped with a
713 Variable expansion occurs in the normal fashion inside both
717 with the single exception that a backslash is used to prevent the expansion
720 not a preceding dollar sign as is usual.
721 .It Ar old_string=new_string
724 style variable substitution.
725 It must be the last modifier specified.
730 do not contain the pattern matching character
732 then it is assumed that they are
733 anchored at the end of each word, so only suffixes or entire
734 words may be replaced.
742 Replaces each word in the variable with its last component.
744 Converts variable to upper-case letters.
746 .Sh DIRECTIVES, CONDITIONALS, AND FOR LOOPS
747 Directives, conditionals, and for loops reminiscent
748 of the C programming language are provided in
750 All such structures are identified by a line beginning with a single
754 The following directives are supported:
756 .It Ic \&.include Ar <file>
757 .It Ic \&.include Ar \*qfile\*q
758 Include the specified makefile.
759 Variables between the angle brackets
760 or double quotes are expanded to form the file name.
762 are used, the included makefile is expected to be in the system
764 If double quotes are used, the including
765 makefile's directory and any directories specified using the
767 option are searched before the system
769 .It Ic .undef Ar variable
770 Un-define the specified global variable.
771 Only global variables may be un-defined.
772 .It Ic .error Ar message
773 Terminate processing of the makefile immediately.
775 makefile, the line on which the error was encountered and the specified
776 message are printed to the standard error output and
778 terminates with exit code 1.
779 Variables in the message are expanded.
780 .It Ic .warning Ar message
781 Emit a warning message.
782 The filename of the makefile,
783 the line on which the warning was encountered,
784 and the specified message are printed to the standard error output.
785 Variables in the message are expanded.
788 Conditionals are used to determine which parts of the Makefile
790 They are used similarly to the conditionals supported
791 by the C pre-processor.
792 The following conditionals are supported:
796 .Oo \&! Oc Ns Ar expression
797 .Op Ar operator expression ...
799 Test the value of an expression.
802 .Oo \&! Oc Ns Ar variable
803 .Op Ar operator variable ...
805 Test the value of a variable.
808 .Oo \&! Oc Ns Ar variable
809 .Op Ar operator variable ...
811 Test the value of a variable.
814 .Oo \&! Oc Ns Ar target
815 .Op Ar operator target ...
817 Test the target being built.
820 .Oo \&! Oc Ns Ar target
821 .Op Ar operator target ...
823 Test the target being built.
825 Reverse the sense of the last conditional.
828 .Oo \&! Oc Ns Ar expression
829 .Op Ar operator expression ...
837 .Oo \&! Oc Ns Ar variable
838 .Op Ar operator variable ...
846 .Oo \&! Oc Ns Ar variable
847 .Op Ar operator variable ...
855 .Oo \&! Oc Ns Ar target
856 .Op Ar operator target ...
864 .Oo \&! Oc Ns Ar target
865 .Op Ar operator target ...
872 End the body of the conditional.
877 may be any one of the following:
878 .Bl -tag -width "Cm XX"
885 of higher precedence than
891 will only evaluate a conditional as far as is necessary to determine
893 Parentheses may be used to change the order of evaluation.
896 may be used to logically negate an entire
898 It is of higher precedence than
903 may be any of the following:
906 Takes a variable name as an argument and evaluates to true if the variable
909 Takes a target name as an argument and evaluates to true if the target
910 was specified as part of
912 command line or was declared the default target (either implicitly or
915 before the line containing the conditional.
917 Takes a variable, with possible modifiers, and evaluates to true if
918 the expansion of the variable would result in an empty string.
920 Takes a file name as an argument and evaluates to true if the file exists.
921 The file is searched for on the system search path (see
924 Takes a target name as an argument and evaluates to true if the target
930 may also be an arithmetic or string comparison, with the left-hand side
931 being a variable expansion.
932 Variable expansion is
933 performed on both sides of the comparison, after which the integral
935 A value is interpreted as hexadecimal if it is
936 preceded by 0x, otherwise it is decimal; octal numbers are not supported.
937 The standard C relational operators are all supported.
939 variable expansion, either the left or right hand side of a
943 operator is not an integral value, then
944 string comparison is performed between the expanded
946 If no relational operator is given, it is assumed that the expanded
947 variable is being compared against 0.
951 is evaluating one of these conditional expressions, and it encounters
952 a word it doesn't recognize, either the
956 expression is applied to it, depending on the form of the conditional.
964 expression is applied.
965 Similarly, if the form is
971 expression is applied.
973 If the conditional evaluates to true the parsing of the makefile continues
975 If it evaluates to false, the following lines are skipped.
976 In both cases this continues until a
982 For loops are typically used to apply a set of rules to a list of files.
983 The syntax of a for loop is:
985 .Bl -tag -width indent -compact
986 .It Ic .for Ar variable Ic in Ar expression
993 is evaluated, it is split into words.
997 is successively set to each word, and substituted in the
999 inside the body of the for loop.
1001 Comments begin with a hash
1003 character, anywhere but in a shell
1004 command line, and continue to the end of the line.
1008 Ignore any errors from the commands associated with this target, exactly
1009 as if they all were preceded by a dash
1012 Execute the commands associated with this target even if the
1016 options were specified.
1017 Normally used to mark recursive
1022 selects the first target it encounters as the default target to be built
1023 if no target was specified.
1024 This source prevents this target from being selected.
1026 If a target is marked with this attribute and
1028 can't figure out how to create it, it will ignore this fact and assume
1029 the file isn't needed or already exists.
1033 is interrupted, it removes any partially made targets.
1034 This source prevents the target from being removed.
1036 Do not echo any of the commands associated with this target, exactly
1037 as if they all were preceded by an at sign
1040 Turn the target into
1043 When the target is used as a source for another target, the other target
1044 acquires the commands, sources, and attributes (except for
1048 If the target already has commands, the
1050 target's commands are appended
1055 source is appears in a dependency line, the sources that precede it are
1056 made before the sources that succeed it in the line.
1058 detected and targets that form loops will be silently ignored.
1060 .Sh "SPECIAL TARGETS"
1061 Special targets may not be included with other targets, i.e., they must be
1062 the only target specified.
1065 Any command lines attached to this target are executed before anything
1070 rule for any target (that was used only as a
1073 can't figure out any other way to create.
1074 Only the shell script is used.
1077 variable of a target that inherits
1080 to the target's own name.
1082 Any command lines attached to this target are executed after everything
1085 Mark each of the sources with the
1088 If no sources are specified, this is the equivalent of specifying the
1092 A list of suffixes that indicate files that can be included in a source
1094 The suffix must have already been declared with
1096 any suffix so declared will have the directories on its search path (see
1100 special variable, each preceded by a
1106 is interrupted, the commands for this target will be executed.
1108 This does for libraries what
1110 does for include files, except that the flag used is
1113 If no target is specified when
1115 is invoked, this target will be built.
1116 This is always set, either
1117 explicitly, or implicitly when
1119 selects the default target, to give the user a way to refer to the default
1120 target on the command line.
1122 This target provides a way to specify flags for
1124 when the makefile is used.
1125 The flags are as if typed to the shell, though the
1129 .\" XXX: NOT YET!!!!
1130 .\" .It Ic .NOTPARALLEL
1131 .\" The named targets are executed in non parallel mode. If no targets are
1132 .\" specified, then all targets are executed in non parallel mode.
1134 Disable parallel mode.
1136 Same as above, for compatibility with other
1140 The named targets are made in sequence.
1141 .\" XXX: NOT YET!!!!
1142 .\" .It Ic .PARALLEL
1143 .\" The named targets are executed in parallel mode. If no targets are
1144 .\" specified, then all targets are executed in parallel mode.
1146 The sources are directories which are to be searched for files not
1147 found in the current directory.
1148 If no sources are specified, any previously specified directories are
1150 Where possible, use of
1152 is preferred over use of the
1155 .It Ic .PATH\fIsuffix\fR
1156 The sources are directories which are to be searched for suffixed files
1157 not found in the current directory.
1161 first searches the suffixed search path, before reverting to the default
1162 path if the file is not found there.
1163 This form is required for
1171 attribute to any specified sources.
1172 Targets with this attribute are always
1173 considered to be out of date.
1177 attribute to any specified sources.
1178 If no sources are specified, the
1180 attribute is applied to every
1185 attribute to any specified sources.
1186 If no sources are specified, the
1188 attribute is applied to every
1189 command in the file.
1191 Each source specifies a suffix to
1193 If no sources are specified, any previous specified suffices are deleted.
1202 This was removed for POSIX compatibility.
1203 The internal variable
1205 is set to the same value as
1207 support for this may be removed in the future.
1209 Most of the more esoteric features of
1211 should probably be avoided for greater compatibility.
1215 utility uses the following environment variables, if they exist:
1221 .Ev MAKEOBJDIRPREFIX .
1223 .Bl -tag -width /usr/share/doc/psd/12.make -compact
1225 list of dependencies
1227 list of dependencies
1229 list of dependencies
1233 system makefile (processed before any other file, including
1237 .It Pa /usr/share/mk
1238 system makefile directory
1239 .It /usr/share/doc/psd/12.make
1243 .Ev MAKEOBJDIRPREFIX
1247 List all included makefiles in order visited:
1249 .Dl "make -V .MAKEFILE_LIST | tr \e\ \e\en"
1251 The determination of
1253 is contorted to the point of absurdity.
1255 In the presence of several
1259 silently ignores all but the first.
1262 is not set to the default target when
1264 is invoked without a target name and no
1266 special target exists.
1270 in a test is very simple-minded.
1271 Currently, the only form that works is
1272 .Ql .if ${VAR} op something
1273 For instance, you should write tests as
1274 .Ql .if ${VAR} = "string"
1275 not the other way around, which doesn't work.
1277 For loops are expanded before tests, so a fragment such as:
1278 .Bd -literal -offset indent
1279 \&.for TMACHINE in ${SHARED_ARCHS}
1280 \&.if ${TMACHINE} = ${MACHINE}
1286 won't work, and should be rewritten the other way around.
1288 The parsing code is broken with respect to handling a semicolon
1289 after a colon, so a fragment like this will fail:
1290 .Bd -literal -offset indent
1294 \&.for h in ${HDRS:S;^;${.CURDIR}/;}
1302 .%T "PMake - A Tutorial"
1305 .Pa /usr/share/doc/psd/12.make
1309 command appeared in PWB UNIX.
projects / FreeBSD / FreeBSD.git / blob