bmake.cat1 revision 300313
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
181296637Ssjg             towards the root of the file system.  If the search is success-
182296637Ssjg             ful, then the resulting directory replaces the ".../" specifica-
183296637Ssjg             tion in the --mm argument.  If used, this feature allows bbmmaakkee to
184296637Ssjg             easily search in the current source tree for customized sys.mk
185296637Ssjg             files (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
441297040Ssjg           _._T_A_R_G_E_T   The name of the target; also known as `_@'.  For compati-
442297040Ssjg                     bility with other makes this is an alias for ..AARRCCHHIIVVEE in
443297040Ssjg                     archive member rules.
444236769Sobrien
445281812Ssjg     The shorter forms (`_>', `_!', `_<', `_%', `_?', `_*', and `_@') are permitted
446281812Ssjg     for backward compatibility with historical makefiles and legacy POSIX
447281812Ssjg     make and are not recommended.
448236769Sobrien
449281812Ssjg     Variants of these variables with the punctuation followed immediately by
450281812Ssjg     `D' or `F', e.g.  `_$_(_@_D_)', are legacy forms equivalent to using the `:H'
451281812Ssjg     and `:T' modifiers.  These forms are accepted for compatibility with AT&T
452281812Ssjg     System V UNIX makefiles and POSIX but are not recommended.
453281812Ssjg
454281812Ssjg     Four of the local variables may be used in sources on dependency lines
455281812Ssjg     because they expand to the proper value for each target on the line.
456281812Ssjg     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'.
457281812Ssjg
458236769Sobrien   AAddddiittiioonnaall bbuuiilltt--iinn vvaarriiaabblleess
459236769Sobrien     In addition, bbmmaakkee sets or knows about the following variables:
460236769Sobrien
461236769Sobrien     _$               A single dollar sign `$', i.e.  `$$' expands to a single
462236769Sobrien                     dollar sign.
463236769Sobrien
464236769Sobrien     _._A_L_L_T_A_R_G_E_T_S     The list of all targets encountered in the Makefile.  If
465236769Sobrien                     evaluated during Makefile parsing, lists only those tar-
466236769Sobrien                     gets encountered thus far.
467236769Sobrien
468236769Sobrien     _._C_U_R_D_I_R         A path to the directory where bbmmaakkee was executed.  Refer
469236769Sobrien                     to the description of `PWD' for more details.
470236769Sobrien
471268437Ssjg     _._I_N_C_L_U_D_E_D_F_R_O_M_D_I_R
472268437Ssjg                     The directory of the file this Makefile was included
473268437Ssjg                     from.
474268437Ssjg
475268437Ssjg     _._I_N_C_L_U_D_E_D_F_R_O_M_F_I_L_E
476268437Ssjg                     The filename of the file this Makefile was included from.
477268437Ssjg
478236769Sobrien     MAKE            The name that bbmmaakkee was executed with (_a_r_g_v_[_0_]).  For
479236769Sobrien                     compatibility bbmmaakkee also sets _._M_A_K_E with the same value.
480236769Sobrien                     The preferred variable to use is the environment variable
481236769Sobrien                     MAKE because it is more compatible with other versions of
482236769Sobrien                     bbmmaakkee and cannot be confused with the special target with
483236769Sobrien                     the same name.
484236769Sobrien
485236769Sobrien     _._M_A_K_E_._D_E_P_E_N_D_F_I_L_E
486236769Sobrien                     Names the makefile (default `_._d_e_p_e_n_d') from which gener-
487236769Sobrien                     ated dependencies are read.
488236769Sobrien
489240330Smarcel     _._M_A_K_E_._E_X_P_A_N_D___V_A_R_I_A_B_L_E_S
490240330Smarcel                     A boolean that controls the default behavior of the --VV
491240330Smarcel                     option.
492240330Smarcel
493236769Sobrien     _._M_A_K_E_._E_X_P_O_R_T_E_D  The list of variables exported by bbmmaakkee.
494236769Sobrien
495236769Sobrien     _._M_A_K_E_._J_O_B_S      The argument to the --jj option.
496236769Sobrien
497236769Sobrien     _._M_A_K_E_._J_O_B_._P_R_E_F_I_X
498236769Sobrien                     If bbmmaakkee is run with _j then output for each target is
499236769Sobrien                     prefixed with a token `--- target ---' the first part of
500253883Ssjg                     which can be controlled via _._M_A_K_E_._J_O_B_._P_R_E_F_I_X.  If
501253883Ssjg                     _._M_A_K_E_._J_O_B_._P_R_E_F_I_X is empty, no token is printed.
502236769Sobrien                     For example:
503236769Sobrien                     .MAKE.JOB.PREFIX=${.newline}---${.MAKE:T}[${.MAKE.PID}]
504236769Sobrien                     would produce tokens like `---make[1234] target ---' mak-
505236769Sobrien                     ing it easier to track the degree of parallelism being
506236769Sobrien                     achieved.
507236769Sobrien
508236769Sobrien     MAKEFLAGS       The environment variable `MAKEFLAGS' may contain anything
509236769Sobrien                     that may be specified on bbmmaakkee's command line.  Anything
510236769Sobrien                     specified on bbmmaakkee's command line is appended to the
511236769Sobrien                     `MAKEFLAGS' variable which is then entered into the envi-
512236769Sobrien                     ronment for all programs which bbmmaakkee executes.
513236769Sobrien
514236769Sobrien     _._M_A_K_E_._L_E_V_E_L     The recursion depth of bbmmaakkee.  The initial instance of
515236769Sobrien                     bbmmaakkee will be 0, and an incremented value is put into the
516236769Sobrien                     environment to be seen by the next generation.  This
517236769Sobrien                     allows tests like: .if ${.MAKE.LEVEL} == 0 to protect
518236769Sobrien                     things which should only be evaluated in the initial
519236769Sobrien                     instance of bbmmaakkee.
520236769Sobrien
521236769Sobrien     _._M_A_K_E_._M_A_K_E_F_I_L_E___P_R_E_F_E_R_E_N_C_E
522236769Sobrien                     The ordered list of makefile names (default `_m_a_k_e_f_i_l_e',
523236769Sobrien                     `_M_a_k_e_f_i_l_e') that bbmmaakkee will look for.
524236769Sobrien
525236769Sobrien     _._M_A_K_E_._M_A_K_E_F_I_L_E_S
526236769Sobrien                     The list of makefiles read by bbmmaakkee, which is useful for
527236769Sobrien                     tracking dependencies.  Each makefile is recorded only
528236769Sobrien                     once, regardless of the number of times read.
529236769Sobrien
530236769Sobrien     _._M_A_K_E_._M_O_D_E      Processed after reading all makefiles.  Can affect the
531236769Sobrien                     mode that bbmmaakkee runs in.  It can contain a number of key-
532236769Sobrien                     words:
533236769Sobrien
534236769Sobrien                     _c_o_m_p_a_t      Like --BB, puts bbmmaakkee into "compat" mode.
535236769Sobrien
536236769Sobrien                     _m_e_t_a        Puts bbmmaakkee into "meta" mode, where meta files
537236769Sobrien                                 are created for each target to capture the
538236769Sobrien                                 command run, the output generated and if
539236769Sobrien                                 filemon(4) is available, the system calls
540236769Sobrien                                 which are of interest to bbmmaakkee.  The captured
541236769Sobrien                                 output can be very useful when diagnosing
542236769Sobrien                                 errors.
543236769Sobrien
544236769Sobrien                     _c_u_r_d_i_r_O_k_= _b_f Normally bbmmaakkee will not create .meta files
545236769Sobrien                                 in `_._C_U_R_D_I_R'.  This can be overridden by set-
546236769Sobrien                                 ting _b_f to a value which represents True.
547236769Sobrien
548296637Ssjg                     _e_n_v         For debugging, it can be useful to include
549236769Sobrien                                 the environment in the .meta file.
550236769Sobrien
551236769Sobrien                     _v_e_r_b_o_s_e     If in "meta" mode, print a clue about the
552236769Sobrien                                 target being built.  This is useful if the
553236769Sobrien                                 build is otherwise running silently.  The
554236769Sobrien                                 message printed the value of:
555236769Sobrien                                 _._M_A_K_E_._M_E_T_A_._P_R_E_F_I_X.
556236769Sobrien
557236769Sobrien                     _i_g_n_o_r_e_-_c_m_d  Some makefiles have commands which are simply
558236769Sobrien                                 not stable.  This keyword causes them to be
559236769Sobrien                                 ignored for determining whether a target is
560236769Sobrien                                 out of date in "meta" mode.  See also
561236769Sobrien                                 ..NNOOMMEETTAA__CCMMPP.
562236769Sobrien
563236769Sobrien                     _s_i_l_e_n_t_= _b_f  If _b_f is True, when a .meta file is created,
564236769Sobrien                                 mark the target ..SSIILLEENNTT.
565236769Sobrien
566236769Sobrien     _._M_A_K_E_._M_E_T_A_._B_A_I_L_I_W_I_C_K
567236769Sobrien                     In "meta" mode, provides a list of prefixes which match
568236769Sobrien                     the directories controlled by bbmmaakkee.  If a file that was
569236769Sobrien                     generated outside of _._O_B_J_D_I_R but within said bailiwick is
570236769Sobrien                     missing, the current target is considered out-of-date.
571236769Sobrien
572236769Sobrien     _._M_A_K_E_._M_E_T_A_._C_R_E_A_T_E_D
573236769Sobrien                     In "meta" mode, this variable contains a list of all the
574236769Sobrien                     meta files updated.  If not empty, it can be used to
575236769Sobrien                     trigger processing of _._M_A_K_E_._M_E_T_A_._F_I_L_E_S.
576236769Sobrien
577236769Sobrien     _._M_A_K_E_._M_E_T_A_._F_I_L_E_S
578236769Sobrien                     In "meta" mode, this variable contains a list of all the
579236769Sobrien                     meta files used (updated or not).  This list can be used
580236769Sobrien                     to process the meta files to extract dependency informa-
581236769Sobrien                     tion.
582236769Sobrien
583253883Ssjg     _._M_A_K_E_._M_E_T_A_._I_G_N_O_R_E___P_A_T_H_S
584253883Ssjg                     Provides a list of path prefixes that should be ignored;
585253883Ssjg                     because the contents are expected to change over time.
586253883Ssjg                     The default list includes: `_/_d_e_v _/_e_t_c _/_p_r_o_c _/_t_m_p _/_v_a_r_/_r_u_n
587253883Ssjg                     _/_v_a_r_/_t_m_p'
588253883Ssjg
589300313Ssjg     _._M_A_K_E_._M_E_T_A_._I_G_N_O_R_E___P_A_T_T_E_R_N_S
590300313Ssjg                     Provides a list of patterns to match against pathnames.
591300313Ssjg                     Ignore any that match.
592300313Ssjg
593236769Sobrien     _._M_A_K_E_._M_E_T_A_._P_R_E_F_I_X
594236769Sobrien                     Defines the message printed for each meta file updated in
595236769Sobrien                     "meta verbose" mode.  The default value is:
596236769Sobrien                           Building ${.TARGET:H:tA}/${.TARGET:T}
597236769Sobrien
598236769Sobrien     _._M_A_K_E_O_V_E_R_R_I_D_E_S  This variable is used to record the names of variables
599236769Sobrien                     assigned to on the command line, so that they may be
600296637Ssjg                     exported as part of `MAKEFLAGS'.  This behavior can be
601236769Sobrien                     disabled by assigning an empty value to `_._M_A_K_E_O_V_E_R_R_I_D_E_S'
602236769Sobrien                     within a makefile.  Extra variables can be exported from
603236769Sobrien                     a makefile by appending their names to `_._M_A_K_E_O_V_E_R_R_I_D_E_S'.
604236769Sobrien                     `MAKEFLAGS' is re-exported whenever `_._M_A_K_E_O_V_E_R_R_I_D_E_S' is
605236769Sobrien                     modified.
606236769Sobrien
607249033Ssjg     _._M_A_K_E_._P_A_T_H___F_I_L_E_M_O_N
608249033Ssjg                     If bbmmaakkee was built with filemon(4) support, this is set
609249033Ssjg                     to the path of the device node.  This allows makefiles to
610249033Ssjg                     test for this support.
611249033Ssjg
612236769Sobrien     _._M_A_K_E_._P_I_D       The process-id of bbmmaakkee.
613236769Sobrien
614236769Sobrien     _._M_A_K_E_._P_P_I_D      The parent process-id of bbmmaakkee.
615236769Sobrien
616296637Ssjg     _._M_A_K_E_._S_A_V_E___D_O_L_L_A_R_S
617296637Ssjg                     value should be a boolean that controls whether `$$' are
618296637Ssjg                     preserved when doing `:=' assignments.  The default is
619296637Ssjg                     false, for backwards compatibility.  Set to true for com-
620296637Ssjg                     patability with other makes.  If set to false, `$$'
621296637Ssjg                     becomes `$' per normal evaluation rules.
622296637Ssjg
623236769Sobrien     _M_A_K_E___P_R_I_N_T___V_A_R___O_N___E_R_R_O_R
624236769Sobrien                     When bbmmaakkee stops due to an error, it prints its name and
625236769Sobrien                     the value of `_._C_U_R_D_I_R' as well as the value of any vari-
626236769Sobrien                     ables named in `_M_A_K_E___P_R_I_N_T___V_A_R___O_N___E_R_R_O_R'.
627236769Sobrien
628236769Sobrien     _._n_e_w_l_i_n_e        This variable is simply assigned a newline character as
629236769Sobrien                     its value.  This allows expansions using the ::@@ modifier
630236769Sobrien                     to put a newline between iterations of the loop rather
631236769Sobrien                     than a space.  For example, the printing of
632236769Sobrien                     `_M_A_K_E___P_R_I_N_T___V_A_R___O_N___E_R_R_O_R' could be done as
633236769Sobrien                     ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}.
634236769Sobrien
635236769Sobrien     _._O_B_J_D_I_R         A path to the directory where the targets are built.  Its
636236769Sobrien                     value is determined by trying to chdir(2) to the follow-
637236769Sobrien                     ing directories in order and using the first match:
638236769Sobrien
639236769Sobrien                     1.   ${MAKEOBJDIRPREFIX}${.CURDIR}
640236769Sobrien
641236769Sobrien                          (Only if `MAKEOBJDIRPREFIX' is set in the environ-
642236769Sobrien                          ment or on the command line.)
643236769Sobrien
644236769Sobrien                     2.   ${MAKEOBJDIR}
645236769Sobrien
646236769Sobrien                          (Only if `MAKEOBJDIR' is set in the environment or
647236769Sobrien                          on the command line.)
648236769Sobrien
649236769Sobrien                     3.   ${.CURDIR}_/_o_b_j_.${MACHINE}
650236769Sobrien
651236769Sobrien                     4.   ${.CURDIR}_/_o_b_j
652236769Sobrien
653236769Sobrien                     5.   _/_u_s_r_/_o_b_j_/${.CURDIR}
654236769Sobrien
655236769Sobrien                     6.   ${.CURDIR}
656236769Sobrien
657236769Sobrien                     Variable expansion is performed on the value before it's
658236769Sobrien                     used, so expressions such as
659236769Sobrien                           ${.CURDIR:S,^/usr/src,/var/obj,}
660236769Sobrien                     may be used.  This is especially useful with
661236769Sobrien                     `MAKEOBJDIR'.
662236769Sobrien
663284254Ssjg                     `_._O_B_J_D_I_R' may be modified in the makefile via the special
664284254Ssjg                     target `..OOBBJJDDIIRR'.  In all cases, bbmmaakkee will chdir(2) to
665284254Ssjg                     the specified directory if it exists, and set `_._O_B_J_D_I_R'
666284254Ssjg                     and `PWD' to that directory before executing any targets.
667236769Sobrien
668236769Sobrien     _._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
669236769Sobrien                     parsed.
670236769Sobrien
671236769Sobrien     _._P_A_R_S_E_F_I_L_E      The basename of the current `_M_a_k_e_f_i_l_e' being parsed.
672236769Sobrien                     This variable and `_._P_A_R_S_E_D_I_R' are both set only while the
673236769Sobrien                     `_M_a_k_e_f_i_l_e_s' are being parsed.  If you want to retain
674236769Sobrien                     their current values, assign them to a variable using
675236769Sobrien                     assignment with expansion: (`::==').
676236769Sobrien
677236769Sobrien     _._P_A_T_H           A variable that represents the list of directories that
678236769Sobrien                     bbmmaakkee will search for files.  The search list should be
679236769Sobrien                     updated using the target `_._P_A_T_H' rather than the vari-
680236769Sobrien                     able.
681236769Sobrien
682236769Sobrien     PWD             Alternate path to the current directory.  bbmmaakkee normally
683236769Sobrien                     sets `_._C_U_R_D_I_R' to the canonical path given by getcwd(3).
684236769Sobrien                     However, if the environment variable `PWD' is set and
685236769Sobrien                     gives a path to the current directory, then bbmmaakkee sets
686296637Ssjg                     `_._C_U_R_D_I_R' to the value of `PWD' instead.  This behavior
687236769Sobrien                     is disabled if `MAKEOBJDIRPREFIX' is set or `MAKEOBJDIR'
688236769Sobrien                     contains a variable transform.  `PWD' is set to the value
689236769Sobrien                     of `_._O_B_J_D_I_R' for all programs which bbmmaakkee executes.
690236769Sobrien
691236769Sobrien     .TARGETS        The list of targets explicitly specified on the command
692236769Sobrien                     line, if any.
693236769Sobrien
694236769Sobrien     VPATH           Colon-separated (``:'') lists of directories that bbmmaakkee
695236769Sobrien                     will search for files.  The variable is supported for
696236769Sobrien                     compatibility with old make programs only, use `_._P_A_T_H'
697236769Sobrien                     instead.
698236769Sobrien
699236769Sobrien   VVaarriiaabbllee mmooddiiffiieerrss
700236769Sobrien     Variable expansion may be modified to select or modify each word of the
701236769Sobrien     variable (where a ``word'' is white-space delimited sequence of charac-
702236769Sobrien     ters).  The general format of a variable expansion is as follows:
703236769Sobrien
704236769Sobrien           ${variable[:modifier[:...]]}
705236769Sobrien
706236769Sobrien     Each modifier begins with a colon, which may be escaped with a backslash
707236769Sobrien     (`\').
708236769Sobrien
709236769Sobrien     A set of modifiers can be specified via a variable, as follows:
710236769Sobrien
711236769Sobrien           modifier_variable=modifier[:...]
712236769Sobrien           ${variable:${modifier_variable}[:...]}
713236769Sobrien
714236769Sobrien     In this case the first modifier in the modifier_variable does not start
715236769Sobrien     with a colon, since that must appear in the referencing variable.  If any
716236769Sobrien     of the modifiers in the modifier_variable contain a dollar sign (`$'),
717236769Sobrien     these must be doubled to avoid early expansion.
718236769Sobrien
719236769Sobrien     The supported modifiers are:
720236769Sobrien
721236769Sobrien     ::EE   Replaces each word in the variable with its suffix.
722236769Sobrien
723236769Sobrien     ::HH   Replaces each word in the variable with everything but the last com-
724236769Sobrien          ponent.
725236769Sobrien
726236769Sobrien     ::MM_p_a_t_t_e_r_n
727236769Sobrien          Select only those words that match _p_a_t_t_e_r_n.  The standard shell
728236769Sobrien          wildcard characters (`*', `?', and `[]') may be used.  The wildcard
729261212Ssjg          characters may be escaped with a backslash (`\').  As a consequence
730261212Ssjg          of the way values are split into words, matched, and then joined, a
731261212Ssjg          construct like
732261212Ssjg                ${VAR:M*}
733296637Ssjg          will normalize the inter-word spacing, removing all leading and
734261212Ssjg          trailing space, and converting multiple consecutive spaces to single
735261212Ssjg          spaces.
736236769Sobrien
737236769Sobrien     ::NN_p_a_t_t_e_r_n
738236769Sobrien          This is identical to `::MM', but selects all words which do not match
739236769Sobrien          _p_a_t_t_e_r_n.
740236769Sobrien
741236769Sobrien     ::OO   Order every word in variable alphabetically.  To sort words in
742236769Sobrien          reverse order use the `::OO::[[--11....11]]' combination of modifiers.
743236769Sobrien
744236769Sobrien     ::OOxx  Randomize words in variable.  The results will be different each
745236769Sobrien          time you are referring to the modified variable; use the assignment
746296637Ssjg          with expansion (`::==') to prevent such behavior.  For example,
747236769Sobrien
748236769Sobrien                LIST=                   uno due tre quattro
749236769Sobrien                RANDOM_LIST=            ${LIST:Ox}
750236769Sobrien                STATIC_RANDOM_LIST:=    ${LIST:Ox}
751236769Sobrien
752236769Sobrien                all:
753236769Sobrien                        @echo "${RANDOM_LIST}"
754236769Sobrien                        @echo "${RANDOM_LIST}"
755236769Sobrien                        @echo "${STATIC_RANDOM_LIST}"
756236769Sobrien                        @echo "${STATIC_RANDOM_LIST}"
757236769Sobrien          may produce output similar to:
758236769Sobrien
759236769Sobrien                quattro due tre uno
760236769Sobrien                tre due quattro uno
761236769Sobrien                due uno quattro tre
762236769Sobrien                due uno quattro tre
763236769Sobrien
764236769Sobrien     ::QQ   Quotes every shell meta-character in the variable, so that it can be
765236769Sobrien          passed safely through recursive invocations of bbmmaakkee.
766236769Sobrien
767236769Sobrien     ::RR   Replaces each word in the variable with everything but its suffix.
768236769Sobrien
769236769Sobrien     ::ggmmttiimmee
770236769Sobrien          The value is a format string for strftime(3), using the current
771236769Sobrien          gmtime(3).
772236769Sobrien
773236769Sobrien     ::hhaasshh
774296637Ssjg          Compute a 32-bit hash of the value and encode it as hex digits.
775236769Sobrien
776236769Sobrien     ::llooccaallttiimmee
777236769Sobrien          The value is a format string for strftime(3), using the current
778236769Sobrien          localtime(3).
779236769Sobrien
780236769Sobrien     ::ttAA  Attempt to convert variable to an absolute path using realpath(3),
781236769Sobrien          if that fails, the value is unchanged.
782236769Sobrien
783236769Sobrien     ::ttll  Converts variable to lower-case letters.
784236769Sobrien
785236769Sobrien     ::ttss_c
786236769Sobrien          Words in the variable are normally separated by a space on expan-
787236769Sobrien          sion.  This modifier sets the separator to the character _c.  If _c is
788236769Sobrien          omitted, then no separator is used.  The common escapes (including
789236769Sobrien          octal numeric codes), work as expected.
790236769Sobrien
791236769Sobrien     ::ttuu  Converts variable to upper-case letters.
792236769Sobrien
793236769Sobrien     ::ttWW  Causes the value to be treated as a single word (possibly containing
794236769Sobrien          embedded white space).  See also `::[[**]]'.
795236769Sobrien
796236769Sobrien     ::ttww  Causes the value to be treated as a sequence of words delimited by
797236769Sobrien          white space.  See also `::[[@@]]'.
798236769Sobrien
799236769Sobrien     ::SS/_o_l_d___s_t_r_i_n_g/_n_e_w___s_t_r_i_n_g/[11ggWW]
800236769Sobrien          Modify the first occurrence of _o_l_d___s_t_r_i_n_g in the variable's value,
801236769Sobrien          replacing it with _n_e_w___s_t_r_i_n_g.  If a `g' is appended to the last
802236769Sobrien          slash of the pattern, all occurrences in each word are replaced.  If
803236769Sobrien          a `1' is appended to the last slash of the pattern, only the first
804236769Sobrien          word is affected.  If a `W' is appended to the last slash of the
805236769Sobrien          pattern, then the value is treated as a single word (possibly con-
806236769Sobrien          taining embedded white space).  If _o_l_d___s_t_r_i_n_g begins with a caret
807236769Sobrien          (`^'), _o_l_d___s_t_r_i_n_g is anchored at the beginning of each word.  If
808236769Sobrien          _o_l_d___s_t_r_i_n_g ends with a dollar sign (`$'), it is anchored at the end
809236769Sobrien          of each word.  Inside _n_e_w___s_t_r_i_n_g, an ampersand (`&') is replaced by
810236769Sobrien          _o_l_d___s_t_r_i_n_g (without any `^' or `$').  Any character may be used as a
811236769Sobrien          delimiter for the parts of the modifier string.  The anchoring,
812236769Sobrien          ampersand and delimiter characters may be escaped with a backslash
813236769Sobrien          (`\').
814236769Sobrien
815236769Sobrien          Variable expansion occurs in the normal fashion inside both
816236769Sobrien          _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
817236769Sobrien          is used to prevent the expansion of a dollar sign (`$'), not a pre-
818236769Sobrien          ceding dollar sign as is usual.
819236769Sobrien
820236769Sobrien     ::CC/_p_a_t_t_e_r_n/_r_e_p_l_a_c_e_m_e_n_t/[11ggWW]
821236769Sobrien          The ::CC modifier is just like the ::SS modifier except that the old and
822261212Ssjg          new strings, instead of being simple strings, are an extended regu-
823261212Ssjg          lar expression (see regex(3)) string _p_a_t_t_e_r_n and an ed(1)-style
824261212Ssjg          string _r_e_p_l_a_c_e_m_e_n_t.  Normally, the first occurrence of the pattern
825261212Ssjg          _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.
826261212Ssjg          The `1' modifier causes the substitution to apply to at most one
827261212Ssjg          word; the `g' modifier causes the substitution to apply to as many
828261212Ssjg          instances of the search pattern _p_a_t_t_e_r_n as occur in the word or
829261212Ssjg          words it is found in; the `W' modifier causes the value to be
830261212Ssjg          treated as a single word (possibly containing embedded white space).
831261212Ssjg          Note that `1' and `g' are orthogonal; the former specifies whether
832261212Ssjg          multiple words are potentially affected, the latter whether multiple
833261212Ssjg          substitutions can potentially occur within each affected word.
834236769Sobrien
835268437Ssjg          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
836268437Ssjg          variable expansion before being parsed as regular expressions.
837268437Ssjg
838236769Sobrien     ::TT   Replaces each word in the variable with its last component.
839236769Sobrien
840236769Sobrien     ::uu   Remove adjacent duplicate words (like uniq(1)).
841236769Sobrien
842236769Sobrien     ::??_t_r_u_e___s_t_r_i_n_g::_f_a_l_s_e___s_t_r_i_n_g
843236769Sobrien          If the variable name (not its value), when parsed as a .if condi-
844236769Sobrien          tional expression, evaluates to true, return as its value the
845236769Sobrien          _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
846236769Sobrien          name is used as the expression, :? must be the first modifier after
847236769Sobrien          the variable name itself - which will, of course, usually contain
848236769Sobrien          variable expansions.  A common error is trying to use expressions
849236769Sobrien          like
850236769Sobrien                ${NUMBERS:M42:?match:no}
851236769Sobrien          which actually tests defined(NUMBERS), to determine is any words
852236769Sobrien          match "42" you need to use something like:
853236769Sobrien                ${"${NUMBERS:M42}" != "":?match:no}.
854236769Sobrien
855236769Sobrien     _:_o_l_d___s_t_r_i_n_g_=_n_e_w___s_t_r_i_n_g
856236769Sobrien          This is the AT&T System V UNIX style variable substitution.  It must
857236769Sobrien          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
858236769Sobrien          contain the pattern matching character _% then it is assumed that
859236769Sobrien          they are anchored at the end of each word, so only suffixes or
860236769Sobrien          entire words may be replaced.  Otherwise _% is the substring of
861236769Sobrien          _o_l_d___s_t_r_i_n_g to be replaced in _n_e_w___s_t_r_i_n_g.
862236769Sobrien
863236769Sobrien          Variable expansion occurs in the normal fashion inside both
864236769Sobrien          _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
865236769Sobrien          is used to prevent the expansion of a dollar sign (`$'), not a pre-
866236769Sobrien          ceding dollar sign as is usual.
867236769Sobrien
868236769Sobrien     ::@@_t_e_m_p@@_s_t_r_i_n_g@@
869236769Sobrien          This is the loop expansion mechanism from the OSF Development Envi-
870236769Sobrien          ronment (ODE) make.  Unlike ..ffoorr loops expansion occurs at the time
871236769Sobrien          of reference.  Assign _t_e_m_p to each word in the variable and evaluate
872236769Sobrien          _s_t_r_i_n_g.  The ODE convention is that _t_e_m_p should start and end with a
873236769Sobrien          period.  For example.
874236769Sobrien                ${LINKS:@.LINK.@${LN} ${TARGET} ${.LINK.}@}
875236769Sobrien
876253883Ssjg          However a single character variable is often more readable:
877236769Sobrien                ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}
878236769Sobrien
879236769Sobrien     ::UU_n_e_w_v_a_l
880236769Sobrien          If the variable is undefined _n_e_w_v_a_l is the value.  If the variable
881236769Sobrien          is defined, the existing value is returned.  This is another ODE
882236769Sobrien          make feature.  It is handy for setting per-target CFLAGS for
883236769Sobrien          instance:
884236769Sobrien                ${_${.TARGET:T}_CFLAGS:U${DEF_CFLAGS}}
885236769Sobrien          If a value is only required if the variable is undefined, use:
886236769Sobrien                ${VAR:D:Unewval}
887236769Sobrien
888236769Sobrien     ::DD_n_e_w_v_a_l
889236769Sobrien          If the variable is defined _n_e_w_v_a_l is the value.
890236769Sobrien
891236769Sobrien     ::LL   The name of the variable is the value.
892236769Sobrien
893236769Sobrien     ::PP   The path of the node which has the same name as the variable is the
894236769Sobrien          value.  If no such node exists or its path is null, then the name of
895236769Sobrien          the variable is used.  In order for this modifier to work, the name
896236769Sobrien          (node) must at least have appeared on the rhs of a dependency.
897236769Sobrien
898236769Sobrien     ::!!_c_m_d!!
899236769Sobrien          The output of running _c_m_d is the value.
900236769Sobrien
901236769Sobrien     ::sshh  If the variable is non-empty it is run as a command and the output
902236769Sobrien          becomes the new value.
903236769Sobrien
904236769Sobrien     ::::==_s_t_r
905236769Sobrien          The variable is assigned the value _s_t_r after substitution.  This
906236769Sobrien          modifier and its variations are useful in obscure situations such as
907236769Sobrien          wanting to set a variable when shell commands are being parsed.
908236769Sobrien          These assignment modifiers always expand to nothing, so if appearing
909236769Sobrien          in a rule line by themselves should be preceded with something to
910236769Sobrien          keep bbmmaakkee happy.
911236769Sobrien
912236769Sobrien          The `::::' helps avoid false matches with the AT&T System V UNIX style
913236769Sobrien          ::== modifier and since substitution always occurs the ::::== form is
914236769Sobrien          vaguely appropriate.
915236769Sobrien
916236769Sobrien     ::::??==_s_t_r
917236769Sobrien          As for ::::== but only if the variable does not already have a value.
918236769Sobrien
919236769Sobrien     ::::++==_s_t_r
920236769Sobrien          Append _s_t_r to the variable.
921236769Sobrien
922236769Sobrien     ::::!!==_c_m_d
923236769Sobrien          Assign the output of _c_m_d to the variable.
924236769Sobrien
925236769Sobrien     ::[[_r_a_n_g_e]]
926236769Sobrien          Selects one or more words from the value, or performs other opera-
927236769Sobrien          tions related to the way in which the value is divided into words.
928236769Sobrien
929236769Sobrien          Ordinarily, a value is treated as a sequence of words delimited by
930296637Ssjg          white space.  Some modifiers suppress this behavior, causing a value
931296637Ssjg          to be treated as a single word (possibly containing embedded white
932296637Ssjg          space).  An empty value, or a value that consists entirely of white-
933296637Ssjg          space, is treated as a single word.  For the purposes of the `::[[]]'
934296637Ssjg          modifier, the words are indexed both forwards using positive inte-
935296637Ssjg          gers (where index 1 represents the first word), and backwards using
936296637Ssjg          negative integers (where index -1 represents the last word).
937236769Sobrien
938236769Sobrien          The _r_a_n_g_e is subjected to variable expansion, and the expanded
939236769Sobrien          result is then interpreted as follows:
940236769Sobrien
941236769Sobrien          _i_n_d_e_x  Selects a single word from the value.
942236769Sobrien
943236769Sobrien          _s_t_a_r_t...._e_n_d
944236769Sobrien                 Selects all words from _s_t_a_r_t to _e_n_d, inclusive.  For example,
945236769Sobrien                 `::[[22....--11]]' selects all words from the second word to the last
946236769Sobrien                 word.  If _s_t_a_r_t is greater than _e_n_d, then the words are out-
947236769Sobrien                 put in reverse order.  For example, `::[[--11....11]]' selects all
948236769Sobrien                 the words from last to first.
949236769Sobrien
950236769Sobrien          **      Causes subsequent modifiers to treat the value as a single
951236769Sobrien                 word (possibly containing embedded white space).  Analogous
952236769Sobrien                 to the effect of "$*" in Bourne shell.
953236769Sobrien
954236769Sobrien          0      Means the same as `::[[**]]'.
955236769Sobrien
956236769Sobrien          @@      Causes subsequent modifiers to treat the value as a sequence
957236769Sobrien                 of words delimited by white space.  Analogous to the effect
958236769Sobrien                 of "$@" in Bourne shell.
959236769Sobrien
960236769Sobrien          ##      Returns the number of words in the value.
961236769Sobrien
962236769SobrienIINNCCLLUUDDEE SSTTAATTEEMMEENNTTSS,, CCOONNDDIITTIIOONNAALLSS AANNDD FFOORR LLOOOOPPSS
963236769Sobrien     Makefile inclusion, conditional structures and for loops  reminiscent of
964236769Sobrien     the C programming language are provided in bbmmaakkee.  All such structures
965236769Sobrien     are identified by a line beginning with a single dot (`.') character.
966236769Sobrien     Files are included with either ..iinncclluuddee <_f_i_l_e> or ..iinncclluuddee "_f_i_l_e".  Vari-
967236769Sobrien     ables between the angle brackets or double quotes are expanded to form
968236769Sobrien     the file name.  If angle brackets are used, the included makefile is
969236769Sobrien     expected to be in the system makefile directory.  If double quotes are
970236769Sobrien     used, the including makefile's directory and any directories specified
971236769Sobrien     using the --II option are searched before the system makefile directory.
972236769Sobrien     For compatibility with other versions of bbmmaakkee `include file ...' is also
973296637Ssjg     accepted.
974236769Sobrien
975296637Ssjg     If the include statement is written as ..--iinncclluuddee or as ..ssiinncclluuddee then
976296637Ssjg     errors locating and/or opening include files are ignored.
977296637Ssjg
978296637Ssjg     If the include statement is written as ..ddiinncclluuddee not only are errors
979296637Ssjg     locating and/or opening include files ignored, but stale dependencies
980296637Ssjg     within the included file will be ignored just like _._M_A_K_E_._D_E_P_E_N_D_F_I_L_E.
981296637Ssjg
982236769Sobrien     Conditional expressions are also preceded by a single dot as the first
983236769Sobrien     character of a line.  The possible conditionals are as follows:
984236769Sobrien
985236769Sobrien     ..eerrrroorr _m_e_s_s_a_g_e
986236769Sobrien             The message is printed along with the name of the makefile and
987236769Sobrien             line number, then bbmmaakkee will exit.
988236769Sobrien
989236769Sobrien     ..eexxppoorrtt _v_a_r_i_a_b_l_e _._._.
990236769Sobrien             Export the specified global variable.  If no variable list is
991236769Sobrien             provided, all globals are exported except for internal variables
992236769Sobrien             (those that start with `.').  This is not affected by the --XX
993236769Sobrien             flag, so should be used with caution.  For compatibility with
994236769Sobrien             other bbmmaakkee programs `export variable=value' is also accepted.
995236769Sobrien
996236769Sobrien             Appending a variable name to _._M_A_K_E_._E_X_P_O_R_T_E_D is equivalent to
997236769Sobrien             exporting a variable.
998236769Sobrien
999236769Sobrien     ..eexxppoorrtt--eennvv _v_a_r_i_a_b_l_e _._._.
1000236769Sobrien             The same as `.export', except that the variable is not appended
1001236769Sobrien             to _._M_A_K_E_._E_X_P_O_R_T_E_D.  This allows exporting a value to the environ-
1002236769Sobrien             ment which is different from that used by bbmmaakkee internally.
1003236769Sobrien
1004296637Ssjg     ..eexxppoorrtt--lliitteerraall _v_a_r_i_a_b_l_e _._._.
1005296637Ssjg             The same as `.export-env', except that variables in the value are
1006296637Ssjg             not expanded.
1007296637Ssjg
1008236769Sobrien     ..iinnffoo _m_e_s_s_a_g_e
1009236769Sobrien             The message is printed along with the name of the makefile and
1010236769Sobrien             line number.
1011236769Sobrien
1012236769Sobrien     ..uunnddeeff _v_a_r_i_a_b_l_e
1013236769Sobrien             Un-define the specified global variable.  Only global variables
1014236769Sobrien             may be un-defined.
1015236769Sobrien
1016236769Sobrien     ..uunneexxppoorrtt _v_a_r_i_a_b_l_e _._._.
1017236769Sobrien             The opposite of `.export'.  The specified global _v_a_r_i_a_b_l_e will be
1018236769Sobrien             removed from _._M_A_K_E_._E_X_P_O_R_T_E_D.  If no variable list is provided,
1019236769Sobrien             all globals are unexported, and _._M_A_K_E_._E_X_P_O_R_T_E_D deleted.
1020236769Sobrien
1021236769Sobrien     ..uunneexxppoorrtt--eennvv
1022236769Sobrien             Unexport all globals previously exported and clear the environ-
1023236769Sobrien             ment inherited from the parent.  This operation will cause a mem-
1024236769Sobrien             ory leak of the original environment, so should be used spar-
1025236769Sobrien             ingly.  Testing for _._M_A_K_E_._L_E_V_E_L being 0, would make sense.  Also
1026236769Sobrien             note that any variables which originated in the parent environ-
1027236769Sobrien             ment should be explicitly preserved if desired.  For example:
1028236769Sobrien
1029236769Sobrien                   .if ${.MAKE.LEVEL} == 0
1030236769Sobrien                   PATH := ${PATH}
1031236769Sobrien                   .unexport-env
1032236769Sobrien                   .export PATH
1033236769Sobrien                   .endif
1034236769Sobrien
1035236769Sobrien             Would result in an environment containing only `PATH', which is
1036236769Sobrien             the minimal useful environment.  Actually `.MAKE.LEVEL' will also
1037236769Sobrien             be pushed into the new environment.
1038236769Sobrien
1039236769Sobrien     ..wwaarrnniinngg _m_e_s_s_a_g_e
1040236769Sobrien             The message prefixed by `_w_a_r_n_i_n_g_:' is printed along with the name
1041236769Sobrien             of the makefile and line number.
1042236769Sobrien
1043236769Sobrien     ..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 _._._.]
1044236769Sobrien             Test the value of an expression.
1045236769Sobrien
1046236769Sobrien     ..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 _._._.]
1047236769Sobrien             Test the value of a variable.
1048236769Sobrien
1049236769Sobrien     ..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 _._._.]
1050236769Sobrien             Test the value of a variable.
1051236769Sobrien
1052236769Sobrien     ..iiffmmaakkee [!]_t_a_r_g_e_t [_o_p_e_r_a_t_o_r _t_a_r_g_e_t _._._.]
1053236769Sobrien             Test the target being built.
1054236769Sobrien
1055236769Sobrien     ..iiffnnmmaakkee [!] _t_a_r_g_e_t [_o_p_e_r_a_t_o_r _t_a_r_g_e_t _._._.]
1056236769Sobrien             Test the target being built.
1057236769Sobrien
1058236769Sobrien     ..eellssee   Reverse the sense of the last conditional.
1059236769Sobrien
1060236769Sobrien     ..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 _._._.]
1061236769Sobrien             A combination of `..eellssee' followed by `..iiff'.
1062236769Sobrien
1063236769Sobrien     ..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 _._._.]
1064236769Sobrien             A combination of `..eellssee' followed by `..iiffddeeff'.
1065236769Sobrien
1066236769Sobrien     ..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 _._._.]
1067236769Sobrien             A combination of `..eellssee' followed by `..iiffnnddeeff'.
1068236769Sobrien
1069236769Sobrien     ..eelliiffmmaakkee [!]_t_a_r_g_e_t [_o_p_e_r_a_t_o_r _t_a_r_g_e_t _._._.]
1070236769Sobrien             A combination of `..eellssee' followed by `..iiffmmaakkee'.
1071236769Sobrien
1072236769Sobrien     ..eelliiffnnmmaakkee [!]_t_a_r_g_e_t [_o_p_e_r_a_t_o_r _t_a_r_g_e_t _._._.]
1073236769Sobrien             A combination of `..eellssee' followed by `..iiffnnmmaakkee'.
1074236769Sobrien
1075236769Sobrien     ..eennddiiff  End the body of the conditional.
1076236769Sobrien
1077236769Sobrien     The _o_p_e_r_a_t_o_r may be any one of the following:
1078236769Sobrien
1079236769Sobrien     ||||     Logical OR.
1080236769Sobrien
1081236769Sobrien     &&&&     Logical AND; of higher precedence than ``||''.
1082236769Sobrien
1083236769Sobrien     As in C, bbmmaakkee will only evaluate a conditional as far as is necessary to
1084236769Sobrien     determine its value.  Parentheses may be used to change the order of
1085236769Sobrien     evaluation.  The boolean operator `!!' may be used to logically negate an
1086236769Sobrien     entire conditional.  It is of higher precedence than `&&&&'.
1087236769Sobrien
1088236769Sobrien     The value of _e_x_p_r_e_s_s_i_o_n may be any of the following:
1089236769Sobrien
1090236769Sobrien     ddeeffiinneedd  Takes a variable name as an argument and evaluates to true if
1091236769Sobrien              the variable has been defined.
1092236769Sobrien
1093236769Sobrien     mmaakkee     Takes a target name as an argument and evaluates to true if the
1094236769Sobrien              target was specified as part of bbmmaakkee's command line or was
1095236769Sobrien              declared the default target (either implicitly or explicitly,
1096236769Sobrien              see _._M_A_I_N) before the line containing the conditional.
1097236769Sobrien
1098236769Sobrien     eemmppttyy    Takes a variable, with possible modifiers, and evaluates to true
1099236769Sobrien              if the expansion of the variable would result in an empty
1100236769Sobrien              string.
1101236769Sobrien
1102236769Sobrien     eexxiissttss   Takes a file name as an argument and evaluates to true if the
1103236769Sobrien              file exists.  The file is searched for on the system search path
1104236769Sobrien              (see _._P_A_T_H).
1105236769Sobrien
1106236769Sobrien     ttaarrggeett   Takes a target name as an argument and evaluates to true if the
1107236769Sobrien              target has been defined.
1108236769Sobrien
1109236769Sobrien     ccoommmmaannddss
1110236769Sobrien              Takes a target name as an argument and evaluates to true if the
1111236769Sobrien              target has been defined and has commands associated with it.
1112236769Sobrien
1113236769Sobrien     _E_x_p_r_e_s_s_i_o_n may also be an arithmetic or string comparison.  Variable
1114236769Sobrien     expansion is performed on both sides of the comparison, after which the
1115236769Sobrien     integral values are compared.  A value is interpreted as hexadecimal if
1116236769Sobrien     it is preceded by 0x, otherwise it is decimal; octal numbers are not sup-
1117236769Sobrien     ported.  The standard C relational operators are all supported.  If after
1118236769Sobrien     variable expansion, either the left or right hand side of a `====' or `!!=='
1119236769Sobrien     operator is not an integral value, then string comparison is performed
1120236769Sobrien     between the expanded variables.  If no relational operator is given, it
1121236769Sobrien     is assumed that the expanded variable is being compared against 0 or an
1122236769Sobrien     empty string in the case of a string comparison.
1123236769Sobrien
1124236769Sobrien     When bbmmaakkee is evaluating one of these conditional expressions, and it
1125236769Sobrien     encounters a (white-space separated) word it doesn't recognize, either
1126236769Sobrien     the ``make'' or ``defined'' expression is applied to it, depending on the
1127236769Sobrien     form of the conditional.  If the form is `..iiffddeeff', `..iiffnnddeeff', or `..iiff'
1128236769Sobrien     the ``defined'' expression is applied.  Similarly, if the form is
1129236769Sobrien     `..iiffmmaakkee' or `..iiffnnmmaakkee, tthhee' ``make'' expression is applied.
1130236769Sobrien
1131236769Sobrien     If the conditional evaluates to true the parsing of the makefile contin-
1132236769Sobrien     ues as before.  If it evaluates to false, the following lines are
1133236769Sobrien     skipped.  In both cases this continues until a `..eellssee' or `..eennddiiff' is
1134236769Sobrien     found.
1135236769Sobrien
1136236769Sobrien     For loops are typically used to apply a set of rules to a list of files.
1137236769Sobrien     The syntax of a for loop is:
1138236769Sobrien
1139236769Sobrien     ..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
1140236769Sobrien     <make-rules>
1141236769Sobrien     ..eennddffoorr
1142236769Sobrien
1143236769Sobrien     After the for eexxpprreessssiioonn is evaluated, it is split into words.  On each
1144236769Sobrien     iteration of the loop, one word is taken and assigned to each vvaarriiaabbllee,
1145236769Sobrien     in order, and these vvaarriiaabblleess are substituted into the mmaakkee--rruulleess inside
1146236769Sobrien     the body of the for loop.  The number of words must come out even; that
1147236769Sobrien     is, if there are three iteration variables, the number of words provided
1148236769Sobrien     must be a multiple of three.
1149236769Sobrien
1150236769SobrienCCOOMMMMEENNTTSS
1151236769Sobrien     Comments begin with a hash (`#') character, anywhere but in a shell com-
1152236769Sobrien     mand line, and continue to the end of an unescaped new line.
1153236769Sobrien
1154236769SobrienSSPPEECCIIAALL SSOOUURRCCEESS ((AATTTTRRIIBBUUTTEESS))
1155236769Sobrien     ..EEXXEECC     Target is never out of date, but always execute commands any-
1156236769Sobrien               way.
1157236769Sobrien
1158236769Sobrien     ..IIGGNNOORREE   Ignore any errors from the commands associated with this tar-
1159236769Sobrien               get, exactly as if they all were preceded by a dash (`-').
1160236769Sobrien
1161236769Sobrien     ..MMAADDEE     Mark all sources of this target as being up-to-date.
1162236769Sobrien
1163236769Sobrien     ..MMAAKKEE     Execute the commands associated with this target even if the --nn
1164236769Sobrien               or --tt options were specified.  Normally used to mark recursive
1165261212Ssjg               bbmmaakkees.
1166236769Sobrien
1167236769Sobrien     ..MMEETTAA     Create a meta file for the target, even if it is flagged as
1168236769Sobrien               ..PPHHOONNYY, ..MMAAKKEE, or ..SSPPEECCIIAALL.  Usage in conjunction with ..MMAAKKEE is
1169236769Sobrien               the most likely case.  In "meta" mode, the target is out-of-
1170236769Sobrien               date if the meta file is missing.
1171236769Sobrien
1172236769Sobrien     ..NNOOMMEETTAA   Do not create a meta file for the target.  Meta files are also
1173236769Sobrien               not created for ..PPHHOONNYY, ..MMAAKKEE, or ..SSPPEECCIIAALL targets.
1174236769Sobrien
1175236769Sobrien     ..NNOOMMEETTAA__CCMMPP
1176236769Sobrien               Ignore differences in commands when deciding if target is out
1177236769Sobrien               of date.  This is useful if the command contains a value which
1178236769Sobrien               always changes.  If the number of commands change, though, the
1179249033Ssjg               target will still be out of date.  The same effect applies to
1180249033Ssjg               any command line that uses the variable _._O_O_D_A_T_E, which can be
1181249033Ssjg               used for that purpose even when not otherwise needed or
1182249033Ssjg               desired:
1183236769Sobrien
1184249033Ssjg
1185249033Ssjg                     skip-compare-for-some:
1186249033Ssjg                             @echo this will be compared
1187249033Ssjg                             @echo this will not ${.OODATE:M.NOMETA_CMP}
1188249033Ssjg                             @echo this will also be compared
1189249033Ssjg
1190249033Ssjg               The ::MM pattern suppresses any expansion of the unwanted vari-
1191249033Ssjg               able.
1192249033Ssjg
1193236769Sobrien     ..NNOOPPAATTHH   Do not search for the target in the directories specified by
1194236769Sobrien               ..PPAATTHH.
1195236769Sobrien
1196236769Sobrien     ..NNOOTTMMAAIINN  Normally bbmmaakkee selects the first target it encounters as the
1197236769Sobrien               default target to be built if no target was specified.  This
1198236769Sobrien               source prevents this target from being selected.
1199236769Sobrien
1200236769Sobrien     ..OOPPTTIIOONNAALL
1201236769Sobrien               If a target is marked with this attribute and bbmmaakkee can't fig-
1202236769Sobrien               ure out how to create it, it will ignore this fact and assume
1203236769Sobrien               the file isn't needed or already exists.
1204236769Sobrien
1205236769Sobrien     ..PPHHOONNYY    The target does not correspond to an actual file; it is always
1206236769Sobrien               considered to be out of date, and will not be created with the
1207236769Sobrien               --tt option.  Suffix-transformation rules are not applied to
1208236769Sobrien               ..PPHHOONNYY targets.
1209236769Sobrien
1210236769Sobrien     ..PPRREECCIIOOUUSS
1211236769Sobrien               When bbmmaakkee is interrupted, it normally removes any partially
1212236769Sobrien               made targets.  This source prevents the target from being
1213236769Sobrien               removed.
1214236769Sobrien
1215236769Sobrien     ..RREECCUURRSSIIVVEE
1216236769Sobrien               Synonym for ..MMAAKKEE.
1217236769Sobrien
1218236769Sobrien     ..SSIILLEENNTT   Do not echo any of the commands associated with this target,
1219236769Sobrien               exactly as if they all were preceded by an at sign (`@').
1220236769Sobrien
1221236769Sobrien     ..UUSSEE      Turn the target into bbmmaakkee's version of a macro.  When the tar-
1222236769Sobrien               get is used as a source for another target, the other target
1223236769Sobrien               acquires the commands, sources, and attributes (except for
1224236769Sobrien               ..UUSSEE) of the source.  If the target already has commands, the
1225236769Sobrien               ..UUSSEE target's commands are appended to them.
1226236769Sobrien
1227236769Sobrien     ..UUSSEEBBEEFFOORREE
1228236769Sobrien               Exactly like ..UUSSEE, but prepend the ..UUSSEEBBEEFFOORREE target commands
1229236769Sobrien               to the target.
1230236769Sobrien
1231236769Sobrien     ..WWAAIITT     If ..WWAAIITT appears in a dependency line, the sources that precede
1232236769Sobrien               it are made before the sources that succeed it in the line.
1233236769Sobrien               Since the dependents of files are not made until the file
1234236769Sobrien               itself could be made, this also stops the dependents being
1235236769Sobrien               built unless they are needed for another branch of the depen-
1236236769Sobrien               dency tree.  So given:
1237236769Sobrien
1238236769Sobrien               x: a .WAIT b
1239236769Sobrien                       echo x
1240236769Sobrien               a:
1241236769Sobrien                       echo a
1242236769Sobrien               b: b1
1243236769Sobrien                       echo b
1244236769Sobrien               b1:
1245236769Sobrien                       echo b1
1246236769Sobrien
1247236769Sobrien               the output is always `a', `b1', `b', `x'.
1248236769Sobrien               The ordering imposed by ..WWAAIITT is only relevant for parallel
1249236769Sobrien               makes.
1250236769Sobrien
1251236769SobrienSSPPEECCIIAALL TTAARRGGEETTSS
1252236769Sobrien     Special targets may not be included with other targets, i.e. they must be
1253236769Sobrien     the only target specified.
1254236769Sobrien
1255236769Sobrien     ..BBEEGGIINN   Any command lines attached to this target are executed before
1256236769Sobrien              anything else is done.
1257236769Sobrien
1258236769Sobrien     ..DDEEFFAAUULLTT
1259236769Sobrien              This is sort of a ..UUSSEE rule for any target (that was used only
1260236769Sobrien              as a source) that bbmmaakkee can't figure out any other way to cre-
1261236769Sobrien              ate.  Only the shell script is used.  The ..IIMMPPSSRRCC variable of a
1262236769Sobrien              target that inherits ..DDEEFFAAUULLTT's commands is set to the target's
1263236769Sobrien              own name.
1264236769Sobrien
1265236769Sobrien     ..EENNDD     Any command lines attached to this target are executed after
1266236769Sobrien              everything else is done.
1267236769Sobrien
1268236769Sobrien     ..EERRRROORR   Any command lines attached to this target are executed when
1269236769Sobrien              another target fails.  The ..EERRRROORR__TTAARRGGEETT variable is set to the
1270236769Sobrien              target that failed.  See also MMAAKKEE__PPRRIINNTT__VVAARR__OONN__EERRRROORR.
1271236769Sobrien
1272236769Sobrien     ..IIGGNNOORREE  Mark each of the sources with the ..IIGGNNOORREE attribute.  If no
1273236769Sobrien              sources are specified, this is the equivalent of specifying the
1274236769Sobrien              --ii option.
1275236769Sobrien
1276236769Sobrien     ..IINNTTEERRRRUUPPTT
1277236769Sobrien              If bbmmaakkee is interrupted, the commands for this target will be
1278236769Sobrien              executed.
1279236769Sobrien
1280236769Sobrien     ..MMAAIINN    If no target is specified when bbmmaakkee is invoked, this target
1281236769Sobrien              will be built.
1282236769Sobrien
1283236769Sobrien     ..MMAAKKEEFFLLAAGGSS
1284236769Sobrien              This target provides a way to specify flags for bbmmaakkee when the
1285236769Sobrien              makefile is used.  The flags are as if typed to the shell,
1286236769Sobrien              though the --ff option will have no effect.
1287236769Sobrien
1288236769Sobrien     ..NNOOPPAATTHH  Apply the ..NNOOPPAATTHH attribute to any specified sources.
1289236769Sobrien
1290236769Sobrien     ..NNOOTTPPAARRAALLLLEELL
1291236769Sobrien              Disable parallel mode.
1292236769Sobrien
1293236769Sobrien     ..NNOO__PPAARRAALLLLEELL
1294236769Sobrien              Synonym for ..NNOOTTPPAARRAALLLLEELL, for compatibility with other pmake
1295236769Sobrien              variants.
1296236769Sobrien
1297284254Ssjg     ..OOBBJJDDIIRR  The source is a new value for `_._O_B_J_D_I_R'.  If it exists, bbmmaakkee
1298284254Ssjg              will chdir(2) to it and update the value of `_._O_B_J_D_I_R'.
1299284254Ssjg
1300236769Sobrien     ..OORRDDEERR   The named targets are made in sequence.  This ordering does not
1301236769Sobrien              add targets to the list of targets to be made.  Since the depen-
1302236769Sobrien              dents of a target do not get built until the target itself could
1303236769Sobrien              be built, unless `a' is built by another part of the dependency
1304236769Sobrien              graph, the following is a dependency loop:
1305236769Sobrien
1306236769Sobrien              .ORDER: b a
1307236769Sobrien              b: a
1308236769Sobrien
1309236769Sobrien              The ordering imposed by ..OORRDDEERR is only relevant for parallel
1310236769Sobrien              makes.
1311236769Sobrien
1312236769Sobrien     ..PPAATTHH    The sources are directories which are to be searched for files
1313236769Sobrien              not found in the current directory.  If no sources are speci-
1314236769Sobrien              fied, any previously specified directories are deleted.  If the
1315236769Sobrien              source is the special ..DDOOTTLLAASSTT target, then the current working
1316236769Sobrien              directory is searched last.
1317236769Sobrien
1318255253Ssjg     ..PPAATTHH.._s_u_f_f_i_x
1319255253Ssjg              Like ..PPAATTHH but applies only to files with a particular suffix.
1320255253Ssjg              The suffix must have been previously declared with ..SSUUFFFFIIXXEESS.
1321255253Ssjg
1322236769Sobrien     ..PPHHOONNYY   Apply the ..PPHHOONNYY attribute to any specified sources.
1323236769Sobrien
1324236769Sobrien     ..PPRREECCIIOOUUSS
1325236769Sobrien              Apply the ..PPRREECCIIOOUUSS attribute to any specified sources.  If no
1326236769Sobrien              sources are specified, the ..PPRREECCIIOOUUSS attribute is applied to
1327236769Sobrien              every target in the file.
1328236769Sobrien
1329236769Sobrien     ..SSHHEELLLL   Sets the shell that bbmmaakkee will use to execute commands.  The
1330236769Sobrien              sources are a set of _f_i_e_l_d_=_v_a_l_u_e pairs.
1331236769Sobrien
1332236769Sobrien              _n_a_m_e        This is the minimal specification, used to select
1333296637Ssjg                          one of the built-in shell specs; _s_h, _k_s_h, and _c_s_h.
1334236769Sobrien
1335236769Sobrien              _p_a_t_h        Specifies the path to the shell.
1336236769Sobrien
1337236769Sobrien              _h_a_s_E_r_r_C_t_l   Indicates whether the shell supports exit on error.
1338236769Sobrien
1339236769Sobrien              _c_h_e_c_k       The command to turn on error checking.
1340236769Sobrien
1341236769Sobrien              _i_g_n_o_r_e      The command to disable error checking.
1342236769Sobrien
1343236769Sobrien              _e_c_h_o        The command to turn on echoing of commands executed.
1344236769Sobrien
1345236769Sobrien              _q_u_i_e_t       The command to turn off echoing of commands exe-
1346236769Sobrien                          cuted.
1347236769Sobrien
1348236769Sobrien              _f_i_l_t_e_r      The output to filter after issuing the _q_u_i_e_t com-
1349236769Sobrien                          mand.  It is typically identical to _q_u_i_e_t.
1350236769Sobrien
1351236769Sobrien              _e_r_r_F_l_a_g     The flag to pass the shell to enable error checking.
1352236769Sobrien
1353236769Sobrien              _e_c_h_o_F_l_a_g    The flag to pass the shell to enable command echo-
1354236769Sobrien                          ing.
1355236769Sobrien
1356236769Sobrien              _n_e_w_l_i_n_e     The string literal to pass the shell that results in
1357236769Sobrien                          a single newline character when used outside of any
1358236769Sobrien                          quoting characters.
1359236769Sobrien              Example:
1360236769Sobrien
1361236769Sobrien              .SHELL: name=ksh path=/bin/ksh hasErrCtl=true \
1362236769Sobrien                      check="set -e" ignore="set +e" \
1363236769Sobrien                      echo="set -v" quiet="set +v" filter="set +v" \
1364236769Sobrien                      echoFlag=v errFlag=e newline="'\n'"
1365236769Sobrien
1366236769Sobrien     ..SSIILLEENNTT  Apply the ..SSIILLEENNTT attribute to any specified sources.  If no
1367236769Sobrien              sources are specified, the ..SSIILLEENNTT attribute is applied to every
1368236769Sobrien              command in the file.
1369236769Sobrien
1370249033Ssjg     ..SSTTAALLEE   This target gets run when a dependency file contains stale
1371249033Ssjg              entries, having _._A_L_L_S_R_C set to the name of that dependency file.
1372249033Ssjg
1373236769Sobrien     ..SSUUFFFFIIXXEESS
1374236769Sobrien              Each source specifies a suffix to bbmmaakkee.  If no sources are
1375236769Sobrien              specified, any previously specified suffixes are deleted.  It
1376236769Sobrien              allows the creation of suffix-transformation rules.
1377236769Sobrien
1378236769Sobrien              Example:
1379236769Sobrien
1380236769Sobrien              .SUFFIXES: .o
1381236769Sobrien              .c.o:
1382236769Sobrien                      cc -o ${.TARGET} -c ${.IMPSRC}
1383236769Sobrien
1384236769SobrienEENNVVIIRROONNMMEENNTT
1385236769Sobrien     bbmmaakkee uses the following environment variables, if they exist: MACHINE,
1386236769Sobrien     MACHINE_ARCH, MAKE, MAKEFLAGS, MAKEOBJDIR, MAKEOBJDIRPREFIX, MAKESYSPATH,
1387236769Sobrien     PWD, and TMPDIR.
1388236769Sobrien
1389236769Sobrien     MAKEOBJDIRPREFIX and MAKEOBJDIR may only be set in the environment or on
1390236769Sobrien     the command line to bbmmaakkee and not as makefile variables; see the descrip-
1391236769Sobrien     tion of `_._O_B_J_D_I_R' for more details.
1392236769Sobrien
1393236769SobrienFFIILLEESS
1394236769Sobrien     .depend        list of dependencies
1395236769Sobrien     Makefile       list of dependencies
1396236769Sobrien     makefile       list of dependencies
1397236769Sobrien     sys.mk         system makefile
1398236769Sobrien     /usr/share/mk  system makefile directory
1399236769Sobrien
1400236769SobrienCCOOMMPPAATTIIBBIILLIITTYY
1401281812Ssjg     The basic make syntax is compatible between different versions of make;
1402236769Sobrien     however the special variables, variable modifiers and conditionals are
1403236769Sobrien     not.
1404236769Sobrien
1405281812Ssjg   OOllddeerr vveerrssiioonnss
1406281812Ssjg     An incomplete list of changes in older versions of bbmmaakkee:
1407236769Sobrien
1408236769Sobrien     The way that .for loop variables are substituted changed after NetBSD 5.0
1409236769Sobrien     so that they still appear to be variable expansions.  In particular this
1410236769Sobrien     stops them being treated as syntax, and removes some obscure problems
1411236769Sobrien     using them in .if statements.
1412236769Sobrien
1413281812Ssjg     The way that parallel makes are scheduled changed in NetBSD 4.0 so that
1414281812Ssjg     .ORDER and .WAIT apply recursively to the dependent nodes.  The algo-
1415281812Ssjg     rithms used may change again in the future.
1416281812Ssjg
1417281812Ssjg   OOtthheerr mmaakkee ddiiaalleeccttss
1418281812Ssjg     Other make dialects (GNU make, SVR4 make, POSIX make, etc.) do not sup-
1419281812Ssjg     port most of the features of bbmmaakkee as described in this manual.  Most
1420281812Ssjg     notably:
1421281812Ssjg
1422281812Ssjg           ++oo   The ..WWAAIITT and ..OORRDDEERR declarations and most functionality per-
1423281812Ssjg               taining to parallelization.  (GNU make supports parallelization
1424281812Ssjg               but lacks these features needed to control it effectively.)
1425281812Ssjg
1426281812Ssjg           ++oo   Directives, including for loops and conditionals and most of
1427281812Ssjg               the forms of include files.  (GNU make has its own incompatible
1428281812Ssjg               and less powerful syntax for conditionals.)
1429281812Ssjg
1430281812Ssjg           ++oo   All built-in variables that begin with a dot.
1431281812Ssjg
1432281812Ssjg           ++oo   Most of the special sources and targets that begin with a dot,
1433281812Ssjg               with the notable exception of ..PPHHOONNYY, ..PPRREECCIIOOUUSS, and ..SSUUFFFFIIXXEESS.
1434281812Ssjg
1435281812Ssjg           ++oo   Variable modifiers, except for the
1436281812Ssjg                     :old=new
1437281812Ssjg               string substitution, which does not portably support globbing
1438281812Ssjg               with `%' and historically only works on declared suffixes.
1439281812Ssjg
1440281812Ssjg           ++oo   The $$>> variable even in its short form; most makes support this
1441281812Ssjg               functionality but its name varies.
1442281812Ssjg
1443281812Ssjg     Some features are somewhat more portable, such as assignment with ++==, ??==,
1444281812Ssjg     and !!==.  The ..PPAATTHH functionality is based on an older feature VVPPAATTHH found
1445281812Ssjg     in GNU make and many versions of SVR4 make; however, historically its
1446281812Ssjg     behavior is too ill-defined (and too buggy) to rely upon.
1447281812Ssjg
1448281812Ssjg     The $$@@ and $$<< variables are more or less universally portable, as is the
1449281812Ssjg     $$((MMAAKKEE)) variable.  Basic use of suffix rules (for files only in the cur-
1450281812Ssjg     rent directory, not trying to chain transformations together, etc.) is
1451281812Ssjg     also reasonably portable.
1452281812Ssjg
1453236769SobrienSSEEEE AALLSSOO
1454236769Sobrien     mkdep(1)
1455236769Sobrien
1456236769SobrienHHIISSTTOORRYY
1457236769Sobrien     bbmmaakkee is derived from NetBSD make(1).  It uses autoconf to facilitate
1458236769Sobrien     portability to other platforms.
1459236769Sobrien
1460242102Ssjg     A make command appeared in Version 7 AT&T UNIX.  This make implementation
1461242102Ssjg     is based on Adam De Boor's pmake program which was written for Sprite at
1462242102Ssjg     Berkeley.  It was designed to be a parallel distributed make running jobs
1463242102Ssjg     on different machines using a daemon called ``customs''.
1464240330Smarcel
1465253883Ssjg     Historically the target/dependency ``FRC'' has been used to FoRCe
1466253883Ssjg     rebuilding (since the target/dependency does not exist... unless someone
1467253883Ssjg     creates an ``FRC'' file).
1468253883Ssjg
1469242102SsjgBBUUGGSS
1470242102Ssjg     The make syntax is difficult to parse without actually acting of the
1471242102Ssjg     data.  For instance finding the end of a variable use should involve
1472242102Ssjg     scanning each the modifiers using the correct terminator for each field.
1473242102Ssjg     In many places make just counts {} and () in order to find the end of a
1474242102Ssjg     variable expansion.
1475240330Smarcel
1476242102Ssjg     There is no way of escaping a space character in a filename.
1477240330Smarcel
1478300313SsjgNetBSD 5.1                       May 10, 2016                       NetBSD 5.1
1479