pmake
NAME
SYNOPSIS
k -words
k -words
k -words
k -words
k -words
k -words
k -words
k -words
k -words
k -words
DESCRIPTION
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.
If the file
exists, it is read for this list of specifications.
If it does not exist, the file
is read.
If the file
exists, it is read (see
mkdep(1)
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:
- 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.
- variable Define to be 1, in the global context.
- flags Turn on debugging, and specify which portions of are to print debugging information. is one or more of the following:
- A Print all possible debugging information; equivalent to specifying all of the debugging flags.
- a Print debugging information about archive searching and caching.
- c Print debugging information about conditional evaluation.
- d Print debugging information about directory searching and caching.
- e Print debugging information about failed commands and targets.
- f Print debugging information about loop evaluation.
- g1 Print the input graph before making anything.
- g2 Print the input graph after making everything, or before exiting on error.
- g3 Print the input graph before exiting on error.
- j Print debugging information about running multiple shells.
- m Print debugging information about making targets, including modification dates.
- n Don't delete the temporary command scripts created in
when running commands.
These are created via
mkstemp(3)
and have names of the form
This can create many file in /tmp so use with care.
s
Print debugging information about suffix-transformation rules.
t
Print debugging information about target list maintenance.
v
Print debugging information about variable assignment.
x
Run shell commands with
so the actual commands are printed as they are executed.
e
Specify that environment variables override macro assignments within
makefiles.
makefile
Specify a makefile to read instead of the default
If
is
standard input is read.
Multiple makefiles may be specified, and are read in the order specified.
directory
Specify a directory in which to search for makefiles and included makefiles.
The system makefile directory (or directories, see the
option) is automatically included as part of this list.
i
Ignore non-zero exit of shell commands in the makefile.
Equivalent to specifying
before each command line in the makefile.
private
This option should
be specified by the user.
When the
option is in use in a recursive build, this option is passed by a make
to child makes to allow all the make processes in the build to
cooperate to avoid overloading the system.
max_jobs
Specify the maximum number of jobs that
may have running at any one time.
Turns compatibility mode off, unless the
flag is also specified.
k
Continue processing after errors are encountered, but only on those targets
that do not depend on the target whose creation caused the error.
directory
Specify a directory in which to search for sys.mk and makefiles included
via the
include statement.
The
option can be used multiple times 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
include statements (see the
option).
If a file or directory name in the
argument (or the
environment variable) starts with the string
then
will search for the specified file or directory named in the remaining part
of the argument string.
The search starts with the current directory of
the Makefile and then works upward towards the root of the filesystem.
If the search is successful, then the resulting directory replaces the
specification in the
argument.
If used, this feature allows
to easily search in the current source tree for customized sys.mk files
(e.g., by using
as an argument).
n
Display the commands that would have been executed, but do not
actually execute them unless the target depends on the .MAKE special
source (see below).
N
Display the commands which would have been executed, but do not
actually execute any of them; useful for debugging top-level makefiles
without descending into subdirectories.
q
Do not execute any commands, but exit 0 if the specified targets are
up-to-date and 1, otherwise.
r
Do not use the built-in rules specified in the system makefile.
s
Do not echo any commands as they are executed.
Equivalent to specifying
before each command line in the makefile.
tracefile
When used with the
flag,
append a trace record to
for each job started and completed.
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.
variable
Print
idea of the value of
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.
If
contains a
then the value will be expanded before printing.
W
Treat any warnings during makefile parsing as errors.
X
Don't export variables passed on the command line to the environment
individually.
Variables passed on the command line are still exported
via the
environment variable.
This option may be useful on systems which have a small limit on the
size of command arguments.
variable=value
Set the value of the variable
to
Normally, all values passed on the command line are also exported to
sub-makes in the environment.
The
flag disables this behavior.
Variable assignments should follow options for POSIX compatibility
but no ordering is enforced.
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.
In general, lines may be continued from one line to the next by ending
them with a backslash
The trailing newline character and initial whitespace on the following
line are compressed into a single space.
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:
- : 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 is interrupted.
- ! 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 is interrupted.
- :: 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 is interrupted.
Targets and sources may contain the shell wildcard values
and
The values
and
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
need not necessarily be used to describe existing files.
Expansion is in directory order, not alphabetically as done in the shell.
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
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
operator is used.
If the first characters of the command line are any combination of
or
the command is treated specially.
A
causes the command not to be echoed before it is executed.
A
causes the command to be executed even when
is given.
This is similar to the effect of the .MAKE special source,
except that the effect can be limited to a single line of a script.
A
causes any non-zero exit status of the command line to be ignored.
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:
- = 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 to the variable. 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
curly braces
or parentheses
and preceding it with
a dollar sign
If the variable name contains only a single letter, the surrounding
braces or parentheses 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
executed.
The four different classes of variables (in order of increasing precedence)
are:
- variables Variables defined as part of environment.
- variables Variables defined in the makefile or in included makefiles.
- variables Variables defined as part of the command line.
- variables Variables that are defined specific to a certain target. The seven local variables are as follows:
- .ALLSRC The list of all sources for this target; also known as
- .ARCHIVE The name of the archive file.
- .IMPSRC The name/path of the source from which the target is to be transformed (the ``implied'' source); also known as
- .MEMBER The name of the archive member.
- .OODATE The list of sources for this target that were deemed out-of-date; also known as
- .PREFIX The file prefix of the file, containing only the file portion, no suffix or preceding directory components; also known as
- .TARGET The name of the target; also known as
The shorter forms
and
are permitted for backward
compatibility with historical makefiles and are not recommended.
The six variables
and
are 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.
These variables are
and
In addition,
sets or knows about the following variables:
- $ A single dollar sign i.e. expands to a single dollar sign.
- .ALLTARGETS The list of all targets encountered in the Makefile. If evaluated during Makefile parsing, lists only those targets encountered thus far.
- .CURDIR A path to the directory where was executed. Refer to the description of for more details.
- MAKE The name that was executed with
For compatibily
also sets
with the same value.
The preferred variable to use is the environment variable
because it is more compatible with other versions of
and cannot be confused with the special target with the same name.
MAKEFLAGS
The environment variable
may contain anything that
may be specified on
command line.
Anything specified on
command line is appended to the
variable which is then
entered into the environment for all programs which
executes.
.MAKEOVERRIDES
This variable is used to record the names of variables assigned to
on the command line, so that they may be exported as part of
This behaviour can be disabled by assigning an empty value to
within a makefile.
Extra variables can be exported from a makefile
by appending their names to
is re-exported whenever
is modified.
MAKE_PRINT_VAR_ON_ERROR
When
stops due to an error, it prints its name and the value of
as well as the value of any variables named in
.newline
This variable is simply assigned a newline character as its value.
This allows expansions using the
modifier to put a newline between
iterations of the loop rather than a space.
For example, the printing of
could be done as ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}.
.OBJDIR
A path to the directory where the targets are built.
Its value is determined by trying to
chdir(2)
to the following directories in order and using the first match:
- t
(Only if
is set in the environment or on the command line.)
t
(Only if
is set in the environment or on the command line.)
t
t
t
t
Variable expansion is performed on the value before it's used,
so expressions such as
may be used.
may be modified in the makefile as a global variable.
In all cases,
will
chdir(2)
to
and set
to that directory before executing any targets.
.
.PARSEDIR
A path to the directory of the current
being parsed.
.PARSEFILE
The basename of the current
being parsed.
This variable and
are both set only while the
are being parsed.
.PATH
A variable that represents the list of directories that
will search for files.
The search list should be updated using the target
rather than the variable.
PWD
Alternate path to the current directory.
normally sets
to the canonical path given by
getcwd(3)
However, if the environment variable
is set and gives a path to the current directory, then
sets
to the value of
instead.
This behaviour is disabled if
is set or
contains a variable transform.
is set to the value of
for all programs which
executes.
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:
Each modifier begins with a colon,
which may be escaped with a backslash
The supported modifiers are:
- :E Replaces each word in the variable with its suffix.
- :H Replaces each word in the variable with everything but the last component.
- pattern Select only those words that match The standard shell wildcard characters
and
may
be used.
The wildcard characters may be escaped with a backslash
to prevent such behaviour.
For example,
LIST= uno due tre quattro
RANDOM_LIST= ${LIST:Ox}
STATIC_RANDOM_LIST:= ${LIST:Ox}
all:
@echo "${RANDOM_LIST}"
@echo "${RANDOM_LIST}"
@echo "${STATIC_RANDOM_LIST}"
@echo "${STATIC_RANDOM_LIST}"
may produce output similar to:
quattro due tre uno tre due quattro uno due uno quattro tre due uno quattro tre
is anchored at the beginning of each word.
If
ends with a dollar sign
it is anchored at the end of each word.
Inside
an ampersand
is replaced by
(without any
or
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
Variable expansion occurs in the normal fashion inside both
and
with the single exception that a backslash is used to prevent the expansion
of a dollar sign
not a preceding dollar sign as is usual.
Xo
The
modifier is just like the
modifier except that the old and new strings, instead of being
simple strings, are a regular expression (see
regex(3)
string
and an
ed(1)
string
Normally, the first occurrence of the pattern
in each word of the value is substituted with
The
modifier causes the substitution to apply to at most one word; the
modifier causes the substitution to apply to as many instances of the
search pattern
as occur in the word or words it is found in; the
modifier causes the value to be treated as a single word
(possibly containing embedded white space).
Note that
and
are orthogonal; the former specifies whether multiple words are
potentially affected, the latter whether multiple substitutions can
potentially occur within each affected word.
:T
Replaces each word in the variable with its last component.
:u
Remove adjacent duplicate words (like
uniq(1)
false_string
If the variable (actually an expression; see below)
evaluates to true, return as its value the
otherwise return the
:old_string=new_string
This is the
style variable substitution.
It must be the last modifier specified.
If
or
do not contain the pattern matching character
then it is assumed that they are
anchored at the end of each word, so only suffixes or entire
words may be replaced.
Otherwise
is the substring of
to be replaced in
Variable expansion occurs in the normal fashion inside both
and
with the single exception that a backslash is used to prevent the
expansion of a dollar sign
not a preceding dollar sign as is usual.
Xo
This is the loop expansion mechanism from the OSF Development
Environment (ODE) make.
Unlike
loops expansion occurs at the time of
reference.
Assign
to each word in the variable and evaluate
The ODE convention is that
should start and end with a period.
For example.
newval
If the variable is undefined
is the value.
If the variable is defined, the existing value is returned.
This is another ODE make feature.
It is handy for setting per-target CFLAGS for instance:
If a value is only required if the variable is undefined, use:
newval
If the variable is defined
is the value.
:L
The name of the variable is the value.
:P
The path of the node which has the same name as the variable
is the value.
If no such node exists or its path is null, then the
name of the variable is used.
!
The output of running
is the value.
:sh
If the variable is non-empty it is run as a command and the output
becomes the new value.
str
The variable is assigned the value
after substitution.
This modifier and its variations are useful in
obscure situations such as wanting to apply modifiers to
loop iteration variables which won't work due to the way
loops are implemented.
These assignment modifiers always expand to
nothing, so if appearing in a rule line by themselves should be
preceded with something to keep
happy.
As in:
use_foo: .USE
.for i in ${.TARGET} ${.TARGET:R}.gz
@: ${t::=$i}
@echo t:R:T=${t:R:T}
.endfor
The
helps avoid false matches with the
style
modifier and since substitution always occurs the
form is vaguely appropriate.
Ordinarily, a value is treated as a sequence of words
delimited by white space.
Some modifiers suppress this behaviour,
causing a value to be treated as a single word
(possibly containing embedded white space).
An empty value, or a value that consists entirely of white-space,
is treated as a single word.
For the purposes of the
modifier, the words are indexed both forwards using positive integers
(where index 1 represents the first word),
and backwards using negative integers
(where index -1 represents the last word).
The
is subjected to variable expansion, and the expanded result is
then interpreted as follows:
- index Selects a single word from the value.
- end Selects all words from to inclusive. For example, selects all words from the second word to the last word. If is greater than then the words are output in reverse order. For example, selects all the words from last to first.
- * Causes subsequent modifiers to treat the value as a single word (possibly containing embedded white space). Analogous to the effect of "$*" in Bourne shell.
- 0 Means the same as
- @ Causes subsequent modifiers to treat the value as a sequence of words delimited by white space. Analogous to the effect of "$@" in Bourne shell.
- # Returns the number of words in the value.
INCLUDE STATEMENTS, CONDITIONALS AND FOR LOOPS
Makefile inclusion, conditional structures and for loops reminiscent
of the C programming language are provided in
All such structures are identified by a line beginning with a single
dot
character.
Files are included with either
or
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
option are searched before the system
makefile directory.
For compatibility with other versions of
is also accepted.
If the include statement is written as
or as
then errors locating and/or opening include files are ignored.
Conditional expressions are also preceded by a single dot as the first
character of a line.
The possible conditionals are as follows:
- variable Un-define the specified global variable. Only global variables may be un-defined.
- Xo c .if Test the value of an expression.
- Xo c .ifdef Test the value of a variable.
- Xo c .ifndef Test the value of a variable.
- Xo c .ifmake Test the target being built.
- Xo c .ifnmake Test the target being built.
- .else Reverse the sense of the last conditional.
- Xo c .elif A combination of followed by
- Xo c .elifdef A combination of followed by
- Xo c .elifndef A combination of followed by
- Xo c .elifmake A combination of followed by
- Xo c .elifnmake A combination of followed by
- .endif End the body of the conditional.
The
may be any one of the following:
- || Logical OR.
- Logical of higher precedence than
As in C,
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
may be used to logically negate an entire
conditional.
It is of higher precedence than
The value of
may be any of the following:
- defined Takes a variable name as an argument and evaluates to true if the variable has been defined.
- pmake Takes a target name as an argument and evaluates to true if the target was specified as part of command line or was declared the default target (either implicitly or explicitly, see before the line containing the conditional.
- empty Takes a variable, with possible modifiers, and evaluates to true if the expansion of the variable would result in an empty string.
- 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
- target Takes a target name as an argument and evaluates to true if the target has been defined.
- commands Takes a target name as an argument and evaluates to true if the target has been defined and has commands associated with it.
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
or
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 or an empty string in the case
of a string comparison.
When
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
or
the ``defined'' expression
is applied.
Similarly, if the form is
or
expression is applied.
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
or
is found.
For loops are typically used to apply a set of rules to a list of files.
The syntax of a for loop is:
- Xo c .for c in
- make-rules
- .endfor
After the for
c expression
is evaluated, it is split into words.
On each iteration of the loop, one word is taken and assigned to each
c variable ,
in order, and these
c variables
are substituted into the
c make-rules
inside the body of the for loop.
The number of words must come out even; that is, if there are three
iteration variables, the number of words provided must be a multiple
of three.
COMMENTS
Comments begin with a hash
character, anywhere but in a shell
command line, and continue to the end of an unescaped new line.
SPECIAL SOURCES (ATTRIBUTES)
- .EXEC Target is never out of date, but always execute commands anyway.
- .IGNORE Ignore any errors from the commands associated with this target, exactly as if they all were preceded by a dash
SPECIAL TARGETS
Special targets may not be included with other targets, i.e. they must be
the only target specified.
- .BEGIN Any command lines attached to this target are executed before anything else is done.
- .DEFAULT This is sort of a c .USE rule for any target (that was used only as a source) that 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.
- .END Any command lines attached to this target are executed after everything else is done.
- .IGNORE Mark each of the sources with the c .IGNORE attribute. If no sources are specified, this is the equivalent of specifying the option.
- .INTERRUPT If is interrupted, the commands for this target will be executed.
- .MAIN If no target is specified when is invoked, this target will be built.
- .MAKEFLAGS 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 option will have no effect.
- .NOPATH Apply the c .NOPATH attribute to any specified sources.
- .NOTPARALLEL Disable parallel mode.
- .NO_PARALLEL Synonym for c .NOTPARALLEL , for compatibility with other pmake variants.
- .ORDER The named targets are made in sequence.
- .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. If the source is the special c .DOTLAST target, then the current working directory is searched last.
- .PHONY Apply the c .PHONY attribute to any specified sources.
- .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.
- .SHELL Sets the shell that will use to execute commands. The sources are a set of pairs.
- name This is the minimal specification, used to select one of the builtin shell specs; and
- path Specifies the path to the shell.
- hasErrCtl Indicates whether the shell supports exit on error.
- check The command to turn on error checking.
- ignore The command to disable error checking.
- echo The command to turn on echoing of commands executed.
- quiet The command to turn off echoing of commands executed.
- filter The output to filter after issuing the command. It is typically identical to
- errFlag The flag to pass the shell to enable error checking.
- echoFlag The flag to pass the shell to enable command echoing.
Example:
.SHELL: name=ksh path=/bin/ksh hasErrCtl=true \ check="set -e" ignore="set +e" \ echo="set -v" quiet="set +v" filter="set +v" \ echoFlag=v errFlag=e
ENVIRONMENT
uses the following environment variables, if they exist:
and
and
may only be set in the environment or on the command line to
and not as makefile variables;
see the description of
for more details.
FILES
- .depend list of dependencies
- Makefile list of dependencies
- makefile list of dependencies
- sys.mk system makefile
- /usr/share/mk system makefile directory
SEE ALSO
mkdep(1)
HISTORY
A make
command appeared in
