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