Cleanup:
[dragonfly.git] / usr.bin / make / make.1
1 .\" Copyright (c) 1990, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
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 .\"
32 .\"     from: @(#)make.1        8.4 (Berkeley) 3/19/94
33 .\" $FreeBSD: src/usr.bin/make/make.1,v 1.29.2.15 2002/12/17 19:01:18 seanc Exp $
34 .\" $DragonFly: src/usr.bin/make/make.1,v 1.28 2005/08/03 17:33:30 okumoto Exp $
35 .\"
36 .Dd March 30, 2005
37 .Dt MAKE 1
38 .Os
39 .Sh NAME
40 .Nm make
41 .Nd maintain program dependencies
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl ABPSXeiknqrstv
45 .Op Fl C Ar directory
46 .Op Fl D Ar variable
47 .Op Fl d Ar flags
48 .Op Fl E Ar variable
49 .Op Fl f Ar makefile
50 .Op Fl I Ar directory
51 .Bk -words
52 .Op Fl j Ar max_jobs
53 .Op Fl m Ar directory
54 .Ek
55 .Op Fl V Ar variable
56 .Op Fl x Ar warning_options
57 .Op Ar variable Ns No = Ns Ar value
58 .Op Ar target ...
59 .Sh DESCRIPTION
60 The
61 .Nm
62 utility is a program designed to simplify the maintenance of other programs.
63 Its input is a list of specifications
64 describing dependency relationships between the generation of
65 files and programs.
66 The first of
67 .Pa BSDmakefile ,
68 .Pa makefile
69 and
70 .Pa Makefile
71 that can be found in either the current directory or a special object directory
72 (see
73 .Va .OBJDIR )
74 will be read for this list of specifications.
75 If the file
76 .Pa .depend
77 can be found, it is also read (see
78 .Xr mkdep 1 ) .
79 .Pp
80 This manual page is intended as a reference document only.
81 For a more thorough introduction to
82 .Nm
83 and makefiles, please refer to
84 .%T "Make \- A Tutorial" .
85 .Pp
86 The options are as follows:
87 .Bl -tag -width Ds
88 .It Fl A
89 Make archive errors non-fatal, causing
90 .Nm
91 to just skip the remainder
92 or all of the archive and continue after printing a message.
93 .It Fl B
94 Try to be backwards compatible by executing a single shell per command and
95 by executing the commands to make the sources of a dependency line in sequence.
96 This is turned on by default unless
97 .Fl j
98 is used.
99 .It Fl C Ar directory
100 Change to
101 .Ar directory
102 before reading the makefiles or doing anything else.
103 If multiple
104 .Fl C
105 options are specified, each is interpreted relative to the previous one:
106 .Fl C Pa / Fl C Pa etc
107 is equivalent to
108 .Fl C Pa /etc .
109 .It Fl D Ar variable
110 Define
111 .Ar variable
112 to be 1, in the global context.
113 .It Fl d Ar flags
114 Turn on debugging, and specify which portions of
115 .Nm
116 are to print debugging information.
117 Argument
118 .Ar flags
119 is one or more of the following:
120 .Bl -tag -width Ds
121 .It Ar A
122 Print all possible debugging information;
123 equivalent to specifying all of the debugging flags.
124 .It Ar a
125 Print debugging information about archive searching and caching.
126 .It Ar c
127 Print debugging information about conditional evaluation.
128 .It Ar d
129 Print debugging information about directory searching and caching.
130 .It Ar f
131 Print debugging information about the execution of for loops.
132 .It Ar "g1"
133 Print the input graph before making anything.
134 .It Ar "g2"
135 Print the input graph after making everything, or before exiting
136 on error.
137 .It Ar j
138 Print debugging information about running multiple shells.
139 .It Ar l
140 Print commands in Makefiles regardless of whether or not they are prefixed
141 by @ or other "quiet" flags.
142 Also known as "loud" behavior.
143 .It Ar m
144 Print debugging information about making targets, including modification
145 dates.
146 .It Ar s
147 Print debugging information about suffix-transformation rules.
148 .It Ar t
149 Print debugging information about target list maintenance.
150 .It Ar v
151 Print debugging information about variable assignment.
152 .El
153 .It Fl E Ar variable
154 Specify a variable whose environment value (if any) will override
155 macro assignments within makefiles.
156 .It Fl e
157 Specify that environment values override macro assignments within
158 makefiles for all variables.
159 .It Fl f Ar makefile
160 Specify a makefile to read instead of the default
161 .Pa makefile
162 and
163 .Pa Makefile .
164 If
165 .Ar makefile
166 is
167 .Sq Fl ,
168 standard input is read.
169 Multiple makefiles may be specified, and are read in the order specified.
170 .It Fl I Ar directory
171 Specify a directory in which to search for makefiles and included makefiles.
172 The system makefile directory (or directories, see the
173 .Fl m
174 option) is automatically included as part of this list.
175 .It Fl i
176 Ignore non-zero exit of shell commands in the makefile.
177 Equivalent to specifying
178 .Sq Ic \-
179 before each command line in the makefile.
180 .It Fl j Ar max_jobs
181 Specify the maximum number of jobs that
182 .Nm
183 may have running at any one time.
184 Turns compatibility mode off, unless the
185 .Ar B
186 flag is also specified.
187 .It Fl k
188 Continue processing after errors are encountered, but only on those targets
189 that do not depend on the target whose creation caused the error.
190 .It Fl m Ar directory
191 Specify a directory in which to search for
192 .Pa sys.mk
193 and makefiles included via the <...> style.
194 Multiple directories can be added to form a search path.
195 This path will override the default system include path:
196 .Pa /usr/share/mk .
197 Furthermore, the system include path will be appended to the search path used
198 for "..."-style inclusions (see the
199 .Fl I
200 option).
201 .It Fl n
202 Display the commands that would have been executed, but do not actually
203 execute them.
204 .It Fl P
205 Collate the output of a given job and display it only when the job finishes,
206 instead of mixing the output of parallel jobs together.
207 This option has no effect unless
208 .Fl j
209 is used too.
210 .It Fl q
211 Do not execute any commands, but exit 0 if the specified targets are
212 up-to-date and 1, otherwise.
213 .It Fl r
214 Do not use the built-in rules specified in the system makefile.
215 .It Fl S
216 Stop processing when an error is encountered.
217 Default behaviour.
218 This is needed to negate the
219 .Fl k
220 option during recursive builds.
221 .It Fl s
222 Do not echo any commands as they are executed.
223 Equivalent to specifying
224 .Sq Ic @
225 before each command line in the makefile.
226 .It Fl t
227 Rather than re-building a target as specified in the makefile, create it
228 or update its modification time to make it appear up-to-date.
229 .It Fl V Ar variable
230 Print
231 .Nm Ns 's
232 idea of the value of
233 .Ar variable ,
234 in the global context.
235 Do not build any targets.
236 Multiple instances of this option may be specified;
237 the variables will be printed one per line,
238 with a blank line for each null or undefined variable.
239 .It Fl v
240 Be extra verbose.
241 For multi-job makes, this will cause file banners to be generated.
242 .It Fl X
243 When using the
244 .Fl V
245 option to print the values of variables,
246 do not recursively expand the values.
247 .It Ar variable Ns No = Ns Ar value
248 Set the value of the variable
249 .Ar variable
250 to
251 .Ar value .
252 .It Fl x Ar warning_options
253 Specify extended warning options.
254 This option may be specified several times.
255 A
256 .Ar warning_option
257 can be prefixed with
258 .Dq Li no
259 in which case the warning is switched off.
260 The currently available options are:
261 .Bl -tag -width indent
262 .It Li dirsyntax
263 Warn if anything except blanks and comments follows an
264 .Ic .endif
265 or
266 .Ic .else
267 directive.
268 .El
269 .Pp
270 See also the
271 .Ic .WARN
272 special target.
273 .El
274 .Pp
275 There are seven different types of lines in a makefile: file dependency
276 specifications, shell commands, variable assignments, include statements,
277 conditional directives, for loops, and comments.
278 .Pp
279 In general, lines may be continued from one line to the next by ending
280 them with a backslash
281 .Pq Ql \e .
282 The trailing newline character and initial whitespace on the following
283 line are compressed into a single space.
284 .Sh FILE DEPENDENCY SPECIFICATIONS
285 Dependency lines consist of one or more targets, an operator, and zero
286 or more sources.
287 This creates a relationship where the targets
288 .Dq depend
289 on the sources
290 and are usually created from them.
291 The exact relationship between the target and the source is determined
292 by the operator that separates them.
293 The three operators are as follows:
294 .Bl -tag -width flag
295 .It Ic \&:
296 A target is considered out-of-date if its modification time is less than
297 those of any of its sources.
298 Sources for a target accumulate over dependency lines when this operator
299 is used.
300 The target is removed if
301 .Nm
302 is interrupted.
303 .It Ic \&!
304 Targets are always re-created, but not until all sources have been
305 examined and re-created as necessary.
306 Sources for a target accumulate over dependency lines when this operator
307 is used.
308 The target is removed if
309 .Nm
310 is interrupted.
311 .It Ic \&::
312 If no sources are specified, the target is always re-created.
313 Otherwise, a target is considered out-of-date if any of its sources has
314 been modified more recently than the target.
315 Sources for a target do not accumulate over dependency lines when this
316 operator is used.
317 The target will not be removed if
318 .Nm
319 is interrupted.
320 .El
321 .Pp
322 Targets and sources may contain the shell wildcard expressions
323 .Ql \&? ,
324 .Ql * ,
325 .Ql []
326 and
327 .Ql {} .
328 The expressions
329 .Ql \&? ,
330 .Ql *
331 and
332 .Ql []
333 may only be used as part of the final
334 component of the target or source, and must be used to describe existing
335 files.
336 The expression
337 .Ql {}
338 need not necessarily be used to describe existing files.
339 Expansion is in directory order, not alphabetically as done in the shell.
340 .Sh SHELL COMMANDS
341 Each target may have associated with it a series of shell commands, normally
342 used to create the target.
343 Each of the commands in this script
344 .Em must
345 be preceded by a tab.
346 While any target may appear on a dependency line, only one of these
347 dependencies may be followed by a creation script, unless the
348 .Sq Ic ::
349 operator is used.
350 .Pp
351 If the first characters of the command line are
352 .Sq Ic @ ,
353 .Sq Ic \- ,
354 and/or
355 .Sq Ic + ,
356 the command is treated specially.
357 A
358 .Sq Ic @
359 causes the command not to be echoed before it is executed.
360 A
361 .Sq Ic \-
362 causes any non-zero exit status of the command line to be ignored.
363 A
364 .Sq Ic +
365 causes the command to be executed even if
366 .Fl n
367 is specified on the command line.
368 .Sh VARIABLE ASSIGNMENTS
369 Variables in
370 .Nm
371 are much like variables in the shell, and, by tradition,
372 consist of all upper-case letters.
373 The five operators that can be used to assign values to variables are as
374 follows:
375 .Bl -tag -width Ds
376 .It Ic \&=
377 Assign the value to the variable.
378 Any previous value is overridden.
379 .It Ic \&+=
380 Append the value to the current value of the variable.
381 .It Ic \&?=
382 Assign the value to the variable if it is not already defined.
383 .It Ic \&:=
384 Assign with expansion, i.e., expand the value before assigning it
385 to the variable.
386 Normally, expansion is not done until the variable is referenced.
387 .It Ic \&!=
388 Expand the value and pass it to the shell for execution and assign
389 the result to the variable.
390 Any newlines in the result are replaced with spaces.
391 .El
392 .Pp
393 Any whitespace before the assigned
394 .Ar value
395 is removed; if the value is being appended, a single space is inserted
396 between the previous contents of the variable and the appended value.
397 .Pp
398 Variables are expanded by surrounding the variable name with either
399 curly braces
400 .Pq Ql {}
401 or parentheses
402 .Pq Ql ()
403 and preceding it with
404 a dollar sign
405 .Pq Ql \&$ .
406 If the variable name contains only a single letter, the surrounding
407 braces or parentheses are not required.
408 This shorter form is not recommended.
409 .Pp
410 Variable substitution occurs at two distinct times, depending on where
411 the variable is being used.
412 Variables in dependency lines are expanded as the line is read.
413 Variables in shell commands are expanded when the shell command is
414 executed.
415 .Pp
416 The four different classes of variables (in order of increasing precedence)
417 are:
418 .Bl -tag -width Ds
419 .It Environment variables
420 Variables defined as part of
421 .Nm Ns 's
422 environment.
423 .It Global variables
424 Variables defined in the makefile or in included makefiles.
425 .It Command line variables
426 Variables defined as part of the command line and variables
427 obtained from the
428 .Ev MAKEFLAGS
429 environment variable or the
430 .Ic .MAKEFLAGS
431 target.
432 .It Local variables
433 Variables that are defined specific to a certain target.
434 The seven local variables are as follows:
435 .Bl -tag -width ".ARCHIVE"
436 .It Va .ALLSRC
437 The list of all sources for this target; also known as
438 .Sq Va \&> .
439 .It Va .ARCHIVE
440 The name of the archive file; also known as
441 .Sq Va \&! .
442 .It Va .IMPSRC
443 The name/path of the source from which the target is to be transformed
444 (the
445 .Dq implied
446 source); also known as
447 .Sq Va \&< .
448 .It Va .MEMBER
449 The name of the archive member; also known as
450 .Sq Va \&% .
451 .It Va .OODATE
452 The list of sources for this target that were deemed out-of-date; also
453 known as
454 .Sq Va \&? .
455 .It Va .PREFIX
456 The file prefix of the file, containing only the file portion, no suffix
457 or preceding directory components; also known as
458 .Sq Va * .
459 .It Va .TARGET
460 The name of the target; also known as
461 .Sq Va @ .
462 .El
463 .Pp
464 The shorter forms
465 .Sq Va @ ,
466 .Sq Va \&! ,
467 .Sq Va \&< ,
468 .Sq Va \&% ,
469 .Sq Va \&? ,
470 .Sq Va \&> ,
471 and
472 .Sq Va *
473 are permitted for backward
474 compatibility and are not recommended.
475 The six variables
476 .Sq Va @F ,
477 .Sq Va @D ,
478 .Sq Va <F ,
479 .Sq Va <D ,
480 .Sq Va *F ,
481 and
482 .Sq Va *D
483 are
484 permitted for compatibility with
485 .At V
486 makefiles and are not recommended.
487 .Pp
488 Four of the local variables may be used in sources on dependency lines
489 because they expand to the proper value for each target on the line.
490 These variables are
491 .Va .TARGET ,
492 .Va .PREFIX ,
493 .Va .ARCHIVE ,
494 and
495 .Va .MEMBER .
496 .El
497 .Pp
498 In addition,
499 .Nm
500 sets or knows about the following internal variables or environment
501 variables:
502 .Bl -tag -width ".Va .MAKEFILE_LIST"
503 .It Va \&$
504 A single dollar sign
505 .Ql \&$ ,
506 i.e.\&
507 .Ql \&$$
508 expands to a single dollar
509 sign.
510 .It Va MAKE
511 The name that
512 .Nm
513 was executed with
514 .Pq Va argv Ns Op 0 .
515 .It Va .CURDIR
516 A path to the directory where
517 .Nm
518 was executed.
519 The
520 .Nm
521 utility sets
522 .Va .CURDIR
523 to the canonical path given by
524 .Xr getcwd 3 .
525 .It Va .OBJDIR
526 A path to the directory where the targets are built.
527 At startup,
528 .Nm
529 searches for an alternate directory to place target files.
530 It will attempt to change into this special directory
531 and will search this directory for makefiles
532 not found in the current directory.
533 The following directories are tried in order:
534 .Pp
535 .Bl -enum -compact
536 .It
537 ${MAKEOBJDIRPREFIX}/`pwd`
538 .It
539 ${MAKEOBJDIR}
540 .It
541 obj.${MACHINE}
542 .It
543 obj
544 .It
545 /usr/obj/`pwd`
546 .El
547 .Pp
548 The first directory that
549 .Nm
550 successfully changes into is used.
551 If either
552 .Ev MAKEOBJDIRPREFIX
553 or
554 .Ev MAKEOBJDIR
555 is set in the environment but
556 .Nm
557 is unable to change into the corresponding directory,
558 then the current directory is used
559 without checking the remainder of the list.
560 If they are undefined and
561 .Nm
562 is unable to change into any of the remaining three directories,
563 then the current directory is used.
564 Note, that
565 .Ev MAKEOBJDIRPREFIX
566 and
567 .Ev MAKEOBJDIR
568 must be environment variables and should not be set on
569 .Nm Ns 's
570 command line.
571 .Pp
572 The
573 .Nm
574 utility sets
575 .Va .OBJDIR
576 to the canonical path given by
577 .Xr getcwd 3 .
578 .It Va .MAKEFILE_LIST
579 As
580 .Nm
581 reads various makefiles, including the default files and any
582 obtained from the command line and
583 .Ic .include
584 directives, their names will be automatically appended to the
585 .Va .MAKEFILE_LIST
586 variable.
587 They are added right before
588 .Nm
589 begins to parse them, so that the name of the current makefile is the
590 last word in this variable.
591 .It Va .MAKEFLAGS
592 The environment variable
593 .Ev MAKEFLAGS
594 may contain anything that
595 may be specified on
596 .Nm Ns 's
597 command line.
598 Its contents are stored in
599 .Nm Ns 's
600 .Va .MAKEFLAGS
601 variable.
602 All options and variable assignments specified on
603 .Nm Ns 's
604 command line are appended to the
605 .Va .MAKEFLAGS
606 variable which is then
607 entered into the environment as
608 .Ev MAKEFLAGS
609 for all programs which
610 .Nm
611 executes.
612 By modifying the contents of the
613 .Va .MAKEFLAGS
614 variable, makefile can alter the contents of the
615 .Va MAKEFLAGS
616 environment variable made available for all programs which
617 .Nm
618 executes; compare with the
619 .Ic .MAKEFLAGS
620 special target below.
621 .Pp
622 When passing macro definitions and flag arguments in the
623 .Ev MAKEFLAGS
624 environment variable,
625 space and tab characters are quoted by preceding them with a backslash.
626 When reading the
627 .Ev MAKEFLAGS
628 variable from the environment,
629 all sequences of a backslash and one of space or tab
630 are replaced just with their second character
631 without causing a word break.
632 Any other occurrences of a backslash are retained.
633 Groups of unquoted space, tab and newline characters cause word
634 breaking.
635 .It Va MFLAGS
636 This variable is provided for backward compatibility and
637 contains all the options from the
638 .Ev MAKEFLAGS
639 environment variable plus any options specified on
640 .Nm Ns 's
641 command line.
642 .It Va .TARGETS
643 List of targets
644 .Nm
645 is currently building.
646 .It Va .INCLUDES
647 See
648 .Ic .INCLUDES
649 special target.
650 .It Va .LIBS
651 See
652 .Ic .LIBS
653 special target.
654 .It Va MACHINE
655 Name of the machine architecture
656 .Nm
657 is running on, obtained from the
658 .Ev MACHINE
659 environment variable, or through
660 .Xr uname 3
661 if not defined.
662 .It Va MACHINE_ARCH
663 Name of the machine architecture
664 .Nm
665 was compiled for, defined at compilation time.
666 .It Va VPATH
667 Makefiles may assign a colon-delimited list of directories to
668 .Va VPATH .
669 These directories will be searched for source files by
670 .Nm
671 after it has finished parsing all input makefiles.
672 .El
673 .Pp
674 Variable expansion may be modified to select or modify each word of the
675 variable (where a
676 .Dq word
677 is whitespace-delimited sequence of characters).
678 The general format of a variable expansion is as follows:
679 .Pp
680 .Dl {variable[:modifier[:...]]}
681 .Pp
682 Each modifier begins with a colon and one of the following
683 special characters.
684 The colon may be escaped with a backslash
685 .Pq Ql \e .
686 .Bl -tag -width Cm
687 .Sm off
688 .It Cm C No \&/ Ar pattern Xo
689 .No \&/ Ar replacement
690 .No \&/ Op Cm 1g
691 .Xc
692 .Sm on
693 Modify each word of the value,
694 substituting every match of the extended regular expression
695 .Ar pattern
696 (see
697 .Xr re_format 7 )
698 with the
699 .Xr ed 1 Ns \-style
700 .Ar replacement
701 string.
702 Normally, the first occurrence of the pattern in
703 each word of the value is changed.
704 The
705 .Ql 1
706 modifier causes the substitution to apply to at most one word; the
707 .Ql g
708 modifier causes the substitution to apply to as many instances of the
709 search pattern as occur in the word or words it is found in.
710 Note that
711 .Ql 1
712 and
713 .Ql g
714 are orthogonal; the former specifies whether multiple words are
715 potentially affected, the latter whether multiple substitutions can
716 potentially occur within each affected word.
717 .It Cm E
718 Replaces each word in the variable with its suffix.
719 .It Cm H
720 Replaces each word in the variable with everything but the last component.
721 .It Cm L
722 Converts variable to lower-case letters.
723 .It Cm M Ns Ar pattern
724 Select only those words that match the rest of the modifier.
725 The standard shell wildcard characters
726 .Pf ( Ql * ,
727 .Ql \&? ,
728 and
729 .Ql [] )
730 may
731 be used.
732 The wildcard characters may be escaped with a backslash
733 .Pq Ql \e .
734 .It Cm N Ns Ar pattern
735 This is identical to
736 .Cm M ,
737 but selects all words which do not match
738 the rest of the modifier.
739 .It Cm O
740 Order every word in the variable alphabetically.
741 .It Cm Q
742 Quotes every shell meta-character in the variable, so that it can be passed
743 safely through recursive invocations of
744 .Nm .
745 .It Cm R
746 Replaces each word in the variable with everything but its suffix.
747 .Sm off
748 .It Cm S No \&/ Ar old_string Xo
749 .No \&/ Ar new_string
750 .No \&/ Op Cm g
751 .Xc
752 .Sm on
753 Modify the first occurrence of
754 .Ar old_string
755 in each word of the variable's value, replacing it with
756 .Ar new_string .
757 If a
758 .Ql g
759 is appended to the last slash of the pattern, all occurrences
760 in each word are replaced.
761 If
762 .Ar old_string
763 begins with a caret
764 .Pq Ql ^ ,
765 .Ar old_string
766 is anchored at the beginning of each word.
767 If
768 .Ar old_string
769 ends with a dollar sign
770 .Pq Ql \&$ ,
771 it is anchored at the end of each word.
772 Inside
773 .Ar new_string ,
774 an ampersand
775 .Pq Ql &
776 is replaced by
777 .Ar old_string .
778 Any character may be used as a delimiter for the parts of the modifier
779 string.
780 The anchoring, ampersand, and delimiter characters may be escaped with a
781 backslash
782 .Pq Ql \e .
783 .Pp
784 Variable expansion occurs in the normal fashion inside both
785 .Ar old_string
786 and
787 .Ar new_string
788 with the single exception that a backslash is used to prevent the expansion
789 of a dollar sign
790 .Pq Ql \&$ ,
791 not a preceding dollar sign as is usual.
792 .It Ar old_string=new_string
793 This is the
794 .At V
795 style variable substitution.
796 It must be the last modifier specified.
797 If
798 .Ar old_string
799 or
800 .Ar new_string
801 do not contain the pattern matching character
802 .Ar %
803 then it is assumed that they are
804 anchored at the end of each word, so only suffixes or entire
805 words may be replaced.
806 Otherwise
807 .Ar %
808 is the substring of
809 .Ar old_string
810 to be replaced in
811 .Ar new_string
812 .It Cm T
813 Replaces each word in the variable with its last component.
814 .It Cm U
815 Converts variable to upper-case letters.
816 .El
817 .Sh DIRECTIVES, CONDITIONALS, AND FOR LOOPS
818 Directives, conditionals, and for loops reminiscent
819 of the C programming language are provided in
820 .Nm .
821 All such structures are identified by a line beginning with a single
822 dot
823 .Pq Ql \&.
824 character.
825 The following directives are supported:
826 .Bl -tag -width Ds
827 .It Ic \&.include Ar <file>
828 .It Ic \&.include Ar \*qfile\*q
829 Include the specified makefile.
830 Variables between the angle brackets
831 or double quotes are expanded to form the file name.
832 If angle brackets
833 are used, the included makefile is expected to be in the system
834 makefile directory.
835 If double quotes are used, the including
836 makefile's directory and any directories specified using the
837 .Fl I
838 option are searched before the system
839 makefile directory.
840 .It Ic .undef Ar variable
841 Un-define the specified global variable.
842 Only global variables may be un-defined.
843 .It Ic \&.makeenv Ar variable
844 Set the environment flag for a preexisting global variable.  The current
845 and future contents of the variable will be exported to the environment.
846 .It Ic .error Ar message
847 Terminate processing of the makefile immediately.
848 The filename of the
849 makefile, the line on which the error was encountered and the specified
850 message are printed to the standard error output and
851 .Nm
852 terminates with exit code 1.
853 Variables in the message are expanded.
854 .It Ic .warning Ar message
855 Emit a warning message.
856 The filename of the makefile,
857 the line on which the warning was encountered,
858 and the specified message are printed to the standard error output.
859 Variables in the message are expanded.
860 .El
861 .Pp
862 Conditionals are used to determine which parts of the Makefile
863 to process.
864 They are used similarly to the conditionals supported
865 by the C pre-processor.
866 The following conditionals are supported:
867 .Bl -tag -width Ds
868 .It Xo
869 .Ic .if
870 .Oo \&! Oc Ns Ar expression
871 .Op Ar operator expression ...
872 .Xc
873 Test the value of an expression.
874 .It Xo
875 .Ic .ifdef
876 .Oo \&! Oc Ns Ar variable
877 .Op Ar operator variable ...
878 .Xc
879 Test the value of a variable.
880 .It Xo
881 .Ic .ifndef
882 .Oo \&! Oc Ns Ar variable
883 .Op Ar operator variable ...
884 .Xc
885 Test the value of a variable.
886 .It Xo
887 .Ic .ifmake
888 .Oo \&! Oc Ns Ar target
889 .Op Ar operator target ...
890 .Xc
891 Test the target being built.
892 .It Xo
893 .Ic .ifnmake
894 .Oo \&! Oc Ns Ar target
895 .Op Ar operator target ...
896 .Xc
897 Test the target being built.
898 .It Ic .else
899 Reverse the sense of the last conditional.
900 .It Xo
901 .Ic .elif
902 .Oo \&! Oc Ns Ar expression
903 .Op Ar operator expression ...
904 .Xc
905 A combination of
906 .Ic .else
907 followed by
908 .Ic .if .
909 .It Xo
910 .Ic .elifdef
911 .Oo \&! Oc Ns Ar variable
912 .Op Ar operator variable ...
913 .Xc
914 A combination of
915 .Ic .else
916 followed by
917 .Ic .ifdef .
918 .It Xo
919 .Ic .elifndef
920 .Oo \&! Oc Ns Ar variable
921 .Op Ar operator variable ...
922 .Xc
923 A combination of
924 .Ic .else
925 followed by
926 .Ic .ifndef .
927 .It Xo
928 .Ic .elifmake
929 .Oo \&! Oc Ns Ar target
930 .Op Ar operator target ...
931 .Xc
932 A combination of
933 .Ic .else
934 followed by
935 .Ic .ifmake .
936 .It Xo
937 .Ic .elifnmake
938 .Oo \&! Oc Ns Ar target
939 .Op Ar operator target ...
940 .Xc
941 A combination of
942 .Ic .else
943 followed by
944 .Ic .ifnmake .
945 .It Ic .endif
946 End the body of the conditional.
947 .El
948 .Pp
949 The
950 .Ar operator
951 may be any one of the following:
952 .Bl -tag -width "Cm XX"
953 .It Cm ||
954 logical
955 .Tn OR
956 .It Cm &&
957 Logical
958 .Tn AND ;
959 of higher precedence than
960 .Sq Ic || .
961 .El
962 .Pp
963 As in C,
964 .Nm
965 will only evaluate a conditional as far as is necessary to determine
966 its value.
967 Parentheses may be used to change the order of evaluation.
968 The boolean operator
969 .Sq Ic !\&
970 may be used to logically negate an entire
971 conditional.
972 It is of higher precedence than
973 .Sq Ic && .
974 .Pp
975 The value of
976 .Ar expression
977 may be any of the following:
978 .Bl -tag -width Ic
979 .It Ic defined
980 Takes a variable name as an argument and evaluates to true if the variable
981 has been defined.
982 .It Ic make
983 Takes a target name as an argument and evaluates to true if the target
984 was specified as part of
985 .Nm Ns 's
986 command line or was declared the default target (either implicitly or
987 explicitly, see
988 .Va .MAIN )
989 before the line containing the conditional.
990 .It Ic empty
991 Takes a variable, with possible modifiers, and evaluates to true if
992 the expansion of the variable would result in an empty string.
993 .It Ic exists
994 Takes a file name as an argument and evaluates to true if the file exists.
995 The file is searched for on the system search path (see
996 .Va .PATH ) .
997 .It Ic target
998 Takes a target name as an argument and evaluates to true if the target
999 has been defined.
1000 .El
1001 .Pp
1002 An
1003 .Ar expression
1004 may also be an arithmetic or string comparison, with the left-hand side
1005 being a variable expansion.
1006 Variable expansion is
1007 performed on both sides of the comparison, after which the integral
1008 values are compared.
1009 A value is interpreted as hexadecimal if it is
1010 preceded by 0x, otherwise it is decimal; octal numbers are not supported.
1011 The standard C relational operators are all supported.
1012 If after
1013 variable expansion, either the left or right hand side of a
1014 .Sq Ic ==
1015 or
1016 .Sq Ic !=
1017 operator is not an integral value, then
1018 string comparison is performed between the expanded
1019 variables.
1020 If no relational operator is given, it is assumed that the expanded
1021 variable is being compared against 0.
1022 .Pp
1023 When
1024 .Nm
1025 is evaluating one of these conditional expressions, and it encounters
1026 a word it does not recognize, either the
1027 .Dq make
1028 or
1029 .Dq defined
1030 expression is applied to it, depending on the form of the conditional.
1031 If the form is
1032 .Ic .if ,
1033 .Ic .ifdef
1034 or
1035 .Ic .ifndef ,
1036 the
1037 .Dq defined
1038 expression is applied.
1039 Similarly, if the form is
1040 .Ic .ifmake
1041 or
1042 .Ic .ifnmake ,
1043 the
1044 .Dq make
1045 expression is applied.
1046 .Pp
1047 If the conditional evaluates to true the parsing of the makefile continues
1048 as before.
1049 If it evaluates to false, the following lines are skipped.
1050 In both cases this continues until a
1051 .Ic .else
1052 or
1053 .Ic .endif
1054 is found.
1055 .Pp
1056 For loops are typically used to apply a set of rules to a list of files.
1057 The syntax of a for loop is:
1058 .Pp
1059 .Bl -tag -width indent -compact
1060 .It Ic .for Ar variable Ic in Ar expression
1061 .It <make-rules>
1062 .It Ic .endfor
1063 .El
1064 .Pp
1065 After the for
1066 .Ar expression
1067 is evaluated, it is split into words.
1068 The
1069 iteration
1070 .Ar variable
1071 is successively set to each word, and substituted in the
1072 .Ic make-rules
1073 inside the body of the for loop.
1074 .Sh COMMENTS
1075 Comments begin with a hash
1076 .Pq Ql #
1077 character, anywhere but in a shell
1078 command line, and continue to the end of the line.
1079 .Sh SPECIAL SOURCES
1080 .Bl -tag -width Ic
1081 .It Ic .IGNORE
1082 Ignore any errors from the commands associated with this target, exactly
1083 as if they all were preceded by a dash
1084 .Pq Ql \- .
1085 .It Ic .MAKE
1086 Execute the commands associated with this target even if the
1087 .Fl n
1088 or
1089 .Fl t
1090 options were specified.
1091 Normally used to mark recursive
1092 .Nm Ns 's .
1093 .It Ic .NOTMAIN
1094 Normally
1095 .Nm
1096 selects the first target it encounters as the default target to be built
1097 if no target was specified.
1098 This source prevents this target from being selected.
1099 .It Ic .OPTIONAL
1100 If a target is marked with this attribute and
1101 .Nm
1102 cannot figure out how to create it, it will ignore this fact and assume
1103 the file is not needed or already exists.
1104 .It Ic .PRECIOUS
1105 When
1106 .Nm
1107 is interrupted, it removes any partially made targets.
1108 This source prevents the target from being removed.
1109 .It Ic .SILENT
1110 Do not echo any of the commands associated with this target, exactly
1111 as if they all were preceded by an at sign
1112 .Pq Ql @ .
1113 .It Ic .USE
1114 Turn the target into
1115 .Nm Ns 's
1116 version of a macro.
1117 When the target is used as a source for another target, the other target
1118 acquires the commands, sources, and attributes (except for
1119 .Ic .USE )
1120 of the
1121 source.
1122 If the target already has commands, the
1123 .Ic .USE
1124 target's commands are appended
1125 to them.
1126 .It Ic .WAIT
1127 If special
1128 .Ic .WAIT
1129 source is appears in a dependency line, the sources that precede it are
1130 made before the sources that succeed it in the line.
1131 Loops are not being
1132 detected and targets that form loops will be silently ignored.
1133 .El
1134 .Sh "SPECIAL TARGETS"
1135 Special targets may not be included with other targets, i.e., they must be
1136 the only target specified.
1137 .Bl -tag -width Ic
1138 .It Ic .BEGIN
1139 Any command lines attached to this target are executed before anything
1140 else is done.
1141 .It Ic .DEFAULT
1142 This is sort of a
1143 .Ic .USE
1144 rule for any target (that was used only as a
1145 source) that
1146 .Nm
1147 cannot figure out any other way to create.
1148 Only the shell script is used.
1149 The
1150 .Ic .IMPSRC
1151 variable of a target that inherits
1152 .Ic .DEFAULT Ns 's
1153 commands is set
1154 to the target's own name.
1155 .It Ic .END
1156 Any command lines attached to this target are executed after everything
1157 else is done.
1158 .It Ic .IGNORE
1159 Mark each of the sources with the
1160 .Ic .IGNORE
1161 attribute.
1162 If no sources are specified, this is the equivalent of specifying the
1163 .Fl i
1164 option.
1165 .It Ic .INCLUDES
1166 A list of suffixes that indicate files that can be included in a source
1167 file.
1168 The suffix must have already been declared with
1169 .Ic .SUFFIXES ;
1170 any suffix so declared will have the directories on its search path (see
1171 .Ic .PATH )
1172 placed in the
1173 .Va .INCLUDES
1174 special variable, each preceded by a
1175 .Fl I
1176 flag.
1177 .It Ic .INTERRUPT
1178 If
1179 .Nm
1180 is interrupted, the commands for this target will be executed.
1181 .It Ic .LIBS
1182 This does for libraries what
1183 .Ic .INCLUDES
1184 does for include files, except that the flag used is
1185 .Fl L .
1186 .It Ic .MAIN
1187 If no target is specified when
1188 .Nm
1189 is invoked, this target will be built.
1190 This is always set, either
1191 explicitly, or implicitly when
1192 .Nm
1193 selects the default target, to give the user a way to refer to the default
1194 target on the command line.
1195 .It Ic .MAKEFLAGS
1196 This target provides a way to specify flags for
1197 .Nm
1198 when the makefile is used.
1199 The flags are as if typed to the shell, though the
1200 .Fl f
1201 option will have
1202 no effect.
1203 Flags (except for
1204 .Fl f )
1205 and variable assignments specified as the source
1206 for this target are also appended to the
1207 .Va .MAKEFLAGS
1208 internal variable.
1209 Please note the difference between this target and the
1210 .Va .MAKEFLAGS
1211 internal variable: specifying an option or variable
1212 assignment as the source for this target will affect
1213 .Em both
1214 the current makefile and all processes that
1215 .Nm
1216 executes.
1217 .It Ic .MFLAGS
1218 Same as above, for backward compatibility.
1219 .\" XXX: NOT YET!!!!
1220 .\" .It Ic .NOTPARALLEL
1221 .\" The named targets are executed in non parallel mode. If no targets are
1222 .\" specified, then all targets are executed in non parallel mode.
1223 .It Ic .NOTPARALLEL
1224 Disable parallel mode.
1225 .It Ic .NO_PARALLEL
1226 Same as above, for compatibility with other
1227 .Nm pmake
1228 variants.
1229 .It Ic .ORDER
1230 The named targets are made in sequence.
1231 .\" XXX: NOT YET!!!!
1232 .\" .It Ic .PARALLEL
1233 .\" The named targets are executed in parallel mode. If no targets are
1234 .\" specified, then all targets are executed in parallel mode.
1235 .It Ic .PATH
1236 The sources are directories which are to be searched for files not
1237 found in the current directory.
1238 If no sources are specified, any previously specified directories are
1239 deleted.
1240 Where possible, use of
1241 .Ic .PATH
1242 is preferred over use of the
1243 .Va VPATH
1244 variable.
1245 .It Ic .PATH\fIsuffix\fR
1246 The sources are directories which are to be searched for suffixed files
1247 not found in the current directory.
1248 The
1249 .Nm
1250 utility
1251 first searches the suffixed search path, before reverting to the default
1252 path if the file is not found there.
1253 This form is required for
1254 .Ic .LIBS
1255 and
1256 .Ic .INCLUDES
1257 to work.
1258 .It Ic .PHONY
1259 Apply the
1260 .Ic .PHONY
1261 attribute to any specified sources.
1262 Targets with this attribute are always
1263 considered to be out of date.
1264 .It Ic .PRECIOUS
1265 Apply the
1266 .Ic .PRECIOUS
1267 attribute to any specified sources.
1268 If no sources are specified, the
1269 .Ic .PRECIOUS
1270 attribute is applied to every
1271 target in the file.
1272 .It Ic .SHELL
1273 Select another shell.
1274 The sources of this target have the format
1275 .Ar key Ns = Ns Ar value .
1276 The
1277 .Ar key
1278 is one of:
1279 .Bl -tag -width ".Va hasErrCtl"
1280 .It Va path
1281 Specify the path to the new shell.
1282 .It Va name
1283 Specify the name of the new shell.
1284 This may be either one of the three builtin shells (see below) or any
1285 other name.
1286 .It Va quiet
1287 Specify the shell command to turn echoing off.
1288 .It Va echo
1289 Specify the shell command to turn echoing on.
1290 .It Va filter
1291 Usually shells print the echo off command before turning echoing off.
1292 This is the exact string that will be printed by the shell and is used
1293 to filter the shell output to remove the echo off command.
1294 .It Va echoFlag
1295 The shell option that turns echoing on.
1296 .It Va errFlag
1297 The shell option to turn on error checking.
1298 If error checking is on, the shell should exit if a command returns
1299 a non-zero status.
1300 .It Va hasErrCtl
1301 True if the shell has error control.
1302 .It Va check
1303 If
1304 .Va hasErrCtl
1305 is true then this is the shell command to turn error checking on.
1306 If
1307 .Va hasErrCtl
1308 is false then this is a command template to echo commands for which error
1309 checking is disabled.
1310 The template must contain a
1311 .Ql %s .
1312 .It Va ignore
1313 If
1314 .Va hasErrCtl
1315 is true, this is the shell command to turn error checking off.
1316 If
1317 .Va hasErrCtl
1318 is false, this is a command template to execute a command so that errors
1319 are ignored.
1320 The template must contain a
1321 .Ql %s .
1322 .It Va meta
1323 This is a string of meta characters of the shell.
1324 .It Va builtins
1325 This is a string holding all the shell's builtin commands separated by blanks.
1326 The
1327 .Va meta
1328 and
1329 .Va builtins
1330 strings are used in compat mode.
1331 When a command line contains neither a meta
1332 character nor starts with a shell builtin, it is executed directly without
1333 invoking a shell.
1334 When one of these strings (or both) is empty all commands are executed
1335 through a shell.
1336 .It Va unsetenv
1337 If true, remove the
1338 .Ev ENV
1339 environment variable before executing any command.
1340 This is useful for the Korn-shell
1341 .Pq Nm ksh .
1342 .El
1343 .Pp
1344 Values that are strings must be surrounded by double quotes.
1345 Boolean values are specified as
1346 .Ql T
1347 or
1348 .Ql Y
1349 (in either case) to mean true.
1350 Any other value is taken to mean false.
1351 .Pp
1352 There are several uses of the
1353 .Ic .SHELL
1354 target:
1355 .Bl -bullet
1356 .It
1357 Selecting one of the builtin shells.
1358 This is done by just specifying the name of the shell with the
1359 .Va name
1360 keyword.
1361 It is also possible to modify the parameters of the builtin shell by just
1362 specifying other keywords (except for
1363 .Va path ) .
1364 .It
1365 Using another executable for one of the builtin shells.
1366 This is done by specifying the path to the executable with the
1367 .Va path
1368 keyword.
1369 If the last component is the same as the name of the builtin shell, no
1370 name needs to be specified; if it is different, the name must be given:
1371 .Bd -literal -offset indent
1372 \&.SHELL: path="/usr/local/bin/sh"
1373 .Ed
1374 .Pp
1375 selects the builtin shell
1376 .Dq Li sh
1377 but will execute it from
1378 .Pa /usr/local/bin/sh .
1379 Like in the previous case, it is possible to modify parameters of the builtin
1380 shell by just specifying them.
1381 .It
1382 Using an entirely different shell.
1383 This is done by specifying all keywords.
1384 .El
1385 .Pp
1386 The builtin shells are
1387 .Dq Li sh ,
1388 .Dq Li csh
1389 and
1390 .Dq Li ksh .
1391 Because
1392 .Fx
1393 has no
1394 .Nm ksh
1395 in
1396 .Pa /bin ,
1397 it is unwise to specify
1398 .Va name Ns = Ns Qq Li ksh
1399 without also specifying a path.
1400 .It Ic .SILENT
1401 Apply the
1402 .Ic .SILENT
1403 attribute to any specified sources.
1404 If no sources are specified, the
1405 .Ic .SILENT
1406 attribute is applied to every
1407 command in the file.
1408 .It Ic .SUFFIXES
1409 Each source specifies a suffix to
1410 .Nm .
1411 If no sources are specified, any previous specified suffices are deleted.
1412 .It Ic .WARN
1413 Each source specifies a warning flag as previously described for the
1414 .Fl x
1415 command line option.
1416 Warning flags specified on the command line take precedence over flags
1417 specified in the makefile.
1418 Also, command line warning flags are pushed to sub-makes through the
1419 .Ev MAKEFLAGS
1420 environment variables so that a warning flag specified on the command
1421 line will influence all sub-makes.
1422 Several flags can be specified on a single
1423 .Ic .WARN
1424 target by seperating them with blanks.
1425 .El
1426 .Sh ENVIRONMENT
1427 The
1428 .Nm
1429 utility uses the following environment variables, if they exist:
1430 .Ev MACHINE ,
1431 .Ev MAKE ,
1432 .Ev MAKEFLAGS ,
1433 .Ev MAKEOBJDIR ,
1434 and
1435 .Ev MAKEOBJDIRPREFIX .
1436 .Sh FILES
1437 .Bl -tag -width /usr/share/doc/psd/12.make -compact
1438 .It Pa .depend
1439 list of dependencies
1440 .It Pa Makefile
1441 list of dependencies
1442 .It Pa makefile
1443 list of dependencies
1444 .It obj
1445 object directory
1446 .It Pa sys.mk
1447 system makefile (processed before any other file, including
1448 .Pa makefile
1449 and
1450 .Pa Makefile )
1451 .It Pa /usr/share/mk
1452 system makefile directory
1453 .It /usr/share/doc/psd/12.make
1454 PMake tutorial
1455 .It Pa /usr/obj
1456 default
1457 .Ev MAKEOBJDIRPREFIX
1458 directory.
1459 .El
1460 .Sh EXAMPLES
1461 List all included makefiles in order visited:
1462 .Pp
1463 .Dl "make -V .MAKEFILE_LIST | tr \e\  \e\en"
1464 .Sh COMPATIBILITY
1465 Older versions of
1466 .Nm
1467 used
1468 .Ev MAKE
1469 instead of
1470 .Ev MAKEFLAGS .
1471 This was removed for POSIX compatibility.
1472 The internal variable
1473 .Va MAKE
1474 is set to the same value as
1475 .Va .MAKE ;
1476 support for this may be removed in the future.
1477 .Pp
1478 Most of the more esoteric features of
1479 .Nm
1480 should probably be avoided for greater compatibility.
1481 .Sh SEE ALSO
1482 .Xr mkdep 1 ,
1483 .Xr make.conf 5
1484 .Rs
1485 .%T "PMake - A Tutorial"
1486 .Re
1487 in
1488 .Pa /usr/share/doc/psd/12.make
1489 .Sh HISTORY
1490 A
1491 .Nm
1492 command appeared in PWB UNIX.
1493 .Sh BUGS
1494 The determination of
1495 .Va .OBJDIR
1496 is contorted to the point of absurdity.
1497 .Pp
1498 In the presence of several
1499 .Ic .MAIN
1500 special targets,
1501 .Nm
1502 silently ignores all but the first.
1503 .Pp
1504 .Va .TARGETS
1505 is not set to the default target when
1506 .Nm
1507 is invoked without a target name and no
1508 .Ic .MAIN
1509 special target exists.
1510 .Pp
1511 The evaluation of
1512 .Ar expression
1513 in a test is very simple-minded.
1514 Currently, the only form that works is
1515 .Ql .if ${VAR} op something
1516 For instance, you should write tests as
1517 .Ql .if ${VAR} == "string"
1518 not the other way around, which would give you an error.
1519 .Pp
1520 For loops are expanded before tests, so a fragment such as:
1521 .Bd -literal -offset indent
1522 \&.for ARCH in ${SHARED_ARCHS}
1523 \&.if ${ARCH} == ${MACHINE}
1524      ...
1525 \&.endif
1526 \&.endfor
1527 .Ed
1528 .Pp
1529 will not work, and should be rewritten as:
1530 .Bd -literal -offset indent
1531 \&.for ARCH in ${SHARED_ARCHS}
1532 \&.if ${MACHINE} == ${ARCH}
1533      ...
1534 \&.endif
1535 \&.endfor
1536 .Ed
1537 .Pp
1538 The parsing code is broken with respect to handling a semicolon
1539 after a colon, so a fragment like this will fail:
1540 .Bd -literal -offset indent
1541 HDRS=   foo.h bar.h
1542
1543 all:
1544 \&.for h in ${HDRS:S;^;${.CURDIR}/;}
1545      ...
1546 \&.endfor
1547 .Ed
1548 .Pp
1549 A trailing backslash in a variable value defined on the command line causes
1550 the delimiting space in the
1551 .Ev MAKEFLAGS
1552 environment variable to be preceeded by that backslash.
1553 That causes a submake to not treat that space as a word delimiter.
1554 Fixing this requires a larger rewrite of the code handling command line
1555 macros and assignments to
1556 .Va .MAKEFLAGS .