The Regents of the University of California. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software
must display the following acknowledgement:
This product includes software developed by the University of
California, Berkeley and its contributors.
4. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
from: @(#)make.1 8.4 (Berkeley) 3/19/94
$Id: make.1,v 1.19 1999/08/11 17:52:55 chris Exp $
.Dd March 19, 1994 .Dt MAKE 1 .Os .Sh NAME .Nm make .Nd maintain program dependencies .Sh SYNOPSIS .Nm make .Op Fl Beiknqrstv .Op Fl D Ar variable .Op Fl d Ar flags .Op Fl E Ar variable .Op Fl f Ar makefile .Op Fl I Ar directory k -words .Op Fl j Ar max_jobs .Op Fl m Ar directory .Ek .Op Fl V Ar variable .Op Ar variable=value .Op Ar target ... .Sh DESCRIPTION .Nm Make is a program designed to simplify the maintenance of other programs. Its input is a list of specifications as to the files upon which programs and other files depend. .Nm Make searches a built-in path for this list. If the file .Ql Pa makefile exists along this path, it is read for this list of specifications. If it does not exist, the file .Ql Pa Makefile is used. If the file .Ql Pa .depend exists, it is also read (see .Xr mkdep 1) .
p This manual page is intended as a reference document only. For a more thorough description of .Nm make and makefiles, please refer to .%T "Make - A Tutorial" .
p The options are as follows: l -tag -width Ds t Fl B Try to be backwards compatible by executing a single shell per command and by executing the commands to make the sources of a dependency line in sequence. t Fl D Ar variable Define .Ar variable to be 1, in the global context. t Fl d Ar flags Turn on debugging, and specify which portions of .Nm make are to print debugging information. .Ar Flags is one or more of the following: l -tag -width Ds t Ar A Print all possible debugging information; equivalent to specifying all of the debugging flags. t Ar a Print debugging information about archive searching and caching. t Ar c Print debugging information about conditional evaluation. t Ar d Print debugging information about directory searching and caching. t Ar "g1" Print the input graph before making anything. t Ar "g2" Print the input graph after making everything, or before exiting on error. t Ar j Print debugging information about running multiple shells. t Ar m Print debugging information about making targets, including modification dates. t Ar s Print debugging information about suffix-transformation rules. t Ar t Print debugging information about target list maintenance. t Ar v Print debugging information about variable assignment. .El t Fl E Ar variable Specify a variable whose environment value (if any) will override macro assignments within makefiles. t Fl e Specify that environment values override macro assignments within makefiles for all variables. t Fl f Ar makefile Specify a makefile to read instead of the default .Ql Pa makefile and .Ql Pa Makefile . If .Ar makefile is .Ql Fl , standard input is read. Multiple makefile's may be specified, and are read in the order specified. t Fl I Ar directory Specify a directory in which to search for makefiles and included makefiles. The system makefile directory (or directories, see the .Fl m option) is automatically included as part of this list. t Fl i Ignore non-zero exit of shell commands in the makefile. Equivalent to specifying .Ql Fl before each command line in the makefile. t Fl j Ar max_jobs Specify the maximum number of jobs that .Nm make may have running at any one time. Turns compatibility mode off, unless the .Ar B flag is also specified. t Fl k Continue processing after errors are encountered, but only on those targets that do not depend on the target whose creation caused the error. t Fl m Ar directory Specify a directory in which to search for sys.mk and makefiles included via the <...> style. Multiple directories can be added to form a search path. This path will override the default system include path: /usr/share/mk. Furthermore the system include path will be appended to the search path used for "..."-style inclusions (see the .Fl I option). t Fl n Display the commands that would have been executed, but do not actually execute them. t Fl q Do not execute any commands, but exit 0 if the specified targets are up-to-date and 1, otherwise. t Fl r Do not use the built-in rules specified in the system makefile. t Fl s Do not echo any commands as they are executed. Equivalent to specifying .Ql Ic @ before each command line in the makefile. t Fl t Rather than re-building a target as specified in the makefile, create it or update its modification time to make it appear up-to-date. t Fl V Ar variable Print .Nm make Ns 's idea of the value of .Ar variable , in the global context. Do not build any targets. Multiple instances of this option may be specified; the variables will be printed one per line, with a blank line for each null or undefined variable. t Fl v Be extra verbose. For multi-job makes, this will cause file banners to be generated. t Ar variable=value Set the value of the variable .Ar variable to .Ar value . .El
p There are seven different types of lines in a makefile: file dependency specifications, shell commands, variable assignments, include statements, conditional directives, for loops, and comments.
p In general, lines may be continued from one line to the next by ending them with a backslash
q Ql \e . The trailing newline character and initial whitespace on the following line are compressed into a single space. .Sh FILE DEPENDENCY SPECIFICATIONS Dependency lines consist of one or more targets, an operator, and zero or more sources. This creates a relationship where the targets ``depend'' on the sources and are usually created from them. The exact relationship between the target and the source is determined by the operator that separates them. The three operators are as follows: l -tag -width flag t Ic : A target is considered out-of-date if its modification time is less than those of any of its sources. Sources for a target accumulate over dependency lines when this operator is used. The target is removed if .Nm make is interrupted. t Ic ! Targets are always re-created, but not until all sources have been examined and re-created as necessary. Sources for a target accumulate over dependency lines when this operator is used. The target is removed if .Nm make is interrupted. t Ic :: If no sources are specified, the target is always re-created. Otherwise, a target is considered out-of-date if any of its sources has been modified more recently than the target. Sources for a target do not accumulate over dependency lines when this operator is used. The target will not be removed if .Nm make is interrupted. .El
p Targets and sources may contain the shell wildcard values .Ql ? , .Ql * , .Ql [] and .Ql {} . The values .Ql ? , .Ql * and .Ql [] may only be used as part of the final component of the target or source, and must be used to describe existing files. The value .Ql {} need not necessarily be used to describe existing files. Expansion is in directory order, not alphabetically as done in the shell. .Sh SHELL COMMANDS Each target may have associated with it a series of shell commands, normally used to create the target. Each of the commands in this script .Em must be preceded by a tab. While any target may appear on a dependency line, only one of these dependencies may be followed by a creation script, unless the .Ql Ic :: operator is used.
p If the first or first two characters of the command line are .Ql Ic @ and/or .Ql Ic - , the command is treated specially. A .Ql Ic @ causes the command not to be echoed before it is executed. A .Ql Ic - causes any non-zero exit status of the command line to be ignored. .Sh VARIABLE ASSIGNMENTS Variables in make are much like variables in the shell, and, by tradition, consist of all upper-case letters. The five operators that can be used to assign values to variables are as follows: l -tag -width Ds t Ic = Assign the value to the variable. Any previous value is overridden. t Ic += Append the value to the current value of the variable. t Ic ?= Assign the value to the variable if it is not already defined. t Ic := Assign with expansion, i.e. expand the value before assigning it to the variable. Normally, expansion is not done until the variable is referenced. t Ic != Expand the value and pass it to the shell for execution and assign the result to the variable. Any newlines in the result are replaced with spaces. .El
p Any white-space before the assigned .Ar value is removed; if the value is being appended, a single space is inserted between the previous contents of the variable and the appended value.
p Variables are expanded by surrounding the variable name with either curly braces
q Ql {} or parentheses
q Ql () and preceding it with a dollar sign
q Ql $ . If the variable name contains only a single letter, the surrounding braces or parentheses are not required. This shorter form is not recommended.
p Variable substitution occurs at two distinct times, depending on where the variable is being used. Variables in dependency lines are expanded as the line is read. Variables in shell commands are expanded when the shell command is executed.
p The four different classes of variables (in order of increasing precedence) are: l -tag -width Ds t Environment variables Variables defined as part of .Nm make Ns 's environment. t Global variables Variables defined in the makefile or in included makefiles. t Command line variables Variables defined as part of the command line. t Local variables Variables that are defined specific to a certain target. The seven local variables are as follows: l -tag -width ".ARCHIVE" t Va .ALLSRC The list of all sources for this target; also known as .Ql Va > . t Va .ARCHIVE The name of the archive file. t Va .IMPSRC The name/path of the source from which the target is to be transformed (the ``implied'' source); also known as .Ql Va < . t Va .MEMBER The name of the archive member. t Va .OODATE The list of sources for this target that were deemed out-of-date; also known as .Ql Va ? . t Va .PREFIX The file prefix of the file, containing only the file portion, no suffix or preceding directory components; also known as .Ql Va * . t Va .TARGET The name of the target; also known as .Ql Va @ . .El
p The shorter forms .Ql Va @ , .Ql Va ? , .Ql Va > and .Ql Va * are permitted for backward compatibility with historical makefiles and are not recommended. The six variables .Ql Va "@F" , .Ql Va "@D" , .Ql Va "<F" , .Ql Va "<D" , .Ql Va "*F" and .Ql Va "*D" are permitted for compatibility with .At V makefiles and are not recommended.
p Four of the local variables may be used in sources on dependency lines because they expand to the proper value for each target on the line. These variables are .Ql Va .TARGET , .Ql Va .PREFIX , .Ql Va .ARCHIVE , and .Ql Va .MEMBER .
p In addition, .Nm make sets or knows about the following variables: l -tag -width MAKEFLAGS t Va $ A single dollar sign .Ql $ , i.e. .Ql $$ expands to a single dollar sign. t Va .MAKE The name that .Nm make was executed with
q Va argv Op 0 t Va .CURDIR A path to the directory where .Nm make was executed. t Va .OBJDIR A path to the directory where the targets are built. t Ev MAKEFLAGS The environment variable .Ql Ev MAKEFLAGS may contain anything that may be specified on .Nm make Ns 's command line. Anything specified on .Nm make Ns 's command line is appended to the .Ql Ev MAKEFLAGS variable which is then entered into the environment for all programs which .Nm make executes. t Ev PWD Alternate path to the current directory. Supported if built with WANT_ENV_PWD defined. .Nm make normally sets .Ql Va .CURDIR to the canonical path given by .Xr getcwd 2 . However, if the environment variable .Ql Ev PWD is set and gives a path to the current directory, then .Nm make sets .Ql Va .CURDIR to the value of .Ql Ev PWD instead. .Ql Ev PWD is set to the value of .Ql Va .OBJDIR for all programs which .Nm make executes. .El
p Variable expansion may be modified to select or modify each word of the variable (where a ``word'' is white-space delimited sequence of characters). The general format of a variable expansion is as follows:
p .Dl {variable[:modifier[:...]]}
p Each modifier begins with a colon and one of the following special characters. The colon may be escaped with a backslash
q Ql \e . l -tag -width Cm E\& t Cm E Replaces each word in the variable with its suffix. t Cm H Replaces each word in the variable with everything but the last component. t Cm M Ns Ar pattern Select only those words that match the rest of the modifier. The standard shell wildcard characters
f ( Ql * , .Ql ? , and .Ql Op ) may be used. The wildcard characters may be escaped with a backslash
q Ql \e . t Cm N Ns Ar pattern This is identical to .Ql Cm M , but selects all words which do not match the rest of the modifier. t Cm Q Quotes every shell meta-character in the variable, so that it can be passed safely through recursive invocations of .Nm make . t Cm R Replaces each word in the variable with everything but its suffix. .Sm off t Cm S No / Ar old_pattern Xo .No / Ar new_pattern .No / Op Cm g .Xc .Sm on Modify the first occurrence of .Ar old_pattern in each word to be replaced with .Ar new_pattern . If a .Ql g is appended to the last slash of the pattern, all occurrences in each word are replaced. If .Ar old_pattern begins with a carat
q Ql ^ , .Ar old_pattern is anchored at the beginning of each word. If .Ar old_pattern ends with a dollar sign
q Ql $ , it is anchored at the end of each word. Inside .Ar new_string , an ampersand
q Ql & is replaced by .Ar old_pattern . Any character may be used as a delimiter for the parts of the modifier string. The anchoring, ampersand and delimiter characters may be escaped with a backslash
q Ql \e .
p Variable expansion occurs in the normal fashion inside both .Ar old_string and .Ar new_string with the single exception that a backslash is used to prevent the expansion of a dollar sign
q Ql $ not a preceding dollar sign as is usual. t Cm T Replaces each word in the variable with its last component. t Ar old_string=new_string This is the .At V style variable substitution. It must be the last modifier specified. If .Ar old_string or .Ar new_string do not contain the pattern matching character .Ar % then it is assumed that they are anchored at the end of each word, so only suffixes or entire words may be replaced. Otherwise .Ar % is the substring of .Ar old_string to be replaced in .Ar new_string .El .Sh DIRECTIVES, CONDITIONALS AND FOR LOOPS Directives, conditionals and for loops reminiscent of the C programming language are provided in .Nm make . All such structures are identified by a line beginning with a single dot
q Ql . character. The following directives are supported: l -tag -width Ds t Ic .include Ar <file> t Ic .include Ar \*qfile\*q Include the specified makefile. Variables between the angle brackets or double quotes are expanded to form the file name. If angle brackets are used, the included makefile is expected to be in the system makefile directory. If double quotes are used, the including makefile's directory and any directories specified using the .Fl I option are searched before the system makefile directory. t Ic .undef Ar variable Un-define the specified global variable. Only global variables may be un-defined. t Ic .error Ar message Terminate processing of the makefile immediately. The filename of the makefile, the line on which the error was encountered and the specified message are printed to standard output and .Nm make terminates with exit code 1. Variables in the message are expanded. .El
p Conditionals are used to determine which parts of the Makefile to process. They are used similarly to the conditionals supported by the C pre-processor. The following conditionals are supported: l -tag -width Ds t Xo c .if .Oo ! Oc Ns Ar expression .Op Ar operator expression ... .Xc Test the value of an expression. t Xo c .ifdef .Oo ! Oc Ns Ar variable .Op Ar operator variable ... .Xc Test the value of a variable. t Xo c .ifndef .Oo ! Oc Ns Ar variable .Op Ar operator variable ... .Xc Test the value of a variable. t Xo c .ifmake .Oo ! Oc Ns Ar target .Op Ar operator target ... .Xc Test the target being built. t Xo c .ifnmake .Oo ! Oc Ar target .Op Ar operator target ... .Xc Test the target being built. t Ic .else Reverse the sense of the last conditional. t Xo c .elif .Oo ! Oc Ar expression .Op Ar operator expression ... .Xc A combination of .Ql Ic .else followed by .Ql Ic .if . t Xo c .elifdef .Oo ! Oc Ns Ar variable .Op Ar operator variable ... .Xc A combination of .Ql Ic .else followed by .Ql Ic .ifdef . t Xo c .elifndef .Oo ! Oc Ns Ar variable .Op Ar operator variable ... .Xc A combination of .Ql Ic .else followed by .Ql Ic .ifndef . t Xo c .elifmake .Oo ! Oc Ns Ar target .Op Ar operator target ... .Xc A combination of .Ql Ic .else followed by .Ql Ic .ifmake . t Xo c .elifnmake .Oo ! Oc Ns Ar target .Op Ar operator target ... .Xc A combination of .Ql Ic .else followed by .Ql Ic .ifnmake . t Ic .endif End the body of the conditional. .El
p The .Ar operator may be any one of the following: l -tag -width "Cm XX" t Cm || logical OR t Cm && Logical .Tn AND ; of higher precedence than .Dq . .El
p As in C, .Nm make will only evaluate a conditional as far as is necessary to determine its value. Parentheses may be used to change the order of evaluation. The boolean operator .Ql Ic ! may be used to logically negate an entire conditional. It is of higher precedence than .Ql Ic && .
p The value of .Ar expression may be any of the following: l -tag -width Ic defined t Ic defined Takes a variable name as an argument and evaluates to true if the variable has been defined. t Ic make Takes a target name as an argument and evaluates to true if the target was specified as part of .Nm make Ns 's command line or was declared the default target (either implicitly or explicitly, see .Va .MAIN ) before the line containing the conditional. t Ic empty Takes a variable, with possible modifiers, and evaluates to true if the expansion of the variable would result in an empty string. t Ic exists Takes a file name as an argument and evaluates to true if the file exists. The file is searched for on the system search path (see .Va .PATH ) . t Ic target Takes a target name as an argument and evaluates to true if the target has been defined. .El
p .Ar Expression may also be an arithmetic or string comparison. Variable expansion is performed on both sides of the comparison, after which the integral values are compared. A value is interpreted as hexadecimal if it is preceded by 0x, otherwise it is decimal; octal numbers are not supported. The standard C relational operators are all supported. If after variable expansion, either the left or right hand side of a .Ql Ic == or .Ql Ic "!=" operator is not an integral value, then string comparison is performed between the expanded variables. If no relational operator is given, it is assumed that the expanded variable is being compared against 0.
p When .Nm make is evaluating one of these conditional expression, and it encounters a word it doesn't recognize, either the ``make'' or ``defined'' expression is applied to it, depending on the form of the conditional. If the form is .Ql Ic .ifdef or .Ql Ic .ifndef , the ``defined'' expression is applied. Similarly, if the form is .Ql Ic .ifmake or .Ql Ic .ifnmake , the ``make'' expression is applied.
p If the conditional evaluates to true the parsing of the makefile continues as before. If it evaluates to false, the following lines are skipped. In both cases this continues until a .Ql Ic .else or .Ql Ic .endif is found.
p For loops are typically used to apply a set of rules to a list of files. The syntax of a for loop is: l -tag -width Ds t Xo c .for .Ar variable c in .Ar expression .Xc t Xo <make-rules> .Xc t Xo c .endfor .Xc .El After the for c expression is evaluated, it is split into words. The iteration c variable is successively set to each word, and substituted in the c make-rules inside the body of the for loop. .Sh COMMENTS Comments begin with a hash
q Ql # character, anywhere but in a shell command line, and continue to the end of the line. .Sh SPECIAL SOURCES l -tag -width Ic .IGNORE t Ic .IGNORE Ignore any errors from the commands associated with this target, exactly as if they all were preceded by a dash
q Ql - . t Ic .MAKE Execute the commands associated with this target even if the .Fl n or .Fl t options were specified. Normally used to mark recursive .Nm make Ns 's . t Ic .NOTMAIN Normally .Nm make selects the first target it encounters as the default target to be built if no target was specified. This source prevents this target from being selected. t Ic .OPTIONAL If a target is marked with this attribute and .Nm make can't figure out how to create it, it will ignore this fact and assume the file isn't needed or already exists. t Ic .PRECIOUS When .Nm make is interrupted, it removes any partially made targets. This source prevents the target from being removed. t Ic .SILENT Do not echo any of the commands associated with this target, exactly as if they all were preceded by an at sign
q Ql @ .
t Ic .USE Turn the target into
.Nm make Ns 's .
version of a macro.
When the target is used as a source for another target, the other target
acquires the commands, sources, and attributes (except for
c .USE ) of the
source.
If the target already has commands, the
c .USE target's commands are appended
to them.
t Ic .WAIT If special
c .WAIT source is appears in a dependency line, the sources that precede it are
made before the sources that succeed it in the line. Loops are not being
detected and targets that form loops will be silently ignored.
.El
.Sh "SPECIAL TARGETS"
Special targets may not be included with other targets, i.e. they must be
the only target specified.
l -tag -width Ic .BEGIN t Ic .BEGIN Any command lines attached to this target are executed before anything
else is done.
t Ic .DEFAULT This is sort of a
c .USE rule for any target (that was used only as a
source) that
.Nm make
can't figure out any other way to create.
Only the shell script is used.
The
c .IMPSRC variable of a target that inherits
c .DEFAULT Ns 's commands is set
to the target's own name.
t Ic .END Any command lines attached to this target are executed after everything
else is done.
t Ic .IGNORE Mark each of the sources with the
c .IGNORE attribute.
If no sources are specified, this is the equivalent of specifying the
.Fl i
option.
t Ic .INTERRUPT If
.Nm make
is interrupted, the commands for this target will be executed.
t Ic .MAIN If no target is specified when
.Nm make
is invoked, this target will be built.
t Ic .MAKEFLAGS This target provides a way to specify flags for
.Nm make
when the makefile is used.
The flags are as if typed to the shell, though the
.Fl f
option will have
no effect.
XXX: NOT YET!!!!
.It Ic .NOTPARALLEL
The named targets are executed in non parallel mode. If no targets are
specified, then all targets are executed in non parallel mode.
t Ic .NOTPARALLEL Disable parallel mode.
t Ic .NO_PARALLEL Same as above, for compatibility with other pmake variants.
t Ic .ORDER The named targets are made in sequence.
XXX: NOT YET!!!!
.It Ic .PARALLEL
The named targets are executed in parallel mode. If no targets are
specified, then all targets are executed in parallel mode.
t Ic .PATH The sources are directories which are to be searched for files not
found in the current directory.
If no sources are specified, any previously specified directories are
deleted.
p Additionally, the variable .Ql Ev VPATH can be used to specify additional directories for the search path, separated by a .Dq \: character.
p However, it is .Em strongly recommended that you do not use this in any new Makefiles, as it exists only for backward compatibility. t Ic .PHONY Apply the c .PHONY attribute to any specified sources. Targets with this attribute are always considered to be out of date. t Ic .PRECIOUS Apply the c .PRECIOUS attribute to any specified sources. If no sources are specified, the c .PRECIOUS attribute is applied to every target in the file. t Ic .SILENT Apply the c .SILENT attribute to any specified sources. If no sources are specified, the c .SILENT attribute is applied to every command in the file. t Ic .SUFFIXES Each source specifies a suffix to .Nm make . If no sources are specified, any previous specified suffices are deleted. .Sh SEARCH PATH .Nm Make searches for .Ql Pa Makefile in the following directories, in order:
p l -enum -compact t ${MAKEOBJDIRPREFIX}`cwd` t ${MAKEOBJDIR} t obj.${MACHINE} t obj t /usr/obj${MACHINE}`cwd` t The current directory (`cwd`). .El
p If .Nm make finds the .Ql Pa Makefile someplace other than the current working directory, it adds the CWD to the search path. .Sh ENVIRONMENT .Nm Make utilizes the following environment variables, if they exist: .Ev MACHINE , .Ev MAKE , .Ev MAKEFLAGS , .Ev MAKEOBJDIR , .Ev MAKEOBJDIRPREFIX , and .Ev PWD . .Sh FILES l -tag -width /usr/share/doc/psd/12.make -compact t .depend list of dependencies t Makefile list of dependencies t makefile list of dependencies t obj object directory t sys.mk system makefile t /usr/share/mk system makefile directory t /usr/share/doc/psd/12.make PMake tutorial t /usr/obj system object directory prefix .El .Sh SEE ALSO .Xr mkdep 1 .Rs .%T "PMake - A Tutorial" .Re .Sh HISTORY A .Nm Make command appeared in .At v7 .