bmake.cat1 revision 284254
1236769SobrienMAKE(1)                 NetBSD General Commands Manual                 MAKE(1)
2236769Sobrien
3236769SobrienNNAAMMEE
4236769Sobrien     bbmmaakkee -- maintain program dependencies
5236769Sobrien
6236769SobrienSSYYNNOOPPSSIISS
7253883Ssjg     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]
8236769Sobrien           [--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]
9236769Sobrien           [--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]
10236769Sobrien           [_t_a_r_g_e_t _._._.]
11236769Sobrien
12236769SobrienDDEESSCCRRIIPPTTIIOONN
13236769Sobrien     bbmmaakkee is a program designed to simplify the maintenance of other pro-
14236769Sobrien     grams.  Its input is a list of specifications as to the files upon which
15236769Sobrien     programs and other files depend.  If no --ff _m_a_k_e_f_i_l_e makefile option is
16236769Sobrien     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
17236769Sobrien     the specifications.  If the file `_._d_e_p_e_n_d' exists, it is read (see
18236769Sobrien     mkdep(1)).
19236769Sobrien
20236769Sobrien     This manual page is intended as a reference document only.  For a more
21236769Sobrien     thorough description of bbmmaakkee and makefiles, please refer to _P_M_a_k_e _- _A
22236769Sobrien     _T_u_t_o_r_i_a_l.
23236769Sobrien
24236769Sobrien     bbmmaakkee will prepend the contents of the _M_A_K_E_F_L_A_G_S environment variable to
25236769Sobrien     the command line arguments before parsing them.
26236769Sobrien
27236769Sobrien     The options are as follows:
28236769Sobrien
29236769Sobrien     --BB      Try to be backwards compatible by executing a single shell per
30236769Sobrien             command and by executing the commands to make the sources of a
31236769Sobrien             dependency line in sequence.
32236769Sobrien
33236769Sobrien     --CC _d_i_r_e_c_t_o_r_y
34236769Sobrien             Change to _d_i_r_e_c_t_o_r_y before reading the makefiles or doing any-
35236769Sobrien             thing else.  If multiple --CC options are specified, each is inter-
36236769Sobrien             preted relative to the previous one: --CC _/ --CC _e_t_c is equivalent to
37236769Sobrien             --CC _/_e_t_c.
38236769Sobrien
39236769Sobrien     --DD _v_a_r_i_a_b_l_e
40236769Sobrien             Define _v_a_r_i_a_b_l_e to be 1, in the global context.
41236769Sobrien
42236769Sobrien     --dd _[_-_]_f_l_a_g_s
43236769Sobrien             Turn on debugging, and specify which portions of bbmmaakkee are to
44236769Sobrien             print debugging information.  Unless the flags are preceded by
45236769Sobrien             `-' they are added to the _M_A_K_E_F_L_A_G_S environment variable and will
46236769Sobrien             be processed by any child make processes.  By default, debugging
47236769Sobrien             information is printed to standard error, but this can be changed
48236769Sobrien             using the _F debugging flag.  The debugging output is always
49236769Sobrien             unbuffered; in addition, if debugging is enabled but debugging
50236769Sobrien             output is not directed to standard output, then the standard out-
51236769Sobrien             put is line buffered.  _F_l_a_g_s is one or more of the following:
52236769Sobrien
53236769Sobrien             _A       Print all possible debugging information; equivalent to
54236769Sobrien                     specifying all of the debugging flags.
55236769Sobrien
56236769Sobrien             _a       Print debugging information about archive searching and
57236769Sobrien                     caching.
58236769Sobrien
59236769Sobrien             _C       Print debugging information about current working direc-
60236769Sobrien                     tory.
61236769Sobrien
62236769Sobrien             _c       Print debugging information about conditional evaluation.
63236769Sobrien
64236769Sobrien             _d       Print debugging information about directory searching and
65236769Sobrien                     caching.
66236769Sobrien
67236769Sobrien             _e       Print debugging information about failed commands and
68236769Sobrien                     targets.
69236769Sobrien
70236769Sobrien             _F[++]_f_i_l_e_n_a_m_e
71236769Sobrien                     Specify where debugging output is written.  This must be
72236769Sobrien                     the last flag, because it consumes the remainder of the
73236769Sobrien                     argument.  If the character immediately after the `F'
74236769Sobrien                     flag is `+', then the file will be opened in append mode;
75236769Sobrien                     otherwise the file will be overwritten.  If the file name
76236769Sobrien                     is `stdout' or `stderr' then debugging output will be
77236769Sobrien                     written to the standard output or standard error output
78236769Sobrien                     file descriptors respectively (and the `+' option has no
79236769Sobrien                     effect).  Otherwise, the output will be written to the
80236769Sobrien                     named file.  If the file name ends `.%d' then the `%d' is
81236769Sobrien                     replaced by the pid.
82236769Sobrien
83236769Sobrien             _f       Print debugging information about loop evaluation.
84236769Sobrien
85236769Sobrien             _g_1      Print the input graph before making anything.
86236769Sobrien
87236769Sobrien             _g_2      Print the input graph after making everything, or before
88236769Sobrien                     exiting on error.
89236769Sobrien
90236769Sobrien             _g_3      Print the input graph before exiting on error.
91236769Sobrien
92236769Sobrien             _j       Print debugging information about running multiple
93236769Sobrien                     shells.
94236769Sobrien
95236769Sobrien             _l       Print commands in Makefiles regardless of whether or not
96236769Sobrien                     they are prefixed by `@' or other "quiet" flags.  Also
97236769Sobrien                     known as "loud" behavior.
98236769Sobrien
99236769Sobrien             _M       Print debugging information about "meta" mode decisions
100236769Sobrien                     about targets.
101236769Sobrien
102236769Sobrien             _m       Print debugging information about making targets, includ-
103236769Sobrien                     ing modification dates.
104236769Sobrien
105236769Sobrien             _n       Don't delete the temporary command scripts created when
106236769Sobrien                     running commands.  These temporary scripts are created in
107236769Sobrien                     the directory referred to by the TMPDIR environment vari-
108236769Sobrien                     able, or in _/_t_m_p if TMPDIR is unset or set to the empty
109236769Sobrien                     string.  The temporary scripts are created by mkstemp(3),
110236769Sobrien                     and have names of the form _m_a_k_e_X_X_X_X_X_X.  _N_O_T_E: This can
111236769Sobrien                     create many files in TMPDIR or _/_t_m_p, so use with care.
112236769Sobrien
113236769Sobrien             _p       Print debugging information about makefile parsing.
114236769Sobrien
115236769Sobrien             _s       Print debugging information about suffix-transformation
116236769Sobrien                     rules.
117236769Sobrien
118236769Sobrien             _t       Print debugging information about target list mainte-
119236769Sobrien                     nance.
120236769Sobrien
121240330Smarcel             _V       Force the --VV option to print raw values of variables.
122240330Smarcel
123236769Sobrien             _v       Print debugging information about variable assignment.
124236769Sobrien
125236769Sobrien             _x       Run shell commands with --xx so the actual commands are
126236769Sobrien                     printed as they are executed.
127236769Sobrien
128236769Sobrien     --ee      Specify that environment variables override macro assignments
129236769Sobrien             within makefiles.
130236769Sobrien
131236769Sobrien     --ff _m_a_k_e_f_i_l_e
132236769Sobrien             Specify a makefile to read instead of the default `_m_a_k_e_f_i_l_e'.  If
133236769Sobrien             _m_a_k_e_f_i_l_e is `--', standard input is read.  Multiple makefiles may
134236769Sobrien             be specified, and are read in the order specified.
135236769Sobrien
136236769Sobrien     --II _d_i_r_e_c_t_o_r_y
137236769Sobrien             Specify a directory in which to search for makefiles and included
138236769Sobrien             makefiles.  The system makefile directory (or directories, see
139236769Sobrien             the --mm option) is automatically included as part of this list.
140236769Sobrien
141236769Sobrien     --ii      Ignore non-zero exit of shell commands in the makefile.  Equiva-
142236769Sobrien             lent to specifying `--' before each command line in the makefile.
143236769Sobrien
144236769Sobrien     --JJ _p_r_i_v_a_t_e
145236769Sobrien             This option should _n_o_t be specified by the user.
146236769Sobrien
147236769Sobrien             When the _j option is in use in a recursive build, this option is
148236769Sobrien             passed by a make to child makes to allow all the make processes
149236769Sobrien             in the build to cooperate to avoid overloading the system.
150236769Sobrien
151236769Sobrien     --jj _m_a_x___j_o_b_s
152236769Sobrien             Specify the maximum number of jobs that bbmmaakkee may have running at
153236769Sobrien             any one time.  The value is saved in _._M_A_K_E_._J_O_B_S.  Turns compati-
154236769Sobrien             bility mode off, unless the _B flag is also specified.  When com-
155236769Sobrien             patibility mode is off, all commands associated with a target are
156236769Sobrien             executed in a single shell invocation as opposed to the tradi-
157236769Sobrien             tional one shell invocation per line.  This can break traditional
158236769Sobrien             scripts which change directories on each command invocation and
159236769Sobrien             then expect to start with a fresh environment on the next line.
160236769Sobrien             It is more efficient to correct the scripts rather than turn
161236769Sobrien             backwards compatibility on.
162236769Sobrien
163236769Sobrien     --kk      Continue processing after errors are encountered, but only on
164236769Sobrien             those targets that do not depend on the target whose creation
165236769Sobrien             caused the error.
166236769Sobrien
167236769Sobrien     --mm _d_i_r_e_c_t_o_r_y
168236769Sobrien             Specify a directory in which to search for sys.mk and makefiles
169236769Sobrien             included via the <_f_i_l_e>-style include statement.  The --mm option
170236769Sobrien             can be used multiple times to form a search path.  This path will
171236769Sobrien             override the default system include path: /usr/share/mk.  Fur-
172236769Sobrien             thermore the system include path will be appended to the search
173236769Sobrien             path used for "_f_i_l_e"-style include statements (see the --II
174236769Sobrien             option).
175236769Sobrien
176236769Sobrien             If a file or directory name in the --mm argument (or the
177236769Sobrien             MAKESYSPATH environment variable) starts with the string ".../"
178236769Sobrien             then bbmmaakkee will search for the specified file or directory named
179236769Sobrien             in the remaining part of the argument string.  The search starts
180236769Sobrien             with the current directory of the Makefile and then works upward
181236769Sobrien             towards the root of the filesystem.  If the search is successful,
182236769Sobrien             then the resulting directory replaces the ".../" specification in
183236769Sobrien             the --mm argument.  If used, this feature allows bbmmaakkee to easily
184236769Sobrien             search in the current source tree for customized sys.mk files
185236769Sobrien             (e.g., by using ".../mk/sys.mk" as an argument).
186236769Sobrien
187236769Sobrien     --nn      Display the commands that would have been executed, but do not
188236769Sobrien             actually execute them unless the target depends on the .MAKE spe-
189236769Sobrien             cial source (see below).
190236769Sobrien
191236769Sobrien     --NN      Display the commands which would have been executed, but do not
192236769Sobrien             actually execute any of them; useful for debugging top-level
193236769Sobrien             makefiles without descending into subdirectories.
194236769Sobrien
195236769Sobrien     --qq      Do not execute any commands, but exit 0 if the specified targets
196236769Sobrien             are up-to-date and 1, otherwise.
197236769Sobrien
198236769Sobrien     --rr      Do not use the built-in rules specified in the system makefile.
199236769Sobrien
200236769Sobrien     --ss      Do not echo any commands as they are executed.  Equivalent to
201236769Sobrien             specifying `@@' before each command line in the makefile.
202236769Sobrien
203236769Sobrien     --TT _t_r_a_c_e_f_i_l_e
204236769Sobrien             When used with the --jj flag, append a trace record to _t_r_a_c_e_f_i_l_e
205236769Sobrien             for each job started and completed.
206236769Sobrien
207236769Sobrien     --tt      Rather than re-building a target as specified in the makefile,
208236769Sobrien             create it or update its modification time to make it appear up-
209236769Sobrien             to-date.
210236769Sobrien
211236769Sobrien     --VV _v_a_r_i_a_b_l_e
212236769Sobrien             Print bbmmaakkee's idea of the value of _v_a_r_i_a_b_l_e, in the global con-
213236769Sobrien             text.  Do not build any targets.  Multiple instances of this
214236769Sobrien             option may be specified; the variables will be printed one per
215236769Sobrien             line, with a blank line for each null or undefined variable.  If
216236769Sobrien             _v_a_r_i_a_b_l_e contains a `$' then the value will be expanded before
217236769Sobrien             printing.
218236769Sobrien
219236769Sobrien     --WW      Treat any warnings during makefile parsing as errors.
220236769Sobrien
221281812Ssjg     --ww      Print entering and leaving directory messages, pre and post pro-
222281812Ssjg             cessing.
223281812Ssjg
224236769Sobrien     --XX      Don't export variables passed on the command line to the environ-
225236769Sobrien             ment individually.  Variables passed on the command line are
226236769Sobrien             still exported via the _M_A_K_E_F_L_A_G_S environment variable.  This
227236769Sobrien             option may be useful on systems which have a small limit on the
228236769Sobrien             size of command arguments.
229236769Sobrien
230236769Sobrien     _v_a_r_i_a_b_l_e_=_v_a_l_u_e
231236769Sobrien             Set the value of the variable _v_a_r_i_a_b_l_e to _v_a_l_u_e.  Normally, all
232236769Sobrien             values passed on the command line are also exported to sub-makes
233236769Sobrien             in the environment.  The --XX flag disables this behavior.  Vari-
234236769Sobrien             able assignments should follow options for POSIX compatibility
235236769Sobrien             but no ordering is enforced.
236236769Sobrien
237236769Sobrien     There are seven different types of lines in a makefile: file dependency
238236769Sobrien     specifications, shell commands, variable assignments, include statements,
239236769Sobrien     conditional directives, for loops, and comments.
240236769Sobrien
241236769Sobrien     In general, lines may be continued from one line to the next by ending
242236769Sobrien     them with a backslash (`\').  The trailing newline character and initial
243236769Sobrien     whitespace on the following line are compressed into a single space.
244236769Sobrien
245236769SobrienFFIILLEE DDEEPPEENNDDEENNCCYY SSPPEECCIIFFIICCAATTIIOONNSS
246236769Sobrien     Dependency lines consist of one or more targets, an operator, and zero or
247236769Sobrien     more sources.  This creates a relationship where the targets ``depend''
248236769Sobrien     on the sources and are usually created from them.  The exact relationship
249236769Sobrien     between the target and the source is determined by the operator that sep-
250236769Sobrien     arates them.  The three operators are as follows:
251236769Sobrien
252236769Sobrien     ::     A target is considered out-of-date if its modification time is less
253236769Sobrien           than those of any of its sources.  Sources for a target accumulate
254236769Sobrien           over dependency lines when this operator is used.  The target is
255236769Sobrien           removed if bbmmaakkee is interrupted.
256236769Sobrien
257236769Sobrien     !!     Targets are always re-created, but not until all sources have been
258236769Sobrien           examined and re-created as necessary.  Sources for a target accumu-
259236769Sobrien           late over dependency lines when this operator is used.  The target
260236769Sobrien           is removed if bbmmaakkee is interrupted.
261236769Sobrien
262236769Sobrien     ::::    If no sources are specified, the target is always re-created.  Oth-
263236769Sobrien           erwise, a target is considered out-of-date if any of its sources
264236769Sobrien           has been modified more recently than the target.  Sources for a
265236769Sobrien           target do not accumulate over dependency lines when this operator
266236769Sobrien           is used.  The target will not be removed if bbmmaakkee is interrupted.
267236769Sobrien
268236769Sobrien     Targets and sources may contain the shell wildcard values `?', `*', `[]',
269236769Sobrien     and `{}'.  The values `?', `*', and `[]' may only be used as part of the
270236769Sobrien     final component of the target or source, and must be used to describe
271236769Sobrien     existing files.  The value `{}' need not necessarily be used to describe
272236769Sobrien     existing files.  Expansion is in directory order, not alphabetically as
273236769Sobrien     done in the shell.
274236769Sobrien
275236769SobrienSSHHEELLLL CCOOMMMMAANNDDSS
276281812Ssjg     Each target may have associated with it one or more lines of shell com-
277281812Ssjg     mands, normally used to create the target.  Each of the lines in this
278281812Ssjg     script _m_u_s_t be preceded by a tab.  (For historical reasons, spaces are
279281812Ssjg     not accepted.)  While targets can appear in many dependency lines if
280281812Ssjg     desired, by default only one of these rules may be followed by a creation
281281812Ssjg     script.  If the `::::' operator is used, however, all rules may include
282281812Ssjg     scripts and the scripts are executed in the order found.
283236769Sobrien
284281812Ssjg     Each line is treated as a separate shell command, unless the end of line
285281812Ssjg     is escaped with a backslash (`\') in which case that line and the next
286281812Ssjg     are combined.  If the first characters of the command are any combination
287281812Ssjg     of `@@', `++', or `--', the command is treated specially.  A `@@' causes the
288281812Ssjg     command not to be echoed before it is executed.  A `++' causes the command
289281812Ssjg     to be executed even when --nn is given.  This is similar to the effect of
290281812Ssjg     the .MAKE special source, except that the effect can be limited to a sin-
291281812Ssjg     gle line of a script.  A `--' in compatibility mode causes any non-zero
292281812Ssjg     exit status of the command line to be ignored.
293236769Sobrien
294246223Ssjg     When bbmmaakkee is run in jobs mode with --jj _m_a_x___j_o_b_s, the entire script for
295281812Ssjg     the target is fed to a single instance of the shell.  In compatibility
296281812Ssjg     (non-jobs) mode, each command is run in a separate process.  If the com-
297281812Ssjg     mand contains any shell meta characters (`#=|^(){};&<>*?[]:$`\\n') it
298281812Ssjg     will be passed to the shell; otherwise bbmmaakkee will attempt direct execu-
299281812Ssjg     tion.  If a line starts with `--' and the shell has ErrCtl enabled then
300281812Ssjg     failure of the command line will be ignored as in compatibility mode.
301281812Ssjg     Otherwise `--' affects the entire job; the script will stop at the first
302281812Ssjg     command line that fails, but the target will not be deemed to have
303281812Ssjg     failed.
304246223Ssjg
305246223Ssjg     Makefiles should be written so that the mode of bbmmaakkee operation does not
306246223Ssjg     change their behavior.  For example, any command which needs to use
307281812Ssjg     ``cd'' or ``chdir'' without potentially changing the directory for subse-
308281812Ssjg     quent commands should be put in parentheses so it executes in a subshell.
309281812Ssjg     To force the use of one shell, escape the line breaks so as to make the
310281812Ssjg     whole script one command.  For example:
311246223Ssjg
312246223Ssjg           avoid-chdir-side-effects:
313246223Ssjg                   @echo Building $@ in `pwd`
314281812Ssjg                   @(cd ${.CURDIR} && ${MAKE} $@)
315246223Ssjg                   @echo Back in `pwd`
316246223Ssjg
317246223Ssjg           ensure-one-shell-regardless-of-mode:
318246223Ssjg                   @echo Building $@ in `pwd`; \
319281812Ssjg                   (cd ${.CURDIR} && ${MAKE} $@); \
320246223Ssjg                   echo Back in `pwd`
321246223Ssjg
322281812Ssjg     Since bbmmaakkee will chdir(2) to `_._O_B_J_D_I_R' before executing any targets, each
323281812Ssjg     child process starts with that as its current working directory.
324281812Ssjg
325236769SobrienVVAARRIIAABBLLEE AASSSSIIGGNNMMEENNTTSS
326236769Sobrien     Variables in make are much like variables in the shell, and, by tradi-
327236769Sobrien     tion, consist of all upper-case letters.
328236769Sobrien
329236769Sobrien   VVaarriiaabbllee aassssiiggnnmmeenntt mmooddiiffiieerrss
330236769Sobrien     The five operators that can be used to assign values to variables are as
331236769Sobrien     follows:
332236769Sobrien
333236769Sobrien     ==       Assign the value to the variable.  Any previous value is overrid-
334236769Sobrien             den.
335236769Sobrien
336236769Sobrien     ++==      Append the value to the current value of the variable.
337236769Sobrien
338236769Sobrien     ??==      Assign the value to the variable if it is not already defined.
339236769Sobrien
340236769Sobrien     ::==      Assign with expansion, i.e. expand the value before assigning it
341236769Sobrien             to the variable.  Normally, expansion is not done until the vari-
342236769Sobrien             able is referenced.  _N_O_T_E: References to undefined variables are
343236769Sobrien             _n_o_t expanded.  This can cause problems when variable modifiers
344236769Sobrien             are used.
345236769Sobrien
346236769Sobrien     !!==      Expand the value and pass it to the shell for execution and
347236769Sobrien             assign the result to the variable.  Any newlines in the result
348236769Sobrien             are replaced with spaces.
349236769Sobrien
350236769Sobrien     Any white-space before the assigned _v_a_l_u_e is removed; if the value is
351236769Sobrien     being appended, a single space is inserted between the previous contents
352236769Sobrien     of the variable and the appended value.
353236769Sobrien
354236769Sobrien     Variables are expanded by surrounding the variable name with either curly
355236769Sobrien     braces (`{}') or parentheses (`()') and preceding it with a dollar sign
356236769Sobrien     (`$').  If the variable name contains only a single letter, the surround-
357236769Sobrien     ing braces or parentheses are not required.  This shorter form is not
358236769Sobrien     recommended.
359236769Sobrien
360236769Sobrien     If the variable name contains a dollar, then the name itself is expanded
361236769Sobrien     first.  This allows almost arbitrary variable names, however names con-
362236769Sobrien     taining dollar, braces, parenthesis, or whitespace are really best
363236769Sobrien     avoided!
364236769Sobrien
365236769Sobrien     If the result of expanding a variable contains a dollar sign (`$') the
366236769Sobrien     string is expanded again.
367236769Sobrien
368236769Sobrien     Variable substitution occurs at three distinct times, depending on where
369236769Sobrien     the variable is being used.
370236769Sobrien
371236769Sobrien     1.   Variables in dependency lines are expanded as the line is read.
372236769Sobrien
373236769Sobrien     2.   Variables in shell commands are expanded when the shell command is
374236769Sobrien          executed.
375236769Sobrien
376236769Sobrien     3.   ``.for'' loop index variables are expanded on each loop iteration.
377236769Sobrien          Note that other variables are not expanded inside loops so the fol-
378236769Sobrien          lowing example code:
379236769Sobrien
380236769Sobrien
381236769Sobrien                .for i in 1 2 3
382236769Sobrien                a+=     ${i}
383236769Sobrien                j=      ${i}
384236769Sobrien                b+=     ${j}
385236769Sobrien                .endfor
386236769Sobrien
387236769Sobrien                all:
388236769Sobrien                        @echo ${a}
389236769Sobrien                        @echo ${b}
390236769Sobrien
391236769Sobrien          will print:
392236769Sobrien
393236769Sobrien                1 2 3
394236769Sobrien                3 3 3
395236769Sobrien
396236769Sobrien          Because while ${a} contains ``1 2 3'' after the loop is executed,
397236769Sobrien          ${b} contains ``${j} ${j} ${j}'' which expands to ``3 3 3'' since
398236769Sobrien          after the loop completes ${j} contains ``3''.
399236769Sobrien
400236769Sobrien   VVaarriiaabbllee ccllaasssseess
401236769Sobrien     The four different classes of variables (in order of increasing prece-
402236769Sobrien     dence) are:
403236769Sobrien
404236769Sobrien     Environment variables
405236769Sobrien             Variables defined as part of bbmmaakkee's environment.
406236769Sobrien
407236769Sobrien     Global variables
408236769Sobrien             Variables defined in the makefile or in included makefiles.
409236769Sobrien
410236769Sobrien     Command line variables
411236769Sobrien             Variables defined as part of the command line.
412236769Sobrien
413236769Sobrien     Local variables
414281812Ssjg             Variables that are defined specific to a certain target.
415236769Sobrien
416281812Ssjg     Local variables are all built in and their values vary magically from
417281812Ssjg     target to target.  It is not currently possible to define new local vari-
418281812Ssjg     ables.  The seven local variables are as follows:
419236769Sobrien
420281812Ssjg           _._A_L_L_S_R_C   The list of all sources for this target; also known as
421281812Ssjg                     `_>'.
422236769Sobrien
423281812Ssjg           _._A_R_C_H_I_V_E  The name of the archive file; also known as `_!'.
424236769Sobrien
425281812Ssjg           _._I_M_P_S_R_C   In suffix-transformation rules, the name/path of the
426281812Ssjg                     source from which the target is to be transformed (the
427281812Ssjg                     ``implied'' source); also known as `_<'.  It is not
428281812Ssjg                     defined in explicit rules.
429236769Sobrien
430281812Ssjg           _._M_E_M_B_E_R   The name of the archive member; also known as `_%'.
431236769Sobrien
432281812Ssjg           _._O_O_D_A_T_E   The list of sources for this target that were deemed out-
433281812Ssjg                     of-date; also known as `_?'.
434236769Sobrien
435281812Ssjg           _._P_R_E_F_I_X   The file prefix of the target, containing only the file
436281812Ssjg                     portion, no suffix or preceding directory components;
437281812Ssjg                     also known as `_*'.  The suffix must be one of the known
438281812Ssjg                     suffixes declared with ..SSUUFFFFIIXXEESS or it will not be recog-
439281812Ssjg                     nized.
440236769Sobrien
441281812Ssjg           _._T_A_R_G_E_T   The name of the target; also known as `_@'.
442236769Sobrien
443281812Ssjg     The shorter forms (`_>', `_!', `_<', `_%', `_?', `_*', and `_@') are permitted
444281812Ssjg     for backward compatibility with historical makefiles and legacy POSIX
445281812Ssjg     make and are not recommended.
446236769Sobrien
447281812Ssjg     Variants of these variables with the punctuation followed immediately by
448281812Ssjg     `D' or `F', e.g.  `_$_(_@_D_)', are legacy forms equivalent to using the `:H'
449281812Ssjg     and `:T' modifiers.  These forms are accepted for compatibility with AT&T
450281812Ssjg     System V UNIX makefiles and POSIX but are not recommended.
451281812Ssjg
452281812Ssjg     Four of the local variables may be used in sources on dependency lines
453281812Ssjg     because they expand to the proper value for each target on the line.
454281812Ssjg     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'.
455281812Ssjg
456236769Sobrien   AAddddiittiioonnaall bbuuiilltt--iinn vvaarriiaabblleess
457236769Sobrien     In addition, bbmmaakkee sets or knows about the following variables:
458236769Sobrien
459236769Sobrien     _$               A single dollar sign `$', i.e.  `$$' expands to a single
460236769Sobrien                     dollar sign.
461236769Sobrien
462236769Sobrien     _._A_L_L_T_A_R_G_E_T_S     The list of all targets encountered in the Makefile.  If
463236769Sobrien                     evaluated during Makefile parsing, lists only those tar-
464236769Sobrien                     gets encountered thus far.
465236769Sobrien
466236769Sobrien     _._C_U_R_D_I_R         A path to the directory where bbmmaakkee was executed.  Refer
467236769Sobrien                     to the description of `PWD' for more details.
468236769Sobrien
469268437Ssjg     _._I_N_C_L_U_D_E_D_F_R_O_M_D_I_R
470268437Ssjg                     The directory of the file this Makefile was included
471268437Ssjg                     from.
472268437Ssjg
473268437Ssjg     _._I_N_C_L_U_D_E_D_F_R_O_M_F_I_L_E
474268437Ssjg                     The filename of the file this Makefile was included from.
475268437Ssjg
476236769Sobrien     MAKE            The name that bbmmaakkee was executed with (_a_r_g_v_[_0_]).  For
477236769Sobrien                     compatibility bbmmaakkee also sets _._M_A_K_E with the same value.
478236769Sobrien                     The preferred variable to use is the environment variable
479236769Sobrien                     MAKE because it is more compatible with other versions of
480236769Sobrien                     bbmmaakkee and cannot be confused with the special target with
481236769Sobrien                     the same name.
482236769Sobrien
483236769Sobrien     _._M_A_K_E_._D_E_P_E_N_D_F_I_L_E
484236769Sobrien                     Names the makefile (default `_._d_e_p_e_n_d') from which gener-
485236769Sobrien                     ated dependencies are read.
486236769Sobrien
487240330Smarcel     _._M_A_K_E_._E_X_P_A_N_D___V_A_R_I_A_B_L_E_S
488240330Smarcel                     A boolean that controls the default behavior of the --VV
489240330Smarcel                     option.
490240330Smarcel
491236769Sobrien     _._M_A_K_E_._E_X_P_O_R_T_E_D  The list of variables exported by bbmmaakkee.
492236769Sobrien
493236769Sobrien     _._M_A_K_E_._J_O_B_S      The argument to the --jj option.
494236769Sobrien
495236769Sobrien     _._M_A_K_E_._J_O_B_._P_R_E_F_I_X
496236769Sobrien                     If bbmmaakkee is run with _j then output for each target is
497236769Sobrien                     prefixed with a token `--- target ---' the first part of
498253883Ssjg                     which can be controlled via _._M_A_K_E_._J_O_B_._P_R_E_F_I_X.  If
499253883Ssjg                     _._M_A_K_E_._J_O_B_._P_R_E_F_I_X is empty, no token is printed.
500236769Sobrien                     For example:
501236769Sobrien                     .MAKE.JOB.PREFIX=${.newline}---${.MAKE:T}[${.MAKE.PID}]
502236769Sobrien                     would produce tokens like `---make[1234] target ---' mak-
503236769Sobrien                     ing it easier to track the degree of parallelism being
504236769Sobrien                     achieved.
505236769Sobrien
506236769Sobrien     MAKEFLAGS       The environment variable `MAKEFLAGS' may contain anything
507236769Sobrien                     that may be specified on bbmmaakkee's command line.  Anything
508236769Sobrien                     specified on bbmmaakkee's command line is appended to the
509236769Sobrien                     `MAKEFLAGS' variable which is then entered into the envi-
510236769Sobrien                     ronment for all programs which bbmmaakkee executes.
511236769Sobrien
512236769Sobrien     _._M_A_K_E_._L_E_V_E_L     The recursion depth of bbmmaakkee.  The initial instance of
513236769Sobrien                     bbmmaakkee will be 0, and an incremented value is put into the
514236769Sobrien                     environment to be seen by the next generation.  This
515236769Sobrien                     allows tests like: .if ${.MAKE.LEVEL} == 0 to protect
516236769Sobrien                     things which should only be evaluated in the initial
517236769Sobrien                     instance of bbmmaakkee.
518236769Sobrien
519236769Sobrien     _._M_A_K_E_._M_A_K_E_F_I_L_E___P_R_E_F_E_R_E_N_C_E
520236769Sobrien                     The ordered list of makefile names (default `_m_a_k_e_f_i_l_e',
521236769Sobrien                     `_M_a_k_e_f_i_l_e') that bbmmaakkee will look for.
522236769Sobrien
523236769Sobrien     _._M_A_K_E_._M_A_K_E_F_I_L_E_S
524236769Sobrien                     The list of makefiles read by bbmmaakkee, which is useful for
525236769Sobrien                     tracking dependencies.  Each makefile is recorded only
526236769Sobrien                     once, regardless of the number of times read.
527236769Sobrien
528236769Sobrien     _._M_A_K_E_._M_O_D_E      Processed after reading all makefiles.  Can affect the
529236769Sobrien                     mode that bbmmaakkee runs in.  It can contain a number of key-
530236769Sobrien                     words:
531236769Sobrien
532236769Sobrien                     _c_o_m_p_a_t      Like --BB, puts bbmmaakkee into "compat" mode.
533236769Sobrien
534236769Sobrien                     _m_e_t_a        Puts bbmmaakkee into "meta" mode, where meta files
535236769Sobrien                                 are created for each target to capture the
536236769Sobrien                                 command run, the output generated and if
537236769Sobrien                                 filemon(4) is available, the system calls
538236769Sobrien                                 which are of interest to bbmmaakkee.  The captured
539236769Sobrien                                 output can be very useful when diagnosing
540236769Sobrien                                 errors.
541236769Sobrien
542236769Sobrien                     _c_u_r_d_i_r_O_k_= _b_f Normally bbmmaakkee will not create .meta files
543236769Sobrien                                 in `_._C_U_R_D_I_R'.  This can be overridden by set-
544236769Sobrien                                 ting _b_f to a value which represents True.
545236769Sobrien
546236769Sobrien                     _e_n_v         For debugging, it can be useful to inlcude
547236769Sobrien                                 the environment in the .meta file.
548236769Sobrien
549236769Sobrien                     _v_e_r_b_o_s_e     If in "meta" mode, print a clue about the
550236769Sobrien                                 target being built.  This is useful if the
551236769Sobrien                                 build is otherwise running silently.  The
552236769Sobrien                                 message printed the value of:
553236769Sobrien                                 _._M_A_K_E_._M_E_T_A_._P_R_E_F_I_X.
554236769Sobrien
555236769Sobrien                     _i_g_n_o_r_e_-_c_m_d  Some makefiles have commands which are simply
556236769Sobrien                                 not stable.  This keyword causes them to be
557236769Sobrien                                 ignored for determining whether a target is
558236769Sobrien                                 out of date in "meta" mode.  See also
559236769Sobrien                                 ..NNOOMMEETTAA__CCMMPP.
560236769Sobrien
561236769Sobrien                     _s_i_l_e_n_t_= _b_f  If _b_f is True, when a .meta file is created,
562236769Sobrien                                 mark the target ..SSIILLEENNTT.
563236769Sobrien
564236769Sobrien     _._M_A_K_E_._M_E_T_A_._B_A_I_L_I_W_I_C_K
565236769Sobrien                     In "meta" mode, provides a list of prefixes which match
566236769Sobrien                     the directories controlled by bbmmaakkee.  If a file that was
567236769Sobrien                     generated outside of _._O_B_J_D_I_R but within said bailiwick is
568236769Sobrien                     missing, the current target is considered out-of-date.
569236769Sobrien
570236769Sobrien     _._M_A_K_E_._M_E_T_A_._C_R_E_A_T_E_D
571236769Sobrien                     In "meta" mode, this variable contains a list of all the
572236769Sobrien                     meta files updated.  If not empty, it can be used to
573236769Sobrien                     trigger processing of _._M_A_K_E_._M_E_T_A_._F_I_L_E_S.
574236769Sobrien
575236769Sobrien     _._M_A_K_E_._M_E_T_A_._F_I_L_E_S
576236769Sobrien                     In "meta" mode, this variable contains a list of all the
577236769Sobrien                     meta files used (updated or not).  This list can be used
578236769Sobrien                     to process the meta files to extract dependency informa-
579236769Sobrien                     tion.
580236769Sobrien
581253883Ssjg     _._M_A_K_E_._M_E_T_A_._I_G_N_O_R_E___P_A_T_H_S
582253883Ssjg                     Provides a list of path prefixes that should be ignored;
583253883Ssjg                     because the contents are expected to change over time.
584253883Ssjg                     The default list includes: `_/_d_e_v _/_e_t_c _/_p_r_o_c _/_t_m_p _/_v_a_r_/_r_u_n
585253883Ssjg                     _/_v_a_r_/_t_m_p'
586253883Ssjg
587236769Sobrien     _._M_A_K_E_._M_E_T_A_._P_R_E_F_I_X
588236769Sobrien                     Defines the message printed for each meta file updated in
589236769Sobrien                     "meta verbose" mode.  The default value is:
590236769Sobrien                           Building ${.TARGET:H:tA}/${.TARGET:T}
591236769Sobrien
592236769Sobrien     _._M_A_K_E_O_V_E_R_R_I_D_E_S  This variable is used to record the names of variables
593236769Sobrien                     assigned to on the command line, so that they may be
594236769Sobrien                     exported as part of `MAKEFLAGS'.  This behaviour can be
595236769Sobrien                     disabled by assigning an empty value to `_._M_A_K_E_O_V_E_R_R_I_D_E_S'
596236769Sobrien                     within a makefile.  Extra variables can be exported from
597236769Sobrien                     a makefile by appending their names to `_._M_A_K_E_O_V_E_R_R_I_D_E_S'.
598236769Sobrien                     `MAKEFLAGS' is re-exported whenever `_._M_A_K_E_O_V_E_R_R_I_D_E_S' is
599236769Sobrien                     modified.
600236769Sobrien
601249033Ssjg     _._M_A_K_E_._P_A_T_H___F_I_L_E_M_O_N
602249033Ssjg                     If bbmmaakkee was built with filemon(4) support, this is set
603249033Ssjg                     to the path of the device node.  This allows makefiles to
604249033Ssjg                     test for this support.
605249033Ssjg
606236769Sobrien     _._M_A_K_E_._P_I_D       The process-id of bbmmaakkee.
607236769Sobrien
608236769Sobrien     _._M_A_K_E_._P_P_I_D      The parent process-id of bbmmaakkee.
609236769Sobrien
610236769Sobrien     _M_A_K_E___P_R_I_N_T___V_A_R___O_N___E_R_R_O_R
611236769Sobrien                     When bbmmaakkee stops due to an error, it prints its name and
612236769Sobrien                     the value of `_._C_U_R_D_I_R' as well as the value of any vari-
613236769Sobrien                     ables named in `_M_A_K_E___P_R_I_N_T___V_A_R___O_N___E_R_R_O_R'.
614236769Sobrien
615236769Sobrien     _._n_e_w_l_i_n_e        This variable is simply assigned a newline character as
616236769Sobrien                     its value.  This allows expansions using the ::@@ modifier
617236769Sobrien                     to put a newline between iterations of the loop rather
618236769Sobrien                     than a space.  For example, the printing of
619236769Sobrien                     `_M_A_K_E___P_R_I_N_T___V_A_R___O_N___E_R_R_O_R' could be done as
620236769Sobrien                     ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}.
621236769Sobrien
622236769Sobrien     _._O_B_J_D_I_R         A path to the directory where the targets are built.  Its
623236769Sobrien                     value is determined by trying to chdir(2) to the follow-
624236769Sobrien                     ing directories in order and using the first match:
625236769Sobrien
626236769Sobrien                     1.   ${MAKEOBJDIRPREFIX}${.CURDIR}
627236769Sobrien
628236769Sobrien                          (Only if `MAKEOBJDIRPREFIX' is set in the environ-
629236769Sobrien                          ment or on the command line.)
630236769Sobrien
631236769Sobrien                     2.   ${MAKEOBJDIR}
632236769Sobrien
633236769Sobrien                          (Only if `MAKEOBJDIR' is set in the environment or
634236769Sobrien                          on the command line.)
635236769Sobrien
636236769Sobrien                     3.   ${.CURDIR}_/_o_b_j_.${MACHINE}
637236769Sobrien
638236769Sobrien                     4.   ${.CURDIR}_/_o_b_j
639236769Sobrien
640236769Sobrien                     5.   _/_u_s_r_/_o_b_j_/${.CURDIR}
641236769Sobrien
642236769Sobrien                     6.   ${.CURDIR}
643236769Sobrien
644236769Sobrien                     Variable expansion is performed on the value before it's
645236769Sobrien                     used, so expressions such as
646236769Sobrien                           ${.CURDIR:S,^/usr/src,/var/obj,}
647236769Sobrien                     may be used.  This is especially useful with
648236769Sobrien                     `MAKEOBJDIR'.
649236769Sobrien
650284254Ssjg                     `_._O_B_J_D_I_R' may be modified in the makefile via the special
651284254Ssjg                     target `..OOBBJJDDIIRR'.  In all cases, bbmmaakkee will chdir(2) to
652284254Ssjg                     the specified directory if it exists, and set `_._O_B_J_D_I_R'
653284254Ssjg                     and `PWD' to that directory before executing any targets.
654236769Sobrien
655236769Sobrien     _._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
656236769Sobrien                     parsed.
657236769Sobrien
658236769Sobrien     _._P_A_R_S_E_F_I_L_E      The basename of the current `_M_a_k_e_f_i_l_e' being parsed.
659236769Sobrien                     This variable and `_._P_A_R_S_E_D_I_R' are both set only while the
660236769Sobrien                     `_M_a_k_e_f_i_l_e_s' are being parsed.  If you want to retain
661236769Sobrien                     their current values, assign them to a variable using
662236769Sobrien                     assignment with expansion: (`::==').
663236769Sobrien
664236769Sobrien     _._P_A_T_H           A variable that represents the list of directories that
665236769Sobrien                     bbmmaakkee will search for files.  The search list should be
666236769Sobrien                     updated using the target `_._P_A_T_H' rather than the vari-
667236769Sobrien                     able.
668236769Sobrien
669236769Sobrien     PWD             Alternate path to the current directory.  bbmmaakkee normally
670236769Sobrien                     sets `_._C_U_R_D_I_R' to the canonical path given by getcwd(3).
671236769Sobrien                     However, if the environment variable `PWD' is set and
672236769Sobrien                     gives a path to the current directory, then bbmmaakkee sets
673236769Sobrien                     `_._C_U_R_D_I_R' to the value of `PWD' instead.  This behaviour
674236769Sobrien                     is disabled if `MAKEOBJDIRPREFIX' is set or `MAKEOBJDIR'
675236769Sobrien                     contains a variable transform.  `PWD' is set to the value
676236769Sobrien                     of `_._O_B_J_D_I_R' for all programs which bbmmaakkee executes.
677236769Sobrien
678236769Sobrien     .TARGETS        The list of targets explicitly specified on the command
679236769Sobrien                     line, if any.
680236769Sobrien
681236769Sobrien     VPATH           Colon-separated (``:'') lists of directories that bbmmaakkee
682236769Sobrien                     will search for files.  The variable is supported for
683236769Sobrien                     compatibility with old make programs only, use `_._P_A_T_H'
684236769Sobrien                     instead.
685236769Sobrien
686236769Sobrien   VVaarriiaabbllee mmooddiiffiieerrss
687236769Sobrien     Variable expansion may be modified to select or modify each word of the
688236769Sobrien     variable (where a ``word'' is white-space delimited sequence of charac-
689236769Sobrien     ters).  The general format of a variable expansion is as follows:
690236769Sobrien
691236769Sobrien           ${variable[:modifier[:...]]}
692236769Sobrien
693236769Sobrien     Each modifier begins with a colon, which may be escaped with a backslash
694236769Sobrien     (`\').
695236769Sobrien
696236769Sobrien     A set of modifiers can be specified via a variable, as follows:
697236769Sobrien
698236769Sobrien           modifier_variable=modifier[:...]
699236769Sobrien           ${variable:${modifier_variable}[:...]}
700236769Sobrien
701236769Sobrien     In this case the first modifier in the modifier_variable does not start
702236769Sobrien     with a colon, since that must appear in the referencing variable.  If any
703236769Sobrien     of the modifiers in the modifier_variable contain a dollar sign (`$'),
704236769Sobrien     these must be doubled to avoid early expansion.
705236769Sobrien
706236769Sobrien     The supported modifiers are:
707236769Sobrien
708236769Sobrien     ::EE   Replaces each word in the variable with its suffix.
709236769Sobrien
710236769Sobrien     ::HH   Replaces each word in the variable with everything but the last com-
711236769Sobrien          ponent.
712236769Sobrien
713236769Sobrien     ::MM_p_a_t_t_e_r_n
714236769Sobrien          Select only those words that match _p_a_t_t_e_r_n.  The standard shell
715236769Sobrien          wildcard characters (`*', `?', and `[]') may be used.  The wildcard
716261212Ssjg          characters may be escaped with a backslash (`\').  As a consequence
717261212Ssjg          of the way values are split into words, matched, and then joined, a
718261212Ssjg          construct like
719261212Ssjg                ${VAR:M*}
720261212Ssjg          will normalise the inter-word spacing, removing all leading and
721261212Ssjg          trailing space, and converting multiple consecutive spaces to single
722261212Ssjg          spaces.
723236769Sobrien
724236769Sobrien     ::NN_p_a_t_t_e_r_n
725236769Sobrien          This is identical to `::MM', but selects all words which do not match
726236769Sobrien          _p_a_t_t_e_r_n.
727236769Sobrien
728236769Sobrien     ::OO   Order every word in variable alphabetically.  To sort words in
729236769Sobrien          reverse order use the `::OO::[[--11....11]]' combination of modifiers.
730236769Sobrien
731236769Sobrien     ::OOxx  Randomize words in variable.  The results will be different each
732236769Sobrien          time you are referring to the modified variable; use the assignment
733236769Sobrien          with expansion (`::==') to prevent such behaviour.  For example,
734236769Sobrien
735236769Sobrien                LIST=                   uno due tre quattro
736236769Sobrien                RANDOM_LIST=            ${LIST:Ox}
737236769Sobrien                STATIC_RANDOM_LIST:=    ${LIST:Ox}
738236769Sobrien
739236769Sobrien                all:
740236769Sobrien                        @echo "${RANDOM_LIST}"
741236769Sobrien                        @echo "${RANDOM_LIST}"
742236769Sobrien                        @echo "${STATIC_RANDOM_LIST}"
743236769Sobrien                        @echo "${STATIC_RANDOM_LIST}"
744236769Sobrien          may produce output similar to:
745236769Sobrien
746236769Sobrien                quattro due tre uno
747236769Sobrien                tre due quattro uno
748236769Sobrien                due uno quattro tre
749236769Sobrien                due uno quattro tre
750236769Sobrien
751236769Sobrien     ::QQ   Quotes every shell meta-character in the variable, so that it can be
752236769Sobrien          passed safely through recursive invocations of bbmmaakkee.
753236769Sobrien
754236769Sobrien     ::RR   Replaces each word in the variable with everything but its suffix.
755236769Sobrien
756236769Sobrien     ::ggmmttiimmee
757236769Sobrien          The value is a format string for strftime(3), using the current
758236769Sobrien          gmtime(3).
759236769Sobrien
760236769Sobrien     ::hhaasshh
761236769Sobrien          Compute a 32bit hash of the value and encode it as hex digits.
762236769Sobrien
763236769Sobrien     ::llooccaallttiimmee
764236769Sobrien          The value is a format string for strftime(3), using the current
765236769Sobrien          localtime(3).
766236769Sobrien
767236769Sobrien     ::ttAA  Attempt to convert variable to an absolute path using realpath(3),
768236769Sobrien          if that fails, the value is unchanged.
769236769Sobrien
770236769Sobrien     ::ttll  Converts variable to lower-case letters.
771236769Sobrien
772236769Sobrien     ::ttss_c
773236769Sobrien          Words in the variable are normally separated by a space on expan-
774236769Sobrien          sion.  This modifier sets the separator to the character _c.  If _c is
775236769Sobrien          omitted, then no separator is used.  The common escapes (including
776236769Sobrien          octal numeric codes), work as expected.
777236769Sobrien
778236769Sobrien     ::ttuu  Converts variable to upper-case letters.
779236769Sobrien
780236769Sobrien     ::ttWW  Causes the value to be treated as a single word (possibly containing
781236769Sobrien          embedded white space).  See also `::[[**]]'.
782236769Sobrien
783236769Sobrien     ::ttww  Causes the value to be treated as a sequence of words delimited by
784236769Sobrien          white space.  See also `::[[@@]]'.
785236769Sobrien
786236769Sobrien     ::SS/_o_l_d___s_t_r_i_n_g/_n_e_w___s_t_r_i_n_g/[11ggWW]
787236769Sobrien          Modify the first occurrence of _o_l_d___s_t_r_i_n_g in the variable's value,
788236769Sobrien          replacing it with _n_e_w___s_t_r_i_n_g.  If a `g' is appended to the last
789236769Sobrien          slash of the pattern, all occurrences in each word are replaced.  If
790236769Sobrien          a `1' is appended to the last slash of the pattern, only the first
791236769Sobrien          word is affected.  If a `W' is appended to the last slash of the
792236769Sobrien          pattern, then the value is treated as a single word (possibly con-
793236769Sobrien          taining embedded white space).  If _o_l_d___s_t_r_i_n_g begins with a caret
794236769Sobrien          (`^'), _o_l_d___s_t_r_i_n_g is anchored at the beginning of each word.  If
795236769Sobrien          _o_l_d___s_t_r_i_n_g ends with a dollar sign (`$'), it is anchored at the end
796236769Sobrien          of each word.  Inside _n_e_w___s_t_r_i_n_g, an ampersand (`&') is replaced by
797236769Sobrien          _o_l_d___s_t_r_i_n_g (without any `^' or `$').  Any character may be used as a
798236769Sobrien          delimiter for the parts of the modifier string.  The anchoring,
799236769Sobrien          ampersand and delimiter characters may be escaped with a backslash
800236769Sobrien          (`\').
801236769Sobrien
802236769Sobrien          Variable expansion occurs in the normal fashion inside both
803236769Sobrien          _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
804236769Sobrien          is used to prevent the expansion of a dollar sign (`$'), not a pre-
805236769Sobrien          ceding dollar sign as is usual.
806236769Sobrien
807236769Sobrien     ::CC/_p_a_t_t_e_r_n/_r_e_p_l_a_c_e_m_e_n_t/[11ggWW]
808236769Sobrien          The ::CC modifier is just like the ::SS modifier except that the old and
809261212Ssjg          new strings, instead of being simple strings, are an extended regu-
810261212Ssjg          lar expression (see regex(3)) string _p_a_t_t_e_r_n and an ed(1)-style
811261212Ssjg          string _r_e_p_l_a_c_e_m_e_n_t.  Normally, the first occurrence of the pattern
812261212Ssjg          _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.
813261212Ssjg          The `1' modifier causes the substitution to apply to at most one
814261212Ssjg          word; the `g' modifier causes the substitution to apply to as many
815261212Ssjg          instances of the search pattern _p_a_t_t_e_r_n as occur in the word or
816261212Ssjg          words it is found in; the `W' modifier causes the value to be
817261212Ssjg          treated as a single word (possibly containing embedded white space).
818261212Ssjg          Note that `1' and `g' are orthogonal; the former specifies whether
819261212Ssjg          multiple words are potentially affected, the latter whether multiple
820261212Ssjg          substitutions can potentially occur within each affected word.
821236769Sobrien
822268437Ssjg          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
823268437Ssjg          variable expansion before being parsed as regular expressions.
824268437Ssjg
825236769Sobrien     ::TT   Replaces each word in the variable with its last component.
826236769Sobrien
827236769Sobrien     ::uu   Remove adjacent duplicate words (like uniq(1)).
828236769Sobrien
829236769Sobrien     ::??_t_r_u_e___s_t_r_i_n_g::_f_a_l_s_e___s_t_r_i_n_g
830236769Sobrien          If the variable name (not its value), when parsed as a .if condi-
831236769Sobrien          tional expression, evaluates to true, return as its value the
832236769Sobrien          _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
833236769Sobrien          name is used as the expression, :? must be the first modifier after
834236769Sobrien          the variable name itself - which will, of course, usually contain
835236769Sobrien          variable expansions.  A common error is trying to use expressions
836236769Sobrien          like
837236769Sobrien                ${NUMBERS:M42:?match:no}
838236769Sobrien          which actually tests defined(NUMBERS), to determine is any words
839236769Sobrien          match "42" you need to use something like:
840236769Sobrien                ${"${NUMBERS:M42}" != "":?match:no}.
841236769Sobrien
842236769Sobrien     _:_o_l_d___s_t_r_i_n_g_=_n_e_w___s_t_r_i_n_g
843236769Sobrien          This is the AT&T System V UNIX style variable substitution.  It must
844236769Sobrien          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
845236769Sobrien          contain the pattern matching character _% then it is assumed that
846236769Sobrien          they are anchored at the end of each word, so only suffixes or
847236769Sobrien          entire words may be replaced.  Otherwise _% is the substring of
848236769Sobrien          _o_l_d___s_t_r_i_n_g to be replaced in _n_e_w___s_t_r_i_n_g.
849236769Sobrien
850236769Sobrien          Variable expansion occurs in the normal fashion inside both
851236769Sobrien          _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
852236769Sobrien          is used to prevent the expansion of a dollar sign (`$'), not a pre-
853236769Sobrien          ceding dollar sign as is usual.
854236769Sobrien
855236769Sobrien     ::@@_t_e_m_p@@_s_t_r_i_n_g@@
856236769Sobrien          This is the loop expansion mechanism from the OSF Development Envi-
857236769Sobrien          ronment (ODE) make.  Unlike ..ffoorr loops expansion occurs at the time
858236769Sobrien          of reference.  Assign _t_e_m_p to each word in the variable and evaluate
859236769Sobrien          _s_t_r_i_n_g.  The ODE convention is that _t_e_m_p should start and end with a
860236769Sobrien          period.  For example.
861236769Sobrien                ${LINKS:@.LINK.@${LN} ${TARGET} ${.LINK.}@}
862236769Sobrien
863253883Ssjg          However a single character variable is often more readable:
864236769Sobrien                ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}
865236769Sobrien
866236769Sobrien     ::UU_n_e_w_v_a_l
867236769Sobrien          If the variable is undefined _n_e_w_v_a_l is the value.  If the variable
868236769Sobrien          is defined, the existing value is returned.  This is another ODE
869236769Sobrien          make feature.  It is handy for setting per-target CFLAGS for
870236769Sobrien          instance:
871236769Sobrien                ${_${.TARGET:T}_CFLAGS:U${DEF_CFLAGS}}
872236769Sobrien          If a value is only required if the variable is undefined, use:
873236769Sobrien                ${VAR:D:Unewval}
874236769Sobrien
875236769Sobrien     ::DD_n_e_w_v_a_l
876236769Sobrien          If the variable is defined _n_e_w_v_a_l is the value.
877236769Sobrien
878236769Sobrien     ::LL   The name of the variable is the value.
879236769Sobrien
880236769Sobrien     ::PP   The path of the node which has the same name as the variable is the
881236769Sobrien          value.  If no such node exists or its path is null, then the name of
882236769Sobrien          the variable is used.  In order for this modifier to work, the name
883236769Sobrien          (node) must at least have appeared on the rhs of a dependency.
884236769Sobrien
885236769Sobrien     ::!!_c_m_d!!
886236769Sobrien          The output of running _c_m_d is the value.
887236769Sobrien
888236769Sobrien     ::sshh  If the variable is non-empty it is run as a command and the output
889236769Sobrien          becomes the new value.
890236769Sobrien
891236769Sobrien     ::::==_s_t_r
892236769Sobrien          The variable is assigned the value _s_t_r after substitution.  This
893236769Sobrien          modifier and its variations are useful in obscure situations such as
894236769Sobrien          wanting to set a variable when shell commands are being parsed.
895236769Sobrien          These assignment modifiers always expand to nothing, so if appearing
896236769Sobrien          in a rule line by themselves should be preceded with something to
897236769Sobrien          keep bbmmaakkee happy.
898236769Sobrien
899236769Sobrien          The `::::' helps avoid false matches with the AT&T System V UNIX style
900236769Sobrien          ::== modifier and since substitution always occurs the ::::== form is
901236769Sobrien          vaguely appropriate.
902236769Sobrien
903236769Sobrien     ::::??==_s_t_r
904236769Sobrien          As for ::::== but only if the variable does not already have a value.
905236769Sobrien
906236769Sobrien     ::::++==_s_t_r
907236769Sobrien          Append _s_t_r to the variable.
908236769Sobrien
909236769Sobrien     ::::!!==_c_m_d
910236769Sobrien          Assign the output of _c_m_d to the variable.
911236769Sobrien
912236769Sobrien     ::[[_r_a_n_g_e]]
913236769Sobrien          Selects one or more words from the value, or performs other opera-
914236769Sobrien          tions related to the way in which the value is divided into words.
915236769Sobrien
916236769Sobrien          Ordinarily, a value is treated as a sequence of words delimited by
917236769Sobrien          white space.  Some modifiers suppress this behaviour, causing a
918236769Sobrien          value to be treated as a single word (possibly containing embedded
919236769Sobrien          white space).  An empty value, or a value that consists entirely of
920236769Sobrien          white-space, is treated as a single word.  For the purposes of the
921236769Sobrien          `::[[]]' modifier, the words are indexed both forwards using positive
922236769Sobrien          integers (where index 1 represents the first word), and backwards
923236769Sobrien          using negative integers (where index -1 represents the last word).
924236769Sobrien
925236769Sobrien          The _r_a_n_g_e is subjected to variable expansion, and the expanded
926236769Sobrien          result is then interpreted as follows:
927236769Sobrien
928236769Sobrien          _i_n_d_e_x  Selects a single word from the value.
929236769Sobrien
930236769Sobrien          _s_t_a_r_t...._e_n_d
931236769Sobrien                 Selects all words from _s_t_a_r_t to _e_n_d, inclusive.  For example,
932236769Sobrien                 `::[[22....--11]]' selects all words from the second word to the last
933236769Sobrien                 word.  If _s_t_a_r_t is greater than _e_n_d, then the words are out-
934236769Sobrien                 put in reverse order.  For example, `::[[--11....11]]' selects all
935236769Sobrien                 the words from last to first.
936236769Sobrien
937236769Sobrien          **      Causes subsequent modifiers to treat the value as a single
938236769Sobrien                 word (possibly containing embedded white space).  Analogous
939236769Sobrien                 to the effect of "$*" in Bourne shell.
940236769Sobrien
941236769Sobrien          0      Means the same as `::[[**]]'.
942236769Sobrien
943236769Sobrien          @@      Causes subsequent modifiers to treat the value as a sequence
944236769Sobrien                 of words delimited by white space.  Analogous to the effect
945236769Sobrien                 of "$@" in Bourne shell.
946236769Sobrien
947236769Sobrien          ##      Returns the number of words in the value.
948236769Sobrien
949236769SobrienIINNCCLLUUDDEE SSTTAATTEEMMEENNTTSS,, CCOONNDDIITTIIOONNAALLSS AANNDD FFOORR LLOOOOPPSS
950236769Sobrien     Makefile inclusion, conditional structures and for loops  reminiscent of
951236769Sobrien     the C programming language are provided in bbmmaakkee.  All such structures
952236769Sobrien     are identified by a line beginning with a single dot (`.') character.
953236769Sobrien     Files are included with either ..iinncclluuddee <_f_i_l_e> or ..iinncclluuddee "_f_i_l_e".  Vari-
954236769Sobrien     ables between the angle brackets or double quotes are expanded to form
955236769Sobrien     the file name.  If angle brackets are used, the included makefile is
956236769Sobrien     expected to be in the system makefile directory.  If double quotes are
957236769Sobrien     used, the including makefile's directory and any directories specified
958236769Sobrien     using the --II option are searched before the system makefile directory.
959236769Sobrien     For compatibility with other versions of bbmmaakkee `include file ...' is also
960236769Sobrien     accepted.  If the include statement is written as ..--iinncclluuddee or as
961236769Sobrien     ..ssiinncclluuddee then errors locating and/or opening include files are ignored.
962236769Sobrien
963236769Sobrien     Conditional expressions are also preceded by a single dot as the first
964236769Sobrien     character of a line.  The possible conditionals are as follows:
965236769Sobrien
966236769Sobrien     ..eerrrroorr _m_e_s_s_a_g_e
967236769Sobrien             The message is printed along with the name of the makefile and
968236769Sobrien             line number, then bbmmaakkee will exit.
969236769Sobrien
970236769Sobrien     ..eexxppoorrtt _v_a_r_i_a_b_l_e _._._.
971236769Sobrien             Export the specified global variable.  If no variable list is
972236769Sobrien             provided, all globals are exported except for internal variables
973236769Sobrien             (those that start with `.').  This is not affected by the --XX
974236769Sobrien             flag, so should be used with caution.  For compatibility with
975236769Sobrien             other bbmmaakkee programs `export variable=value' is also accepted.
976236769Sobrien
977236769Sobrien             Appending a variable name to _._M_A_K_E_._E_X_P_O_R_T_E_D is equivalent to
978236769Sobrien             exporting a variable.
979236769Sobrien
980236769Sobrien     ..eexxppoorrtt--eennvv _v_a_r_i_a_b_l_e _._._.
981236769Sobrien             The same as `.export', except that the variable is not appended
982236769Sobrien             to _._M_A_K_E_._E_X_P_O_R_T_E_D.  This allows exporting a value to the environ-
983236769Sobrien             ment which is different from that used by bbmmaakkee internally.
984236769Sobrien
985236769Sobrien     ..iinnffoo _m_e_s_s_a_g_e
986236769Sobrien             The message is printed along with the name of the makefile and
987236769Sobrien             line number.
988236769Sobrien
989236769Sobrien     ..uunnddeeff _v_a_r_i_a_b_l_e
990236769Sobrien             Un-define the specified global variable.  Only global variables
991236769Sobrien             may be un-defined.
992236769Sobrien
993236769Sobrien     ..uunneexxppoorrtt _v_a_r_i_a_b_l_e _._._.
994236769Sobrien             The opposite of `.export'.  The specified global _v_a_r_i_a_b_l_e will be
995236769Sobrien             removed from _._M_A_K_E_._E_X_P_O_R_T_E_D.  If no variable list is provided,
996236769Sobrien             all globals are unexported, and _._M_A_K_E_._E_X_P_O_R_T_E_D deleted.
997236769Sobrien
998236769Sobrien     ..uunneexxppoorrtt--eennvv
999236769Sobrien             Unexport all globals previously exported and clear the environ-
1000236769Sobrien             ment inherited from the parent.  This operation will cause a mem-
1001236769Sobrien             ory leak of the original environment, so should be used spar-
1002236769Sobrien             ingly.  Testing for _._M_A_K_E_._L_E_V_E_L being 0, would make sense.  Also
1003236769Sobrien             note that any variables which originated in the parent environ-
1004236769Sobrien             ment should be explicitly preserved if desired.  For example:
1005236769Sobrien
1006236769Sobrien                   .if ${.MAKE.LEVEL} == 0
1007236769Sobrien                   PATH := ${PATH}
1008236769Sobrien                   .unexport-env
1009236769Sobrien                   .export PATH
1010236769Sobrien                   .endif
1011236769Sobrien
1012236769Sobrien             Would result in an environment containing only `PATH', which is
1013236769Sobrien             the minimal useful environment.  Actually `.MAKE.LEVEL' will also
1014236769Sobrien             be pushed into the new environment.
1015236769Sobrien
1016236769Sobrien     ..wwaarrnniinngg _m_e_s_s_a_g_e
1017236769Sobrien             The message prefixed by `_w_a_r_n_i_n_g_:' is printed along with the name
1018236769Sobrien             of the makefile and line number.
1019236769Sobrien
1020236769Sobrien     ..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 _._._.]
1021236769Sobrien             Test the value of an expression.
1022236769Sobrien
1023236769Sobrien     ..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 _._._.]
1024236769Sobrien             Test the value of a variable.
1025236769Sobrien
1026236769Sobrien     ..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 _._._.]
1027236769Sobrien             Test the value of a variable.
1028236769Sobrien
1029236769Sobrien     ..iiffmmaakkee [!]_t_a_r_g_e_t [_o_p_e_r_a_t_o_r _t_a_r_g_e_t _._._.]
1030236769Sobrien             Test the target being built.
1031236769Sobrien
1032236769Sobrien     ..iiffnnmmaakkee [!] _t_a_r_g_e_t [_o_p_e_r_a_t_o_r _t_a_r_g_e_t _._._.]
1033236769Sobrien             Test the target being built.
1034236769Sobrien
1035236769Sobrien     ..eellssee   Reverse the sense of the last conditional.
1036236769Sobrien
1037236769Sobrien     ..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 _._._.]
1038236769Sobrien             A combination of `..eellssee' followed by `..iiff'.
1039236769Sobrien
1040236769Sobrien     ..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 _._._.]
1041236769Sobrien             A combination of `..eellssee' followed by `..iiffddeeff'.
1042236769Sobrien
1043236769Sobrien     ..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 _._._.]
1044236769Sobrien             A combination of `..eellssee' followed by `..iiffnnddeeff'.
1045236769Sobrien
1046236769Sobrien     ..eelliiffmmaakkee [!]_t_a_r_g_e_t [_o_p_e_r_a_t_o_r _t_a_r_g_e_t _._._.]
1047236769Sobrien             A combination of `..eellssee' followed by `..iiffmmaakkee'.
1048236769Sobrien
1049236769Sobrien     ..eelliiffnnmmaakkee [!]_t_a_r_g_e_t [_o_p_e_r_a_t_o_r _t_a_r_g_e_t _._._.]
1050236769Sobrien             A combination of `..eellssee' followed by `..iiffnnmmaakkee'.
1051236769Sobrien
1052236769Sobrien     ..eennddiiff  End the body of the conditional.
1053236769Sobrien
1054236769Sobrien     The _o_p_e_r_a_t_o_r may be any one of the following:
1055236769Sobrien
1056236769Sobrien     ||||     Logical OR.
1057236769Sobrien
1058236769Sobrien     &&&&     Logical AND; of higher precedence than ``||''.
1059236769Sobrien
1060236769Sobrien     As in C, bbmmaakkee will only evaluate a conditional as far as is necessary to
1061236769Sobrien     determine its value.  Parentheses may be used to change the order of
1062236769Sobrien     evaluation.  The boolean operator `!!' may be used to logically negate an
1063236769Sobrien     entire conditional.  It is of higher precedence than `&&&&'.
1064236769Sobrien
1065236769Sobrien     The value of _e_x_p_r_e_s_s_i_o_n may be any of the following:
1066236769Sobrien
1067236769Sobrien     ddeeffiinneedd  Takes a variable name as an argument and evaluates to true if
1068236769Sobrien              the variable has been defined.
1069236769Sobrien
1070236769Sobrien     mmaakkee     Takes a target name as an argument and evaluates to true if the
1071236769Sobrien              target was specified as part of bbmmaakkee's command line or was
1072236769Sobrien              declared the default target (either implicitly or explicitly,
1073236769Sobrien              see _._M_A_I_N) before the line containing the conditional.
1074236769Sobrien
1075236769Sobrien     eemmppttyy    Takes a variable, with possible modifiers, and evaluates to true
1076236769Sobrien              if the expansion of the variable would result in an empty
1077236769Sobrien              string.
1078236769Sobrien
1079236769Sobrien     eexxiissttss   Takes a file name as an argument and evaluates to true if the
1080236769Sobrien              file exists.  The file is searched for on the system search path
1081236769Sobrien              (see _._P_A_T_H).
1082236769Sobrien
1083236769Sobrien     ttaarrggeett   Takes a target name as an argument and evaluates to true if the
1084236769Sobrien              target has been defined.
1085236769Sobrien
1086236769Sobrien     ccoommmmaannddss
1087236769Sobrien              Takes a target name as an argument and evaluates to true if the
1088236769Sobrien              target has been defined and has commands associated with it.
1089236769Sobrien
1090236769Sobrien     _E_x_p_r_e_s_s_i_o_n may also be an arithmetic or string comparison.  Variable
1091236769Sobrien     expansion is performed on both sides of the comparison, after which the
1092236769Sobrien     integral values are compared.  A value is interpreted as hexadecimal if
1093236769Sobrien     it is preceded by 0x, otherwise it is decimal; octal numbers are not sup-
1094236769Sobrien     ported.  The standard C relational operators are all supported.  If after
1095236769Sobrien     variable expansion, either the left or right hand side of a `====' or `!!=='
1096236769Sobrien     operator is not an integral value, then string comparison is performed
1097236769Sobrien     between the expanded variables.  If no relational operator is given, it
1098236769Sobrien     is assumed that the expanded variable is being compared against 0 or an
1099236769Sobrien     empty string in the case of a string comparison.
1100236769Sobrien
1101236769Sobrien     When bbmmaakkee is evaluating one of these conditional expressions, and it
1102236769Sobrien     encounters a (white-space separated) word it doesn't recognize, either
1103236769Sobrien     the ``make'' or ``defined'' expression is applied to it, depending on the
1104236769Sobrien     form of the conditional.  If the form is `..iiffddeeff', `..iiffnnddeeff', or `..iiff'
1105236769Sobrien     the ``defined'' expression is applied.  Similarly, if the form is
1106236769Sobrien     `..iiffmmaakkee' or `..iiffnnmmaakkee, tthhee' ``make'' expression is applied.
1107236769Sobrien
1108236769Sobrien     If the conditional evaluates to true the parsing of the makefile contin-
1109236769Sobrien     ues as before.  If it evaluates to false, the following lines are
1110236769Sobrien     skipped.  In both cases this continues until a `..eellssee' or `..eennddiiff' is
1111236769Sobrien     found.
1112236769Sobrien
1113236769Sobrien     For loops are typically used to apply a set of rules to a list of files.
1114236769Sobrien     The syntax of a for loop is:
1115236769Sobrien
1116236769Sobrien     ..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
1117236769Sobrien     <make-rules>
1118236769Sobrien     ..eennddffoorr
1119236769Sobrien
1120236769Sobrien     After the for eexxpprreessssiioonn is evaluated, it is split into words.  On each
1121236769Sobrien     iteration of the loop, one word is taken and assigned to each vvaarriiaabbllee,
1122236769Sobrien     in order, and these vvaarriiaabblleess are substituted into the mmaakkee--rruulleess inside
1123236769Sobrien     the body of the for loop.  The number of words must come out even; that
1124236769Sobrien     is, if there are three iteration variables, the number of words provided
1125236769Sobrien     must be a multiple of three.
1126236769Sobrien
1127236769SobrienCCOOMMMMEENNTTSS
1128236769Sobrien     Comments begin with a hash (`#') character, anywhere but in a shell com-
1129236769Sobrien     mand line, and continue to the end of an unescaped new line.
1130236769Sobrien
1131236769SobrienSSPPEECCIIAALL SSOOUURRCCEESS ((AATTTTRRIIBBUUTTEESS))
1132236769Sobrien     ..EEXXEECC     Target is never out of date, but always execute commands any-
1133236769Sobrien               way.
1134236769Sobrien
1135236769Sobrien     ..IIGGNNOORREE   Ignore any errors from the commands associated with this tar-
1136236769Sobrien               get, exactly as if they all were preceded by a dash (`-').
1137236769Sobrien
1138236769Sobrien     ..MMAADDEE     Mark all sources of this target as being up-to-date.
1139236769Sobrien
1140236769Sobrien     ..MMAAKKEE     Execute the commands associated with this target even if the --nn
1141236769Sobrien               or --tt options were specified.  Normally used to mark recursive
1142261212Ssjg               bbmmaakkees.
1143236769Sobrien
1144236769Sobrien     ..MMEETTAA     Create a meta file for the target, even if it is flagged as
1145236769Sobrien               ..PPHHOONNYY, ..MMAAKKEE, or ..SSPPEECCIIAALL.  Usage in conjunction with ..MMAAKKEE is
1146236769Sobrien               the most likely case.  In "meta" mode, the target is out-of-
1147236769Sobrien               date if the meta file is missing.
1148236769Sobrien
1149236769Sobrien     ..NNOOMMEETTAA   Do not create a meta file for the target.  Meta files are also
1150236769Sobrien               not created for ..PPHHOONNYY, ..MMAAKKEE, or ..SSPPEECCIIAALL targets.
1151236769Sobrien
1152236769Sobrien     ..NNOOMMEETTAA__CCMMPP
1153236769Sobrien               Ignore differences in commands when deciding if target is out
1154236769Sobrien               of date.  This is useful if the command contains a value which
1155236769Sobrien               always changes.  If the number of commands change, though, the
1156249033Ssjg               target will still be out of date.  The same effect applies to
1157249033Ssjg               any command line that uses the variable _._O_O_D_A_T_E, which can be
1158249033Ssjg               used for that purpose even when not otherwise needed or
1159249033Ssjg               desired:
1160236769Sobrien
1161249033Ssjg
1162249033Ssjg                     skip-compare-for-some:
1163249033Ssjg                             @echo this will be compared
1164249033Ssjg                             @echo this will not ${.OODATE:M.NOMETA_CMP}
1165249033Ssjg                             @echo this will also be compared
1166249033Ssjg
1167249033Ssjg               The ::MM pattern suppresses any expansion of the unwanted vari-
1168249033Ssjg               able.
1169249033Ssjg
1170236769Sobrien     ..NNOOPPAATTHH   Do not search for the target in the directories specified by
1171236769Sobrien               ..PPAATTHH.
1172236769Sobrien
1173236769Sobrien     ..NNOOTTMMAAIINN  Normally bbmmaakkee selects the first target it encounters as the
1174236769Sobrien               default target to be built if no target was specified.  This
1175236769Sobrien               source prevents this target from being selected.
1176236769Sobrien
1177236769Sobrien     ..OOPPTTIIOONNAALL
1178236769Sobrien               If a target is marked with this attribute and bbmmaakkee can't fig-
1179236769Sobrien               ure out how to create it, it will ignore this fact and assume
1180236769Sobrien               the file isn't needed or already exists.
1181236769Sobrien
1182236769Sobrien     ..PPHHOONNYY    The target does not correspond to an actual file; it is always
1183236769Sobrien               considered to be out of date, and will not be created with the
1184236769Sobrien               --tt option.  Suffix-transformation rules are not applied to
1185236769Sobrien               ..PPHHOONNYY targets.
1186236769Sobrien
1187236769Sobrien     ..PPRREECCIIOOUUSS
1188236769Sobrien               When bbmmaakkee is interrupted, it normally removes any partially
1189236769Sobrien               made targets.  This source prevents the target from being
1190236769Sobrien               removed.
1191236769Sobrien
1192236769Sobrien     ..RREECCUURRSSIIVVEE
1193236769Sobrien               Synonym for ..MMAAKKEE.
1194236769Sobrien
1195236769Sobrien     ..SSIILLEENNTT   Do not echo any of the commands associated with this target,
1196236769Sobrien               exactly as if they all were preceded by an at sign (`@').
1197236769Sobrien
1198236769Sobrien     ..UUSSEE      Turn the target into bbmmaakkee's version of a macro.  When the tar-
1199236769Sobrien               get is used as a source for another target, the other target
1200236769Sobrien               acquires the commands, sources, and attributes (except for
1201236769Sobrien               ..UUSSEE) of the source.  If the target already has commands, the
1202236769Sobrien               ..UUSSEE target's commands are appended to them.
1203236769Sobrien
1204236769Sobrien     ..UUSSEEBBEEFFOORREE
1205236769Sobrien               Exactly like ..UUSSEE, but prepend the ..UUSSEEBBEEFFOORREE target commands
1206236769Sobrien               to the target.
1207236769Sobrien
1208236769Sobrien     ..WWAAIITT     If ..WWAAIITT appears in a dependency line, the sources that precede
1209236769Sobrien               it are made before the sources that succeed it in the line.
1210236769Sobrien               Since the dependents of files are not made until the file
1211236769Sobrien               itself could be made, this also stops the dependents being
1212236769Sobrien               built unless they are needed for another branch of the depen-
1213236769Sobrien               dency tree.  So given:
1214236769Sobrien
1215236769Sobrien               x: a .WAIT b
1216236769Sobrien                       echo x
1217236769Sobrien               a:
1218236769Sobrien                       echo a
1219236769Sobrien               b: b1
1220236769Sobrien                       echo b
1221236769Sobrien               b1:
1222236769Sobrien                       echo b1
1223236769Sobrien
1224236769Sobrien               the output is always `a', `b1', `b', `x'.
1225236769Sobrien               The ordering imposed by ..WWAAIITT is only relevant for parallel
1226236769Sobrien               makes.
1227236769Sobrien
1228236769SobrienSSPPEECCIIAALL TTAARRGGEETTSS
1229236769Sobrien     Special targets may not be included with other targets, i.e. they must be
1230236769Sobrien     the only target specified.
1231236769Sobrien
1232236769Sobrien     ..BBEEGGIINN   Any command lines attached to this target are executed before
1233236769Sobrien              anything else is done.
1234236769Sobrien
1235236769Sobrien     ..DDEEFFAAUULLTT
1236236769Sobrien              This is sort of a ..UUSSEE rule for any target (that was used only
1237236769Sobrien              as a source) that bbmmaakkee can't figure out any other way to cre-
1238236769Sobrien              ate.  Only the shell script is used.  The ..IIMMPPSSRRCC variable of a
1239236769Sobrien              target that inherits ..DDEEFFAAUULLTT's commands is set to the target's
1240236769Sobrien              own name.
1241236769Sobrien
1242236769Sobrien     ..EENNDD     Any command lines attached to this target are executed after
1243236769Sobrien              everything else is done.
1244236769Sobrien
1245236769Sobrien     ..EERRRROORR   Any command lines attached to this target are executed when
1246236769Sobrien              another target fails.  The ..EERRRROORR__TTAARRGGEETT variable is set to the
1247236769Sobrien              target that failed.  See also MMAAKKEE__PPRRIINNTT__VVAARR__OONN__EERRRROORR.
1248236769Sobrien
1249236769Sobrien     ..IIGGNNOORREE  Mark each of the sources with the ..IIGGNNOORREE attribute.  If no
1250236769Sobrien              sources are specified, this is the equivalent of specifying the
1251236769Sobrien              --ii option.
1252236769Sobrien
1253236769Sobrien     ..IINNTTEERRRRUUPPTT
1254236769Sobrien              If bbmmaakkee is interrupted, the commands for this target will be
1255236769Sobrien              executed.
1256236769Sobrien
1257236769Sobrien     ..MMAAIINN    If no target is specified when bbmmaakkee is invoked, this target
1258236769Sobrien              will be built.
1259236769Sobrien
1260236769Sobrien     ..MMAAKKEEFFLLAAGGSS
1261236769Sobrien              This target provides a way to specify flags for bbmmaakkee when the
1262236769Sobrien              makefile is used.  The flags are as if typed to the shell,
1263236769Sobrien              though the --ff option will have no effect.
1264236769Sobrien
1265236769Sobrien     ..NNOOPPAATTHH  Apply the ..NNOOPPAATTHH attribute to any specified sources.
1266236769Sobrien
1267236769Sobrien     ..NNOOTTPPAARRAALLLLEELL
1268236769Sobrien              Disable parallel mode.
1269236769Sobrien
1270236769Sobrien     ..NNOO__PPAARRAALLLLEELL
1271236769Sobrien              Synonym for ..NNOOTTPPAARRAALLLLEELL, for compatibility with other pmake
1272236769Sobrien              variants.
1273236769Sobrien
1274284254Ssjg     ..OOBBJJDDIIRR  The source is a new value for `_._O_B_J_D_I_R'.  If it exists, bbmmaakkee
1275284254Ssjg              will chdir(2) to it and update the value of `_._O_B_J_D_I_R'.
1276284254Ssjg
1277236769Sobrien     ..OORRDDEERR   The named targets are made in sequence.  This ordering does not
1278236769Sobrien              add targets to the list of targets to be made.  Since the depen-
1279236769Sobrien              dents of a target do not get built until the target itself could
1280236769Sobrien              be built, unless `a' is built by another part of the dependency
1281236769Sobrien              graph, the following is a dependency loop:
1282236769Sobrien
1283236769Sobrien              .ORDER: b a
1284236769Sobrien              b: a
1285236769Sobrien
1286236769Sobrien              The ordering imposed by ..OORRDDEERR is only relevant for parallel
1287236769Sobrien              makes.
1288236769Sobrien
1289236769Sobrien     ..PPAATTHH    The sources are directories which are to be searched for files
1290236769Sobrien              not found in the current directory.  If no sources are speci-
1291236769Sobrien              fied, any previously specified directories are deleted.  If the
1292236769Sobrien              source is the special ..DDOOTTLLAASSTT target, then the current working
1293236769Sobrien              directory is searched last.
1294236769Sobrien
1295255253Ssjg     ..PPAATTHH.._s_u_f_f_i_x
1296255253Ssjg              Like ..PPAATTHH but applies only to files with a particular suffix.
1297255253Ssjg              The suffix must have been previously declared with ..SSUUFFFFIIXXEESS.
1298255253Ssjg
1299236769Sobrien     ..PPHHOONNYY   Apply the ..PPHHOONNYY attribute to any specified sources.
1300236769Sobrien
1301236769Sobrien     ..PPRREECCIIOOUUSS
1302236769Sobrien              Apply the ..PPRREECCIIOOUUSS attribute to any specified sources.  If no
1303236769Sobrien              sources are specified, the ..PPRREECCIIOOUUSS attribute is applied to
1304236769Sobrien              every target in the file.
1305236769Sobrien
1306236769Sobrien     ..SSHHEELLLL   Sets the shell that bbmmaakkee will use to execute commands.  The
1307236769Sobrien              sources are a set of _f_i_e_l_d_=_v_a_l_u_e pairs.
1308236769Sobrien
1309236769Sobrien              _n_a_m_e        This is the minimal specification, used to select
1310236769Sobrien                          one of the builtin shell specs; _s_h, _k_s_h, and _c_s_h.
1311236769Sobrien
1312236769Sobrien              _p_a_t_h        Specifies the path to the shell.
1313236769Sobrien
1314236769Sobrien              _h_a_s_E_r_r_C_t_l   Indicates whether the shell supports exit on error.
1315236769Sobrien
1316236769Sobrien              _c_h_e_c_k       The command to turn on error checking.
1317236769Sobrien
1318236769Sobrien              _i_g_n_o_r_e      The command to disable error checking.
1319236769Sobrien
1320236769Sobrien              _e_c_h_o        The command to turn on echoing of commands executed.
1321236769Sobrien
1322236769Sobrien              _q_u_i_e_t       The command to turn off echoing of commands exe-
1323236769Sobrien                          cuted.
1324236769Sobrien
1325236769Sobrien              _f_i_l_t_e_r      The output to filter after issuing the _q_u_i_e_t com-
1326236769Sobrien                          mand.  It is typically identical to _q_u_i_e_t.
1327236769Sobrien
1328236769Sobrien              _e_r_r_F_l_a_g     The flag to pass the shell to enable error checking.
1329236769Sobrien
1330236769Sobrien              _e_c_h_o_F_l_a_g    The flag to pass the shell to enable command echo-
1331236769Sobrien                          ing.
1332236769Sobrien
1333236769Sobrien              _n_e_w_l_i_n_e     The string literal to pass the shell that results in
1334236769Sobrien                          a single newline character when used outside of any
1335236769Sobrien                          quoting characters.
1336236769Sobrien              Example:
1337236769Sobrien
1338236769Sobrien              .SHELL: name=ksh path=/bin/ksh hasErrCtl=true \
1339236769Sobrien                      check="set -e" ignore="set +e" \
1340236769Sobrien                      echo="set -v" quiet="set +v" filter="set +v" \
1341236769Sobrien                      echoFlag=v errFlag=e newline="'\n'"
1342236769Sobrien
1343236769Sobrien     ..SSIILLEENNTT  Apply the ..SSIILLEENNTT attribute to any specified sources.  If no
1344236769Sobrien              sources are specified, the ..SSIILLEENNTT attribute is applied to every
1345236769Sobrien              command in the file.
1346236769Sobrien
1347249033Ssjg     ..SSTTAALLEE   This target gets run when a dependency file contains stale
1348249033Ssjg              entries, having _._A_L_L_S_R_C set to the name of that dependency file.
1349249033Ssjg
1350236769Sobrien     ..SSUUFFFFIIXXEESS
1351236769Sobrien              Each source specifies a suffix to bbmmaakkee.  If no sources are
1352236769Sobrien              specified, any previously specified suffixes are deleted.  It
1353236769Sobrien              allows the creation of suffix-transformation rules.
1354236769Sobrien
1355236769Sobrien              Example:
1356236769Sobrien
1357236769Sobrien              .SUFFIXES: .o
1358236769Sobrien              .c.o:
1359236769Sobrien                      cc -o ${.TARGET} -c ${.IMPSRC}
1360236769Sobrien
1361236769SobrienEENNVVIIRROONNMMEENNTT
1362236769Sobrien     bbmmaakkee uses the following environment variables, if they exist: MACHINE,
1363236769Sobrien     MACHINE_ARCH, MAKE, MAKEFLAGS, MAKEOBJDIR, MAKEOBJDIRPREFIX, MAKESYSPATH,
1364236769Sobrien     PWD, and TMPDIR.
1365236769Sobrien
1366236769Sobrien     MAKEOBJDIRPREFIX and MAKEOBJDIR may only be set in the environment or on
1367236769Sobrien     the command line to bbmmaakkee and not as makefile variables; see the descrip-
1368236769Sobrien     tion of `_._O_B_J_D_I_R' for more details.
1369236769Sobrien
1370236769SobrienFFIILLEESS
1371236769Sobrien     .depend        list of dependencies
1372236769Sobrien     Makefile       list of dependencies
1373236769Sobrien     makefile       list of dependencies
1374236769Sobrien     sys.mk         system makefile
1375236769Sobrien     /usr/share/mk  system makefile directory
1376236769Sobrien
1377236769SobrienCCOOMMPPAATTIIBBIILLIITTYY
1378281812Ssjg     The basic make syntax is compatible between different versions of make;
1379236769Sobrien     however the special variables, variable modifiers and conditionals are
1380236769Sobrien     not.
1381236769Sobrien
1382281812Ssjg   OOllddeerr vveerrssiioonnss
1383281812Ssjg     An incomplete list of changes in older versions of bbmmaakkee:
1384236769Sobrien
1385236769Sobrien     The way that .for loop variables are substituted changed after NetBSD 5.0
1386236769Sobrien     so that they still appear to be variable expansions.  In particular this
1387236769Sobrien     stops them being treated as syntax, and removes some obscure problems
1388236769Sobrien     using them in .if statements.
1389236769Sobrien
1390281812Ssjg     The way that parallel makes are scheduled changed in NetBSD 4.0 so that
1391281812Ssjg     .ORDER and .WAIT apply recursively to the dependent nodes.  The algo-
1392281812Ssjg     rithms used may change again in the future.
1393281812Ssjg
1394281812Ssjg   OOtthheerr mmaakkee ddiiaalleeccttss
1395281812Ssjg     Other make dialects (GNU make, SVR4 make, POSIX make, etc.) do not sup-
1396281812Ssjg     port most of the features of bbmmaakkee as described in this manual.  Most
1397281812Ssjg     notably:
1398281812Ssjg
1399281812Ssjg           ++oo   The ..WWAAIITT and ..OORRDDEERR declarations and most functionality per-
1400281812Ssjg               taining to parallelization.  (GNU make supports parallelization
1401281812Ssjg               but lacks these features needed to control it effectively.)
1402281812Ssjg
1403281812Ssjg           ++oo   Directives, including for loops and conditionals and most of
1404281812Ssjg               the forms of include files.  (GNU make has its own incompatible
1405281812Ssjg               and less powerful syntax for conditionals.)
1406281812Ssjg
1407281812Ssjg           ++oo   All built-in variables that begin with a dot.
1408281812Ssjg
1409281812Ssjg           ++oo   Most of the special sources and targets that begin with a dot,
1410281812Ssjg               with the notable exception of ..PPHHOONNYY, ..PPRREECCIIOOUUSS, and ..SSUUFFFFIIXXEESS.
1411281812Ssjg
1412281812Ssjg           ++oo   Variable modifiers, except for the
1413281812Ssjg                     :old=new
1414281812Ssjg               string substitution, which does not portably support globbing
1415281812Ssjg               with `%' and historically only works on declared suffixes.
1416281812Ssjg
1417281812Ssjg           ++oo   The $$>> variable even in its short form; most makes support this
1418281812Ssjg               functionality but its name varies.
1419281812Ssjg
1420281812Ssjg     Some features are somewhat more portable, such as assignment with ++==, ??==,
1421281812Ssjg     and !!==.  The ..PPAATTHH functionality is based on an older feature VVPPAATTHH found
1422281812Ssjg     in GNU make and many versions of SVR4 make; however, historically its
1423281812Ssjg     behavior is too ill-defined (and too buggy) to rely upon.
1424281812Ssjg
1425281812Ssjg     The $$@@ and $$<< variables are more or less universally portable, as is the
1426281812Ssjg     $$((MMAAKKEE)) variable.  Basic use of suffix rules (for files only in the cur-
1427281812Ssjg     rent directory, not trying to chain transformations together, etc.) is
1428281812Ssjg     also reasonably portable.
1429281812Ssjg
1430236769SobrienSSEEEE AALLSSOO
1431236769Sobrien     mkdep(1)
1432236769Sobrien
1433236769SobrienHHIISSTTOORRYY
1434236769Sobrien     bbmmaakkee is derived from NetBSD make(1).  It uses autoconf to facilitate
1435236769Sobrien     portability to other platforms.
1436236769Sobrien
1437242102Ssjg     A make command appeared in Version 7 AT&T UNIX.  This make implementation
1438242102Ssjg     is based on Adam De Boor's pmake program which was written for Sprite at
1439242102Ssjg     Berkeley.  It was designed to be a parallel distributed make running jobs
1440242102Ssjg     on different machines using a daemon called ``customs''.
1441240330Smarcel
1442253883Ssjg     Historically the target/dependency ``FRC'' has been used to FoRCe
1443253883Ssjg     rebuilding (since the target/dependency does not exist... unless someone
1444253883Ssjg     creates an ``FRC'' file).
1445253883Ssjg
1446242102SsjgBBUUGGSS
1447242102Ssjg     The make syntax is difficult to parse without actually acting of the
1448242102Ssjg     data.  For instance finding the end of a variable use should involve
1449242102Ssjg     scanning each the modifiers using the correct terminator for each field.
1450242102Ssjg     In many places make just counts {} and () in order to find the end of a
1451242102Ssjg     variable expansion.
1452240330Smarcel
1453242102Ssjg     There is no way of escaping a space character in a filename.
1454240330Smarcel
1455284254SsjgNetBSD 5.1                       June 4, 2015                       NetBSD 5.1
1456