summaryrefslogtreecommitdiff
path: root/devel/bmake/files/bmake.cat1
diff options
context:
space:
mode:
Diffstat (limited to 'devel/bmake/files/bmake.cat1')
-rw-r--r--devel/bmake/files/bmake.cat11210
1 files changed, 651 insertions, 559 deletions
diff --git a/devel/bmake/files/bmake.cat1 b/devel/bmake/files/bmake.cat1
index 5c62c1ba8e4..4f1893db18c 100644
--- a/devel/bmake/files/bmake.cat1
+++ b/devel/bmake/files/bmake.cat1
@@ -1,73 +1,73 @@
-MAKE(1) NetBSD General Commands Manual MAKE(1)
+BMAKE(1) FreeBSD General Commands Manual BMAKE(1)
-NNAAMMEE
- bbmmaakkee -- maintain program dependencies
+NAME
+ bmake -- maintain program dependencies
-SSYYNNOOPPSSIISS
- bbmmaakkee [--BBeeiikkNNnnqqrrssttWWwwXX] [--CC _d_i_r_e_c_t_o_r_y] [--DD _v_a_r_i_a_b_l_e] [--dd _f_l_a_g_s]
- [--ff _m_a_k_e_f_i_l_e] [--II _d_i_r_e_c_t_o_r_y] [--JJ _p_r_i_v_a_t_e] [--jj _m_a_x___j_o_b_s]
- [--mm _d_i_r_e_c_t_o_r_y] [--TT _f_i_l_e] [--VV _v_a_r_i_a_b_l_e] [_v_a_r_i_a_b_l_e_=_v_a_l_u_e]
- [_t_a_r_g_e_t _._._.]
+SYNOPSIS
+ bmake [-BeikNnqrstWwX] [-C directory] [-D variable] [-d flags]
+ [-f makefile] [-I directory] [-J private] [-j max_jobs]
+ [-m directory] [-T file] [-V variable] [-v variable]
+ [variable=value] [target ...]
-DDEESSCCRRIIPPTTIIOONN
- bbmmaakkee is a program designed to simplify the maintenance of other pro-
+DESCRIPTION
+ bmake is a program designed to simplify the maintenance of other pro-
grams. Its input is a list of specifications as to the files upon which
- programs and other files depend. If no --ff _m_a_k_e_f_i_l_e makefile option is
- given, bbmmaakkee will try to open `_m_a_k_e_f_i_l_e' then `_M_a_k_e_f_i_l_e' in order to find
- the specifications. If the file `_._d_e_p_e_n_d' exists, it is read (see
+ programs and other files depend. If no -f makefile makefile option is
+ given, bmake will try to open `makefile' then `Makefile' in order to find
+ the specifications. If the file `.depend' exists, it is read (see
mkdep(1)).
This manual page is intended as a reference document only. For a more
- thorough description of bbmmaakkee and makefiles, please refer to _P_M_a_k_e _- _A
- _T_u_t_o_r_i_a_l.
+ thorough description of bmake and makefiles, please refer to PMake - A
+ Tutorial.
- bbmmaakkee will prepend the contents of the _M_A_K_E_F_L_A_G_S environment variable to
+ bmake will prepend the contents of the MAKEFLAGS environment variable to
the command line arguments before parsing them.
The options are as follows:
- --BB Try to be backwards compatible by executing a single shell per
+ -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.
- --CC _d_i_r_e_c_t_o_r_y
- Change to _d_i_r_e_c_t_o_r_y before reading the makefiles or doing any-
- thing else. If multiple --CC options are specified, each is inter-
- preted relative to the previous one: --CC _/ --CC _e_t_c is equivalent to
- --CC _/_e_t_c.
+ -C directory
+ Change to directory before reading the makefiles or doing any-
+ thing else. If multiple -C options are specified, each is inter-
+ preted relative to the previous one: -C / -C etc is equivalent to
+ -C /etc.
- --DD _v_a_r_i_a_b_l_e
- Define _v_a_r_i_a_b_l_e to be 1, in the global context.
+ -D variable
+ Define variable to be 1, in the global context.
- --dd _[_-_]_f_l_a_g_s
- Turn on debugging, and specify which portions of bbmmaakkee are to
+ -d [-]flags
+ Turn on debugging, and specify which portions of bmake are to
print debugging information. Unless the flags are preceded by
- `-' they are added to the _M_A_K_E_F_L_A_G_S environment variable and will
+ `-' they are added to the MAKEFLAGS environment variable and will
be processed by any child make processes. By default, debugging
information is printed to standard error, but this can be changed
- using the _F debugging flag. The debugging output is always
+ using the F debugging flag. The debugging output is always
unbuffered; in addition, if debugging is enabled but debugging
output is not directed to standard output, then the standard out-
- put is line buffered. _F_l_a_g_s is one or more of the following:
+ put is line buffered. Flags is one or more of the following:
- _A Print all possible debugging information; equivalent to
+ A Print all possible debugging information; equivalent to
specifying all of the debugging flags.
- _a Print debugging information about archive searching and
+ a Print debugging information about archive searching and
caching.
- _C Print debugging information about current working direc-
+ C Print debugging information about current working direc-
tory.
- _c Print debugging information about conditional evaluation.
+ c Print debugging information about conditional evaluation.
- _d Print debugging information about directory searching and
+ d Print debugging information about directory searching and
caching.
- _e Print debugging information about failed commands and
+ e Print debugging information about failed commands and
targets.
- _F[++]_f_i_l_e_n_a_m_e
+ F[+]filename
Specify where debugging output is written. This must be
the last flag, because it consumes the remainder of the
argument. If the character immediately after the `F'
@@ -80,78 +80,80 @@ DDEESSCCRRIIPPTTIIOONN
named file. If the file name ends `.%d' then the `%d' is
replaced by the pid.
- _f Print debugging information about loop evaluation.
+ f Print debugging information about loop evaluation.
- _g_1 Print the input graph before making anything.
+ g1 Print the input graph before making anything.
- _g_2 Print the input graph after making everything, or before
+ g2 Print the input graph after making everything, or before
exiting on error.
- _g_3 Print the input graph before exiting on error.
+ g3 Print the input graph before exiting on error.
- _j Print debugging information about running multiple
+ j Print debugging information about running multiple
shells.
- _l Print commands in Makefiles regardless of whether or not
+ l Print commands in Makefiles regardless of whether or not
they are prefixed by `@' or other "quiet" flags. Also
known as "loud" behavior.
- _M Print debugging information about "meta" mode decisions
+ M Print debugging information about "meta" mode decisions
about targets.
- _m Print debugging information about making targets, includ-
+ m Print debugging information about making targets, includ-
ing modification dates.
- _n Don't delete the temporary command scripts created when
+ n Don't delete the temporary command scripts created when
running commands. These temporary scripts are created in
the directory referred to by the TMPDIR environment vari-
- able, or in _/_t_m_p if TMPDIR is unset or set to the empty
+ able, or in /tmp if TMPDIR is unset or set to the empty
string. The temporary scripts are created by mkstemp(3),
- and have names of the form _m_a_k_e_X_X_X_X_X_X. _N_O_T_E: This can
- create many files in TMPDIR or _/_t_m_p, so use with care.
+ and have names of the form makeXXXXXX. NOTE: This can
+ create many files in TMPDIR or /tmp, so use with care.
- _p Print debugging information about makefile parsing.
+ p Print debugging information about makefile parsing.
- _s Print debugging information about suffix-transformation
+ s Print debugging information about suffix-transformation
rules.
- _t Print debugging information about target list mainte-
+ t Print debugging information about target list mainte-
nance.
- _V Force the --VV option to print raw values of variables.
+ V Force the -V option to print raw values of variables,
+ overriding the default behavior set via
+ .MAKE.EXPAND_VARIABLES.
- _v Print debugging information about variable assignment.
+ v Print debugging information about variable assignment.
- _x Run shell commands with --xx so the actual commands are
+ x Run shell commands with -x so the actual commands are
printed as they are executed.
- --ee Specify that environment variables override macro assignments
+ -e Specify that environment variables override macro assignments
within makefiles.
- --ff _m_a_k_e_f_i_l_e
- Specify a makefile to read instead of the default `_m_a_k_e_f_i_l_e'. If
- _m_a_k_e_f_i_l_e is `--', standard input is read. Multiple makefiles may
+ -f makefile
+ Specify a makefile to read instead of the default `makefile'. If
+ makefile is `-', standard input is read. Multiple makefiles may
be specified, and are read in the order specified.
- --II _d_i_r_e_c_t_o_r_y
+ -I directory
Specify a directory in which to search for makefiles and included
makefiles. The system makefile directory (or directories, see
- the --mm option) is automatically included as part of this list.
+ the -m option) is automatically included as part of this list.
- --ii Ignore non-zero exit of shell commands in the makefile. Equiva-
- lent to specifying `--' before each command line in the makefile.
+ -i Ignore non-zero exit of shell commands in the makefile. Equiva-
+ lent to specifying `-' before each command line in the makefile.
- --JJ _p_r_i_v_a_t_e
- This option should _n_o_t be specified by the user.
+ -J private
+ This option should not be specified by the user.
- When the _j option is in use in a recursive build, this option is
+ When the j 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.
- --jj _m_a_x___j_o_b_s
- Specify the maximum number of jobs that bbmmaakkee may have running at
- any one time. The value is saved in _._M_A_K_E_._J_O_B_S. Turns compati-
- bility mode off, unless the _B flag is also specified. When com-
+ -j max_jobs
+ Specify the maximum number of jobs that bmake may have running at
+ any one time. The value is saved in .MAKE.JOBS. Turns compati-
+ bility mode off, unless the B flag is also specified. When com-
patibility mode is off, all commands associated with a target are
executed in a single shell invocation as opposed to the tradi-
tional one shell invocation per line. This can break traditional
@@ -160,77 +162,90 @@ DDEESSCCRRIIPPTTIIOONN
It is more efficient to correct the scripts rather than turn
backwards compatibility on.
- --kk Continue processing after errors are encountered, but only on
+ -k Continue processing after errors are encountered, but only on
those targets that do not depend on the target whose creation
caused the error.
- --mm _d_i_r_e_c_t_o_r_y
+ -m directory
Specify a directory in which to search for sys.mk and makefiles
- included via the <_f_i_l_e>-style include statement. The --mm option
+ included via the <file>-style include statement. The -m option
can be used multiple times to form a search path. This path will
override the default system include path: /usr/share/mk. Fur-
thermore the system include path will be appended to the search
- path used for "_f_i_l_e"-style include statements (see the --II
+ path used for "file"-style include statements (see the -I
option).
- If a file or directory name in the --mm argument (or the
+ If a file or directory name in the -m argument (or the
MAKESYSPATH environment variable) starts with the string ".../"
- then bbmmaakkee will search for the specified file or directory named
+ then bmake 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 --mm argument. If used, this feature allows bbmmaakkee to easily
- search in the current source tree for customized sys.mk files
- (e.g., by using ".../mk/sys.mk" as an argument).
+ towards the root of the file system. If the search is success-
+ ful, then the resulting directory replaces the ".../" specifica-
+ tion in the -m argument. If used, this feature allows bmake to
+ easily search in the current source tree for customized sys.mk
+ files (e.g., by using ".../mk/sys.mk" as an argument).
- --nn Display the commands that would have been executed, but do not
+ -n Display the commands that would have been executed, but do not
actually execute them unless the target depends on the .MAKE spe-
cial source (see below).
- --NN Display the commands which would have been executed, but do not
+ -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.
- --qq Do not execute any commands, but exit 0 if the specified targets
+ -q Do not execute any commands, but exit 0 if the specified targets
are up-to-date and 1, otherwise.
- --rr Do not use the built-in rules specified in the system makefile.
+ -r Do not use the built-in rules specified in the system makefile.
- --ss Do not echo any commands as they are executed. Equivalent to
- specifying `@@' before each command line in the makefile.
+ -s Do not echo any commands as they are executed. Equivalent to
+ specifying `@' before each command line in the makefile.
- --TT _t_r_a_c_e_f_i_l_e
- When used with the --jj flag, append a trace record to _t_r_a_c_e_f_i_l_e
+ -T tracefile
+ When used with the -j flag, append a trace record to tracefile
for each job started and completed.
- --tt Rather than re-building a target as specified in the makefile,
+ -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.
- --VV _v_a_r_i_a_b_l_e
- Print bbmmaakkee's idea of the value of _v_a_r_i_a_b_l_e, in the global con-
- text. 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
- _v_a_r_i_a_b_l_e contains a `$' then the value will be expanded before
- printing.
-
- --WW Treat any warnings during makefile parsing as errors.
-
- --ww Print entering and leaving directory messages, pre and post pro-
+ -V variable
+ Print the value of variable. 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 unde-
+ fined variable. The value printed is extracted from the global
+ context after all makefiles have been read. By default, the raw
+ variable contents (which may include additional unexpanded vari-
+ able references) are shown. If variable contains a `$' then the
+ value will be recursively expanded to its complete resultant text
+ before printing. The expanded value will also be printed if
+ .MAKE.EXPAND_VARIABLES is set to true and the -dV option has not
+ been used to override it. Note that loop-local and target-local
+ variables, as well as values taken temporarily by global vari-
+ ables during makefile processing, are not accessible via this
+ option. The -dv debug mode can be used to see these at the cost
+ of generating substantial extraneous output.
+
+ -v variable
+ Like -V but the variable is always expanded to its complete
+ value.
+
+ -W Treat any warnings during makefile parsing as errors.
+
+ -w Print entering and leaving directory messages, pre and post pro-
cessing.
- --XX Don't export variables passed on the command line to the environ-
+ -X Don't export variables passed on the command line to the environ-
ment individually. Variables passed on the command line are
- still exported via the _M_A_K_E_F_L_A_G_S environment variable. This
+ still exported via the MAKEFLAGS environment variable. This
option may be useful on systems which have a small limit on the
size of command arguments.
- _v_a_r_i_a_b_l_e_=_v_a_l_u_e
- Set the value of the variable _v_a_r_i_a_b_l_e to _v_a_l_u_e. Normally, all
+ variable=value
+ Set the value of the variable variable to value. Normally, all
values passed on the command line are also exported to sub-makes
- in the environment. The --XX flag disables this behavior. Vari-
+ in the environment. The -X flag disables this behavior. Vari-
able assignments should follow options for POSIX compatibility
but no ordering is enforced.
@@ -242,28 +257,28 @@ DDEESSCCRRIIPPTTIIOONN
them with a backslash (`\'). The trailing newline character and initial
whitespace on the following line are compressed into a single space.
-FFIILLEE DDEEPPEENNDDEENNCCYY SSPPEECCIIFFIICCAATTIIOONNSS
+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 sep-
arates them. The three operators are as follows:
- :: A target is considered out-of-date if its modification time is less
+ : 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 bbmmaakkee is interrupted.
+ removed if bmake is interrupted.
- !! Targets are always re-created, but not until all sources have been
+ ! Targets are always re-created, but not until all sources have been
examined and re-created as necessary. Sources for a target accumu-
late over dependency lines when this operator is used. The target
- is removed if bbmmaakkee is interrupted.
+ is removed if bmake is interrupted.
- :::: If no sources are specified, the target is always re-created. Oth-
+ :: If no sources are specified, the target is always re-created. Oth-
erwise, 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 bbmmaakkee is interrupted.
+ is used. The target will not be removed if bmake is interrupted.
Targets and sources may contain the shell wildcard values `?', `*', `[]',
and `{}'. The values `?', `*', and `[]' may only be used as part of the
@@ -272,37 +287,37 @@ FFIILLEE DDEEPPEENNDDEENNCCYY SSPPEECCIIFFIICCAATTIIOO
existing files. Expansion is in directory order, not alphabetically as
done in the shell.
-SSHHEELLLL CCOOMMMMAANNDDSS
+SHELL COMMANDS
Each target may have associated with it one or more lines of shell com-
mands, normally used to create the target. Each of the lines in this
- script _m_u_s_t be preceded by a tab. (For historical reasons, spaces are
+ script must be preceded by a tab. (For historical reasons, spaces are
not accepted.) While targets can appear in many dependency lines if
desired, by default only one of these rules may be followed by a creation
- script. If the `::::' operator is used, however, all rules may include
+ script. If the `::' operator is used, however, all rules may include
scripts and the scripts are executed in the order found.
Each line is treated as a separate shell command, unless the end of line
is escaped with a backslash (`\') in which case that line and the next
are combined. If the first characters of the command 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 --nn is given. This is similar to the effect of
+ 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 -n is given. This is similar to the effect of
the .MAKE special source, except that the effect can be limited to a sin-
- gle line of a script. A `--' in compatibility mode causes any non-zero
+ gle line of a script. A `-' in compatibility mode causes any non-zero
exit status of the command line to be ignored.
- When bbmmaakkee is run in jobs mode with --jj _m_a_x___j_o_b_s, the entire script for
+ When bmake is run in jobs mode with -j max_jobs, the entire script for
the target is fed to a single instance of the shell. In compatibility
(non-jobs) mode, each command is run in a separate process. If the com-
mand contains any shell meta characters (`#=|^(){};&<>*?[]:$`\\n') it
- will be passed to the shell; otherwise bbmmaakkee will attempt direct execu-
- tion. If a line starts with `--' and the shell has ErrCtl enabled then
+ will be passed to the shell; otherwise bmake will attempt direct execu-
+ tion. If a line starts with `-' and the shell has ErrCtl enabled then
failure of the command line will be ignored as in compatibility mode.
- Otherwise `--' affects the entire job; the script will stop at the first
+ Otherwise `-' affects the entire job; the script will stop at the first
command line that fails, but the target will not be deemed to have
failed.
- Makefiles should be written so that the mode of bbmmaakkee operation does not
+ Makefiles should be written so that the mode of bmake operation does not
change their behavior. For example, any command which needs to use
``cd'' or ``chdir'' without potentially changing the directory for subse-
quent commands should be put in parentheses so it executes in a subshell.
@@ -319,35 +334,35 @@ SSHHEELLLL CCOOMMMMAANNDDSS
(cd ${.CURDIR} && ${MAKE} $@); \
echo Back in `pwd`
- Since bbmmaakkee will chdir(2) to `_._O_B_J_D_I_R' before executing any targets, each
+ Since bmake will chdir(2) to `.OBJDIR' before executing any targets, each
child process starts with that as its current working directory.
-VVAARRIIAABBLLEE AASSSSIIGGNNMMEENNTTSS
+VARIABLE ASSIGNMENTS
Variables in make are much like variables in the shell, and, by tradi-
tion, consist of all upper-case letters.
- VVaarriiaabbllee aassssiiggnnmmeenntt mmooddiiffiieerrss
+ Variable assignment modifiers
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 overrid-
+ = Assign the value to the variable. Any previous value is overrid-
den.
- ++== Append the value to the current value of the variable.
+ += Append the value to the current value of the variable.
- ??== Assign the value to the variable if it is not already defined.
+ ?= Assign the value to the variable if it is not already defined.
- ::== Assign with expansion, i.e. expand the value before assigning it
+ := Assign with expansion, i.e. expand the value before assigning it
to the variable. Normally, expansion is not done until the vari-
- able is referenced. _N_O_T_E: References to undefined variables are
- _n_o_t expanded. This can cause problems when variable modifiers
+ able is referenced. NOTE: References to undefined variables are
+ not expanded. This can cause problems when variable modifiers
are used.
- !!== Expand the value and pass it to the shell for execution and
+ != 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 _v_a_l_u_e is removed; if the value is
+ Any white-space before the assigned 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.
@@ -397,12 +412,12 @@ VVAARRIIAABBLLEE AASSSSIIGGNNMMEENNTTSS
${b} contains ``${j} ${j} ${j}'' which expands to ``3 3 3'' since
after the loop completes ${j} contains ``3''.
- VVaarriiaabbllee ccllaasssseess
+ Variable classes
The four different classes of variables (in order of increasing prece-
dence) are:
Environment variables
- Variables defined as part of bbmmaakkee's environment.
+ Variables defined as part of bmake's environment.
Global variables
Variables defined in the makefile or in included makefiles.
@@ -417,86 +432,91 @@ VVAARRIIAABBLLEE AASSSSIIGGNNMMEENNTTSS
target to target. It is not currently possible to define new local vari-
ables. The seven local variables are as follows:
- _._A_L_L_S_R_C The list of all sources for this target; also known as
- `_>'.
+ .ALLSRC The list of all sources for this target; also known as
+ `>'.
- _._A_R_C_H_I_V_E The name of the archive file; also known as `_!'.
+ .ARCHIVE The name of the archive file; also known as `!'.
- _._I_M_P_S_R_C In suffix-transformation rules, the name/path of the
+ .IMPSRC In suffix-transformation rules, the name/path of the
source from which the target is to be transformed (the
- ``implied'' source); also known as `_<'. It is not
+ ``implied'' source); also known as `<'. It is not
defined in explicit rules.
- _._M_E_M_B_E_R The name of the archive member; also known as `_%'.
+ .MEMBER The name of the archive member; also known as `%'.
- _._O_O_D_A_T_E The list of sources for this target that were deemed out-
- of-date; also known as `_?'.
+ .OODATE The list of sources for this target that were deemed out-
+ of-date; also known as `?'.
- _._P_R_E_F_I_X The file prefix of the target, containing only the file
+ .PREFIX The file prefix of the target, containing only the file
portion, no suffix or preceding directory components;
- also known as `_*'. The suffix must be one of the known
- suffixes declared with ..SSUUFFFFIIXXEESS or it will not be recog-
+ also known as `*'. The suffix must be one of the known
+ suffixes declared with .SUFFIXES or it will not be recog-
nized.
- _._T_A_R_G_E_T The name of the target; also known as `_@'.
+ .TARGET The name of the target; also known as `@'. For compati-
+ bility with other makes this is an alias for .ARCHIVE in
+ archive member rules.
- The shorter forms (`_>', `_!', `_<', `_%', `_?', `_*', and `_@') are permitted
+ The shorter forms (`>', `!', `<', `%', `?', `*', and `@') are permitted
for backward compatibility with historical makefiles and legacy POSIX
make and are not recommended.
Variants of these variables with the punctuation followed immediately by
- `D' or `F', e.g. `_$_(_@_D_)', are legacy forms equivalent to using the `:H'
+ `D' or `F', e.g. `$(@D)', are legacy forms equivalent to using the `:H'
and `:T' modifiers. These forms are accepted for compatibility with AT&T
System V UNIX makefiles and POSIX but 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 `_._T_A_R_G_E_T', `_._P_R_E_F_I_X', `_._A_R_C_H_I_V_E', and `_._M_E_M_B_E_R'.
+ These variables are `.TARGET', `.PREFIX', `.ARCHIVE', and `.MEMBER'.
- AAddddiittiioonnaall bbuuiilltt--iinn vvaarriiaabblleess
- In addition, bbmmaakkee sets or knows about the following variables:
+ Additional built-in variables
+ In addition, bmake sets or knows about the following variables:
- _$ A single dollar sign `$', i.e. `$$' expands to a single
+ $ A single dollar sign `$', i.e. `$$' expands to a single
dollar sign.
- _._A_L_L_T_A_R_G_E_T_S The list of all targets encountered in the Makefile. If
+ .ALLTARGETS The list of all targets encountered in the Makefile. If
evaluated during Makefile parsing, lists only those tar-
gets encountered thus far.
- _._C_U_R_D_I_R A path to the directory where bbmmaakkee was executed. Refer
+ .CURDIR A path to the directory where bmake was executed. Refer
to the description of `PWD' for more details.
- _._I_N_C_L_U_D_E_D_F_R_O_M_D_I_R
+ .INCLUDEDFROMDIR
The directory of the file this Makefile was included
from.
- _._I_N_C_L_U_D_E_D_F_R_O_M_F_I_L_E
+ .INCLUDEDFROMFILE
The filename of the file this Makefile was included from.
- MAKE The name that bbmmaakkee was executed with (_a_r_g_v_[_0_]). For
- compatibility bbmmaakkee also sets _._M_A_K_E with the same value.
+ MAKE The name that bmake was executed with (argv[0]). For
+ compatibility bmake also sets .MAKE with the same value.
The preferred variable to use is the environment variable
MAKE because it is more compatible with other versions of
- bbmmaakkee and cannot be confused with the special target with
+ bmake and cannot be confused with the special target with
the same name.
- _._M_A_K_E_._D_E_P_E_N_D_F_I_L_E
- Names the makefile (default `_._d_e_p_e_n_d') from which gener-
+ .MAKE.DEPENDFILE
+ Names the makefile (default `.depend') from which gener-
ated dependencies are read.
- _._M_A_K_E_._E_X_P_A_N_D___V_A_R_I_A_B_L_E_S
- A boolean that controls the default behavior of the --VV
- option.
+ .MAKE.EXPAND_VARIABLES
+ A boolean that controls the default behavior of the -V
+ option. If true, variable values printed with -V are
+ fully expanded; if false, the raw variable contents
+ (which may include additional unexpanded variable refer-
+ ences) are shown.
- _._M_A_K_E_._E_X_P_O_R_T_E_D The list of variables exported by bbmmaakkee.
+ .MAKE.EXPORTED The list of variables exported by bmake.
- _._M_A_K_E_._J_O_B_S The argument to the --jj option.
+ .MAKE.JOBS The argument to the -j option.
- _._M_A_K_E_._J_O_B_._P_R_E_F_I_X
- If bbmmaakkee is run with _j then output for each target is
+ .MAKE.JOB.PREFIX
+ If bmake is run with j then output for each target is
prefixed with a token `--- target ---' the first part of
- which can be controlled via _._M_A_K_E_._J_O_B_._P_R_E_F_I_X. If
- _._M_A_K_E_._J_O_B_._P_R_E_F_I_X is empty, no token is printed.
+ which can be controlled via .MAKE.JOB.PREFIX. If
+ .MAKE.JOB.PREFIX is empty, no token is printed.
For example:
.MAKE.JOB.PREFIX=${.newline}---${.MAKE:T}[${.MAKE.PID}]
would produce tokens like `---make[1234] target ---' mak-
@@ -504,122 +524,156 @@ VVAARRIIAABBLLEE AASSSSIIGGNNMMEENNTTSS
achieved.
MAKEFLAGS The environment variable `MAKEFLAGS' may contain anything
- that may be specified on bbmmaakkee's command line. Anything
- specified on bbmmaakkee's command line is appended to the
+ that may be specified on bmake's command line. Anything
+ specified on bmake's command line is appended to the
`MAKEFLAGS' variable which is then entered into the envi-
- ronment for all programs which bbmmaakkee executes.
+ ronment for all programs which bmake executes.
- _._M_A_K_E_._L_E_V_E_L The recursion depth of bbmmaakkee. The initial instance of
- bbmmaakkee will be 0, and an incremented value is put into the
+ .MAKE.LEVEL The recursion depth of bmake. The initial instance of
+ bmake will be 0, and an incremented value is put into the
environment to be seen by the next generation. This
allows tests like: .if ${.MAKE.LEVEL} == 0 to protect
things which should only be evaluated in the initial
- instance of bbmmaakkee.
+ instance of bmake.
- _._M_A_K_E_._M_A_K_E_F_I_L_E___P_R_E_F_E_R_E_N_C_E
- The ordered list of makefile names (default `_m_a_k_e_f_i_l_e',
- `_M_a_k_e_f_i_l_e') that bbmmaakkee will look for.
+ .MAKE.MAKEFILE_PREFERENCE
+ The ordered list of makefile names (default `makefile',
+ `Makefile') that bmake will look for.
- _._M_A_K_E_._M_A_K_E_F_I_L_E_S
- The list of makefiles read by bbmmaakkee, which is useful for
+ .MAKE.MAKEFILES
+ The list of makefiles read by bmake, which is useful for
tracking dependencies. Each makefile is recorded only
once, regardless of the number of times read.
- _._M_A_K_E_._M_O_D_E Processed after reading all makefiles. Can affect the
- mode that bbmmaakkee runs in. It can contain a number of key-
+ .MAKE.MODE Processed after reading all makefiles. Can affect the
+ mode that bmake runs in. It can contain a number of key-
words:
- _c_o_m_p_a_t Like --BB, puts bbmmaakkee into "compat" mode.
-
- _m_e_t_a Puts bbmmaakkee into "meta" mode, where meta files
- are created for each target to capture the
- command run, the output generated and if
- filemon(4) is available, the system calls
- which are of interest to bbmmaakkee. The captured
- output can be very useful when diagnosing
- errors.
-
- _c_u_r_d_i_r_O_k_= _b_f Normally bbmmaakkee will not create .meta files
- in `_._C_U_R_D_I_R'. This can be overridden by set-
- ting _b_f to a value which represents True.
-
- _e_n_v For debugging, it can be useful to inlcude
- the environment in the .meta file.
-
- _v_e_r_b_o_s_e If in "meta" mode, print a clue about the
- target being built. This is useful if the
- build is otherwise running silently. The
- message printed the value of:
- _._M_A_K_E_._M_E_T_A_._P_R_E_F_I_X.
-
- _i_g_n_o_r_e_-_c_m_d Some makefiles have commands which are simply
- not stable. This keyword causes them to be
- ignored for determining whether a target is
- out of date in "meta" mode. See also
- ..NNOOMMEETTAA__CCMMPP.
-
- _s_i_l_e_n_t_= _b_f If _b_f is True, when a .meta file is created,
- mark the target ..SSIILLEENNTT.
-
- _._M_A_K_E_._M_E_T_A_._B_A_I_L_I_W_I_C_K
+ compat Like -B, puts bmake into "compat"
+ mode.
+
+ meta Puts bmake into "meta" mode, where
+ meta files are created for each tar-
+ get to capture the command run, the
+ output generated and if filemon(4)
+ is available, the system calls which
+ are of interest to bmake. The cap-
+ tured output can be very useful when
+ diagnosing errors.
+
+ curdirOk= bf Normally bmake will not create .meta
+ files in `.CURDIR'. This can be
+ overridden by setting bf to a value
+ which represents True.
+
+ missing-meta= bf If bf is True, then a missing .meta
+ file makes the target out-of-date.
+
+ missing-filemon= bf If bf is True, then missing filemon
+ data makes the target out-of-date.
+
+ nofilemon Do not use filemon(4).
+
+ env For debugging, it can be useful to
+ include the environment in the .meta
+ file.
+
+ verbose If in "meta" mode, print a clue
+ about the target being built. This
+ is useful if the build is otherwise
+ running silently. The message
+ printed the value of:
+ .MAKE.META.PREFIX.
+
+ ignore-cmd Some makefiles have commands which
+ are simply not stable. This keyword
+ causes them to be ignored for deter-
+ mining whether a target is out of
+ date in "meta" mode. See also
+ .NOMETA_CMP.
+
+ silent= bf If bf is True, when a .meta file is
+ created, mark the target .SILENT.
+
+ .MAKE.META.BAILIWICK
In "meta" mode, provides a list of prefixes which match
- the directories controlled by bbmmaakkee. If a file that was
- generated outside of _._O_B_J_D_I_R but within said bailiwick is
+ the directories controlled by bmake. If a file that was
+ generated outside of .OBJDIR but within said bailiwick is
missing, the current target is considered out-of-date.
- _._M_A_K_E_._M_E_T_A_._C_R_E_A_T_E_D
+ .MAKE.META.CREATED
In "meta" mode, this variable contains a list of all the
meta files updated. If not empty, it can be used to
- trigger processing of _._M_A_K_E_._M_E_T_A_._F_I_L_E_S.
+ trigger processing of .MAKE.META.FILES.
- _._M_A_K_E_._M_E_T_A_._F_I_L_E_S
+ .MAKE.META.FILES
In "meta" mode, this variable contains a list of all the
meta files used (updated or not). This list can be used
to process the meta files to extract dependency informa-
tion.
- _._M_A_K_E_._M_E_T_A_._I_G_N_O_R_E___P_A_T_H_S
+ .MAKE.META.IGNORE_PATHS
Provides a list of path prefixes that should be ignored;
because the contents are expected to change over time.
- The default list includes: `_/_d_e_v _/_e_t_c _/_p_r_o_c _/_t_m_p _/_v_a_r_/_r_u_n
- _/_v_a_r_/_t_m_p'
+ The default list includes: `/dev /etc /proc /tmp /var/run
+ /var/tmp'
- _._M_A_K_E_._M_E_T_A_._P_R_E_F_I_X
+ .MAKE.META.IGNORE_PATTERNS
+ Provides a list of patterns to match against pathnames.
+ Ignore any that match.
+
+ .MAKE.META.IGNORE_FILTER
+ Provides a list of variable modifiers to apply to each
+ pathname. Ignore if the expansion is an empty string.
+
+ .MAKE.META.PREFIX
Defines the message printed for each meta file updated in
"meta verbose" mode. The default value is:
Building ${.TARGET:H:tA}/${.TARGET:T}
- _._M_A_K_E_O_V_E_R_R_I_D_E_S This variable is used to record the names of variables
+ .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 `MAKEFLAGS'. This behaviour can be
- disabled by assigning an empty value to `_._M_A_K_E_O_V_E_R_R_I_D_E_S'
+ exported as part of `MAKEFLAGS'. This behavior can be
+ disabled by assigning an empty value to `.MAKEOVERRIDES'
within a makefile. Extra variables can be exported from
- a makefile by appending their names to `_._M_A_K_E_O_V_E_R_R_I_D_E_S'.
- `MAKEFLAGS' is re-exported whenever `_._M_A_K_E_O_V_E_R_R_I_D_E_S' is
+ a makefile by appending their names to `.MAKEOVERRIDES'.
+ `MAKEFLAGS' is re-exported whenever `.MAKEOVERRIDES' is
modified.
- _._M_A_K_E_._P_A_T_H___F_I_L_E_M_O_N
- If bbmmaakkee was built with filemon(4) support, this is set
+ .MAKE.PATH_FILEMON
+ If bmake was built with filemon(4) support, this is set
to the path of the device node. This allows makefiles to
test for this support.
- _._M_A_K_E_._P_I_D The process-id of bbmmaakkee.
-
- _._M_A_K_E_._P_P_I_D The parent process-id of bbmmaakkee.
-
- _M_A_K_E___P_R_I_N_T___V_A_R___O_N___E_R_R_O_R
- When bbmmaakkee stops due to an error, it prints its name and
- the value of `_._C_U_R_D_I_R' as well as the value of any vari-
- ables named in `_M_A_K_E___P_R_I_N_T___V_A_R___O_N___E_R_R_O_R'.
-
- _._n_e_w_l_i_n_e This variable is simply assigned a newline character as
- its value. This allows expansions using the ::@@ modifier
+ .MAKE.PID The process-id of bmake.
+
+ .MAKE.PPID The parent process-id of bmake.
+
+ .MAKE.SAVE_DOLLARS
+ value should be a boolean that controls whether `$$' are
+ preserved when doing `:=' assignments. The default is
+ false, for backwards compatibility. Set to true for com-
+ patability with other makes. If set to false, `$$'
+ becomes `$' per normal evaluation rules.
+
+ MAKE_PRINT_VAR_ON_ERROR
+ When bmake stops due to an error, it sets `.ERROR_TARGET'
+ to the name of the target that failed, `.ERROR_CMD' to
+ the commands of the failed target, and in "meta" mode, it
+ also sets `.ERROR_CWD' to the getcwd(3), and
+ `.ERROR_META_FILE' to the path of the meta file (if any)
+ describing the failed target. It then prints its name
+ and the value of `.CURDIR' as well as the value of any
+ variables named in `MAKE_PRINT_VAR_ON_ERROR'.
+
+ .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
- `_M_A_K_E___P_R_I_N_T___V_A_R___O_N___E_R_R_O_R' could be done as
+ `MAKE_PRINT_VAR_ON_ERROR' could be done as
${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}.
- _._O_B_J_D_I_R A path to the directory where the targets are built. Its
+ .OBJDIR A path to the directory where the targets are built. Its
value is determined by trying to chdir(2) to the follow-
ing directories in order and using the first match:
@@ -633,11 +687,11 @@ VVAARRIIAABBLLEE AASSSSIIGGNNMMEENNTTSS
(Only if `MAKEOBJDIR' is set in the environment or
on the command line.)
- 3. ${.CURDIR}_/_o_b_j_.${MACHINE}
+ 3. ${.CURDIR}/obj.${MACHINE}
- 4. ${.CURDIR}_/_o_b_j
+ 4. ${.CURDIR}/obj
- 5. _/_u_s_r_/_o_b_j_/${.CURDIR}
+ 5. /usr/obj/${.CURDIR}
6. ${.CURDIR}
@@ -647,43 +701,43 @@ VVAARRIIAABBLLEE AASSSSIIGGNNMMEENNTTSS
may be used. This is especially useful with
`MAKEOBJDIR'.
- `_._O_B_J_D_I_R' may be modified in the makefile as a global
- variable. In all cases, bbmmaakkee will chdir(2) to `_._O_B_J_D_I_R'
- and set `PWD' to that directory before executing any tar-
- gets.
+ `.OBJDIR' may be modified in the makefile via the special
+ target `.OBJDIR'. In all cases, bmake will chdir(2) to
+ the specified directory if it exists, and set `.OBJDIR'
+ and `PWD' to that directory before executing any targets.
- _._P_A_R_S_E_D_I_R A path to the directory of the current `_M_a_k_e_f_i_l_e' being
+ .PARSEDIR A path to the directory of the current `Makefile' being
parsed.
- _._P_A_R_S_E_F_I_L_E The basename of the current `_M_a_k_e_f_i_l_e' being parsed.
- This variable and `_._P_A_R_S_E_D_I_R' are both set only while the
- `_M_a_k_e_f_i_l_e_s' are being parsed. If you want to retain
+ .PARSEFILE The basename of the current `Makefile' being parsed.
+ This variable and `.PARSEDIR' are both set only while the
+ `Makefiles' are being parsed. If you want to retain
their current values, assign them to a variable using
- assignment with expansion: (`::==').
+ assignment with expansion: (`:=').
- _._P_A_T_H A variable that represents the list of directories that
- bbmmaakkee will search for files. The search list should be
- updated using the target `_._P_A_T_H' rather than the vari-
+ .PATH A variable that represents the list of directories that
+ bmake will search for files. The search list should be
+ updated using the target `.PATH' rather than the vari-
able.
- PWD Alternate path to the current directory. bbmmaakkee normally
- sets `_._C_U_R_D_I_R' to the canonical path given by getcwd(3).
+ PWD Alternate path to the current directory. bmake normally
+ sets `.CURDIR' to the canonical path given by getcwd(3).
However, if the environment variable `PWD' is set and
- gives a path to the current directory, then bbmmaakkee sets
- `_._C_U_R_D_I_R' to the value of `PWD' instead. This behaviour
+ gives a path to the current directory, then bmake sets
+ `.CURDIR' to the value of `PWD' instead. This behavior
is disabled if `MAKEOBJDIRPREFIX' is set or `MAKEOBJDIR'
contains a variable transform. `PWD' is set to the value
- of `_._O_B_J_D_I_R' for all programs which bbmmaakkee executes.
+ of `.OBJDIR' for all programs which bmake executes.
.TARGETS The list of targets explicitly specified on the command
line, if any.
- VPATH Colon-separated (``:'') lists of directories that bbmmaakkee
+ VPATH Colon-separated (``:'') lists of directories that bmake
will search for files. The variable is supported for
- compatibility with old make programs only, use `_._P_A_T_H'
+ compatibility with old make programs only, use `.PATH'
instead.
- VVaarriiaabbllee mmooddiiffiieerrss
+ Variable modifiers
Variable expansion may be modified to select or modify each word of the
variable (where a ``word'' is white-space delimited sequence of charac-
ters). The general format of a variable expansion is as follows:
@@ -705,32 +759,32 @@ VVAARRIIAABBLLEE AASSSSIIGGNNMMEENNTTSS
The supported modifiers are:
- ::EE Replaces each word in the variable with its suffix.
+ :E Replaces each word in the variable with its suffix.
- ::HH Replaces each word in the variable with everything but the last com-
+ :H Replaces each word in the variable with everything but the last com-
ponent.
- ::MM_p_a_t_t_e_r_n
- Select only those words that match _p_a_t_t_e_r_n. The standard shell
+ :Mpattern
+ Select only those words that match pattern. The standard shell
wildcard characters (`*', `?', and `[]') may be used. The wildcard
characters may be escaped with a backslash (`\'). As a consequence
of the way values are split into words, matched, and then joined, a
construct like
${VAR:M*}
- will normalise the inter-word spacing, removing all leading and
+ will normalize the inter-word spacing, removing all leading and
trailing space, and converting multiple consecutive spaces to single
spaces.
- ::NN_p_a_t_t_e_r_n
- This is identical to `::MM', but selects all words which do not match
- _p_a_t_t_e_r_n.
+ :Npattern
+ This is identical to `:M', but selects all words which do not match
+ pattern.
- ::OO Order every word in variable alphabetically. To sort words in
- reverse order use the `::OO::[[--11....11]]' combination of modifiers.
+ :O Order every word in variable alphabetically. To sort words in
+ reverse order use the `:O:[-1..1]' combination of modifiers.
- ::OOxx Randomize words in variable. The results will be different each
+ :Ox Randomize words in variable. The results will be different each
time you are referring to the modified variable; use the assignment
- with expansion (`::==') to prevent such behaviour. For example,
+ with expansion (`:=') to prevent such behavior. For example,
LIST= uno due tre quattro
RANDOM_LIST= ${LIST:Ox}
@@ -748,88 +802,92 @@ VVAARRIIAABBLLEE AASSSSIIGGNNMMEENNTTSS
due uno quattro tre
due uno quattro tre
- ::QQ Quotes every shell meta-character in the variable, so that it can be
- passed safely through recursive invocations of bbmmaakkee.
+ :Q Quotes every shell meta-character in the variable, so that it can be
+ passed safely through recursive invocations of bmake.
+
+ :R Replaces each word in the variable with everything but its suffix.
- ::RR Replaces each word in the variable with everything but its suffix.
+ :range[=count]
+ The value is an integer sequence representing the words of the orig-
+ inal value, or the supplied count.
- ::ggmmttiimmee
- The value is a format string for strftime(3), using the current
- gmtime(3).
+ :gmtime[=utc]
+ The value is a format string for strftime(3), using gmtime(3). If a
+ utc value is not provided or is 0, the current time is used.
- ::hhaasshh
- Compute a 32bit hash of the value and encode it as hex digits.
+ :hash
+ Compute a 32-bit hash of the value and encode it as hex digits.
- ::llooccaallttiimmee
- The value is a format string for strftime(3), using the current
- localtime(3).
+ :localtime[=utc]
+ The value is a format string for strftime(3), using localtime(3).
+ If a utc value is not provided or is 0, the current time is used.
- ::ttAA Attempt to convert variable to an absolute path using realpath(3),
+ :tA Attempt to convert variable to an absolute path using realpath(3),
if that fails, the value is unchanged.
- ::ttll Converts variable to lower-case letters.
+ :tl Converts variable to lower-case letters.
- ::ttss_c
+ :tsc
Words in the variable are normally separated by a space on expan-
- sion. This modifier sets the separator to the character _c. If _c is
+ sion. This modifier sets the separator to the character c. If c is
omitted, then no separator is used. The common escapes (including
octal numeric codes), work as expected.
- ::ttuu Converts variable to upper-case letters.
+ :tu Converts variable to upper-case letters.
- ::ttWW Causes the value to be treated as a single word (possibly containing
- embedded white space). See also `::[[**]]'.
+ :tW Causes the value to be treated as a single word (possibly containing
+ embedded white space). See also `:[*]'.
- ::ttww Causes the value to be treated as a sequence of words delimited by
- white space. See also `::[[@@]]'.
+ :tw Causes the value to be treated as a sequence of words delimited by
+ white space. See also `:[@]'.
- ::SS/_o_l_d___s_t_r_i_n_g/_n_e_w___s_t_r_i_n_g/[11ggWW]
- Modify the first occurrence of _o_l_d___s_t_r_i_n_g in the variable's value,
- replacing it with _n_e_w___s_t_r_i_n_g. If a `g' is appended to the last
+ :S/old_string/new_string/[1gW]
+ Modify the first occurrence of old_string in the variable's value,
+ replacing it with new_string. If a `g' is appended to the last
slash of the pattern, all occurrences in each word are replaced. If
a `1' is appended to the last slash of the pattern, only the first
word is affected. If a `W' is appended to the last slash of the
pattern, then the value is treated as a single word (possibly con-
- taining embedded white space). If _o_l_d___s_t_r_i_n_g begins with a caret
- (`^'), _o_l_d___s_t_r_i_n_g is anchored at the beginning of each word. If
- _o_l_d___s_t_r_i_n_g ends with a dollar sign (`$'), it is anchored at the end
- of each word. Inside _n_e_w___s_t_r_i_n_g, an ampersand (`&') is replaced by
- _o_l_d___s_t_r_i_n_g (without any `^' or `$'). Any character may be used as a
+ taining embedded white space). If old_string begins with a caret
+ (`^'), old_string is anchored at the beginning of each word. If
+ old_string ends with a dollar sign (`$'), it is anchored at the end
+ of each word. Inside new_string, an ampersand (`&') is replaced by
+ old_string (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
- _o_l_d___s_t_r_i_n_g and _n_e_w___s_t_r_i_n_g with the single exception that a backslash
+ old_string and new_string with the single exception that a backslash
is used to prevent the expansion of a dollar sign (`$'), not a pre-
ceding dollar sign as is usual.
- ::CC/_p_a_t_t_e_r_n/_r_e_p_l_a_c_e_m_e_n_t/[11ggWW]
- The ::CC modifier is just like the ::SS modifier except that the old and
+ :C/pattern/replacement/[1gW]
+ The :C modifier is just like the :S modifier except that the old and
new strings, instead of being simple strings, are an extended regu-
- lar expression (see regex(3)) string _p_a_t_t_e_r_n and an ed(1)-style
- string _r_e_p_l_a_c_e_m_e_n_t. Normally, the first occurrence of the pattern
- _p_a_t_t_e_r_n in each word of the value is substituted with _r_e_p_l_a_c_e_m_e_n_t.
+ lar expression (see regex(3)) string pattern and an ed(1)-style
+ string replacement. Normally, the first occurrence of the pattern
+ pattern in each word of the value is substituted with replacement.
The `1' modifier causes the substitution to apply to at most one
word; the `g' modifier causes the substitution to apply to as many
- instances of the search pattern _p_a_t_t_e_r_n as occur in the word or
+ instances of the search pattern pattern as occur in the word or
words it is found in; the `W' modifier causes the value to be
treated as a single word (possibly containing embedded white space).
Note that `1' and `g' are orthogonal; the former specifies whether
multiple words are potentially affected, the latter whether multiple
substitutions can potentially occur within each affected word.
- As for the ::SS modifier, the _p_a_t_t_e_r_n and _r_e_p_l_a_c_e_m_e_n_t are subjected to
+ As for the :S modifier, the pattern and replacement are subjected to
variable expansion before being parsed as regular expressions.
- ::TT Replaces each word in the variable with its last component.
+ :T Replaces each word in the variable with its last component.
- ::uu Remove adjacent duplicate words (like uniq(1)).
+ :u Remove adjacent duplicate words (like uniq(1)).
- ::??_t_r_u_e___s_t_r_i_n_g::_f_a_l_s_e___s_t_r_i_n_g
+ :?true_string:false_string
If the variable name (not its value), when parsed as a .if condi-
tional expression, evaluates to true, return as its value the
- _t_r_u_e___s_t_r_i_n_g, otherwise return the _f_a_l_s_e___s_t_r_i_n_g. Since the variable
+ true_string, otherwise return the false_string. Since the variable
name is used as the expression, :? must be the first modifier after
the variable name itself - which will, of course, usually contain
variable expansions. A common error is trying to use expressions
@@ -839,32 +897,45 @@ VVAARRIIAABBLLEE AASSSSIIGGNNMMEENNTTSS
match "42" you need to use something like:
${"${NUMBERS:M42}" != "":?match:no}.
- _:_o_l_d___s_t_r_i_n_g_=_n_e_w___s_t_r_i_n_g
+ :old_string=new_string
This is the AT&T System V UNIX style variable substitution. It must
- be the last modifier specified. If _o_l_d___s_t_r_i_n_g or _n_e_w___s_t_r_i_n_g do not
- contain the pattern matching character _% then it is assumed that
+ be the last modifier specified. If old_string or new_string 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
- _o_l_d___s_t_r_i_n_g to be replaced in _n_e_w___s_t_r_i_n_g.
+ entire words may be replaced. Otherwise % is the substring of
+ old_string to be replaced in new_string.
Variable expansion occurs in the normal fashion inside both
- _o_l_d___s_t_r_i_n_g and _n_e_w___s_t_r_i_n_g with the single exception that a backslash
+ old_string and new_string with the single exception that a backslash
is used to prevent the expansion of a dollar sign (`$'), not a pre-
ceding dollar sign as is usual.
- ::@@_t_e_m_p@@_s_t_r_i_n_g@@
+ :@temp@string@
This is the loop expansion mechanism from the OSF Development Envi-
- ronment (ODE) make. Unlike ..ffoorr loops expansion occurs at the time
- of reference. Assign _t_e_m_p to each word in the variable and evaluate
- _s_t_r_i_n_g. The ODE convention is that _t_e_m_p should start and end with a
+ ronment (ODE) make. Unlike .for loops expansion occurs at the time
+ of reference. Assign temp to each word in the variable and evaluate
+ string. The ODE convention is that temp should start and end with a
period. For example.
${LINKS:@.LINK.@${LN} ${TARGET} ${.LINK.}@}
However a single character variable is often more readable:
${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}
- ::UU_n_e_w_v_a_l
- If the variable is undefined _n_e_w_v_a_l is the value. If the variable
+ :_[=var]
+ Save the current variable value in `$_' or the named var for later
+ reference. Example usage:
+
+ M_cmpv.units = 1 1000 1000000
+ M_cmpv = S,., ,g:_:range:@i@+ $${_:[-$$i]} \
+ \* $${M_cmpv.units:[$$i]}@:S,^,expr 0 ,1:sh
+
+ .if ${VERSION:${M_cmpv}} < ${3.1.12:L:${M_cmpv}}
+
+ Here `$_' is used to save the result of the `:S' modifier which is
+ later referenced using the index values from `:range'.
+
+ :Unewval
+ If the variable is undefined newval 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:
@@ -872,134 +943,144 @@ VVAARRIIAABBLLEE AASSSSIIGGNNMMEENNTTSS
If a value is only required if the variable is undefined, use:
${VAR:D:Unewval}
- ::DD_n_e_w_v_a_l
- If the variable is defined _n_e_w_v_a_l is the value.
+ :Dnewval
+ If the variable is defined newval is the value.
- ::LL The name of the variable is the value.
+ :L The name of the variable is the value.
- ::PP The path of the node which has the same name as the variable is the
+ :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. In order for this modifier to work, the name
(node) must at least have appeared on the rhs of a dependency.
- ::!!_c_m_d!!
- The output of running _c_m_d is the value.
+ :!cmd!
+ The output of running cmd is the value.
- ::sshh If the variable is non-empty it is run as a command and the output
+ :sh If the variable is non-empty it is run as a command and the output
becomes the new value.
- ::::==_s_t_r
- The variable is assigned the value _s_t_r after substitution. This
+ ::=str
+ The variable is assigned the value str after substitution. This
modifier and its variations are useful in obscure situations such as
wanting to set a variable when shell commands are being parsed.
These assignment modifiers always expand to nothing, so if appearing
in a rule line by themselves should be preceded with something to
- keep bbmmaakkee happy.
+ keep bmake happy.
- The `::::' helps avoid false matches with the AT&T System V UNIX style
- ::== modifier and since substitution always occurs the ::::== form is
+ The `::' helps avoid false matches with the AT&T System V UNIX style
+ := modifier and since substitution always occurs the ::= form is
vaguely appropriate.
- ::::??==_s_t_r
- As for ::::== but only if the variable does not already have a value.
+ ::?=str
+ As for ::= but only if the variable does not already have a value.
- ::::++==_s_t_r
- Append _s_t_r to the variable.
+ ::+=str
+ Append str to the variable.
- ::::!!==_c_m_d
- Assign the output of _c_m_d to the variable.
+ ::!=cmd
+ Assign the output of cmd to the variable.
- ::[[_r_a_n_g_e]]
+ :[range]
Selects one or more words from the value, or performs other opera-
tions related to the way in which the value is divided into words.
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 _r_a_n_g_e is subjected to variable expansion, and the expanded
+ white space. Some modifiers suppress this behavior, 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 inte-
+ gers (where index 1 represents the first word), and backwards using
+ negative integers (where index -1 represents the last word).
+
+ The range is subjected to variable expansion, and the expanded
result is then interpreted as follows:
- _i_n_d_e_x Selects a single word from the value.
+ index Selects a single word from the value.
- _s_t_a_r_t...._e_n_d
- Selects all words from _s_t_a_r_t to _e_n_d, inclusive. For example,
- `::[[22....--11]]' selects all words from the second word to the last
- word. If _s_t_a_r_t is greater than _e_n_d, then the words are out-
- put in reverse order. For example, `::[[--11....11]]' selects all
+ start..end
+ Selects all words from start to end, inclusive. For example,
+ `:[2..-1]' selects all words from the second word to the last
+ word. If start is greater than end, then the words are out-
+ put in reverse order. For example, `:[-1..1]' selects all
the words from last to first.
- ** Causes subsequent modifiers to treat the value as a single
+ * 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 `::[[**]]'.
+ 0 Means the same as `:[*]'.
- @@ Causes subsequent modifiers to treat the value as a sequence
+ @ 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.
+ # Returns the number of words in the value.
-IINNCCLLUUDDEE SSTTAATTEEMMEENNTTSS,, CCOONNDDIITTIIOONNAALLSS AANNDD FFOORR LLOOOOPPSS
+INCLUDE STATEMENTS, CONDITIONALS AND FOR LOOPS
Makefile inclusion, conditional structures and for loops reminiscent of
- the C programming language are provided in bbmmaakkee. All such structures
+ the C programming language are provided in bmake. All such structures
are identified by a line beginning with a single dot (`.') character.
- Files are included with either ..iinncclluuddee <_f_i_l_e> or ..iinncclluuddee "_f_i_l_e". Vari-
+ Files are included with either .include <file> or .include "file". Vari-
ables 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 --II option are searched before the system makefile directory.
- For compatibility with other versions of bbmmaakkee `include file ...' is also
- accepted. If the include statement is written as ..--iinncclluuddee or as
- ..ssiinncclluuddee then errors locating and/or opening include files are ignored.
+ using the -I option are searched before the system makefile directory.
+ For compatibility with other versions of bmake `include file ...' is also
+ accepted.
+
+ If the include statement is written as .-include or as .sinclude then
+ errors locating and/or opening include files are ignored.
+
+ If the include statement is written as .dinclude not only are errors
+ locating and/or opening include files ignored, but stale dependencies
+ within the included file will be ignored just like .MAKE.DEPENDFILE.
Conditional expressions are also preceded by a single dot as the first
character of a line. The possible conditionals are as follows:
- ..eerrrroorr _m_e_s_s_a_g_e
+ .error message
The message is printed along with the name of the makefile and
- line number, then bbmmaakkee will exit.
+ line number, then bmake will exit.
- ..eexxppoorrtt _v_a_r_i_a_b_l_e _._._.
+ .export variable ...
Export the specified global variable. If no variable list is
provided, all globals are exported except for internal variables
- (those that start with `.'). This is not affected by the --XX
+ (those that start with `.'). This is not affected by the -X
flag, so should be used with caution. For compatibility with
- other bbmmaakkee programs `export variable=value' is also accepted.
+ other bmake programs `export variable=value' is also accepted.
- Appending a variable name to _._M_A_K_E_._E_X_P_O_R_T_E_D is equivalent to
+ Appending a variable name to .MAKE.EXPORTED is equivalent to
exporting a variable.
- ..eexxppoorrtt--eennvv _v_a_r_i_a_b_l_e _._._.
+ .export-env variable ...
The same as `.export', except that the variable is not appended
- to _._M_A_K_E_._E_X_P_O_R_T_E_D. This allows exporting a value to the environ-
- ment which is different from that used by bbmmaakkee internally.
+ to .MAKE.EXPORTED. This allows exporting a value to the environ-
+ ment which is different from that used by bmake internally.
- ..iinnffoo _m_e_s_s_a_g_e
+ .export-literal variable ...
+ The same as `.export-env', except that variables in the value are
+ not expanded.
+
+ .info message
The message is printed along with the name of the makefile and
line number.
- ..uunnddeeff _v_a_r_i_a_b_l_e
+ .undef variable
Un-define the specified global variable. Only global variables
may be un-defined.
- ..uunneexxppoorrtt _v_a_r_i_a_b_l_e _._._.
- The opposite of `.export'. The specified global _v_a_r_i_a_b_l_e will be
- removed from _._M_A_K_E_._E_X_P_O_R_T_E_D. If no variable list is provided,
- all globals are unexported, and _._M_A_K_E_._E_X_P_O_R_T_E_D deleted.
+ .unexport variable ...
+ The opposite of `.export'. The specified global variable will be
+ removed from .MAKE.EXPORTED. If no variable list is provided,
+ all globals are unexported, and .MAKE.EXPORTED deleted.
- ..uunneexxppoorrtt--eennvv
+ .unexport-env
Unexport all globals previously exported and clear the environ-
ment inherited from the parent. This operation will cause a mem-
ory leak of the original environment, so should be used spar-
- ingly. Testing for _._M_A_K_E_._L_E_V_E_L being 0, would make sense. Also
+ ingly. Testing for .MAKE.LEVEL being 0, would make sense. Also
note that any variables which originated in the parent environ-
ment should be explicitly preserved if desired. For example:
@@ -1013,148 +1094,148 @@ IINNCCLLUUDDEE SSTTAATTEEMMEENNTTSS,, CCOONNDDIITTIIOO
the minimal useful environment. Actually `.MAKE.LEVEL' will also
be pushed into the new environment.
- ..wwaarrnniinngg _m_e_s_s_a_g_e
- The message prefixed by `_w_a_r_n_i_n_g_:' is printed along with the name
+ .warning message
+ The message prefixed by `warning:' is printed along with the name
of the makefile and line number.
- ..iiff [!]_e_x_p_r_e_s_s_i_o_n [_o_p_e_r_a_t_o_r _e_x_p_r_e_s_s_i_o_n _._._.]
+ .if [!]expression [operator expression ...]
Test the value of an expression.
- ..iiffddeeff [!]_v_a_r_i_a_b_l_e [_o_p_e_r_a_t_o_r _v_a_r_i_a_b_l_e _._._.]
+ .ifdef [!]variable [operator variable ...]
Test the value of a variable.
- ..iiffnnddeeff [!]_v_a_r_i_a_b_l_e [_o_p_e_r_a_t_o_r _v_a_r_i_a_b_l_e _._._.]
+ .ifndef [!]variable [operator variable ...]
Test the value of a variable.
- ..iiffmmaakkee [!]_t_a_r_g_e_t [_o_p_e_r_a_t_o_r _t_a_r_g_e_t _._._.]
+ .ifmake [!]target [operator target ...]
Test the target being built.
- ..iiffnnmmaakkee [!] _t_a_r_g_e_t [_o_p_e_r_a_t_o_r _t_a_r_g_e_t _._._.]
+ .ifnmake [!] target [operator target ...]
Test the target being built.
- ..eellssee Reverse the sense of the last conditional.
+ .else Reverse the sense of the last conditional.
- ..eelliiff [!] _e_x_p_r_e_s_s_i_o_n [_o_p_e_r_a_t_o_r _e_x_p_r_e_s_s_i_o_n _._._.]
- A combination of `..eellssee' followed by `..iiff'.
+ .elif [!] expression [operator expression ...]
+ A combination of `.else' followed by `.if'.
- ..eelliiffddeeff [!]_v_a_r_i_a_b_l_e [_o_p_e_r_a_t_o_r _v_a_r_i_a_b_l_e _._._.]
- A combination of `..eellssee' followed by `..iiffddeeff'.
+ .elifdef [!]variable [operator variable ...]
+ A combination of `.else' followed by `.ifdef'.
- ..eelliiffnnddeeff [!]_v_a_r_i_a_b_l_e [_o_p_e_r_a_t_o_r _v_a_r_i_a_b_l_e _._._.]
- A combination of `..eellssee' followed by `..iiffnnddeeff'.
+ .elifndef [!]variable [operator variable ...]
+ A combination of `.else' followed by `.ifndef'.
- ..eelliiffmmaakkee [!]_t_a_r_g_e_t [_o_p_e_r_a_t_o_r _t_a_r_g_e_t _._._.]
- A combination of `..eellssee' followed by `..iiffmmaakkee'.
+ .elifmake [!]target [operator target ...]
+ A combination of `.else' followed by `.ifmake'.
- ..eelliiffnnmmaakkee [!]_t_a_r_g_e_t [_o_p_e_r_a_t_o_r _t_a_r_g_e_t _._._.]
- A combination of `..eellssee' followed by `..iiffnnmmaakkee'.
+ .elifnmake [!]target [operator target ...]
+ A combination of `.else' followed by `.ifnmake'.
- ..eennddiiff End the body of the conditional.
+ .endif End the body of the conditional.
- The _o_p_e_r_a_t_o_r may be any one of the following:
+ The operator may be any one of the following:
- |||| Logical OR.
+ || Logical OR.
- &&&& Logical AND; of higher precedence than ``||''.
+ && Logical AND; of higher precedence than ``||''.
- As in C, bbmmaakkee will only evaluate a conditional as far as is necessary to
+ As in C, bmake 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 `&&&&'.
+ evaluation. The boolean operator `!' may be used to logically negate an
+ entire conditional. It is of higher precedence than `&&'.
- The value of _e_x_p_r_e_s_s_i_o_n may be any of the following:
+ The value of expression may be any of the following:
- ddeeffiinneedd Takes a variable name as an argument and evaluates to true if
+ defined Takes a variable name as an argument and evaluates to true if
the variable has been defined.
- mmaakkee Takes a target name as an argument and evaluates to true if the
- target was specified as part of bbmmaakkee's command line or was
+ make Takes a target name as an argument and evaluates to true if the
+ target was specified as part of bmake's command line or was
declared the default target (either implicitly or explicitly,
- see _._M_A_I_N) before the line containing the conditional.
+ see .MAIN) before the line containing the conditional.
- eemmppttyy Takes a variable, with possible modifiers, and evaluates to true
+ empty Takes a variable, with possible modifiers, and evaluates to true
if the expansion of the variable would result in an empty
string.
- eexxiissttss Takes a file name as an argument and evaluates to true if the
+ 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 _._P_A_T_H).
+ (see .PATH).
- ttaarrggeett Takes a target name as an argument and evaluates to true if the
+ target Takes a target name as an argument and evaluates to true if the
target has been defined.
- ccoommmmaannddss
+ commands
Takes a target name as an argument and evaluates to true if the
target has been defined and has commands associated with it.
- _E_x_p_r_e_s_s_i_o_n may also be an arithmetic or string comparison. Variable
+ 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 sup-
ported. The standard C relational operators are all supported. If after
- variable expansion, either the left or right hand side of a `====' or `!!=='
+ 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 bbmmaakkee is evaluating one of these conditional expressions, and it
+ When bmake is evaluating one of these conditional expressions, and it
encounters a (white-space separated) 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 `..iiffddeeff', `..iiffnnddeeff', or `..iiff'
+ form of the conditional. If the form is `.ifdef', `.ifndef', or `.if'
the ``defined'' expression is applied. Similarly, if the form is
- `..iiffmmaakkee' or `..iiffnnmmaakkee, tthhee' ``make'' expression is applied.
+ `.ifmake' or `.ifnmake, the' ``make'' expression is applied.
If the conditional evaluates to true the parsing of the makefile contin-
ues as before. If it evaluates to false, the following lines are
- skipped. In both cases this continues until a `..eellssee' or `..eennddiiff' is
+ skipped. In both cases this continues until a `.else' or `.endif' 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:
- ..ffoorr _v_a_r_i_a_b_l_e [_v_a_r_i_a_b_l_e _._._.] iinn _e_x_p_r_e_s_s_i_o_n
+ .for variable [variable ...] in expression
<make-rules>
- ..eennddffoorr
+ .endfor
- After the for eexxpprreessssiioonn is evaluated, it is split into words. On each
- iteration of the loop, one word is taken and assigned to each vvaarriiaabbllee,
- in order, and these vvaarriiaabblleess are substituted into the mmaakkee--rruulleess inside
+ After the for expression is evaluated, it is split into words. On each
+ iteration of the loop, one word is taken and assigned to each variable,
+ in order, and these variables are substituted into the 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.
-CCOOMMMMEENNTTSS
+COMMENTS
Comments begin with a hash (`#') character, anywhere but in a shell com-
mand line, and continue to the end of an unescaped new line.
-SSPPEECCIIAALL SSOOUURRCCEESS ((AATTTTRRIIBBUUTTEESS))
- ..EEXXEECC Target is never out of date, but always execute commands any-
+SPECIAL SOURCES (ATTRIBUTES)
+ .EXEC Target is never out of date, but always execute commands any-
way.
- ..IIGGNNOORREE Ignore any errors from the commands associated with this tar-
+ .IGNORE Ignore any errors from the commands associated with this tar-
get, exactly as if they all were preceded by a dash (`-').
- ..MMAADDEE Mark all sources of this target as being up-to-date.
+ .MADE Mark all sources of this target as being up-to-date.
- ..MMAAKKEE Execute the commands associated with this target even if the --nn
- or --tt options were specified. Normally used to mark recursive
- bbmmaakkees.
+ .MAKE Execute the commands associated with this target even if the -n
+ or -t options were specified. Normally used to mark recursive
+ bmakes.
- ..MMEETTAA Create a meta file for the target, even if it is flagged as
- ..PPHHOONNYY, ..MMAAKKEE, or ..SSPPEECCIIAALL. Usage in conjunction with ..MMAAKKEE is
+ .META Create a meta file for the target, even if it is flagged as
+ .PHONY, .MAKE, or .SPECIAL. Usage in conjunction with .MAKE is
the most likely case. In "meta" mode, the target is out-of-
date if the meta file is missing.
- ..NNOOMMEETTAA Do not create a meta file for the target. Meta files are also
- not created for ..PPHHOONNYY, ..MMAAKKEE, or ..SSPPEECCIIAALL targets.
+ .NOMETA Do not create a meta file for the target. Meta files are also
+ not created for .PHONY, .MAKE, or .SPECIAL targets.
- ..NNOOMMEETTAA__CCMMPP
+ .NOMETA_CMP
Ignore differences in commands when deciding if target is out
of date. This is useful if the command contains a value which
always changes. If the number of commands change, though, the
target will still be out of date. The same effect applies to
- any command line that uses the variable _._O_O_D_A_T_E, which can be
+ any command line that uses the variable .OODATE, which can be
used for that purpose even when not otherwise needed or
desired:
@@ -1164,48 +1245,48 @@ SSPPEECCIIAALL SSOOUURRCCEESS ((AATTTTRRIIBBUUTTEESS))
@echo this will not ${.OODATE:M.NOMETA_CMP}
@echo this will also be compared
- The ::MM pattern suppresses any expansion of the unwanted vari-
+ The :M pattern suppresses any expansion of the unwanted vari-
able.
- ..NNOOPPAATTHH Do not search for the target in the directories specified by
- ..PPAATTHH.
+ .NOPATH Do not search for the target in the directories specified by
+ .PATH.
- ..NNOOTTMMAAIINN Normally bbmmaakkee selects the first target it encounters as the
+ .NOTMAIN Normally bmake 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.
- ..OOPPTTIIOONNAALL
- If a target is marked with this attribute and bbmmaakkee can't fig-
+ .OPTIONAL
+ If a target is marked with this attribute and bmake can't fig-
ure out how to create it, it will ignore this fact and assume
the file isn't needed or already exists.
- ..PPHHOONNYY The target does not correspond to an actual file; it is always
+ .PHONY The target does not correspond to an actual file; it is always
considered to be out of date, and will not be created with the
- --tt option. Suffix-transformation rules are not applied to
- ..PPHHOONNYY targets.
+ -t option. Suffix-transformation rules are not applied to
+ .PHONY targets.
- ..PPRREECCIIOOUUSS
- When bbmmaakkee is interrupted, it normally removes any partially
+ .PRECIOUS
+ When bmake is interrupted, it normally removes any partially
made targets. This source prevents the target from being
removed.
- ..RREECCUURRSSIIVVEE
- Synonym for ..MMAAKKEE.
+ .RECURSIVE
+ Synonym for .MAKE.
- ..SSIILLEENNTT Do not echo any of the commands associated with this target,
+ .SILENT Do not echo any of the commands associated with this target,
exactly as if they all were preceded by an at sign (`@').
- ..UUSSEE Turn the target into bbmmaakkee's version of a macro. When the tar-
+ .USE Turn the target into bmake's version of a macro. When the tar-
get is used as a source for another target, the other target
acquires the commands, sources, and attributes (except for
- ..UUSSEE) of the source. If the target already has commands, the
- ..UUSSEE target's commands are appended to them.
+ .USE) of the source. If the target already has commands, the
+ .USE target's commands are appended to them.
- ..UUSSEEBBEEFFOORREE
- Exactly like ..UUSSEE, but prepend the ..UUSSEEBBEEFFOORREE target commands
+ .USEBEFORE
+ Exactly like .USE, but prepend the .USEBEFORE target commands
to the target.
- ..WWAAIITT If ..WWAAIITT appears in a dependency line, the sources that precede
+ .WAIT If .WAIT appears in a dependency line, the sources that precede
it are made before the sources that succeed it in the line.
Since the dependents of files are not made until the file
itself could be made, this also stops the dependents being
@@ -1222,56 +1303,67 @@ SSPPEECCIIAALL SSOOUURRCCEESS ((AATTTTRRIIBBUUTTEESS))
echo b1
the output is always `a', `b1', `b', `x'.
- The ordering imposed by ..WWAAIITT is only relevant for parallel
+ The ordering imposed by .WAIT is only relevant for parallel
makes.
-SSPPEECCIIAALL TTAARRGGEETTSS
+SPECIAL TARGETS
Special targets may not be included with other targets, i.e. they must be
the only target specified.
- ..BBEEGGIINN Any command lines attached to this target are executed before
+ .BEGIN Any command lines attached to this target are executed before
anything else is done.
- ..DDEEFFAAUULLTT
- This is sort of a ..UUSSEE rule for any target (that was used only
- as a source) that bbmmaakkee can't figure out any other way to cre-
- ate. Only the shell script is used. The ..IIMMPPSSRRCC variable of a
- target that inherits ..DDEEFFAAUULLTT's commands is set to the target's
+ .DEFAULT
+ This is sort of a .USE rule for any target (that was used only
+ as a source) that bmake can't figure out any other way to cre-
+ ate. Only the shell script is used. The .IMPSRC variable of a
+ target that inherits .DEFAULT's commands is set to the target's
own name.
- ..EENNDD Any command lines attached to this target are executed after
+ .DELETE_ON_ERROR
+ If this target is present in the makefile, it globally causes
+ make to delete targets whose commands fail. (By default, only
+ targets whose commands are interrupted during execution are
+ deleted. This is the historical behavior.) This setting can be
+ used to help prevent half-finished or malformed targets from
+ being left around and corrupting future rebuilds.
+
+ .END Any command lines attached to this target are executed after
everything else is done.
- ..EERRRROORR Any command lines attached to this target are executed when
- another target fails. The ..EERRRROORR__TTAARRGGEETT variable is set to the
- target that failed. See also MMAAKKEE__PPRRIINNTT__VVAARR__OONN__EERRRROORR.
+ .ERROR Any command lines attached to this target are executed when
+ another target fails. The .ERROR_TARGET variable is set to the
+ target that failed. See also MAKE_PRINT_VAR_ON_ERROR.
- ..IIGGNNOORREE Mark each of the sources with the ..IIGGNNOORREE attribute. If no
+ .IGNORE Mark each of the sources with the .IGNORE attribute. If no
sources are specified, this is the equivalent of specifying the
- --ii option.
+ -i option.
- ..IINNTTEERRRRUUPPTT
- If bbmmaakkee is interrupted, the commands for this target will be
+ .INTERRUPT
+ If bmake is interrupted, the commands for this target will be
executed.
- ..MMAAIINN If no target is specified when bbmmaakkee is invoked, this target
+ .MAIN If no target is specified when bmake is invoked, this target
will be built.
- ..MMAAKKEEFFLLAAGGSS
- This target provides a way to specify flags for bbmmaakkee when the
+ .MAKEFLAGS
+ This target provides a way to specify flags for bmake when the
makefile is used. The flags are as if typed to the shell,
- though the --ff option will have no effect.
+ though the -f option will have no effect.
- ..NNOOPPAATTHH Apply the ..NNOOPPAATTHH attribute to any specified sources.
+ .NOPATH Apply the .NOPATH attribute to any specified sources.
- ..NNOOTTPPAARRAALLLLEELL
+ .NOTPARALLEL
Disable parallel mode.
- ..NNOO__PPAARRAALLLLEELL
- Synonym for ..NNOOTTPPAARRAALLLLEELL, for compatibility with other pmake
+ .NO_PARALLEL
+ Synonym for .NOTPARALLEL, for compatibility with other pmake
variants.
- ..OORRDDEERR The named targets are made in sequence. This ordering does not
+ .OBJDIR The source is a new value for `.OBJDIR'. If it exists, bmake
+ will chdir(2) to it and update the value of `.OBJDIR'.
+
+ .ORDER The named targets are made in sequence. This ordering does not
add targets to the list of targets to be made. Since the depen-
dents of a target do not get built until the target itself could
be built, unless `a' is built by another part of the dependency
@@ -1280,54 +1372,54 @@ SSPPEECCIIAALL TTAARRGGEETTSS
.ORDER: b a
b: a
- The ordering imposed by ..OORRDDEERR is only relevant for parallel
+ The ordering imposed by .ORDER is only relevant for parallel
makes.
- ..PPAATTHH The sources are directories which are to be searched for files
+ .PATH The sources are directories which are to be searched for files
not found in the current directory. If no sources are speci-
fied, any previously specified directories are deleted. If the
- source is the special ..DDOOTTLLAASSTT target, then the current working
+ source is the special .DOTLAST target, then the current working
directory is searched last.
- ..PPAATTHH.._s_u_f_f_i_x
- Like ..PPAATTHH but applies only to files with a particular suffix.
- The suffix must have been previously declared with ..SSUUFFFFIIXXEESS.
+ .PATH.suffix
+ Like .PATH but applies only to files with a particular suffix.
+ The suffix must have been previously declared with .SUFFIXES.
- ..PPHHOONNYY Apply the ..PPHHOONNYY attribute to any specified sources.
+ .PHONY Apply the .PHONY attribute to any specified sources.
- ..PPRREECCIIOOUUSS
- Apply the ..PPRREECCIIOOUUSS attribute to any specified sources. If no
- sources are specified, the ..PPRREECCIIOOUUSS attribute is applied to
+ .PRECIOUS
+ Apply the .PRECIOUS attribute to any specified sources. If no
+ sources are specified, the .PRECIOUS attribute is applied to
every target in the file.
- ..SSHHEELLLL Sets the shell that bbmmaakkee will use to execute commands. The
- sources are a set of _f_i_e_l_d_=_v_a_l_u_e pairs.
+ .SHELL Sets the shell that bmake will use to execute commands. The
+ sources are a set of field=value pairs.
- _n_a_m_e This is the minimal specification, used to select
- one of the builtin shell specs; _s_h, _k_s_h, and _c_s_h.
+ name This is the minimal specification, used to select
+ one of the built-in shell specs; sh, ksh, and csh.
- _p_a_t_h Specifies the path to the shell.
+ path Specifies the path to the shell.
- _h_a_s_E_r_r_C_t_l Indicates whether the shell supports exit on error.
+ hasErrCtl Indicates whether the shell supports exit on error.
- _c_h_e_c_k The command to turn on error checking.
+ check The command to turn on error checking.
- _i_g_n_o_r_e The command to disable error checking.
+ ignore The command to disable error checking.
- _e_c_h_o The command to turn on echoing of commands executed.
+ echo The command to turn on echoing of commands executed.
- _q_u_i_e_t The command to turn off echoing of commands exe-
+ quiet The command to turn off echoing of commands exe-
cuted.
- _f_i_l_t_e_r The output to filter after issuing the _q_u_i_e_t com-
- mand. It is typically identical to _q_u_i_e_t.
+ filter The output to filter after issuing the quiet com-
+ mand. It is typically identical to quiet.
- _e_r_r_F_l_a_g The flag to pass the shell to enable error checking.
+ errFlag The flag to pass the shell to enable error checking.
- _e_c_h_o_F_l_a_g The flag to pass the shell to enable command echo-
+ echoFlag The flag to pass the shell to enable command echo-
ing.
- _n_e_w_l_i_n_e The string literal to pass the shell that results in
+ newline The string literal to pass the shell that results in
a single newline character when used outside of any
quoting characters.
Example:
@@ -1337,15 +1429,15 @@ SSPPEECCIIAALL TTAARRGGEETTSS
echo="set -v" quiet="set +v" filter="set +v" \
echoFlag=v errFlag=e newline="'\n'"
- ..SSIILLEENNTT Apply the ..SSIILLEENNTT attribute to any specified sources. If no
- sources are specified, the ..SSIILLEENNTT attribute is applied to every
+ .SILENT Apply the .SILENT attribute to any specified sources. If no
+ sources are specified, the .SILENT attribute is applied to every
command in the file.
- ..SSTTAALLEE This target gets run when a dependency file contains stale
- entries, having _._A_L_L_S_R_C set to the name of that dependency file.
+ .STALE This target gets run when a dependency file contains stale
+ entries, having .ALLSRC set to the name of that dependency file.
- ..SSUUFFFFIIXXEESS
- Each source specifies a suffix to bbmmaakkee. If no sources are
+ .SUFFIXES
+ Each source specifies a suffix to bmake. If no sources are
specified, any previously specified suffixes are deleted. It
allows the creation of suffix-transformation rules.
@@ -1355,29 +1447,29 @@ SSPPEECCIIAALL TTAARRGGEETTSS
.c.o:
cc -o ${.TARGET} -c ${.IMPSRC}
-EENNVVIIRROONNMMEENNTT
- bbmmaakkee uses the following environment variables, if they exist: MACHINE,
+ENVIRONMENT
+ bmake uses the following environment variables, if they exist: MACHINE,
MACHINE_ARCH, MAKE, MAKEFLAGS, MAKEOBJDIR, MAKEOBJDIRPREFIX, MAKESYSPATH,
PWD, and TMPDIR.
MAKEOBJDIRPREFIX and MAKEOBJDIR may only be set in the environment or on
- the command line to bbmmaakkee and not as makefile variables; see the descrip-
- tion of `_._O_B_J_D_I_R' for more details.
+ the command line to bmake and not as makefile variables; see the descrip-
+ tion of `.OBJDIR' for more details.
-FFIILLEESS
+FILES
.depend list of dependencies
Makefile list of dependencies
makefile list of dependencies
sys.mk system makefile
/usr/share/mk system makefile directory
-CCOOMMPPAATTIIBBIILLIITTYY
+COMPATIBILITY
The basic make syntax is compatible between different versions of make;
however the special variables, variable modifiers and conditionals are
not.
- OOllddeerr vveerrssiioonnss
- An incomplete list of changes in older versions of bbmmaakkee:
+ Older versions
+ An incomplete list of changes in older versions of bmake:
The way that .for loop variables are substituted changed after NetBSD 5.0
so that they still appear to be variable expansions. In particular this
@@ -1388,47 +1480,47 @@ CCOOMMPPAATTIIBBIILLIITTYY
.ORDER and .WAIT apply recursively to the dependent nodes. The algo-
rithms used may change again in the future.
- OOtthheerr mmaakkee ddiiaalleeccttss
+ Other make dialects
Other make dialects (GNU make, SVR4 make, POSIX make, etc.) do not sup-
- port most of the features of bbmmaakkee as described in this manual. Most
+ port most of the features of bmake as described in this manual. Most
notably:
- ++oo The ..WWAAIITT and ..OORRDDEERR declarations and most functionality per-
+ +o The .WAIT and .ORDER declarations and most functionality per-
taining to parallelization. (GNU make supports parallelization
but lacks these features needed to control it effectively.)
- ++oo Directives, including for loops and conditionals and most of
+ +o Directives, including for loops and conditionals and most of
the forms of include files. (GNU make has its own incompatible
and less powerful syntax for conditionals.)
- ++oo All built-in variables that begin with a dot.
+ +o All built-in variables that begin with a dot.
- ++oo Most of the special sources and targets that begin with a dot,
- with the notable exception of ..PPHHOONNYY, ..PPRREECCIIOOUUSS, and ..SSUUFFFFIIXXEESS.
+ +o Most of the special sources and targets that begin with a dot,
+ with the notable exception of .PHONY, .PRECIOUS, and .SUFFIXES.
- ++oo Variable modifiers, except for the
+ +o Variable modifiers, except for the
:old=new
string substitution, which does not portably support globbing
with `%' and historically only works on declared suffixes.
- ++oo The $$>> variable even in its short form; most makes support this
+ +o The $> variable even in its short form; most makes support this
functionality but its name varies.
- Some features are somewhat more portable, such as assignment with ++==, ??==,
- and !!==. The ..PPAATTHH functionality is based on an older feature VVPPAATTHH found
+ Some features are somewhat more portable, such as assignment with +=, ?=,
+ and !=. The .PATH functionality is based on an older feature VPATH found
in GNU make and many versions of SVR4 make; however, historically its
behavior is too ill-defined (and too buggy) to rely upon.
- The $$@@ and $$<< variables are more or less universally portable, as is the
- $$((MMAAKKEE)) variable. Basic use of suffix rules (for files only in the cur-
+ The $@ and $< variables are more or less universally portable, as is the
+ $(MAKE) variable. Basic use of suffix rules (for files only in the cur-
rent directory, not trying to chain transformations together, etc.) is
also reasonably portable.
-SSEEEE AALLSSOO
+SEE ALSO
mkdep(1)
-HHIISSTTOORRYY
- bbmmaakkee is derived from NetBSD make(1). It uses autoconf to facilitate
+HISTORY
+ bmake is derived from NetBSD make(1). It uses autoconf to facilitate
portability to other platforms.
A make command appeared in Version 7 AT&T UNIX. This make implementation
@@ -1440,7 +1532,7 @@ HHIISSTTOORRYY
rebuilding (since the target/dependency does not exist... unless someone
creates an ``FRC'' file).
-BBUUGGSS
+BUGS
The make syntax is difficult to parse without actually acting of the
data. For instance finding the end of a variable use should involve
scanning each the modifiers using the correct terminator for each field.
@@ -1449,4 +1541,4 @@ BBUUGGSS
There is no way of escaping a space character in a filename.
-NetBSD 5.1 April 9, 2015 NetBSD 5.1
+FreeBSD 11.1 June 22, 2017 FreeBSD 11.1