Annotation of src/usr.bin/make/make.1, Revision 1.57
1.57 ! jmc 1: .\" $OpenBSD: make.1,v 1.56 2003/09/04 22:14:43 jmc Exp $
1.40 espie 2: .\" $OpenPackages$
1.10 millert 3: .\" $NetBSD: make.1,v 1.18 1997/03/10 21:19:53 christos Exp $
1.7 briggs 4: .\"
1.9 millert 5: .\" Copyright (c) 1990, 1993
6: .\" The Regents of the University of California. All rights reserved.
1.1 deraadt 7: .\"
8: .\" Redistribution and use in source and binary forms, with or without
9: .\" modification, are permitted provided that the following conditions
10: .\" are met:
11: .\" 1. Redistributions of source code must retain the above copyright
12: .\" notice, this list of conditions and the following disclaimer.
13: .\" 2. Redistributions in binary form must reproduce the above copyright
14: .\" notice, this list of conditions and the following disclaimer in the
15: .\" documentation and/or other materials provided with the distribution.
1.51 millert 16: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 17: .\" may be used to endorse or promote products derived from this software
18: .\" without specific prior written permission.
19: .\"
20: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30: .\" SUCH DAMAGE.
31: .\"
1.9 millert 32: .\" from: @(#)make.1 8.4 (Berkeley) 3/19/94
1.1 deraadt 33: .\"
1.9 millert 34: .Dd March 19, 1994
1.1 deraadt 35: .Dt MAKE 1
36: .Os
37: .Sh NAME
38: .Nm make
39: .Nd maintain program dependencies
40: .Sh SYNOPSIS
1.19 aaron 41: .Nm make
1.15 espie 42: .Op Fl BPSeiknqrst
1.1 deraadt 43: .Op Fl D Ar variable
44: .Op Fl d Ar flags
45: .Op Fl f Ar makefile
46: .Op Fl I Ar directory
47: .Op Fl j Ar max_jobs
1.5 niklas 48: .Op Fl m Ar directory
1.9 millert 49: .Op Fl V Ar variable
1.19 aaron 50: .Op Ar variable Ns No = Ns Ar value
1.50 jmc 51: .Bk -words
1.1 deraadt 52: .Op Ar target ...
1.50 jmc 53: .Ek
1.1 deraadt 54: .Sh DESCRIPTION
1.19 aaron 55: .Nm
1.1 deraadt 56: is a program designed to simplify the maintenance of other programs.
57: Its input is a list of specifications as to the files upon which programs
58: and other files depend.
59: If the file
1.54 jmc 60: .Sq Pa BSDmakefile
1.12 niklas 61: exists, it is read for this list of specifications.
62: If it does not exist, the files
1.54 jmc 63: .Sq Pa makefile
1.12 niklas 64: and
1.54 jmc 65: .Sq Pa Makefile
1.12 niklas 66: are tried in order.
1.1 deraadt 67: If the file
1.54 jmc 68: .Sq Pa .depend
1.40 espie 69: exists, it is read in addition to the makefile (see
1.42 mpech 70: .Xr mkdep 1 ) .
1.1 deraadt 71: .Pp
1.43 espie 72: The handling of
1.54 jmc 73: .Sq Pa BSDmakefile
1.43 espie 74: and
1.54 jmc 75: .Sq Pa .depend
1.43 espie 76: are BSD extensions.
77: .Pp
78: Standard options are as follows:
79: .Bl -tag -width Ds
80: .It Fl e
81: Specify that environment variables override macro assignments within
82: makefiles.
83: .It Fl f Ar makefile
84: Specify a makefile to read instead of the default
1.54 jmc 85: .Sq Pa makefile
1.43 espie 86: and
1.54 jmc 87: .Sq Pa Makefile .
1.43 espie 88: If
89: .Ar makefile
90: is
91: .Ql \- ,
92: standard input is read.
93: Multiple makefiles may be specified, and are read in the order specified.
94: .It Fl i
95: Ignore non-zero exit of shell commands in the makefile.
96: Equivalent to specifying
97: .Ql \-
98: before each command line in the makefile.
99: .It Fl k
100: Continue processing after errors are encountered, but only on those targets
101: that do not depend on the target whose creation caused the error.
102: .It Fl n
103: Display the commands that would have been executed, but do not actually
104: execute them.
105: .It Fl q
1.50 jmc 106: Do not execute any commands, but exit with status 0 if the specified targets
1.43 espie 107: are up-to-date, and 1 otherwise.
108: .It Fl r
109: Do not use the built-in rules specified in the system makefile.
110: .It Fl S
111: Stop processing when an error is encountered.
112: This is the default behavior.
113: This is needed to negate the
114: .Fl k
115: option during recursive builds.
116: .It Fl s
117: Do not echo commands as they are executed.
118: Equivalent to specifying
1.54 jmc 119: .Sq Ic @
1.43 espie 120: before each command line in the makefile.
121: .It Fl t
122: Rather than re-building a target as specified in the makefile, create it
123: or update its modification time to make it appear up-to-date.
124: .It Ar variable Ns No = Ns Ar value
125: Set the value of the variable
126: .Ar variable
127: to
128: .Ar value .
129: .El
1.1 deraadt 130: .Pp
1.43 espie 131: Extended options are as follows:
1.1 deraadt 132: .Bl -tag -width Ds
1.9 millert 133: .It Fl B
1.3 deraadt 134: Try to be backwards compatible by executing a single shell per command and
135: by executing the commands to make the sources of a dependency line in sequence.
1.15 espie 136: This is turned on by default unless
137: .Fl j
138: is used.
1.1 deraadt 139: .It Fl D Ar variable
140: Define
141: .Ar variable
1.40 espie 142: to be 1.
1.1 deraadt 143: .It Fl d Ar flags
144: Turn on debugging, and specify which portions of
1.19 aaron 145: .Nm
1.1 deraadt 146: are to print debugging information.
1.14 aaron 147: .Ar flags
1.1 deraadt 148: is one or more of the following:
149: .Bl -tag -width Ds
150: .It Ar A
151: Print all possible debugging information;
152: equivalent to specifying all of the debugging flags.
153: .It Ar a
154: Print debugging information about archive searching and caching.
155: .It Ar c
156: Print debugging information about conditional evaluation.
157: .It Ar d
158: Print debugging information about directory searching and caching.
1.15 espie 159: .It Ar f
1.40 espie 160: Print debugging information about the expansion of for loops.
1.1 deraadt 161: .It Ar "g1"
162: Print the input graph before making anything.
163: .It Ar "g2"
164: Print the input graph after making everything, or before exiting
165: on error.
166: .It Ar j
167: Print debugging information about running multiple shells.
1.40 espie 168: .It Ar l
169: Print commands in Makefile targets regardless of whether or not they are
170: prefixed by @.
171: Also known as loud behavior.
1.1 deraadt 172: .It Ar m
173: Print debugging information about making targets, including modification
174: dates.
175: .It Ar s
176: Print debugging information about suffix-transformation rules.
177: .It Ar t
178: Print debugging information about target list maintenance.
179: .It Ar v
180: Print debugging information about variable assignment.
181: .El
182: .It Fl I Ar directory
183: Specify a directory in which to search for makefiles and included makefiles.
1.5 niklas 184: The system makefile directory (or directories, see the
185: .Fl m
186: option) is automatically included as part of this list.
1.1 deraadt 187: .It Fl j Ar max_jobs
188: Specify the maximum number of jobs that
1.19 aaron 189: .Nm
1.28 aaron 190: may have running at any one time.
191: Turns compatibility mode off, unless the
1.57 ! jmc 192: .Fl B
1.3 deraadt 193: flag is also specified.
1.5 niklas 194: .It Fl m Ar directory
1.50 jmc 195: Specify a directory in which to search for
196: .Pa sys.mk
1.40 espie 197: and makefiles included
1.28 aaron 198: via the <...> style.
199: Multiple directories can be added to form a search path.
1.14 aaron 200: This path will override the default system include path:
201: .Pa /usr/share/mk .
202: Furthermore, the system include path will be appended to the search path used
1.5 niklas 203: for "..."-style inclusions (see the
204: .Fl I
205: option).
1.15 espie 206: .It Fl P
1.19 aaron 207: Collate the output of a given job and display it only when the job finishes,
208: instead of mixing the output of parallel jobs together.
209: This option has no effect unless
1.15 espie 210: .Fl j
211: is used too.
1.9 millert 212: .It Fl V Ar variable
213: Print
214: .Nm make Ns 's
215: idea of the value of
1.40 espie 216: .Ar variable .
1.9 millert 217: Do not build any targets.
218: Multiple instances of this option may be specified;
219: the variables will be printed one per line,
220: with a blank line for each null or undefined variable.
1.1 deraadt 221: .El
222: .Pp
223: There are seven different types of lines in a makefile: file dependency
224: specifications, shell commands, variable assignments, include statements,
225: conditional directives, for loops, and comments.
1.43 espie 226: Of these, include statements, conditional directives and for loops are
227: extensions.
1.1 deraadt 228: .Pp
229: In general, lines may be continued from one line to the next by ending
230: them with a backslash
231: .Pq Ql \e .
232: The trailing newline character and initial whitespace on the following
233: line are compressed into a single space.
234: .Sh FILE DEPENDENCY SPECIFICATIONS
235: Dependency lines consist of one or more targets, an operator, and zero
236: or more sources.
1.19 aaron 237: This creates a relationship where the targets
238: .Dq depend
239: on the sources
1.1 deraadt 240: and are usually created from them.
241: The exact relationship between the target and the source is determined
242: by the operator that separates them.
1.43 espie 243: Note that the use of several targets is merely a shorthand for duplicate
1.50 jmc 244: rules.
1.43 espie 245: Specifically,
1.57 ! jmc 246: .Bd -literal -offset indent
1.43 espie 247: target1 target2: depa depb
248: cmd1
249: cmd2
250: .Ed
1.57 ! jmc 251: .Pp
1.43 espie 252: is just a short form of
1.57 ! jmc 253: .Bd -literal -offset indent
1.43 espie 254: target1: depa depb
255: cmd1
256: cmd2
257: target2: depa depb
258: cmd1
259: cmd2
260: .Ed
261: .Pp
262: .Nm
263: does not support Solaris syntax for true multiple targets:
1.57 ! jmc 264: .Bd -literal -offset indent
1.43 espie 265: target1 + target2: depa depb
266: cmd1
267: cmd2
268: .Ed
269: .Pp
1.40 espie 270: The operators are as follows:
1.1 deraadt 271: .Bl -tag -width flag
272: .It Ic \&:
273: A target is considered out-of-date if its modification time is less than
274: those of any of its sources.
275: Sources for a target accumulate over dependency lines when this operator
276: is used.
277: The target is removed if
1.19 aaron 278: .Nm
1.1 deraadt 279: is interrupted.
280: .It Ic \&!
281: Targets are always re-created, but not until all sources have been
282: examined and re-created as necessary.
283: Sources for a target accumulate over dependency lines when this operator
284: is used.
285: The target is removed if
1.19 aaron 286: .Nm
1.1 deraadt 287: is interrupted.
288: .It Ic \&::
289: If no sources are specified, the target is always re-created.
290: Otherwise, a target is considered out-of-date if any of its sources has
291: been modified more recently than the target.
292: Sources for a target do not accumulate over dependency lines when this
293: operator is used.
294: The target will not be removed if
1.19 aaron 295: .Nm
1.1 deraadt 296: is interrupted.
297: .El
298: .Pp
1.43 espie 299: The
300: .Ic \&::
301: operator is a fairly standard extension.
302: The
1.56 jmc 303: .Ic !\&
1.43 espie 304: operator is a BSD extension.
305: .Pp
1.50 jmc 306: As an extension, targets and sources may contain the shell wildcard
1.43 espie 307: expressions
1.55 jmc 308: .Ql \&? ,
1.1 deraadt 309: .Ql * ,
310: .Ql []
311: and
312: .Ql {} .
1.15 espie 313: The expressions
1.55 jmc 314: .Ql \&? ,
1.1 deraadt 315: .Ql *
316: and
317: .Ql []
318: may only be used as part of the final
319: component of the target or source, and must be used to describe existing
320: files.
1.15 espie 321: The expression
1.1 deraadt 322: .Ql {}
323: need not necessarily be used to describe existing files.
324: Expansion is in directory order, not alphabetically as done in the shell.
1.43 espie 325: .Pp
326: For maximum portability, target names should only consist of periods,
327: underscores, digits and alphabetic characters.
1.1 deraadt 328: .Sh SHELL COMMANDS
329: Each target may have associated with it a series of shell commands, normally
330: used to create the target.
331: Each of the commands in this script
332: .Em must
333: be preceded by a tab.
334: While any target may appear on a dependency line, only one of these
335: dependencies may be followed by a creation script, unless the
1.54 jmc 336: .Sq Ic ::
1.1 deraadt 337: operator is used.
338: .Pp
1.34 espie 339: If a command line begins with a combination of the characters,
1.54 jmc 340: .Sq Ic @ ,
341: .Sq Ic \-
1.1 deraadt 342: and/or
1.54 jmc 343: .Sq Ic + ,
1.57 ! jmc 344: the command is treated specially:
1.33 espie 345: .Bl -tag -width `@'
1.54 jmc 346: .It Sq Ic @
1.1 deraadt 347: causes the command not to be echoed before it is executed.
1.54 jmc 348: .It Sq Ic \-
1.1 deraadt 349: causes any non-zero exit status of the command line to be ignored.
1.54 jmc 350: .It Sq Ic +
1.33 espie 351: causes the command to be executed even if
352: .Fl n
1.57 ! jmc 353: has been specified.
! 354: (This can be useful to debug recursive Makefiles.)
1.33 espie 355: .El
1.43 espie 356: .Pp
1.50 jmc 357: The command is always executed using
1.43 espie 358: .Pa /bin/sh
359: in
360: .Qq set -e
361: mode.
1.1 deraadt 362: .Sh VARIABLE ASSIGNMENTS
1.14 aaron 363: Variables in
1.19 aaron 364: .Nm
1.14 aaron 365: are much like variables in the shell, and, by tradition,
1.1 deraadt 366: consist of all upper-case letters.
1.43 espie 367: For portability, only periods, underscores, digits and letters should be
368: used for variable names.
1.1 deraadt 369: The five operators that can be used to assign values to variables are as
370: follows:
371: .Bl -tag -width Ds
372: .It Ic \&=
373: Assign the value to the variable.
374: Any previous value is overridden.
1.43 espie 375: .It Ic \&:=
376: Assign with expansion, i.e., expand the value before assigning it
1.57 ! jmc 377: to the variable (extension).
1.1 deraadt 378: .It Ic \&+=
1.43 espie 379: Append the value to the current value of the variable (extension).
1.1 deraadt 380: .It Ic \&?=
1.43 espie 381: Assign the value to the variable if it is not already defined (BSD
382: extension).
1.1 deraadt 383: Normally, expansion is not done until the variable is referenced.
384: .It Ic \&!=
385: Expand the value and pass it to the shell for execution and assign
386: the result to the variable.
1.43 espie 387: Any newlines in the result are replaced with spaces (BSD extension).
1.1 deraadt 388: .El
389: .Pp
1.14 aaron 390: Any whitespace before the assigned
1.1 deraadt 391: .Ar value
392: is removed; if the value is being appended, a single space is inserted
393: between the previous contents of the variable and the appended value.
394: .Pp
395: Variables are expanded by surrounding the variable name with either
396: curly braces
397: .Pq Ql {}
398: or parentheses
399: .Pq Ql ()
400: and preceding it with
401: a dollar sign
402: .Pq Ql \&$ .
403: If the variable name contains only a single letter, the surrounding
404: braces or parentheses are not required.
405: This shorter form is not recommended.
406: .Pp
407: Variable substitution occurs at two distinct times, depending on where
408: the variable is being used.
409: Variables in dependency lines are expanded as the line is read.
410: Variables in shell commands are expanded when the shell command is
411: executed.
412: .Pp
413: The four different classes of variables (in order of increasing precedence)
414: are:
415: .Bl -tag -width Ds
416: .It Environment variables
417: Variables defined as part of
418: .Nm make Ns 's
419: environment.
420: .It Global variables
421: Variables defined in the makefile or in included makefiles.
422: .It Command line variables
423: Variables defined as part of the command line.
424: .It Local variables
425: Variables that are defined specific to a certain target.
1.43 espie 426: Standard local variables are as follows:
1.1 deraadt 427: .Bl -tag -width ".ARCHIVE"
1.43 espie 428: .It Va @
429: The name of the target.
430: .It Va \&%
431: The name of the archive member (only valid for library rules).
432: .It Va \&!
433: The name of the archive file (only valid for library rules).
434: .It Va \&?
435: The list of prerequisites for this target that were deemed out-of-date.
436: .It Va \&<
437: The name of the source from which this target is to be built, if a valid
438: implied rule (suffix rule) is in scope.
439: .It Va *
440: The file prefix of the file, containing only the file portion,
441: no suffix or preceding directory components.
442: .El
443: .Pp
444: The six variables
1.54 jmc 445: .Sq Va "@F" ,
446: .Sq Va "@D" ,
447: .Sq Va "<F" ,
448: .Sq Va "<D" ,
449: .Sq Va "*F" ,
1.43 espie 450: and
1.54 jmc 451: .Sq Va "*D"
1.43 espie 452: yield the
453: .Qq filename
454: and
455: .Qq directory
456: parts of the corresponding macros.
457: .Pp
458: For maximum compatibility,
1.54 jmc 459: .Sq Va \&<
1.43 espie 460: should only be used for actual implied rules.
461: It is also set when there is an implied rule that matches the current
1.54 jmc 462: dependency in scope.
463: That is, in
1.57 ! jmc 464: .Bd -literal -offset indent
1.43 espie 465: \&.SUFFIXES: .c.o
466: file.o: file.c
467: cmd1 $<
468:
469: \&.c.o:
470: cmd2
471: .Ed
1.57 ! jmc 472: .Pp
1.43 espie 473: building
474: .Pa file.o
475: will execute
476: .Qq cmd1 file.c .
477: .Pp
478: As an extension,
479: .Nm
1.47 jsyn 480: supports the following local variables:
1.43 espie 481: .Bl -tag -width ".ARCHIVE"
482: .It Va \&>
483: The list of all sources for this target.
1.1 deraadt 484: .It Va .ALLSRC
1.43 espie 485: Synonym for
1.54 jmc 486: .Sq Va \&> .
1.1 deraadt 487: .It Va .ARCHIVE
1.43 espie 488: Synonym for
1.54 jmc 489: .Sq Va \&! .
1.1 deraadt 490: .It Va .IMPSRC
1.43 espie 491: Synonym for
1.54 jmc 492: .Sq Va \&< .
1.1 deraadt 493: .It Va .MEMBER
1.43 espie 494: Synonym for
1.54 jmc 495: .Sq Va \&% .
1.1 deraadt 496: .It Va .OODATE
1.43 espie 497: Synonym for
1.54 jmc 498: .Sq Va \&? .
1.1 deraadt 499: .It Va .PREFIX
1.43 espie 500: Synonym for
1.54 jmc 501: .Sq Va * .
1.1 deraadt 502: .It Va .TARGET
1.43 espie 503: Synonym for
1.54 jmc 504: .Sq Va @ .
1.1 deraadt 505: .El
506: .Pp
1.43 espie 507: These variables may be used on the dependency half of dependency
508: lines, when they make sense.
1.15 espie 509: .El
1.1 deraadt 510: .Pp
511: In addition,
1.19 aaron 512: .Nm
513: sets or knows about the following internal variables, or environment
1.15 espie 514: variables:
1.1 deraadt 515: .Bl -tag -width MAKEFLAGS
516: .It Va \&$
517: A single dollar sign
518: .Ql \&$ ,
1.29 aaron 519: i.e.,
1.1 deraadt 520: .Ql \&$$
521: expands to a single dollar
522: sign.
523: .It Va .MAKE
524: The name that
1.19 aaron 525: .Nm
1.1 deraadt 526: was executed with
1.14 aaron 527: .Pq Va argv Ns Op 0 .
1.1 deraadt 528: .It Va .CURDIR
529: A path to the directory where
1.19 aaron 530: .Nm
1.1 deraadt 531: was executed.
532: .It Va .OBJDIR
533: A path to the directory where the targets are built.
1.8 deraadt 534: At startup,
1.19 aaron 535: .Nm
1.8 deraadt 536: searches for an alternate directory to place target files -- it
537: will attempt to change into this special directory.
1.19 aaron 538: First, if
539: .Ev MAKEOBJDIRPREFIX
540: is defined,
541: .Nm
1.18 espie 542: prepends its contents to the current directory name and tries for
1.28 aaron 543: the resulting directory.
544: If that fails,
1.19 aaron 545: .Nm
1.18 espie 546: remains in the current directory.
1.19 aaron 547: If
1.15 espie 548: .Ev MAKEOBJDIRPREFIX
1.18 espie 549: is not defined,
1.19 aaron 550: .Nm
1.18 espie 551: checks
1.19 aaron 552: .Ev MAKEOBJDIR
1.28 aaron 553: and tries to change into that directory.
554: Should that fail,
1.19 aaron 555: .Nm
1.28 aaron 556: remains in the current directory.
557: If
1.18 espie 558: .Ev MAKEOBJDIR
559: is not defined, it tries to change into the directory named
560: .Pa obj.${MACHINE}
1.19 aaron 561: (see
562: .Va MACHINE
1.28 aaron 563: variable).
564: If it still has found no special directory,
1.19 aaron 565: .Nm
1.18 espie 566: next tries the directory named
567: .Pa obj .
568: If this fails,
1.19 aaron 569: .Nm
570: tries to prepend
571: .Pa /usr/obj
572: to the current directory name.
1.18 espie 573: Finally, if none of these directories are available
1.19 aaron 574: .Nm
1.8 deraadt 575: will settle for and use the current directory.
1.15 espie 576: .It Va .MAKEFLAGS
1.1 deraadt 577: The environment variable
1.14 aaron 578: .Ev MAKEFLAGS
1.1 deraadt 579: may contain anything that
580: may be specified on
581: .Nm make Ns 's
1.28 aaron 582: command line.
583: Its contents are stored in
1.15 espie 584: .Nm make Ns 's
1.19 aaron 585: .Va .MAKEFLAGS
1.15 espie 586: variable.
1.40 espie 587: Anything specified on
1.1 deraadt 588: .Nm make Ns 's
589: command line is appended to the
1.15 espie 590: .Va .MAKEFLAGS
591: variable which is then
1.19 aaron 592: entered into the environment as
1.14 aaron 593: .Ev MAKEFLAGS
1.15 espie 594: for all programs which
1.19 aaron 595: .Nm
1.1 deraadt 596: executes.
1.15 espie 597: .It Va MFLAGS
1.19 aaron 598: A shorter synonym for
1.15 espie 599: .Va .MAKEFLAGS .
1.9 millert 600: .It Ev PWD
601: Alternate path to the current directory.
1.19 aaron 602: .Nm
1.9 millert 603: normally sets
1.54 jmc 604: .Sq Va .CURDIR
1.9 millert 605: to the canonical path given by
1.49 jmc 606: .Xr getcwd 3 .
1.9 millert 607: However, if the environment variable
1.14 aaron 608: .Ev PWD
1.9 millert 609: is set and gives a path to the current directory, then
1.19 aaron 610: .Nm
1.9 millert 611: sets
1.54 jmc 612: .Sq Va .CURDIR
1.9 millert 613: to the value of
1.14 aaron 614: .Ev PWD
1.9 millert 615: instead.
1.14 aaron 616: .Ev PWD
1.15 espie 617: is always set to the value of
1.54 jmc 618: .Sq Va .OBJDIR
1.9 millert 619: for all programs which
1.19 aaron 620: .Nm
1.9 millert 621: executes.
1.15 espie 622: .It Va .TARGETS
1.19 aaron 623: List of targets
624: .Nm
1.18 espie 625: is currently building.
1.15 espie 626: .It Va .INCLUDES
1.19 aaron 627: See
1.18 espie 628: .Ic .INCLUDES
1.57 ! jmc 629: special target.
1.15 espie 630: .It Va .LIBS
1.19 aaron 631: See
1.18 espie 632: .Ic .LIBS
1.57 ! jmc 633: special target.
1.15 espie 634: .It Va MACHINE
1.19 aaron 635: Name of the machine architecture
636: .Nm
1.18 espie 637: is running on, obtained from the
638: .Ev MACHINE
1.19 aaron 639: environment variable, or through
1.44 deraadt 640: .Xr uname 3
1.18 espie 641: if not defined.
1.15 espie 642: .It Va MACHINE_ARCH
1.18 espie 643: Name of the machine architecture
1.19 aaron 644: .Nm
1.18 espie 645: was compiled for, obtained from the
1.19 aaron 646: .Ev MACHINE_ARCH
1.18 espie 647: environment variable, or defined at compilation time.
1.1 deraadt 648: .El
649: .Pp
650: Variable expansion may be modified to select or modify each word of the
1.48 pvalchev 651: variable (where
1.19 aaron 652: .Dq word
1.48 pvalchev 653: is a whitespace delimited sequence of characters).
1.1 deraadt 654: The general format of a variable expansion is as follows:
655: .Pp
656: .Dl {variable[:modifier[:...]]}
657: .Pp
658: Each modifier begins with a colon and one of the following
659: special characters.
660: The colon may be escaped with a backslash
661: .Pq Ql \e .
1.54 jmc 662: .Bl -tag -width Ds
1.1 deraadt 663: .It Cm E
664: Replaces each word in the variable with its suffix.
665: .It Cm H
666: Replaces each word in the variable with everything but the last component.
1.20 espie 667: .It Cm L
668: Replaces each word in the variable with its lower case equivalent.
669: .It Cm U
670: Replaces each word in the variable with its upper case equivalent.
1.1 deraadt 671: .It Cm M Ns Ar pattern
672: Select only those words that match the rest of the modifier.
673: The standard shell wildcard characters
674: .Pf ( Ql * ,
1.55 jmc 675: .Ql \&? ,
1.1 deraadt 676: and
1.54 jmc 677: .Ql [] )
1.1 deraadt 678: may
679: be used.
680: The wildcard characters may be escaped with a backslash
681: .Pq Ql \e .
682: .It Cm N Ns Ar pattern
683: This is identical to
1.14 aaron 684: .Cm M ,
1.1 deraadt 685: but selects all words which do not match
686: the rest of the modifier.
1.10 millert 687: .It Cm Q
688: Quotes every shell meta-character in the variable, so that it can be passed
689: safely through recursive invocations of
1.14 aaron 690: .Nm make .
1.1 deraadt 691: .It Cm R
692: Replaces each word in the variable with everything but its suffix.
693: .Sm off
1.10 millert 694: .It Cm S No \&/ Ar old_string Xo
695: .No \&/ Ar new_string
696: .No \&/ Op Cm 1g
1.1 deraadt 697: .Xc
698: .Sm on
699: Modify the first occurrence of
1.10 millert 700: .Ar old_string
701: in the variable's value, replacing it with
702: .Ar new_string .
1.1 deraadt 703: If a
704: .Ql g
705: is appended to the last slash of the pattern, all occurrences
706: in each word are replaced.
1.10 millert 707: If a
708: .Ql 1
709: is appended to the last slash of the pattern, only the first word
710: is affected.
1.1 deraadt 711: If
1.10 millert 712: .Ar old_string
713: begins with a caret
1.1 deraadt 714: .Pq Ql ^ ,
1.10 millert 715: .Ar old_string
1.1 deraadt 716: is anchored at the beginning of each word.
717: If
1.10 millert 718: .Ar old_string
1.1 deraadt 719: ends with a dollar sign
720: .Pq Ql \&$ ,
721: it is anchored at the end of each word.
722: Inside
723: .Ar new_string ,
724: an ampersand
725: .Pq Ql &
726: is replaced by
1.10 millert 727: .Ar old_string
728: (without any
729: .Ql ^
730: or
731: .Ql \&$ ) .
1.1 deraadt 732: Any character may be used as a delimiter for the parts of the modifier
733: string.
734: The anchoring, ampersand and delimiter characters may be escaped with a
735: backslash
736: .Pq Ql \e .
737: .Pp
738: Variable expansion occurs in the normal fashion inside both
739: .Ar old_string
740: and
741: .Ar new_string
742: with the single exception that a backslash is used to prevent the expansion
743: of a dollar sign
1.10 millert 744: .Pq Ql \&$ ,
1.1 deraadt 745: not a preceding dollar sign as is usual.
1.10 millert 746: .Sm off
747: .It Cm C No \&/ Ar pattern Xo
748: .No \&/ Ar replacement
749: .No \&/ Op Cm 1g
750: .Xc
751: .Sm on
752: The
753: .Cm C
754: modifier is just like the
755: .Cm S
1.13 deraadt 756: modifier except that the old and new strings, instead of being
1.10 millert 757: simple strings, are a regular expression (see
758: .Xr regex 3 )
759: and an
760: .Xr ed 1 Ns \-style
1.28 aaron 761: replacement string.
762: Normally, the first occurrence of the pattern in
763: each word of the value is changed.
764: The
1.10 millert 765: .Ql 1
766: modifier causes the substitution to apply to at most one word; the
767: .Ql g
768: modifier causes the substitution to apply to as many instances of the
1.28 aaron 769: search pattern as occur in the word or words it is found in.
770: Note that
1.10 millert 771: .Ql 1
772: and
773: .Ql g
774: are orthogonal; the former specifies whether multiple words are
775: potentially affected, the latter whether multiple substitutions can
776: potentially occur within each affected word.
1.1 deraadt 777: .It Cm T
778: Replaces each word in the variable with its last component.
1.39 aaron 779: .It Ar old_string Ns No = Ns Ar new_string
1.1 deraadt 780: This is the
781: .At V
782: style variable substitution.
783: It must be the last modifier specified.
1.9 millert 784: If
1.1 deraadt 785: .Ar old_string
786: or
787: .Ar new_string
788: do not contain the pattern matching character
789: .Ar %
1.9 millert 790: then it is assumed that they are
1.1 deraadt 791: anchored at the end of each word, so only suffixes or entire
1.28 aaron 792: words may be replaced.
793: Otherwise
1.1 deraadt 794: .Ar %
1.9 millert 795: is the substring of
796: .Ar old_string
1.1 deraadt 797: to be replaced in
1.53 jmc 798: .Ar new_string .
1.1 deraadt 799: .El
1.53 jmc 800: .Pp
1.50 jmc 801: All modifiers are BSD extensions, except for the standard
1.46 espie 802: .At V
803: style variable substitution.
1.1 deraadt 804: .Sh INCLUDE STATEMENTS, CONDITIONALS AND FOR LOOPS
1.28 aaron 805: Makefile inclusion, conditional structures and for loops reminiscent
1.1 deraadt 806: of the C programming language are provided in
807: .Nm make .
808: All such structures are identified by a line beginning with a single
809: dot
810: .Pq Ql \&.
811: character.
1.46 espie 812: Whitespace characters may follow this dot, e.g.,
1.57 ! jmc 813: .Bd -literal -offset indent
! 814: \&.include <file>
1.46 espie 815: .Ed
816: and
1.57 ! jmc 817: .Bd -literal -offset indent -compact
! 818: \&. include <file>
1.46 espie 819: .Ed
1.57 ! jmc 820: .Pp
1.46 espie 821: are identical constructs.
1.1 deraadt 822: Files are included with either
823: .Ql .include <file>
824: or
825: .Ql .include \*qfile\*q .
826: Variables between the angle brackets or double quotes are expanded
827: to form the file name.
828: If angle brackets are used, the included makefile is expected to be in
829: the system makefile directory.
830: If double quotes are used, the including makefile's directory and any
831: directories specified using the
832: .Fl I
833: option are searched before the system
834: makefile directory.
835: .Pp
836: Conditional expressions are also preceded by a single dot as the first
837: character of a line.
838: The possible conditionals are as follows:
839: .Bl -tag -width Ds
840: .It Ic .undef Ar variable
841: Un-define the specified global variable.
842: Only global variables may be un-defined.
843: .It Xo
844: .Ic \&.if
845: .Oo \&! Oc Ns Ar expression
846: .Op Ar operator expression ...
847: .Xc
848: Test the value of an expression.
849: .It Xo
850: .Ic .ifdef
851: .Oo \&! Oc Ns Ar variable
852: .Op Ar operator variable ...
853: .Xc
854: Test the value of a variable.
855: .It Xo
856: .Ic .ifndef
857: .Oo \&! Oc Ns Ar variable
858: .Op Ar operator variable ...
859: .Xc
860: Test the value of a variable.
861: .It Xo
862: .Ic .ifmake
863: .Oo \&! Oc Ns Ar target
864: .Op Ar operator target ...
865: .Xc
866: Test the target being built.
867: .It Xo
868: .Ic .ifnmake
869: .Oo \&! Oc Ar target
870: .Op Ar operator target ...
871: .Xc
872: Test the target being built.
873: .It Ic .else
874: Reverse the sense of the last conditional.
875: .It Xo
876: .Ic .elif
877: .Oo \&! Oc Ar expression
878: .Op Ar operator expression ...
879: .Xc
880: A combination of
1.54 jmc 881: .Sq Ic .else
1.1 deraadt 882: followed by
1.54 jmc 883: .Sq Ic .if .
1.1 deraadt 884: .It Xo
885: .Ic .elifdef
886: .Oo \&! Oc Ns Ar variable
887: .Op Ar operator variable ...
888: .Xc
889: A combination of
1.54 jmc 890: .Sq Ic .else
1.1 deraadt 891: followed by
1.54 jmc 892: .Sq Ic .ifdef .
1.1 deraadt 893: .It Xo
894: .Ic .elifndef
895: .Oo \&! Oc Ns Ar variable
896: .Op Ar operator variable ...
897: .Xc
898: A combination of
1.54 jmc 899: .Sq Ic .else
1.1 deraadt 900: followed by
1.54 jmc 901: .Sq Ic .ifndef .
1.1 deraadt 902: .It Xo
903: .Ic .elifmake
904: .Oo \&! Oc Ns Ar target
905: .Op Ar operator target ...
906: .Xc
907: A combination of
1.54 jmc 908: .Sq Ic .else
1.1 deraadt 909: followed by
1.54 jmc 910: .Sq Ic .ifmake .
1.1 deraadt 911: .It Xo
912: .Ic .elifnmake
913: .Oo \&! Oc Ns Ar target
914: .Op Ar operator target ...
915: .Xc
916: A combination of
1.54 jmc 917: .Sq Ic .else
1.1 deraadt 918: followed by
1.54 jmc 919: .Sq Ic .ifnmake .
1.1 deraadt 920: .It Ic .endif
921: End the body of the conditional.
922: .El
923: .Pp
924: The
925: .Ar operator
926: may be any one of the following:
927: .Bl -tag -width "Cm XX"
928: .It Cm \&|\&|
929: logical OR
930: .It Cm \&&&
931: Logical
932: .Tn AND ;
933: of higher precedence than
1.46 espie 934: .Dq \&|\&| .
1.1 deraadt 935: .El
936: .Pp
937: As in C,
1.19 aaron 938: .Nm
1.1 deraadt 939: will only evaluate a conditional as far as is necessary to determine
940: its value.
1.9 millert 941: Parentheses may be used to change the order of evaluation.
1.1 deraadt 942: The boolean operator
1.54 jmc 943: .Sq Ic \&!
1.1 deraadt 944: may be used to logically negate an entire
945: conditional.
946: It is of higher precedence than
1.54 jmc 947: .Sq Ic \&&& .
1.1 deraadt 948: .Pp
949: The value of
950: .Ar expression
951: may be any of the following:
1.54 jmc 952: .Bl -tag -width defined
1.1 deraadt 953: .It Ic defined
954: Takes a variable name as an argument and evaluates to true if the variable
955: has been defined.
956: .It Ic make
957: Takes a target name as an argument and evaluates to true if the target
958: was specified as part of
959: .Nm make Ns 's
960: command line or was declared the default target (either implicitly or
961: explicitly, see
962: .Va .MAIN )
963: before the line containing the conditional.
964: .It Ic empty
965: Takes a variable, with possible modifiers, and evaluates to true if
966: the expansion of the variable would result in an empty string.
967: .It Ic exists
968: Takes a file name as an argument and evaluates to true if the file exists.
969: The file is searched for on the system search path (see
970: .Va .PATH ) .
971: .It Ic target
972: Takes a target name as an argument and evaluates to true if the target
973: has been defined.
974: .El
975: .Pp
1.14 aaron 976: .Ar expression
1.28 aaron 977: may also be an arithmetic or string comparison.
978: Variable expansion is
1.1 deraadt 979: performed on both sides of the comparison, after which the integral
1.28 aaron 980: values are compared.
981: A value is interpreted as hexadecimal if it is
1.1 deraadt 982: preceded by 0x, otherwise it is decimal; octal numbers are not supported.
1.28 aaron 983: The standard C relational operators are all supported.
984: If after
1.1 deraadt 985: variable expansion, either the left or right hand side of a
1.54 jmc 986: .Sq Ic ==
1.1 deraadt 987: or
1.54 jmc 988: .Sq Ic "!="
1.1 deraadt 989: operator is not an integral value, then
990: string comparison is performed between the expanded
991: variables.
992: If no relational operator is given, it is assumed that the expanded
993: variable is being compared against 0.
994: .Pp
995: When
1.19 aaron 996: .Nm
1.14 aaron 997: is evaluating one of these conditional expressions, and it encounters
1.19 aaron 998: a word it doesn't recognize, either the
999: .Dq make
1000: or
1001: .Dq defined
1.1 deraadt 1002: expression is applied to it, depending on the form of the conditional.
1003: If the form is
1.54 jmc 1004: .Sq Ic .ifdef
1.1 deraadt 1005: or
1.54 jmc 1006: .Sq Ic .ifndef ,
1.19 aaron 1007: the
1008: .Dq defined
1009: expression is applied.
1.1 deraadt 1010: Similarly, if the form is
1.54 jmc 1011: .Sq Ic .ifmake
1.1 deraadt 1012: or
1.54 jmc 1013: .Sq Ic .ifnmake ,
1.19 aaron 1014: the
1015: .Dq make
1.1 deraadt 1016: expression is applied.
1017: .Pp
1018: If the conditional evaluates to true the parsing of the makefile continues
1019: as before.
1020: If it evaluates to false, the following lines are skipped.
1021: In both cases this continues until a
1.54 jmc 1022: .Sq Ic .else
1.1 deraadt 1023: or
1.54 jmc 1024: .Sq Ic .endif
1.1 deraadt 1025: is found.
1.9 millert 1026: .Pp
1.1 deraadt 1027: For loops are typically used to apply a set of rules to a list of files.
1028: The syntax of a for loop is:
1.54 jmc 1029: .Bd -unfilled -offset indent
1030: .Xo
1031: .Ic .for Ar variable Op Ar variable ...
1.9 millert 1032: .Ic in
1.1 deraadt 1033: .Ar expression
1034: .Xc
1.54 jmc 1035: <make-rules>
1.1 deraadt 1036: .Ic \&.endfor
1.54 jmc 1037: .Ed
1038: .Pp
1.1 deraadt 1039: After the for
1.14 aaron 1040: .Ar expression
1.28 aaron 1041: is evaluated, it is split into words.
1.50 jmc 1042: On each iteration of the loop, one word is assigned to each
1.41 espie 1043: .Ar variable ,
1044: in order,
1.50 jmc 1045: and these
1046: .Ar variables
1.41 espie 1047: are substituted in the
1.9 millert 1048: .Ic make-rules
1.1 deraadt 1049: inside the body of the for loop.
1.41 espie 1050: The number of words must match the number of iteration variables;
1051: that is, if there are three iteration variables, the number of words
1.48 pvalchev 1052: must be a multiple of three.
1.45 espie 1053: .Pp
1054: Loops and conditional expressions may nest arbitrarily, but
1055: they may not cross include file boundaries.
1.1 deraadt 1056: .Sh COMMENTS
1057: Comments begin with a hash
1058: .Pq Ql \&#
1059: character, anywhere but in a shell
1060: command line, and continue to the end of the line.
1061: .Sh SPECIAL SOURCES
1.54 jmc 1062: .Bl -tag -width ".PRECIOUS"
1.1 deraadt 1063: .It Ic .IGNORE
1064: Ignore any errors from the commands associated with this target, exactly
1065: as if they all were preceded by a dash
1066: .Pq Ql \- .
1.10 millert 1067: .It Ic .MADE
1.19 aaron 1068: Mark all sources of this target as being up-to-date.
1.1 deraadt 1069: .It Ic .MAKE
1070: Execute the commands associated with this target even if the
1071: .Fl n
1072: or
1073: .Fl t
1074: options were specified.
1075: Normally used to mark recursive
1076: .Nm make Ns 's .
1077: .It Ic .NOTMAIN
1078: Normally
1.19 aaron 1079: .Nm
1.1 deraadt 1080: selects the first target it encounters as the default target to be built
1081: if no target was specified.
1082: This source prevents this target from being selected.
1083: .It Ic .OPTIONAL
1084: If a target is marked with this attribute and
1.19 aaron 1085: .Nm
1.1 deraadt 1086: can't figure out how to create it, it will ignore this fact and assume
1087: the file isn't needed or already exists.
1088: .It Ic .PRECIOUS
1089: When
1.19 aaron 1090: .Nm
1.1 deraadt 1091: is interrupted, it removes any partially made targets.
1092: This source prevents the target from being removed.
1093: .It Ic .SILENT
1094: Do not echo any of the commands associated with this target, exactly
1095: as if they all were preceded by an at sign
1096: .Pq Ql @ .
1097: .It Ic .USE
1098: Turn the target into
1.14 aaron 1099: .Nm make Ns 's
1.1 deraadt 1100: version of a macro.
1101: When the target is used as a source for another target, the other target
1102: acquires the commands, sources, and attributes (except for
1103: .Ic .USE )
1104: of the
1105: source.
1106: If the target already has commands, the
1107: .Ic .USE
1108: target's commands are appended
1109: to them.
1.4 deraadt 1110: .It Ic .WAIT
1.48 pvalchev 1111: If
1.4 deraadt 1112: .Ic .WAIT
1.48 pvalchev 1113: appears in a dependency line, the sources that precede it are
1.28 aaron 1114: made before the sources that succeed it in the line.
1.48 pvalchev 1115: Loops are not
1.4 deraadt 1116: detected and targets that form loops will be silently ignored.
1.1 deraadt 1117: .El
1118: .Sh "SPECIAL TARGETS"
1.29 aaron 1119: Special targets may not be included with other targets, i.e., they must be
1.1 deraadt 1120: the only target specified.
1.54 jmc 1121: .Bl -tag -width ".NOTPARALLEL"
1.1 deraadt 1122: .It Ic .BEGIN
1123: Any command lines attached to this target are executed before anything
1124: else is done.
1125: .It Ic .DEFAULT
1126: This is sort of a
1127: .Ic .USE
1128: rule for any target (that was used only as a
1129: source) that
1.19 aaron 1130: .Nm
1.1 deraadt 1131: can't figure out any other way to create.
1132: Only the shell script is used.
1133: The
1134: .Ic .IMPSRC
1135: variable of a target that inherits
1136: .Ic .DEFAULT Ns 's
1137: commands is set
1138: to the target's own name.
1139: .It Ic .END
1140: Any command lines attached to this target are executed after everything
1141: else is done.
1142: .It Ic .IGNORE
1143: Mark each of the sources with the
1144: .Ic .IGNORE
1145: attribute.
1146: If no sources are specified, this is the equivalent of specifying the
1147: .Fl i
1148: option.
1.18 espie 1149: .It Ic .INCLUDES
1150: A list of suffixes that indicate files that can be included in a source
1.28 aaron 1151: file.
1152: The suffix must have already been declared with
1.18 espie 1153: .Ic .SUFFIXES ,
1.48 pvalchev 1154: any suffix so declared will have the directories in its search path (see
1.18 espie 1155: .Ic .PATH )
1.19 aaron 1156: placed in the
1.18 espie 1157: .Va .INCLUDES
1.19 aaron 1158: special variable, each preceded by a
1159: .Fl I
1.18 espie 1160: flag.
1.1 deraadt 1161: .It Ic .INTERRUPT
1162: If
1.19 aaron 1163: .Nm
1.1 deraadt 1164: is interrupted, the commands for this target will be executed.
1.18 espie 1165: .It Ic .LIBS
1.19 aaron 1166: This does for libraries what
1167: .Ic .INCLUDES
1.18 espie 1168: does for include files, except that the flag used is
1169: .Fl L .
1.1 deraadt 1170: .It Ic .MAIN
1171: If no target is specified when
1.19 aaron 1172: .Nm
1.28 aaron 1173: is invoked, this target will be built.
1174: This is always set, either
1.19 aaron 1175: explicitly, or implicitly when
1176: .Nm
1.16 espie 1177: selects the default target, to give the user a way to refer to the default
1178: target on the command line.
1.1 deraadt 1179: .It Ic .MAKEFLAGS
1180: This target provides a way to specify flags for
1.19 aaron 1181: .Nm
1.1 deraadt 1182: when the makefile is used.
1183: The flags are as if typed to the shell, though the
1184: .Fl f
1185: option will have
1186: no effect.
1.4 deraadt 1187: .\" XXX: NOT YET!!!!
1188: .\" .It Ic .NOTPARALLEL
1189: .\" The named targets are executed in non parallel mode. If no targets are
1190: .\" specified, then all targets are executed in non parallel mode.
1191: .It Ic .NOTPARALLEL
1192: Disable parallel mode.
1193: .It Ic .NO_PARALLEL
1194: Same as above, for compatibility with other pmake variants.
1195: .It Ic .ORDER
1196: The named targets are made in sequence.
1197: .\" XXX: NOT YET!!!!
1198: .\" .It Ic .PARALLEL
1199: .\" The named targets are executed in parallel mode. If no targets are
1200: .\" specified, then all targets are executed in parallel mode.
1.1 deraadt 1201: .It Ic .PATH
1202: The sources are directories which are to be searched for files not
1203: found in the current directory.
1204: If no sources are specified, any previously specified directories are
1205: deleted.
1.18 espie 1206: .It Ic .PATH\fIsuffix\fR
1207: The sources are directories which are to be searched for suffixed files
1208: not found in the current directory.
1.19 aaron 1209: .Nm
1210: first searches the suffixed search path, before reverting to the default
1.18 espie 1211: path if the file is not found there.
1.6 niklas 1212: .It Ic .PHONY
1213: Apply the
1214: .Ic .PHONY
1.28 aaron 1215: attribute to any specified sources.
1216: Targets with this attribute are always
1.6 niklas 1217: considered to be out of date.
1.1 deraadt 1218: .It Ic .PRECIOUS
1219: Apply the
1220: .Ic .PRECIOUS
1221: attribute to any specified sources.
1222: If no sources are specified, the
1223: .Ic .PRECIOUS
1224: attribute is applied to every
1225: target in the file.
1226: .It Ic .SILENT
1227: Apply the
1228: .Ic .SILENT
1229: attribute to any specified sources.
1230: If no sources are specified, the
1231: .Ic .SILENT
1232: attribute is applied to every
1233: command in the file.
1234: .It Ic .SUFFIXES
1235: Each source specifies a suffix to
1236: .Nm make .
1.48 pvalchev 1237: If no sources are specified, any previously specified suffices are deleted.
1.35 aaron 1238: .El
1.1 deraadt 1239: .Sh ENVIRONMENT
1.19 aaron 1240: .Nm
1.15 espie 1241: uses the following environment variables, if they exist:
1.9 millert 1242: .Ev MACHINE ,
1.15 espie 1243: .Ev MACHINE_ARCH ,
1.9 millert 1244: .Ev MAKEFLAGS ,
1245: .Ev MAKEOBJDIR ,
1.15 espie 1246: .Ev MAKEOBJDIRPREFIX ,
1.1 deraadt 1247: and
1.9 millert 1248: .Ev PWD .
1.30 espie 1249: .Nm
1.31 aaron 1250: also ignores and unsets
1.30 espie 1251: .Ev CDPATH .
1.1 deraadt 1252: .Sh FILES
1253: .Bl -tag -width /usr/share/mk -compact
1.14 aaron 1254: .It Pa .depend
1.1 deraadt 1255: list of dependencies
1.15 espie 1256: .It Pa BSDmakefile
1257: list of dependencies
1.14 aaron 1258: .It Pa Makefile
1.1 deraadt 1259: list of dependencies
1.14 aaron 1260: .It Pa makefile
1.1 deraadt 1261: list of dependencies
1.14 aaron 1262: .It Pa sys.mk
1.1 deraadt 1263: system makefile
1.14 aaron 1264: .It Pa /usr/share/mk
1.1 deraadt 1265: system makefile directory
1.15 espie 1266: .IT Pa /usr/obj
1.19 aaron 1267: default
1.52 jmc 1268: .Ev MAKEOBJDIRPREFIX
1.57 ! jmc 1269: directory
1.1 deraadt 1270: .El
1.37 aaron 1271: .Sh SEE ALSO
1.57 ! jmc 1272: .Xr ed 1 ,
! 1273: .Xr mkdep 1 ,
! 1274: .Xr sh 1 ,
! 1275: .Xr getcwd 3 ,
! 1276: .Xr regex 3 ,
! 1277: .Xr uname 3
1.37 aaron 1278: .Pp
1.52 jmc 1279: .Rs
1280: .%T Make \- A Tutorial
1281: .Re
1282: .Sh STANDARDS
1.43 espie 1283: .Nm
1284: mostly conforms to the Single Unix Specification, Version 2,
1285: with some noted extensions and a few problems.
1286: .Pp
1.37 aaron 1287: Older versions of
1288: .Nm
1289: used
1290: .Ev MAKE
1291: instead of
1292: .Ev MAKEFLAGS .
1293: This was removed for POSIX compatibility.
1294: The internal variable
1295: .Va MAKE
1296: is set to the same value as
1.48 pvalchev 1297: .Va .MAKE .
1298: Support for this may be removed in the future.
1.37 aaron 1299: .Pp
1300: Most of the more esoteric features of
1301: .Nm
1302: should probably be avoided for greater compatibility.
1303: .Sh HISTORY
1304: A
1305: .Nm
1306: command appeared in
1307: .At v7 .
1.17 espie 1308: .Sh BUGS
1.18 espie 1309: The determination of
1310: .Va .OBJDIR
1.19 aaron 1311: is contorted to the point of absurdity.
1.18 espie 1312: .Pp
1.50 jmc 1313: If the same target is specified several times in normal dependency rules,
1.31 aaron 1314: .Nm
1.27 espie 1315: silently ignores all commands after the first non empty set of commands,
1.31 aaron 1316: e.g., in
1.57 ! jmc 1317: .Bd -literal -offset indent
1.27 espie 1318: a:
1319: @echo "Executed"
1320: a:
1321: @echo "Bad luck"
1322: .Ed
1323: .Pp
1324: @echo "Bad luck" will be silently ignored.
1.18 espie 1325: .Pp
1326: .Va .TARGETS
1327: is not set to the default target when
1.19 aaron 1328: .Nm
1.18 espie 1329: is invoked without a target name and no
1.19 aaron 1330: .Ic MAIN
1.18 espie 1331: special target exists.
1332: .Pp
1.17 espie 1333: The evaluation of
1334: .Ar expression
1.28 aaron 1335: in a test is very simple-minded.
1336: Currently, the only form that works is
1.48 pvalchev 1337: .Ql .if ${VAR} op something \.
1.50 jmc 1338: For instance, tests should be written as
1.48 pvalchev 1339: .Ql .if ${VAR} = "string" ,
1.17 espie 1340: not the other way around, which doesn't work.
1341: .Pp
1342: For loops are expanded before tests, so a fragment such as:
1.57 ! jmc 1343: .Bd -literal -offset indent
1.17 espie 1344: \&.for TMACHINE in ${SHARED_ARCHS}
1345: \&.if ${TMACHINE} = ${MACHINE}
1346: ...
1347: \&.endif
1.32 ericj 1348: \&.endfor
1.17 espie 1349: .Ed
1.25 espie 1350: .Pp
1.17 espie 1351: won't work, and should be rewritten the other way around.
1.21 espie 1352: .Pp
1.31 aaron 1353: When handling pre-BSD 4.4 archives,
1.21 espie 1354: .Nm
1355: may erroneously mark archive members as out of date if the archive name
1356: was truncated.
1.26 espie 1357: .Pp
1.57 ! jmc 1358: The handling of
! 1359: .Sq ;\&
! 1360: and other special characters in tests may be utterly bogus.
1.28 aaron 1361: For instance, in
1.57 ! jmc 1362: .Bd -literal -offset indent
1.25 espie 1363: \&A=abcd;c.c
1364: \&.if ${A:R} == "abcd;c"
1365: .Ed
1366: .Pp
1367: the test will never match, even though the value is correct.
1.26 espie 1368: .Pp
1.28 aaron 1369: The conditional handler is incredibly lame.
1370: Junk such as
1.57 ! jmc 1371: .Pp
! 1372: .Dl \&.if defined anything goes (A)
1.26 espie 1373: .Pp
1374: will be accepted silently.
1.25 espie 1375: .Pp
1.57 ! jmc 1376: In a .for loop, only the variable value is used; assignments will be
1.25 espie 1377: evaluated later, e.g., in
1.57 ! jmc 1378: .Bd -literal -offset indent
1.25 espie 1379: \&.for I in a b c d
1380: I:=${I:S/a/z}
1381: A+=$I
1382: \&.endfor
1383: .Ed
1.57 ! jmc 1384: .Pp
! 1385: .Sq A
! 1386: will evaluate to a b c d after the loop, not z b c d.
1.33 espie 1387: .Pp
1.50 jmc 1388: The
1.33 espie 1389: .Ql +
1390: command modificator is ignored in parallel make mode.
![[BACK]](/icons/back.gif){kind=icon}
Return to make.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / make