.\" Copyright (c) 1990 The Regents of the University of California.
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" 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
.\" @(#)make.1 5.7 (Berkeley) 7/24/91
.\" PATCHES MAGIC LEVEL PATCH THAT GOT US HERE
.\" -------------------- ----- ----------------------
.\" CURRENT PATCH LEVEL: 1 00130
.\" -------------------- ----- ----------------------
.\" 06 Apr 93 Sascha Wildner Misc small fixes
.Nd maintain program dependencies
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
exists, it is read for this list of specifications.
If it does not exist, the file
This manual page is intended as a reference document only.
For a more thorough description of
and makefiles, please refer to
.%T "Make \- A Tutorial" .
The options are as follows:
to be 1, in the global context.
Turn on debugging, and specify which portions of
are to print debugging information.
is one or more of the following:
Print all possible debugging information;
equivalent to specifying all of the debugging flags.
Print debugging information about archive searching and caching.
Print debugging information about conditional evaluation.
Print debugging information about directory searching and caching.
Print the input graph before making anything.
Print the input graph after making everything, or before exiting
Print debugging information about running multiple shells.
Print debugging information about making targets, including modification
Print debugging information about suffix-transformation rules.
Print debugging information about target list maintenance.
Print debugging information about variable assignment.
Specify that environmental variables override macro assignments within
Specify a makefile to read instead of the default
Multiple makefile's may be specified, and are read in the order specified.
Specify a directory in which to search for makefiles and included makefiles.
The system makefile directory is automatically included as part of this
Ignore non-zero exit of shell commands in the makefile.
before each command line in the makefile.
Specify the maximum number of jobs that
may have running at any one time.
Continue processing after errors are encountered, but only on those targets
that do not depend on the target whose creation caused the error.
Display the commands that would have been executed, but do not actually
Do not execute any commands, but exit 0 if the specified targets are
up-to-date and 1, otherwise.
Do not use the built-in rules specified in the system makefile.
Do not echo any commands as they are executed.
before each command line in the makefile.
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.
Set the value of the variable
There are six different types of lines in a makefile: file dependency
specifications, shell commands, variable assignments, include statements,
conditional directives, and comments.
In general, lines may be continued from one line to the next by ending
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
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:
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
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
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
The target will not be removed if
Targets and sources may contain the shell wildcard values
may only be used as part of the final
component of the target or source, and must be used to describe existing
need not necessarily be used to describe existing files.
Expansion is in directory order, not alphabetically as done in the shell.
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
While any target may appear on a dependency line, only one of these
dependencies may be followed by a creation script, unless the
If the first or first two characters of the command line are
the command is treated specially.
causes the command not to be echoed before it is executed.
causes any non-zero exit status of the command line to be ignored.
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
Assign the value to the variable.
Any previous value is overridden.
Append the value to the current value of the variable.
Assign the value to the variable if it is not already defined.
Assign with expansion, i.e. expand the value before assigning it
Normally, expansion is not done until the variable is referenced.
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.
Any white-space before the assigned
is removed; if the value is being appended, a single space is inserted
between the previous contents of the variable and the appended value.
Variables are expanded by surrounding the variable name with either
If the variable name contains only a single letter, the surrounding
braces or parenthesis are not required.
This shorter form is not recommended.
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
The four different classes of variables (in order of increasing precedence)
.It Environment variables
Variables defined as part of
Variables defined in the makefile or in included makefiles.
.It Command line variables
Variables defined as part of the command line.
Variables that are defined specific to a certain target.
The seven local variables are as follows:
.Bl -tag -width ".ARCHIVE"
The list of all sources for this target; also known as
The name of the archive file.
The name/path of the source from which the target is to be transformed
(the ``implied'' source); also known as
The name of the archive member.
The list of sources for this target that were deemed out-of-date; also
The file prefix of the file, containing only the file portion, no suffix
or preceding directory components; also known as
The name of the target; also known as
are permitted for backward
compatibility with historical makefiles and are not recommended.
permitted for compatibility with
makefiles and are not recommended.
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.
sets or knows about the following variables:
.Bl -tag -width MAKEFLAGS
expands to a single dollar
A path to the directory where
may contain anything that
command line is appended to the
entered into the environment for all programs which
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:
.Dl {variable[:modifier[:...]]}
Each modifier begins with a colon and one of the following
The colon may be escaped with a backslash
Replaces each word in the variable with its suffix.
Replaces each word in the variable with everything but the last component.
Select only those words that match the rest of the modifier.
The standard shell wildcard characters
The wildcard characters may be escaped with a backslash
but selects all words which do not match
the rest of the modifier.
Replaces each word in the variable with everything but its suffix.
.It Cm S No \&/ Ar old_pattern Xo
Modify the first occurrence of
in each word to be replaced with
is appended to the last slash of the pattern, all occurrences
in each word are replaced.
is anchored at the beginning of each word.
it is anchored at the end of each word.
Any character may be used as a delimiter for the parts of the modifier
The anchoring, ampersand and delimiter characters may be escaped with a
Variable expansion occurs in the normal fashion inside both
with the single exception that a backslash is used to prevent the expansion
not a preceding dollar sign as is usual.
Replaces each word in the variable with its last component.
.It Ar old_string=new_string
style variable substitution.
It must be the last modifier specified.
is anchored at the end of each word, so only suffixes or entire
.Sh INCLUDE STATEMENTS AND CONDITIONALS
Makefile inclusion and conditional structures reminiscent of the C
programming language are provided in
All such structures are identified by a line beginning with a single
Files are included with either
.Ql .include \*qfile\*q .
Variables between the angle brackets or double quotes are expanded
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
option are searched before the system
Conditional expressions are also preceded by a single dot as the first
The possible conditionals are as follows:
.It Ic .undef Ar variable
Un-define the specified global variable.
Only global variables may be un-defined.
.Oo \&! Oc Ns Ar expression
.Op Ar operator expression ...
Test the value of an expression.
.Oo \&! Oc Ns Ar variable
.Op Ar operator variable ...
Test the value of an variable.
.Oo \&! Oc Ns Ar variable
.Op Ar operator variable ...
Test the value of an variable.
.Op Ar operator target ...
Test the the target being built.
.Op Ar operator target ...
Test the target being built.
Reverse the sense of the last conditional.
.Op Ar operator expression ...
.Oo \&! Oc Ns Ar variable
.Op Ar operator variable ...
.Oo \&! Oc Ns Ar variable
.Op Ar operator variable ...
.Op Ar operator target ...
.Op Ar operator target ...
End the body of the conditional.
may be any one of the following:
of higher precedence than
will only evaluate a conditional as far as is necessary to determine
Parenthesis may be used to change the order of evaluation.
may be used to logically negate an entire
It is of higher precendence than
may be any of the following:
.Bl -tag -width Ic defined
Takes a variable name as an argument and evaluates to true if the variable
Takes a target name as an argument and evaluates to true if the target
command line or was declared the default target (either implicitly or
before the line containing the conditional.
Takes a variable, with possible modifiers, and evalutes to true if
the expansion of the variable would result in an empty string.
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
Takes a target name as an argument and evaluates to true if the target
may also be an arithmetic or string comparison, with the left-hand side
being a variable expansion.
The standard C relational operators are all supported, and the usual
number/base conversion is performed.
Note, octal numbers are not supported.
If the righthand value of a
a string comparison is done between the expanded
variable and the text between the quotation marks.
If no relational operator is given, it is assumed that the expanded
variable is being compared against 0.
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.
the ``defined'' expression
Similarly, if the form is
.Ql Ic .ifnmake , the ``make''
If the conditional evaluates to true the parsing of the makefile continues
If it evaluates to false, the following lines are skipped.
In both cases this continues until a
Comments begin with a hash
character, anywhere but in a shell
command line, and continue to the end of the line.
.Bl -tag -width Ic .IGNORE
Ignore any errors from the commands associated with this target, exactly
as if they all were preceded by a dash
Execute the commands associated with this target even if the
Normally used to mark recursive
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.
If a target is marked with this attribute and
can't figure out how to create it, it will ignore this fact and assume
the file isn't needed or already exists.
is interrupted, it removes any partially made targets.
This source prevents the target from being removed.
Do not echo any of the commands associated with this target, exactly
as if they all were preceded by an at sign
When the target is used as a source for another target, the other target
acquires the commands, sources, and attributes (except for
If the target already has commands, the
target's commands are appended
Special targets may not be included with other targets, i.e. they must be
the only target specified.
.Bl -tag -width Ic .BEGIN
Any command lines attached to this target are executed before anything
rule for any target (that was used only as a
can't figure out any other way to create.
Only the shell script is used.
variable of a target that inherits
to the target's own name.
Any command lines attached to this target are executed after everything
Mark each of the sources with the
If no sources are specified, this is the equivalent of specifying the
is interrupted, the commands for this target will be executed.
If no target is specified when
is invoked, this target will be built.
This target provides a way to specify flags for
when the makefile is used.
The flags are as if typed to the shell, though the
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
attribute to any specified sources.
If no sources are specified, the
attribute is applied to every
attribute to any specified sources.
If no sources are specified, the
attribute is applied to every
Each source specifies a suffix to
If no sources are specified, any previous specifies suffices are deleted.
utilizes the following environment variables, if they exist:
.Bl -tag -width /usr/share/mk -compact
system makefile directory