1*12904384SSimon J. Gerraty.\" $NetBSD: make.1,v 1.300 2021/12/12 20:45:48 sjg Exp $ 23955d011SMarcel Moolenaar.\" 33955d011SMarcel Moolenaar.\" Copyright (c) 1990, 1993 43955d011SMarcel Moolenaar.\" The Regents of the University of California. All rights reserved. 53955d011SMarcel Moolenaar.\" 63955d011SMarcel Moolenaar.\" Redistribution and use in source and binary forms, with or without 73955d011SMarcel Moolenaar.\" modification, are permitted provided that the following conditions 83955d011SMarcel Moolenaar.\" are met: 93955d011SMarcel Moolenaar.\" 1. Redistributions of source code must retain the above copyright 103955d011SMarcel Moolenaar.\" notice, this list of conditions and the following disclaimer. 113955d011SMarcel Moolenaar.\" 2. Redistributions in binary form must reproduce the above copyright 123955d011SMarcel Moolenaar.\" notice, this list of conditions and the following disclaimer in the 133955d011SMarcel Moolenaar.\" documentation and/or other materials provided with the distribution. 143955d011SMarcel Moolenaar.\" 3. Neither the name of the University nor the names of its contributors 153955d011SMarcel Moolenaar.\" may be used to endorse or promote products derived from this software 163955d011SMarcel Moolenaar.\" without specific prior written permission. 173955d011SMarcel Moolenaar.\" 183955d011SMarcel Moolenaar.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 193955d011SMarcel Moolenaar.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 203955d011SMarcel Moolenaar.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 213955d011SMarcel Moolenaar.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 223955d011SMarcel Moolenaar.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 233955d011SMarcel Moolenaar.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 243955d011SMarcel Moolenaar.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 253955d011SMarcel Moolenaar.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 263955d011SMarcel Moolenaar.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 273955d011SMarcel Moolenaar.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 283955d011SMarcel Moolenaar.\" SUCH DAMAGE. 293955d011SMarcel Moolenaar.\" 303955d011SMarcel Moolenaar.\" from: @(#)make.1 8.4 (Berkeley) 3/19/94 313955d011SMarcel Moolenaar.\" 32*12904384SSimon J. Gerraty.Dd December 12, 2021 3345447996SSimon J. Gerraty.Dt BMAKE 1 343955d011SMarcel Moolenaar.Os 353955d011SMarcel Moolenaar.Sh NAME 363955d011SMarcel Moolenaar.Nm bmake 373955d011SMarcel Moolenaar.Nd maintain program dependencies 383955d011SMarcel Moolenaar.Sh SYNOPSIS 393955d011SMarcel Moolenaar.Nm 40e2eeea75SSimon J. Gerraty.Op Fl BeikNnqrSstWwX 413955d011SMarcel Moolenaar.Op Fl C Ar directory 423955d011SMarcel Moolenaar.Op Fl D Ar variable 433955d011SMarcel Moolenaar.Op Fl d Ar flags 443955d011SMarcel Moolenaar.Op Fl f Ar makefile 453955d011SMarcel Moolenaar.Op Fl I Ar directory 463955d011SMarcel Moolenaar.Op Fl J Ar private 473955d011SMarcel Moolenaar.Op Fl j Ar max_jobs 483955d011SMarcel Moolenaar.Op Fl m Ar directory 493955d011SMarcel Moolenaar.Op Fl T Ar file 503955d011SMarcel Moolenaar.Op Fl V Ar variable 518695518cSSimon J. Gerraty.Op Fl v Ar variable 523955d011SMarcel Moolenaar.Op Ar variable=value 533955d011SMarcel Moolenaar.Op Ar target ... 543955d011SMarcel Moolenaar.Sh DESCRIPTION 553955d011SMarcel Moolenaar.Nm 563955d011SMarcel Moolenaaris a program designed to simplify the maintenance of other programs. 573955d011SMarcel MoolenaarIts input is a list of specifications as to the files upon which programs 583955d011SMarcel Moolenaarand other files depend. 593955d011SMarcel MoolenaarIf no 603955d011SMarcel Moolenaar.Fl f Ar makefile 613955d011SMarcel Moolenaarmakefile option is given, 623955d011SMarcel Moolenaar.Nm 633955d011SMarcel Moolenaarwill try to open 643955d011SMarcel Moolenaar.Ql Pa makefile 653955d011SMarcel Moolenaarthen 663955d011SMarcel Moolenaar.Ql Pa Makefile 673955d011SMarcel Moolenaarin order to find the specifications. 683955d011SMarcel MoolenaarIf the file 693955d011SMarcel Moolenaar.Ql Pa .depend 703955d011SMarcel Moolenaarexists, it is read (see 713955d011SMarcel Moolenaar.Xr mkdep 1 ) . 723955d011SMarcel Moolenaar.Pp 733955d011SMarcel MoolenaarThis manual page is intended as a reference document only. 743955d011SMarcel MoolenaarFor a more thorough description of 753955d011SMarcel Moolenaar.Nm 763955d011SMarcel Moolenaarand makefiles, please refer to 773955d011SMarcel Moolenaar.%T "PMake \- A Tutorial" . 783955d011SMarcel Moolenaar.Pp 793955d011SMarcel Moolenaar.Nm 803955d011SMarcel Moolenaarwill prepend the contents of the 813955d011SMarcel Moolenaar.Va MAKEFLAGS 823955d011SMarcel Moolenaarenvironment variable to the command line arguments before parsing them. 833955d011SMarcel Moolenaar.Pp 843955d011SMarcel MoolenaarThe options are as follows: 853955d011SMarcel Moolenaar.Bl -tag -width Ds 863955d011SMarcel Moolenaar.It Fl B 873955d011SMarcel MoolenaarTry to be backwards compatible by executing a single shell per command and 883955d011SMarcel Moolenaarby executing the commands to make the sources of a dependency line in sequence. 893955d011SMarcel Moolenaar.It Fl C Ar directory 903955d011SMarcel MoolenaarChange to 913955d011SMarcel Moolenaar.Ar directory 923955d011SMarcel Moolenaarbefore reading the makefiles or doing anything else. 933955d011SMarcel MoolenaarIf multiple 943955d011SMarcel Moolenaar.Fl C 953955d011SMarcel Moolenaaroptions are specified, each is interpreted relative to the previous one: 963955d011SMarcel Moolenaar.Fl C Pa / Fl C Pa etc 973955d011SMarcel Moolenaaris equivalent to 983955d011SMarcel Moolenaar.Fl C Pa /etc . 993955d011SMarcel Moolenaar.It Fl D Ar variable 1003955d011SMarcel MoolenaarDefine 1013955d011SMarcel Moolenaar.Ar variable 102dba7b0efSSimon J. Gerratyto be 1, in the global scope. 1033955d011SMarcel Moolenaar.It Fl d Ar [-]flags 1043955d011SMarcel MoolenaarTurn on debugging, and specify which portions of 1053955d011SMarcel Moolenaar.Nm 1063955d011SMarcel Moolenaarare to print debugging information. 1073955d011SMarcel MoolenaarUnless the flags are preceded by 1083955d011SMarcel Moolenaar.Ql \- 1093955d011SMarcel Moolenaarthey are added to the 1103955d011SMarcel Moolenaar.Va MAKEFLAGS 1113955d011SMarcel Moolenaarenvironment variable and will be processed by any child make processes. 1123955d011SMarcel MoolenaarBy default, debugging information is printed to standard error, 1133955d011SMarcel Moolenaarbut this can be changed using the 1143955d011SMarcel Moolenaar.Ar F 1153955d011SMarcel Moolenaardebugging flag. 1163955d011SMarcel MoolenaarThe debugging output is always unbuffered; in addition, if debugging 1173955d011SMarcel Moolenaaris enabled but debugging output is not directed to standard output, 1183955d011SMarcel Moolenaarthen the standard output is line buffered. 1193955d011SMarcel Moolenaar.Ar Flags 1203955d011SMarcel Moolenaaris one or more of the following: 1213955d011SMarcel Moolenaar.Bl -tag -width Ds 1223955d011SMarcel Moolenaar.It Ar A 1233955d011SMarcel MoolenaarPrint all possible debugging information; 1243955d011SMarcel Moolenaarequivalent to specifying all of the debugging flags. 1253955d011SMarcel Moolenaar.It Ar a 1263955d011SMarcel MoolenaarPrint debugging information about archive searching and caching. 1273955d011SMarcel Moolenaar.It Ar C 1283955d011SMarcel MoolenaarPrint debugging information about current working directory. 1293955d011SMarcel Moolenaar.It Ar c 1303955d011SMarcel MoolenaarPrint debugging information about conditional evaluation. 1313955d011SMarcel Moolenaar.It Ar d 1323955d011SMarcel MoolenaarPrint debugging information about directory searching and caching. 1333955d011SMarcel Moolenaar.It Ar e 1343955d011SMarcel MoolenaarPrint debugging information about failed commands and targets. 1353955d011SMarcel Moolenaar.It Ar F Ns Oo Sy \&+ Oc Ns Ar filename 1363955d011SMarcel MoolenaarSpecify where debugging output is written. 1373955d011SMarcel MoolenaarThis must be the last flag, because it consumes the remainder of 1383955d011SMarcel Moolenaarthe argument. 1393955d011SMarcel MoolenaarIf the character immediately after the 1403955d011SMarcel Moolenaar.Ql F 1413955d011SMarcel Moolenaarflag is 1423955d011SMarcel Moolenaar.Ql \&+ , 1433955d011SMarcel Moolenaarthen the file will be opened in append mode; 1443955d011SMarcel Moolenaarotherwise the file will be overwritten. 1453955d011SMarcel MoolenaarIf the file name is 1463955d011SMarcel Moolenaar.Ql stdout 1473955d011SMarcel Moolenaaror 1483955d011SMarcel Moolenaar.Ql stderr 1493955d011SMarcel Moolenaarthen debugging output will be written to the 1503955d011SMarcel Moolenaarstandard output or standard error output file descriptors respectively 1513955d011SMarcel Moolenaar(and the 1523955d011SMarcel Moolenaar.Ql \&+ 1533955d011SMarcel Moolenaaroption has no effect). 1543955d011SMarcel MoolenaarOtherwise, the output will be written to the named file. 1553955d011SMarcel MoolenaarIf the file name ends 1563955d011SMarcel Moolenaar.Ql .%d 1573955d011SMarcel Moolenaarthen the 1583955d011SMarcel Moolenaar.Ql %d 1593955d011SMarcel Moolenaaris replaced by the pid. 1603955d011SMarcel Moolenaar.It Ar f 1613955d011SMarcel MoolenaarPrint debugging information about loop evaluation. 1623955d011SMarcel Moolenaar.It Ar "g1" 1633955d011SMarcel MoolenaarPrint the input graph before making anything. 1643955d011SMarcel Moolenaar.It Ar "g2" 1653955d011SMarcel MoolenaarPrint the input graph after making everything, or before exiting 1663955d011SMarcel Moolenaaron error. 1673955d011SMarcel Moolenaar.It Ar "g3" 1683955d011SMarcel MoolenaarPrint the input graph before exiting on error. 1692c3632d1SSimon J. Gerraty.It Ar h 1702c3632d1SSimon J. GerratyPrint debugging information about hash table operations. 1713955d011SMarcel Moolenaar.It Ar j 1723955d011SMarcel MoolenaarPrint debugging information about running multiple shells. 1732c3632d1SSimon J. Gerraty.It Ar L 1742c3632d1SSimon J. GerratyTurn on lint checks. 1752c3632d1SSimon J. GerratyThis will throw errors for variable assignments that do not parse 1762c3632d1SSimon J. Gerratycorrectly, at the time of assignment so the file and line number 1772c3632d1SSimon J. Gerratyare available. 1783955d011SMarcel Moolenaar.It Ar l 1793955d011SMarcel MoolenaarPrint commands in Makefiles regardless of whether or not they are prefixed by 1803955d011SMarcel Moolenaar.Ql @ 1813955d011SMarcel Moolenaaror other "quiet" flags. 1823955d011SMarcel MoolenaarAlso known as "loud" behavior. 1833955d011SMarcel Moolenaar.It Ar M 1843955d011SMarcel MoolenaarPrint debugging information about "meta" mode decisions about targets. 1853955d011SMarcel Moolenaar.It Ar m 1863955d011SMarcel MoolenaarPrint debugging information about making targets, including modification 1873955d011SMarcel Moolenaardates. 1883955d011SMarcel Moolenaar.It Ar n 1893955d011SMarcel MoolenaarDon't delete the temporary command scripts created when running commands. 1903955d011SMarcel MoolenaarThese temporary scripts are created in the directory 1913955d011SMarcel Moolenaarreferred to by the 1923955d011SMarcel Moolenaar.Ev TMPDIR 1933955d011SMarcel Moolenaarenvironment variable, or in 1943955d011SMarcel Moolenaar.Pa /tmp 1953955d011SMarcel Moolenaarif 1963955d011SMarcel Moolenaar.Ev TMPDIR 1973955d011SMarcel Moolenaaris unset or set to the empty string. 1983955d011SMarcel MoolenaarThe temporary scripts are created by 1993955d011SMarcel Moolenaar.Xr mkstemp 3 , 2003955d011SMarcel Moolenaarand have names of the form 2013955d011SMarcel Moolenaar.Pa makeXXXXXX . 2023955d011SMarcel Moolenaar.Em NOTE : 2033955d011SMarcel MoolenaarThis can create many files in 2043955d011SMarcel Moolenaar.Ev TMPDIR 2053955d011SMarcel Moolenaaror 2063955d011SMarcel Moolenaar.Pa /tmp , 2073955d011SMarcel Moolenaarso use with care. 2083955d011SMarcel Moolenaar.It Ar p 2093955d011SMarcel MoolenaarPrint debugging information about makefile parsing. 2103955d011SMarcel Moolenaar.It Ar s 2113955d011SMarcel MoolenaarPrint debugging information about suffix-transformation rules. 2123955d011SMarcel Moolenaar.It Ar t 2133955d011SMarcel MoolenaarPrint debugging information about target list maintenance. 2143955d011SMarcel Moolenaar.It Ar V 2153955d011SMarcel MoolenaarForce the 2163955d011SMarcel Moolenaar.Fl V 2178695518cSSimon J. Gerratyoption to print raw values of variables, overriding the default behavior 2188695518cSSimon J. Gerratyset via 2198695518cSSimon J. Gerraty.Va .MAKE.EXPAND_VARIABLES . 2203955d011SMarcel Moolenaar.It Ar v 2213955d011SMarcel MoolenaarPrint debugging information about variable assignment. 2223955d011SMarcel Moolenaar.It Ar x 2233955d011SMarcel MoolenaarRun shell commands with 2243955d011SMarcel Moolenaar.Fl x 2253955d011SMarcel Moolenaarso the actual commands are printed as they are executed. 2263955d011SMarcel Moolenaar.El 2273955d011SMarcel Moolenaar.It Fl e 2283955d011SMarcel MoolenaarSpecify that environment variables override macro assignments within 2293955d011SMarcel Moolenaarmakefiles. 2303955d011SMarcel Moolenaar.It Fl f Ar makefile 2313955d011SMarcel MoolenaarSpecify a makefile to read instead of the default 2323955d011SMarcel Moolenaar.Ql Pa makefile . 2333955d011SMarcel MoolenaarIf 2343955d011SMarcel Moolenaar.Ar makefile 2353955d011SMarcel Moolenaaris 2363955d011SMarcel Moolenaar.Ql Fl , 2373955d011SMarcel Moolenaarstandard input is read. 2383955d011SMarcel MoolenaarMultiple makefiles may be specified, and are read in the order specified. 2393955d011SMarcel Moolenaar.It Fl I Ar directory 2403955d011SMarcel MoolenaarSpecify a directory in which to search for makefiles and included makefiles. 2413955d011SMarcel MoolenaarThe system makefile directory (or directories, see the 2423955d011SMarcel Moolenaar.Fl m 2433955d011SMarcel Moolenaaroption) is automatically included as part of this list. 2443955d011SMarcel Moolenaar.It Fl i 2453955d011SMarcel MoolenaarIgnore non-zero exit of shell commands in the makefile. 2463955d011SMarcel MoolenaarEquivalent to specifying 2473955d011SMarcel Moolenaar.Ql Fl 2483955d011SMarcel Moolenaarbefore each command line in the makefile. 2493955d011SMarcel Moolenaar.It Fl J Ar private 2503955d011SMarcel MoolenaarThis option should 2513955d011SMarcel Moolenaar.Em not 2523955d011SMarcel Moolenaarbe specified by the user. 2533955d011SMarcel Moolenaar.Pp 2543955d011SMarcel MoolenaarWhen the 2553955d011SMarcel Moolenaar.Ar j 2563955d011SMarcel Moolenaaroption is in use in a recursive build, this option is passed by a make 2573955d011SMarcel Moolenaarto child makes to allow all the make processes in the build to 2583955d011SMarcel Moolenaarcooperate to avoid overloading the system. 2593955d011SMarcel Moolenaar.It Fl j Ar max_jobs 2603955d011SMarcel MoolenaarSpecify the maximum number of jobs that 2613955d011SMarcel Moolenaar.Nm 2623955d011SMarcel Moolenaarmay have running at any one time. 2633955d011SMarcel MoolenaarThe value is saved in 2643955d011SMarcel Moolenaar.Va .MAKE.JOBS . 2653955d011SMarcel MoolenaarTurns compatibility mode off, unless the 2663955d011SMarcel Moolenaar.Ar B 2673955d011SMarcel Moolenaarflag is also specified. 2683955d011SMarcel MoolenaarWhen compatibility mode is off, all commands associated with a 2693955d011SMarcel Moolenaartarget are executed in a single shell invocation as opposed to the 2703955d011SMarcel Moolenaartraditional one shell invocation per line. 2713955d011SMarcel MoolenaarThis can break traditional scripts which change directories on each 2723955d011SMarcel Moolenaarcommand invocation and then expect to start with a fresh environment 2733955d011SMarcel Moolenaaron the next line. 2743955d011SMarcel MoolenaarIt is more efficient to correct the scripts rather than turn backwards 2753955d011SMarcel Moolenaarcompatibility on. 2763955d011SMarcel Moolenaar.It Fl k 2773955d011SMarcel MoolenaarContinue processing after errors are encountered, but only on those targets 2783955d011SMarcel Moolenaarthat do not depend on the target whose creation caused the error. 2793955d011SMarcel Moolenaar.It Fl m Ar directory 2803955d011SMarcel MoolenaarSpecify a directory in which to search for sys.mk and makefiles included 2813955d011SMarcel Moolenaarvia the 282ef0b2538SSimon J. Gerraty.Li \&< Ns Ar file Ns Li \&> Ns -style 2833955d011SMarcel Moolenaarinclude statement. 2843955d011SMarcel MoolenaarThe 2853955d011SMarcel Moolenaar.Fl m 2863955d011SMarcel Moolenaaroption can be used multiple times to form a search path. 2873955d011SMarcel MoolenaarThis path will override the default system include path: /usr/share/mk. 2883955d011SMarcel MoolenaarFurthermore the system include path will be appended to the search path used 2893955d011SMarcel Moolenaarfor 290ef0b2538SSimon J. Gerraty.Li \*q Ns Ar file Ns Li \*q Ns -style 2913955d011SMarcel Moolenaarinclude statements (see the 2923955d011SMarcel Moolenaar.Fl I 2933955d011SMarcel Moolenaaroption). 2943955d011SMarcel Moolenaar.Pp 2953955d011SMarcel MoolenaarIf a file or directory name in the 2963955d011SMarcel Moolenaar.Fl m 2973955d011SMarcel Moolenaarargument (or the 2983955d011SMarcel Moolenaar.Ev MAKESYSPATH 2993955d011SMarcel Moolenaarenvironment variable) starts with the string 3003955d011SMarcel Moolenaar.Qq \&.../ 3013955d011SMarcel Moolenaarthen 3023955d011SMarcel Moolenaar.Nm 3033955d011SMarcel Moolenaarwill search for the specified file or directory named in the remaining part 3043955d011SMarcel Moolenaarof the argument string. 3053955d011SMarcel MoolenaarThe search starts with the current directory of 3063955d011SMarcel Moolenaarthe Makefile and then works upward towards the root of the file system. 3073955d011SMarcel MoolenaarIf the search is successful, then the resulting directory replaces the 3083955d011SMarcel Moolenaar.Qq \&.../ 3093955d011SMarcel Moolenaarspecification in the 3103955d011SMarcel Moolenaar.Fl m 3113955d011SMarcel Moolenaarargument. 3123955d011SMarcel MoolenaarIf used, this feature allows 3133955d011SMarcel Moolenaar.Nm 3143955d011SMarcel Moolenaarto easily search in the current source tree for customized sys.mk files 3153955d011SMarcel Moolenaar(e.g., by using 3163955d011SMarcel Moolenaar.Qq \&.../mk/sys.mk 3173955d011SMarcel Moolenaaras an argument). 3183955d011SMarcel Moolenaar.It Fl n 3193955d011SMarcel MoolenaarDisplay the commands that would have been executed, but do not 3203955d011SMarcel Moolenaaractually execute them unless the target depends on the .MAKE special 3212c3632d1SSimon J. Gerratysource (see below) or the command is prefixed with 3222c3632d1SSimon J. Gerraty.Ql Ic + . 3233955d011SMarcel Moolenaar.It Fl N 3243955d011SMarcel MoolenaarDisplay the commands which would have been executed, but do not 3253955d011SMarcel Moolenaaractually execute any of them; useful for debugging top-level makefiles 3263955d011SMarcel Moolenaarwithout descending into subdirectories. 3273955d011SMarcel Moolenaar.It Fl q 3283955d011SMarcel MoolenaarDo not execute any commands, but exit 0 if the specified targets are 3293955d011SMarcel Moolenaarup-to-date and 1, otherwise. 3303955d011SMarcel Moolenaar.It Fl r 3313955d011SMarcel MoolenaarDo not use the built-in rules specified in the system makefile. 332e2eeea75SSimon J. Gerraty.It Fl S 333e2eeea75SSimon J. GerratyStop processing if an error is encountered. 334e2eeea75SSimon J. GerratyThis is the default behavior and the opposite of 335e2eeea75SSimon J. Gerraty.Fl k . 3363955d011SMarcel Moolenaar.It Fl s 3373955d011SMarcel MoolenaarDo not echo any commands as they are executed. 3383955d011SMarcel MoolenaarEquivalent to specifying 3393955d011SMarcel Moolenaar.Ql Ic @ 3403955d011SMarcel Moolenaarbefore each command line in the makefile. 3413955d011SMarcel Moolenaar.It Fl T Ar tracefile 3423955d011SMarcel MoolenaarWhen used with the 3433955d011SMarcel Moolenaar.Fl j 3443955d011SMarcel Moolenaarflag, 3453955d011SMarcel Moolenaarappend a trace record to 3463955d011SMarcel Moolenaar.Ar tracefile 3473955d011SMarcel Moolenaarfor each job started and completed. 3483955d011SMarcel Moolenaar.It Fl t 3493955d011SMarcel MoolenaarRather than re-building a target as specified in the makefile, create it 3503955d011SMarcel Moolenaaror update its modification time to make it appear up-to-date. 3513955d011SMarcel Moolenaar.It Fl V Ar variable 3528695518cSSimon J. GerratyPrint the value of 3538695518cSSimon J. Gerraty.Ar variable . 3543955d011SMarcel MoolenaarDo not build any targets. 3553955d011SMarcel MoolenaarMultiple instances of this option may be specified; 3563955d011SMarcel Moolenaarthe variables will be printed one per line, 3573955d011SMarcel Moolenaarwith a blank line for each null or undefined variable. 358dba7b0efSSimon J. GerratyThe value printed is extracted from the global scope after all 3598695518cSSimon J. Gerratymakefiles have been read. 3608695518cSSimon J. GerratyBy default, the raw variable contents (which may 3618695518cSSimon J. Gerratyinclude additional unexpanded variable references) are shown. 3623955d011SMarcel MoolenaarIf 3633955d011SMarcel Moolenaar.Ar variable 3643955d011SMarcel Moolenaarcontains a 3653955d011SMarcel Moolenaar.Ql \&$ 3668695518cSSimon J. Gerratythen the value will be recursively expanded to its complete resultant 3678695518cSSimon J. Gerratytext before printing. 3688695518cSSimon J. GerratyThe expanded value will also be printed if 3698695518cSSimon J. Gerraty.Va .MAKE.EXPAND_VARIABLES 3708695518cSSimon J. Gerratyis set to true and 3718695518cSSimon J. Gerratythe 3728695518cSSimon J. Gerraty.Fl dV 3738695518cSSimon J. Gerratyoption has not been used to override it. 3748695518cSSimon J. GerratyNote that loop-local and target-local variables, as well as values 3758695518cSSimon J. Gerratytaken temporarily by global variables during makefile processing, are 3768695518cSSimon J. Gerratynot accessible via this option. 3778695518cSSimon J. GerratyThe 3788695518cSSimon J. Gerraty.Fl dv 3798695518cSSimon J. Gerratydebug mode can be used to see these at the cost of generating 3808695518cSSimon J. Gerratysubstantial extraneous output. 3818695518cSSimon J. Gerraty.It Fl v Ar variable 3828695518cSSimon J. GerratyLike 3838695518cSSimon J. Gerraty.Fl V 3848695518cSSimon J. Gerratybut the variable is always expanded to its complete value. 3853955d011SMarcel Moolenaar.It Fl W 3863955d011SMarcel MoolenaarTreat any warnings during makefile parsing as errors. 387db29cad8SSimon J. Gerraty.It Fl w 388db29cad8SSimon J. GerratyPrint entering and leaving directory messages, pre and post processing. 3893955d011SMarcel Moolenaar.It Fl X 3903955d011SMarcel MoolenaarDon't export variables passed on the command line to the environment 3913955d011SMarcel Moolenaarindividually. 3923955d011SMarcel MoolenaarVariables passed on the command line are still exported 3933955d011SMarcel Moolenaarvia the 3943955d011SMarcel Moolenaar.Va MAKEFLAGS 3953955d011SMarcel Moolenaarenvironment variable. 3963955d011SMarcel MoolenaarThis option may be useful on systems which have a small limit on the 3973955d011SMarcel Moolenaarsize of command arguments. 3983955d011SMarcel Moolenaar.It Ar variable=value 3993955d011SMarcel MoolenaarSet the value of the variable 4003955d011SMarcel Moolenaar.Ar variable 4013955d011SMarcel Moolenaarto 4023955d011SMarcel Moolenaar.Ar value . 4033955d011SMarcel MoolenaarNormally, all values passed on the command line are also exported to 4043955d011SMarcel Moolenaarsub-makes in the environment. 4053955d011SMarcel MoolenaarThe 4063955d011SMarcel Moolenaar.Fl X 4073955d011SMarcel Moolenaarflag disables this behavior. 4083955d011SMarcel MoolenaarVariable assignments should follow options for POSIX compatibility 4093955d011SMarcel Moolenaarbut no ordering is enforced. 4103955d011SMarcel Moolenaar.El 4113955d011SMarcel Moolenaar.Pp 4123955d011SMarcel MoolenaarThere are seven different types of lines in a makefile: file dependency 4133955d011SMarcel Moolenaarspecifications, shell commands, variable assignments, include statements, 4143955d011SMarcel Moolenaarconditional directives, for loops, and comments. 4153955d011SMarcel Moolenaar.Pp 4163955d011SMarcel MoolenaarIn general, lines may be continued from one line to the next by ending 4173955d011SMarcel Moolenaarthem with a backslash 4183955d011SMarcel Moolenaar.Pq Ql \e . 4193955d011SMarcel MoolenaarThe trailing newline character and initial whitespace on the following 4203955d011SMarcel Moolenaarline are compressed into a single space. 4213955d011SMarcel Moolenaar.Sh FILE DEPENDENCY SPECIFICATIONS 4223955d011SMarcel MoolenaarDependency lines consist of one or more targets, an operator, and zero 4233955d011SMarcel Moolenaaror more sources. 4243955d011SMarcel MoolenaarThis creates a relationship where the targets 4253955d011SMarcel Moolenaar.Dq depend 4263955d011SMarcel Moolenaaron the sources 4272c3632d1SSimon J. Gerratyand are customarily created from them. 4282c3632d1SSimon J. GerratyA target is considered out-of-date if it does not exist, or if its 4292c3632d1SSimon J. Gerratymodification time is less than that of any of its sources. 4302c3632d1SSimon J. GerratyAn out-of-date target will be re-created, but not until all sources 4312c3632d1SSimon J. Gerratyhave been examined and themselves re-created as needed. 4322c3632d1SSimon J. GerratyThree operators may be used: 4333955d011SMarcel Moolenaar.Bl -tag -width flag 4343955d011SMarcel Moolenaar.It Ic \&: 4352c3632d1SSimon J. GerratyMany dependency lines may name this target but only one may have 4362c3632d1SSimon J. Gerratyattached shell commands. 4372c3632d1SSimon J. GerratyAll sources named in all dependency lines are considered together, 4382c3632d1SSimon J. Gerratyand if needed the attached shell commands are run to create or 4392c3632d1SSimon J. Gerratyre-create the target. 4402c3632d1SSimon J. GerratyIf 4413955d011SMarcel Moolenaar.Nm 4422c3632d1SSimon J. Gerratyis interrupted, the target is removed. 4433955d011SMarcel Moolenaar.It Ic \&! 4442c3632d1SSimon J. GerratyThe same, but the target is always re-created whether or not it is out 4452c3632d1SSimon J. Gerratyof date. 4463955d011SMarcel Moolenaar.It Ic \&:: 4472c3632d1SSimon J. GerratyAny dependency line may have attached shell commands, but each one 4482c3632d1SSimon J. Gerratyis handled independently: its sources are considered and the attached 4492c3632d1SSimon J. Gerratyshell commands are run if the target is out of date with respect to 4502c3632d1SSimon J. Gerraty(only) those sources. 4512c3632d1SSimon J. GerratyThus, different groups of the attached shell commands may be run 4522c3632d1SSimon J. Gerratydepending on the circumstances. 4532c3632d1SSimon J. GerratyFurthermore, unlike 4542c3632d1SSimon J. Gerraty.Ic \&:, 4552c3632d1SSimon J. Gerratyfor dependency lines with no sources, the attached shell 4562c3632d1SSimon J. Gerratycommands are always run. 4572c3632d1SSimon J. GerratyAlso unlike 4582c3632d1SSimon J. Gerraty.Ic \&:, 4592c3632d1SSimon J. Gerratythe target will not be removed if 4603955d011SMarcel Moolenaar.Nm 4613955d011SMarcel Moolenaaris interrupted. 4623955d011SMarcel Moolenaar.El 4632c3632d1SSimon J. GerratyAll dependency lines mentioning a particular target must use the same 4642c3632d1SSimon J. Gerratyoperator. 4653955d011SMarcel Moolenaar.Pp 4663955d011SMarcel MoolenaarTargets and sources may contain the shell wildcard values 4673955d011SMarcel Moolenaar.Ql \&? , 4683955d011SMarcel Moolenaar.Ql * , 4693955d011SMarcel Moolenaar.Ql [] , 4703955d011SMarcel Moolenaarand 4713955d011SMarcel Moolenaar.Ql {} . 4723955d011SMarcel MoolenaarThe values 4733955d011SMarcel Moolenaar.Ql \&? , 4743955d011SMarcel Moolenaar.Ql * , 4753955d011SMarcel Moolenaarand 4763955d011SMarcel Moolenaar.Ql [] 4773955d011SMarcel Moolenaarmay only be used as part of the final 4783955d011SMarcel Moolenaarcomponent of the target or source, and must be used to describe existing 4793955d011SMarcel Moolenaarfiles. 4803955d011SMarcel MoolenaarThe value 4813955d011SMarcel Moolenaar.Ql {} 4823955d011SMarcel Moolenaarneed not necessarily be used to describe existing files. 4833955d011SMarcel MoolenaarExpansion is in directory order, not alphabetically as done in the shell. 4843955d011SMarcel Moolenaar.Sh SHELL COMMANDS 485db29cad8SSimon J. GerratyEach target may have associated with it one or more lines of shell 486db29cad8SSimon J. Gerratycommands, normally 4873955d011SMarcel Moolenaarused to create the target. 488db29cad8SSimon J. GerratyEach of the lines in this script 4893955d011SMarcel Moolenaar.Em must 4903955d011SMarcel Moolenaarbe preceded by a tab. 491db29cad8SSimon J. Gerraty(For historical reasons, spaces are not accepted.) 492db29cad8SSimon J. GerratyWhile targets can appear in many dependency lines if desired, by 493db29cad8SSimon J. Gerratydefault only one of these rules may be followed by a creation 494db29cad8SSimon J. Gerratyscript. 495db29cad8SSimon J. GerratyIf the 4963955d011SMarcel Moolenaar.Ql Ic \&:: 497db29cad8SSimon J. Gerratyoperator is used, however, all rules may include scripts and the 498db29cad8SSimon J. Gerratyscripts are executed in the order found. 4993955d011SMarcel Moolenaar.Pp 500db29cad8SSimon J. GerratyEach line is treated as a separate shell command, unless the end of 501db29cad8SSimon J. Gerratyline is escaped with a backslash 502db29cad8SSimon J. Gerraty.Pq Ql \e 503db29cad8SSimon J. Gerratyin which case that line and the next are combined. 504db29cad8SSimon J. Gerraty.\" The escaped newline is retained and passed to the shell, which 505db29cad8SSimon J. Gerraty.\" normally ignores it. 506db29cad8SSimon J. Gerraty.\" However, the tab at the beginning of the following line is removed. 507db29cad8SSimon J. GerratyIf the first characters of the command are any combination of 5083955d011SMarcel Moolenaar.Ql Ic @ , 5093955d011SMarcel Moolenaar.Ql Ic + , 5103955d011SMarcel Moolenaaror 5113955d011SMarcel Moolenaar.Ql Ic \- , 5123955d011SMarcel Moolenaarthe command is treated specially. 5133955d011SMarcel MoolenaarA 5143955d011SMarcel Moolenaar.Ql Ic @ 5153955d011SMarcel Moolenaarcauses the command not to be echoed before it is executed. 5163955d011SMarcel MoolenaarA 5173955d011SMarcel Moolenaar.Ql Ic + 5183955d011SMarcel Moolenaarcauses the command to be executed even when 5193955d011SMarcel Moolenaar.Fl n 5203955d011SMarcel Moolenaaris given. 5213955d011SMarcel MoolenaarThis is similar to the effect of the .MAKE special source, 5223955d011SMarcel Moolenaarexcept that the effect can be limited to a single line of a script. 5233955d011SMarcel MoolenaarA 5243955d011SMarcel Moolenaar.Ql Ic \- 525db29cad8SSimon J. Gerratyin compatibility mode 5263955d011SMarcel Moolenaarcauses any non-zero exit status of the command line to be ignored. 5273cbdda60SSimon J. Gerraty.Pp 5283cbdda60SSimon J. GerratyWhen 5293cbdda60SSimon J. Gerraty.Nm 5303cbdda60SSimon J. Gerratyis run in jobs mode with 5313cbdda60SSimon J. Gerraty.Fl j Ar max_jobs , 5323cbdda60SSimon J. Gerratythe entire script for the target is fed to a 5333cbdda60SSimon J. Gerratysingle instance of the shell. 5343cbdda60SSimon J. GerratyIn compatibility (non-jobs) mode, each command is run in a separate process. 5353cbdda60SSimon J. GerratyIf the command contains any shell meta characters 5363cbdda60SSimon J. Gerraty.Pq Ql #=|^(){};&<>*?[]:$`\e\en 537db29cad8SSimon J. Gerratyit will be passed to the shell; otherwise 5383cbdda60SSimon J. Gerraty.Nm 5393cbdda60SSimon J. Gerratywill attempt direct execution. 540db29cad8SSimon J. GerratyIf a line starts with 541db29cad8SSimon J. Gerraty.Ql Ic \- 542db29cad8SSimon J. Gerratyand the shell has ErrCtl enabled then failure of the command line 543db29cad8SSimon J. Gerratywill be ignored as in compatibility mode. 544db29cad8SSimon J. GerratyOtherwise 545db29cad8SSimon J. Gerraty.Ql Ic \- 546db29cad8SSimon J. Gerratyaffects the entire job; 547db29cad8SSimon J. Gerratythe script will stop at the first command line that fails, 548db29cad8SSimon J. Gerratybut the target will not be deemed to have failed. 549db29cad8SSimon J. Gerraty.Pp 550db29cad8SSimon J. GerratyMakefiles should be written so that the mode of 551db29cad8SSimon J. Gerraty.Nm 552db29cad8SSimon J. Gerratyoperation does not change their behavior. 553db29cad8SSimon J. GerratyFor example, any command which needs to use 554db29cad8SSimon J. Gerraty.Dq cd 555db29cad8SSimon J. Gerratyor 556db29cad8SSimon J. Gerraty.Dq chdir 557db29cad8SSimon J. Gerratywithout potentially changing the directory for subsequent commands 558db29cad8SSimon J. Gerratyshould be put in parentheses so it executes in a subshell. 559db29cad8SSimon J. GerratyTo force the use of one shell, escape the line breaks so as to make 560db29cad8SSimon J. Gerratythe whole script one command. 561db29cad8SSimon J. GerratyFor example: 562db29cad8SSimon J. Gerraty.Bd -literal -offset indent 563db29cad8SSimon J. Gerratyavoid-chdir-side-effects: 564db29cad8SSimon J. Gerraty @echo Building $@ in `pwd` 565db29cad8SSimon J. Gerraty @(cd ${.CURDIR} && ${MAKE} $@) 566db29cad8SSimon J. Gerraty @echo Back in `pwd` 567db29cad8SSimon J. Gerraty 568db29cad8SSimon J. Gerratyensure-one-shell-regardless-of-mode: 569db29cad8SSimon J. Gerraty @echo Building $@ in `pwd`; \e 570db29cad8SSimon J. Gerraty (cd ${.CURDIR} && ${MAKE} $@); \e 571db29cad8SSimon J. Gerraty echo Back in `pwd` 572db29cad8SSimon J. Gerraty.Ed 5733cbdda60SSimon J. Gerraty.Pp 5743cbdda60SSimon J. GerratySince 5753cbdda60SSimon J. Gerraty.Nm 5763cbdda60SSimon J. Gerratywill 5773cbdda60SSimon J. Gerraty.Xr chdir 2 5783cbdda60SSimon J. Gerratyto 5793cbdda60SSimon J. Gerraty.Ql Va .OBJDIR 5803cbdda60SSimon J. Gerratybefore executing any targets, each child process 5813cbdda60SSimon J. Gerratystarts with that as its current working directory. 5823955d011SMarcel Moolenaar.Sh VARIABLE ASSIGNMENTS 5833955d011SMarcel MoolenaarVariables in make are much like variables in the shell, and, by tradition, 5843955d011SMarcel Moolenaarconsist of all upper-case letters. 5853955d011SMarcel Moolenaar.Ss Variable assignment modifiers 5863955d011SMarcel MoolenaarThe five operators that can be used to assign values to variables are as 5873955d011SMarcel Moolenaarfollows: 5883955d011SMarcel Moolenaar.Bl -tag -width Ds 5893955d011SMarcel Moolenaar.It Ic \&= 5903955d011SMarcel MoolenaarAssign the value to the variable. 5913955d011SMarcel MoolenaarAny previous value is overridden. 5923955d011SMarcel Moolenaar.It Ic \&+= 5933955d011SMarcel MoolenaarAppend the value to the current value of the variable. 5943955d011SMarcel Moolenaar.It Ic \&?= 5953955d011SMarcel MoolenaarAssign the value to the variable if it is not already defined. 5963955d011SMarcel Moolenaar.It Ic \&:= 5973955d011SMarcel MoolenaarAssign with expansion, i.e. expand the value before assigning it 5983955d011SMarcel Moolenaarto the variable. 5993955d011SMarcel MoolenaarNormally, expansion is not done until the variable is referenced. 6003955d011SMarcel Moolenaar.Em NOTE : 6013955d011SMarcel MoolenaarReferences to undefined variables are 6023955d011SMarcel Moolenaar.Em not 6033955d011SMarcel Moolenaarexpanded. 6043955d011SMarcel MoolenaarThis can cause problems when variable modifiers are used. 6053955d011SMarcel Moolenaar.It Ic \&!= 6063955d011SMarcel MoolenaarExpand the value and pass it to the shell for execution and assign 6073955d011SMarcel Moolenaarthe result to the variable. 6083955d011SMarcel MoolenaarAny newlines in the result are replaced with spaces. 6093955d011SMarcel Moolenaar.El 6103955d011SMarcel Moolenaar.Pp 6113955d011SMarcel MoolenaarAny white-space before the assigned 6123955d011SMarcel Moolenaar.Ar value 6133955d011SMarcel Moolenaaris removed; if the value is being appended, a single space is inserted 6143955d011SMarcel Moolenaarbetween the previous contents of the variable and the appended value. 6153955d011SMarcel Moolenaar.Pp 6163955d011SMarcel MoolenaarVariables are expanded by surrounding the variable name with either 6173955d011SMarcel Moolenaarcurly braces 6183955d011SMarcel Moolenaar.Pq Ql {} 6193955d011SMarcel Moolenaaror parentheses 6203955d011SMarcel Moolenaar.Pq Ql () 6213955d011SMarcel Moolenaarand preceding it with 6223955d011SMarcel Moolenaara dollar sign 6233955d011SMarcel Moolenaar.Pq Ql \&$ . 6243955d011SMarcel MoolenaarIf the variable name contains only a single letter, the surrounding 6253955d011SMarcel Moolenaarbraces or parentheses are not required. 6263955d011SMarcel MoolenaarThis shorter form is not recommended. 6273955d011SMarcel Moolenaar.Pp 6283955d011SMarcel MoolenaarIf the variable name contains a dollar, then the name itself is expanded first. 6293955d011SMarcel MoolenaarThis allows almost arbitrary variable names, however names containing dollar, 6302c3632d1SSimon J. Gerratybraces, parentheses, or whitespace are really best avoided! 6313955d011SMarcel Moolenaar.Pp 6323955d011SMarcel MoolenaarIf the result of expanding a variable contains a dollar sign 6333955d011SMarcel Moolenaar.Pq Ql \&$ 6343955d011SMarcel Moolenaarthe string is expanded again. 6353955d011SMarcel Moolenaar.Pp 6363955d011SMarcel MoolenaarVariable substitution occurs at three distinct times, depending on where 6373955d011SMarcel Moolenaarthe variable is being used. 6383955d011SMarcel Moolenaar.Bl -enum 6393955d011SMarcel Moolenaar.It 6403955d011SMarcel MoolenaarVariables in dependency lines are expanded as the line is read. 6413955d011SMarcel Moolenaar.It 6423955d011SMarcel MoolenaarVariables in shell commands are expanded when the shell command is 6433955d011SMarcel Moolenaarexecuted. 6443955d011SMarcel Moolenaar.It 6453955d011SMarcel Moolenaar.Dq .for 6463955d011SMarcel Moolenaarloop index variables are expanded on each loop iteration. 6473955d011SMarcel MoolenaarNote that other variables are not expanded inside loops so 6483955d011SMarcel Moolenaarthe following example code: 6493955d011SMarcel Moolenaar.Bd -literal -offset indent 6503955d011SMarcel Moolenaar 6513955d011SMarcel Moolenaar.Dv .for i in 1 2 3 6523955d011SMarcel Moolenaara+= ${i} 6533955d011SMarcel Moolenaarj= ${i} 6543955d011SMarcel Moolenaarb+= ${j} 6553955d011SMarcel Moolenaar.Dv .endfor 6563955d011SMarcel Moolenaar 6573955d011SMarcel Moolenaarall: 6583955d011SMarcel Moolenaar @echo ${a} 6593955d011SMarcel Moolenaar @echo ${b} 6603955d011SMarcel Moolenaar 6613955d011SMarcel Moolenaar.Ed 6623955d011SMarcel Moolenaarwill print: 6633955d011SMarcel Moolenaar.Bd -literal -offset indent 6643955d011SMarcel Moolenaar1 2 3 6653955d011SMarcel Moolenaar3 3 3 6663955d011SMarcel Moolenaar 6673955d011SMarcel Moolenaar.Ed 6683955d011SMarcel MoolenaarBecause while ${a} contains 6693955d011SMarcel Moolenaar.Dq 1 2 3 6703955d011SMarcel Moolenaarafter the loop is executed, ${b} 6713955d011SMarcel Moolenaarcontains 6723955d011SMarcel Moolenaar.Dq ${j} ${j} ${j} 6733955d011SMarcel Moolenaarwhich expands to 6743955d011SMarcel Moolenaar.Dq 3 3 3 6753955d011SMarcel Moolenaarsince after the loop completes ${j} contains 6763955d011SMarcel Moolenaar.Dq 3 . 6773955d011SMarcel Moolenaar.El 6783955d011SMarcel Moolenaar.Ss Variable classes 6793955d011SMarcel MoolenaarThe four different classes of variables (in order of increasing precedence) 6803955d011SMarcel Moolenaarare: 6813955d011SMarcel Moolenaar.Bl -tag -width Ds 6823955d011SMarcel Moolenaar.It Environment variables 6833955d011SMarcel MoolenaarVariables defined as part of 6843955d011SMarcel Moolenaar.Nm Ns 's 6853955d011SMarcel Moolenaarenvironment. 6863955d011SMarcel Moolenaar.It Global variables 6873955d011SMarcel MoolenaarVariables defined in the makefile or in included makefiles. 6883955d011SMarcel Moolenaar.It Command line variables 6893955d011SMarcel MoolenaarVariables defined as part of the command line. 6903955d011SMarcel Moolenaar.It Local variables 6913955d011SMarcel MoolenaarVariables that are defined specific to a certain target. 692db29cad8SSimon J. Gerraty.El 693db29cad8SSimon J. Gerraty.Pp 694db29cad8SSimon J. GerratyLocal variables are all built in and their values vary magically from 695db29cad8SSimon J. Gerratytarget to target. 696db29cad8SSimon J. GerratyIt is not currently possible to define new local variables. 6973955d011SMarcel MoolenaarThe seven local variables are as follows: 698db29cad8SSimon J. Gerraty.Bl -tag -width ".ARCHIVE" -offset indent 6993955d011SMarcel Moolenaar.It Va .ALLSRC 7003955d011SMarcel MoolenaarThe list of all sources for this target; also known as 7018695518cSSimon J. Gerraty.Ql Va \&> . 7023955d011SMarcel Moolenaar.It Va .ARCHIVE 703db29cad8SSimon J. GerratyThe name of the archive file; also known as 704db29cad8SSimon J. Gerraty.Ql Va \&! . 7053955d011SMarcel Moolenaar.It Va .IMPSRC 7063955d011SMarcel MoolenaarIn suffix-transformation rules, the name/path of the source from which the 7073955d011SMarcel Moolenaartarget is to be transformed (the 7083955d011SMarcel Moolenaar.Dq implied 7093955d011SMarcel Moolenaarsource); also known as 7108695518cSSimon J. Gerraty.Ql Va \&< . 7113955d011SMarcel MoolenaarIt is not defined in explicit rules. 7123955d011SMarcel Moolenaar.It Va .MEMBER 713db29cad8SSimon J. GerratyThe name of the archive member; also known as 714db29cad8SSimon J. Gerraty.Ql Va % . 7153955d011SMarcel Moolenaar.It Va .OODATE 7163955d011SMarcel MoolenaarThe list of sources for this target that were deemed out-of-date; also 7173955d011SMarcel Moolenaarknown as 7183955d011SMarcel Moolenaar.Ql Va \&? . 7193955d011SMarcel Moolenaar.It Va .PREFIX 7203955d011SMarcel MoolenaarThe file prefix of the target, containing only the file portion, no suffix 7213955d011SMarcel Moolenaaror preceding directory components; also known as 7223955d011SMarcel Moolenaar.Ql Va * . 723db29cad8SSimon J. GerratyThe suffix must be one of the known suffixes declared with 724db29cad8SSimon J. Gerraty.Ic .SUFFIXES 725db29cad8SSimon J. Gerratyor it will not be recognized. 7263955d011SMarcel Moolenaar.It Va .TARGET 7273955d011SMarcel MoolenaarThe name of the target; also known as 7283955d011SMarcel Moolenaar.Ql Va @ . 7293bebe729SSimon J. GerratyFor compatibility with other makes this is an alias for 7303bebe729SSimon J. Gerraty.Ic .ARCHIVE 7313bebe729SSimon J. Gerratyin archive member rules. 7323955d011SMarcel Moolenaar.El 7333955d011SMarcel Moolenaar.Pp 7343955d011SMarcel MoolenaarThe shorter forms 7358695518cSSimon J. Gerraty.Ql ( Va > , 736db29cad8SSimon J. Gerraty.Ql Va \&! , 7378695518cSSimon J. Gerraty.Ql Va < , 738db29cad8SSimon J. Gerraty.Ql Va % , 7393955d011SMarcel Moolenaar.Ql Va \&? , 740db29cad8SSimon J. Gerraty.Ql Va * , 7413955d011SMarcel Moolenaarand 742db29cad8SSimon J. Gerraty.Ql Va @ ) 7433955d011SMarcel Moolenaarare permitted for backward 744db29cad8SSimon J. Gerratycompatibility with historical makefiles and legacy POSIX make and are 745db29cad8SSimon J. Gerratynot recommended. 746db29cad8SSimon J. Gerraty.Pp 747db29cad8SSimon J. GerratyVariants of these variables with the punctuation followed immediately by 748db29cad8SSimon J. Gerraty.Ql D 749db29cad8SSimon J. Gerratyor 750db29cad8SSimon J. Gerraty.Ql F , 751db29cad8SSimon J. Gerratye.g. 752db29cad8SSimon J. Gerraty.Ql Va $(@D) , 753db29cad8SSimon J. Gerratyare legacy forms equivalent to using the 754db29cad8SSimon J. Gerraty.Ql :H 7553955d011SMarcel Moolenaarand 756db29cad8SSimon J. Gerraty.Ql :T 757db29cad8SSimon J. Gerratymodifiers. 758db29cad8SSimon J. GerratyThese forms are accepted for compatibility with 7593955d011SMarcel Moolenaar.At V 760db29cad8SSimon J. Gerratymakefiles and POSIX but are not recommended. 7613955d011SMarcel Moolenaar.Pp 7623955d011SMarcel MoolenaarFour of the local variables may be used in sources on dependency lines 7633955d011SMarcel Moolenaarbecause they expand to the proper value for each target on the line. 7643955d011SMarcel MoolenaarThese variables are 7653955d011SMarcel Moolenaar.Ql Va .TARGET , 7663955d011SMarcel Moolenaar.Ql Va .PREFIX , 7673955d011SMarcel Moolenaar.Ql Va .ARCHIVE , 7683955d011SMarcel Moolenaarand 7693955d011SMarcel Moolenaar.Ql Va .MEMBER . 7703955d011SMarcel Moolenaar.Ss Additional built-in variables 7713955d011SMarcel MoolenaarIn addition, 7723955d011SMarcel Moolenaar.Nm 7733955d011SMarcel Moolenaarsets or knows about the following variables: 7743955d011SMarcel Moolenaar.Bl -tag -width .MAKEOVERRIDES 7753955d011SMarcel Moolenaar.It Va \&$ 7763955d011SMarcel MoolenaarA single dollar sign 7773955d011SMarcel Moolenaar.Ql \&$ , 7783955d011SMarcel Moolenaari.e. 7793955d011SMarcel Moolenaar.Ql \&$$ 7803955d011SMarcel Moolenaarexpands to a single dollar 7813955d011SMarcel Moolenaarsign. 7823955d011SMarcel Moolenaar.It Va .ALLTARGETS 7833955d011SMarcel MoolenaarThe list of all targets encountered in the Makefile. 7843955d011SMarcel MoolenaarIf evaluated during 7853955d011SMarcel MoolenaarMakefile parsing, lists only those targets encountered thus far. 7863955d011SMarcel Moolenaar.It Va .CURDIR 7873955d011SMarcel MoolenaarA path to the directory where 7883955d011SMarcel Moolenaar.Nm 7893955d011SMarcel Moolenaarwas executed. 7903955d011SMarcel MoolenaarRefer to the description of 7913955d011SMarcel Moolenaar.Ql Ev PWD 7923955d011SMarcel Moolenaarfor more details. 7935bcb7424SSimon J. Gerraty.It Va .INCLUDEDFROMDIR 7945bcb7424SSimon J. GerratyThe directory of the file this Makefile was included from. 7955bcb7424SSimon J. Gerraty.It Va .INCLUDEDFROMFILE 7965bcb7424SSimon J. GerratyThe filename of the file this Makefile was included from. 7973955d011SMarcel Moolenaar.It Ev MAKE 7983955d011SMarcel MoolenaarThe name that 7993955d011SMarcel Moolenaar.Nm 8003955d011SMarcel Moolenaarwas executed with 8013955d011SMarcel Moolenaar.Pq Va argv[0] . 8023955d011SMarcel MoolenaarFor compatibility 8033955d011SMarcel Moolenaar.Nm 8043955d011SMarcel Moolenaaralso sets 8053955d011SMarcel Moolenaar.Va .MAKE 8063955d011SMarcel Moolenaarwith the same value. 8073955d011SMarcel MoolenaarThe preferred variable to use is the environment variable 8083955d011SMarcel Moolenaar.Ev MAKE 8093955d011SMarcel Moolenaarbecause it is more compatible with other versions of 8103955d011SMarcel Moolenaar.Nm 8113955d011SMarcel Moolenaarand cannot be confused with the special target with the same name. 8123955d011SMarcel Moolenaar.It Va .MAKE.DEPENDFILE 8133955d011SMarcel MoolenaarNames the makefile (default 8143955d011SMarcel Moolenaar.Ql Pa .depend ) 8153955d011SMarcel Moolenaarfrom which generated dependencies are read. 8163955d011SMarcel Moolenaar.It Va .MAKE.EXPAND_VARIABLES 8173955d011SMarcel MoolenaarA boolean that controls the default behavior of the 8183955d011SMarcel Moolenaar.Fl V 8193955d011SMarcel Moolenaaroption. 8208695518cSSimon J. GerratyIf true, variable values printed with 8218695518cSSimon J. Gerraty.Fl V 8228695518cSSimon J. Gerratyare fully expanded; if false, the raw variable contents (which may 8238695518cSSimon J. Gerratyinclude additional unexpanded variable references) are shown. 8243955d011SMarcel Moolenaar.It Va .MAKE.EXPORTED 8253955d011SMarcel MoolenaarThe list of variables exported by 8263955d011SMarcel Moolenaar.Nm . 8273955d011SMarcel Moolenaar.It Va .MAKE.JOBS 8283955d011SMarcel MoolenaarThe argument to the 8293955d011SMarcel Moolenaar.Fl j 8303955d011SMarcel Moolenaaroption. 8313955d011SMarcel Moolenaar.It Va .MAKE.JOB.PREFIX 8323955d011SMarcel MoolenaarIf 8333955d011SMarcel Moolenaar.Nm 8343955d011SMarcel Moolenaaris run with 8353955d011SMarcel Moolenaar.Ar j 8363955d011SMarcel Moolenaarthen output for each target is prefixed with a token 8373955d011SMarcel Moolenaar.Ql --- target --- 8383955d011SMarcel Moolenaarthe first part of which can be controlled via 8393955d011SMarcel Moolenaar.Va .MAKE.JOB.PREFIX . 84051ee2c1cSSimon J. GerratyIf 84151ee2c1cSSimon J. Gerraty.Va .MAKE.JOB.PREFIX 84251ee2c1cSSimon J. Gerratyis empty, no token is printed. 8433955d011SMarcel Moolenaar.br 8443955d011SMarcel MoolenaarFor example: 8453955d011SMarcel Moolenaar.Li .MAKE.JOB.PREFIX=${.newline}---${.MAKE:T}[${.MAKE.PID}] 8463955d011SMarcel Moolenaarwould produce tokens like 8473955d011SMarcel Moolenaar.Ql ---make[1234] target --- 8483955d011SMarcel Moolenaarmaking it easier to track the degree of parallelism being achieved. 8493955d011SMarcel Moolenaar.It Ev MAKEFLAGS 8503955d011SMarcel MoolenaarThe environment variable 8513955d011SMarcel Moolenaar.Ql Ev MAKEFLAGS 8523955d011SMarcel Moolenaarmay contain anything that 8533955d011SMarcel Moolenaarmay be specified on 8543955d011SMarcel Moolenaar.Nm Ns 's 8553955d011SMarcel Moolenaarcommand line. 8563955d011SMarcel MoolenaarAnything specified on 8573955d011SMarcel Moolenaar.Nm Ns 's 8583955d011SMarcel Moolenaarcommand line is appended to the 8593955d011SMarcel Moolenaar.Ql Ev MAKEFLAGS 8603955d011SMarcel Moolenaarvariable which is then 8613955d011SMarcel Moolenaarentered into the environment for all programs which 8623955d011SMarcel Moolenaar.Nm 8633955d011SMarcel Moolenaarexecutes. 8643955d011SMarcel Moolenaar.It Va .MAKE.LEVEL 8653955d011SMarcel MoolenaarThe recursion depth of 8663955d011SMarcel Moolenaar.Nm . 8673955d011SMarcel MoolenaarThe initial instance of 8683955d011SMarcel Moolenaar.Nm 8693955d011SMarcel Moolenaarwill be 0, and an incremented value is put into the environment 8703955d011SMarcel Moolenaarto be seen by the next generation. 8713955d011SMarcel MoolenaarThis allows tests like: 8723955d011SMarcel Moolenaar.Li .if ${.MAKE.LEVEL} == 0 8733955d011SMarcel Moolenaarto protect things which should only be evaluated in the initial instance of 8743955d011SMarcel Moolenaar.Nm . 8753955d011SMarcel Moolenaar.It Va .MAKE.MAKEFILE_PREFERENCE 8763955d011SMarcel MoolenaarThe ordered list of makefile names 8773955d011SMarcel Moolenaar(default 8783955d011SMarcel Moolenaar.Ql Pa makefile , 8793955d011SMarcel Moolenaar.Ql Pa Makefile ) 8803955d011SMarcel Moolenaarthat 8813955d011SMarcel Moolenaar.Nm 8823955d011SMarcel Moolenaarwill look for. 8833955d011SMarcel Moolenaar.It Va .MAKE.MAKEFILES 8843955d011SMarcel MoolenaarThe list of makefiles read by 8853955d011SMarcel Moolenaar.Nm , 8863955d011SMarcel Moolenaarwhich is useful for tracking dependencies. 8873955d011SMarcel MoolenaarEach makefile is recorded only once, regardless of the number of times read. 8883955d011SMarcel Moolenaar.It Va .MAKE.MODE 8893955d011SMarcel MoolenaarProcessed after reading all makefiles. 8903955d011SMarcel MoolenaarCan affect the mode that 8913955d011SMarcel Moolenaar.Nm 8923955d011SMarcel Moolenaarruns in. 8933955d011SMarcel MoolenaarIt can contain a number of keywords: 894b778b302SSimon J. Gerraty.Bl -hang -width missing-filemon=bf. 8953955d011SMarcel Moolenaar.It Pa compat 8963955d011SMarcel MoolenaarLike 8973955d011SMarcel Moolenaar.Fl B , 8983955d011SMarcel Moolenaarputs 8993955d011SMarcel Moolenaar.Nm 9003955d011SMarcel Moolenaarinto "compat" mode. 9013955d011SMarcel Moolenaar.It Pa meta 9023955d011SMarcel MoolenaarPuts 9033955d011SMarcel Moolenaar.Nm 9043955d011SMarcel Moolenaarinto "meta" mode, where meta files are created for each target 9053955d011SMarcel Moolenaarto capture the command run, the output generated and if 9063955d011SMarcel Moolenaar.Xr filemon 4 9073955d011SMarcel Moolenaaris available, the system calls which are of interest to 9083955d011SMarcel Moolenaar.Nm . 9093955d011SMarcel MoolenaarThe captured output can be very useful when diagnosing errors. 9103955d011SMarcel Moolenaar.It Pa curdirOk= Ar bf 9113955d011SMarcel MoolenaarNormally 9123955d011SMarcel Moolenaar.Nm 9133955d011SMarcel Moolenaarwill not create .meta files in 9143955d011SMarcel Moolenaar.Ql Va .CURDIR . 9153955d011SMarcel MoolenaarThis can be overridden by setting 9163955d011SMarcel Moolenaar.Va bf 9173955d011SMarcel Moolenaarto a value which represents True. 918b778b302SSimon J. Gerraty.It Pa missing-meta= Ar bf 919b778b302SSimon J. GerratyIf 920b778b302SSimon J. Gerraty.Va bf 921b778b302SSimon J. Gerratyis True, then a missing .meta file makes the target out-of-date. 922b778b302SSimon J. Gerraty.It Pa missing-filemon= Ar bf 923b778b302SSimon J. GerratyIf 924b778b302SSimon J. Gerraty.Va bf 925b778b302SSimon J. Gerratyis True, then missing filemon data makes the target out-of-date. 926b778b302SSimon J. Gerraty.It Pa nofilemon 927b778b302SSimon J. GerratyDo not use 928b778b302SSimon J. Gerraty.Xr filemon 4 . 9293955d011SMarcel Moolenaar.It Pa env 930be19d90bSSimon J. GerratyFor debugging, it can be useful to include the environment 9313955d011SMarcel Moolenaarin the .meta file. 9323955d011SMarcel Moolenaar.It Pa verbose 9333955d011SMarcel MoolenaarIf in "meta" mode, print a clue about the target being built. 9343955d011SMarcel MoolenaarThis is useful if the build is otherwise running silently. 9353955d011SMarcel MoolenaarThe message printed the value of: 9363955d011SMarcel Moolenaar.Va .MAKE.META.PREFIX . 9373955d011SMarcel Moolenaar.It Pa ignore-cmd 9383955d011SMarcel MoolenaarSome makefiles have commands which are simply not stable. 9393955d011SMarcel MoolenaarThis keyword causes them to be ignored for 9403955d011SMarcel Moolenaardetermining whether a target is out of date in "meta" mode. 9413955d011SMarcel MoolenaarSee also 9423955d011SMarcel Moolenaar.Ic .NOMETA_CMP . 9433955d011SMarcel Moolenaar.It Pa silent= Ar bf 9443955d011SMarcel MoolenaarIf 9453955d011SMarcel Moolenaar.Va bf 9463955d011SMarcel Moolenaaris True, when a .meta file is created, mark the target 9473955d011SMarcel Moolenaar.Ic .SILENT . 9483955d011SMarcel Moolenaar.El 9493955d011SMarcel Moolenaar.It Va .MAKE.META.BAILIWICK 9503955d011SMarcel MoolenaarIn "meta" mode, provides a list of prefixes which 9513955d011SMarcel Moolenaarmatch the directories controlled by 9523955d011SMarcel Moolenaar.Nm . 9533955d011SMarcel MoolenaarIf a file that was generated outside of 9543955d011SMarcel Moolenaar.Va .OBJDIR 9553955d011SMarcel Moolenaarbut within said bailiwick is missing, 9563955d011SMarcel Moolenaarthe current target is considered out-of-date. 9573955d011SMarcel Moolenaar.It Va .MAKE.META.CREATED 9583955d011SMarcel MoolenaarIn "meta" mode, this variable contains a list of all the meta files 9593955d011SMarcel Moolenaarupdated. 9603955d011SMarcel MoolenaarIf not empty, it can be used to trigger processing of 9613955d011SMarcel Moolenaar.Va .MAKE.META.FILES . 9623955d011SMarcel Moolenaar.It Va .MAKE.META.FILES 9633955d011SMarcel MoolenaarIn "meta" mode, this variable contains a list of all the meta files 9643955d011SMarcel Moolenaarused (updated or not). 9653955d011SMarcel MoolenaarThis list can be used to process the meta files to extract dependency 9663955d011SMarcel Moolenaarinformation. 96751ee2c1cSSimon J. Gerraty.It Va .MAKE.META.IGNORE_PATHS 96851ee2c1cSSimon J. GerratyProvides a list of path prefixes that should be ignored; 96951ee2c1cSSimon J. Gerratybecause the contents are expected to change over time. 97051ee2c1cSSimon J. GerratyThe default list includes: 97151ee2c1cSSimon J. Gerraty.Ql Pa /dev /etc /proc /tmp /var/run /var/tmp 972e48f47ddSSimon J. Gerraty.It Va .MAKE.META.IGNORE_PATTERNS 973e48f47ddSSimon J. GerratyProvides a list of patterns to match against pathnames. 974e48f47ddSSimon J. GerratyIgnore any that match. 97595e3ed2cSSimon J. Gerraty.It Va .MAKE.META.IGNORE_FILTER 97695e3ed2cSSimon J. GerratyProvides a list of variable modifiers to apply to each pathname. 97795e3ed2cSSimon J. GerratyIgnore if the expansion is an empty string. 9783955d011SMarcel Moolenaar.It Va .MAKE.META.PREFIX 9793955d011SMarcel MoolenaarDefines the message printed for each meta file updated in "meta verbose" mode. 9803955d011SMarcel MoolenaarThe default value is: 9813955d011SMarcel Moolenaar.Dl Building ${.TARGET:H:tA}/${.TARGET:T} 9823955d011SMarcel Moolenaar.It Va .MAKEOVERRIDES 9833955d011SMarcel MoolenaarThis variable is used to record the names of variables assigned to 9843955d011SMarcel Moolenaaron the command line, so that they may be exported as part of 9853955d011SMarcel Moolenaar.Ql Ev MAKEFLAGS . 986be19d90bSSimon J. GerratyThis behavior can be disabled by assigning an empty value to 9873955d011SMarcel Moolenaar.Ql Va .MAKEOVERRIDES 9883955d011SMarcel Moolenaarwithin a makefile. 9893955d011SMarcel MoolenaarExtra variables can be exported from a makefile 9903955d011SMarcel Moolenaarby appending their names to 9913955d011SMarcel Moolenaar.Ql Va .MAKEOVERRIDES . 9923955d011SMarcel Moolenaar.Ql Ev MAKEFLAGS 9933955d011SMarcel Moolenaaris re-exported whenever 9943955d011SMarcel Moolenaar.Ql Va .MAKEOVERRIDES 9953955d011SMarcel Moolenaaris modified. 9961748de26SSimon J. Gerraty.It Va .MAKE.PATH_FILEMON 9971748de26SSimon J. GerratyIf 9981748de26SSimon J. Gerraty.Nm 9991748de26SSimon J. Gerratywas built with 10001748de26SSimon J. Gerraty.Xr filemon 4 10011748de26SSimon J. Gerratysupport, this is set to the path of the device node. 10021748de26SSimon J. GerratyThis allows makefiles to test for this support. 10033955d011SMarcel Moolenaar.It Va .MAKE.PID 10043955d011SMarcel MoolenaarThe process-id of 10053955d011SMarcel Moolenaar.Nm . 10063955d011SMarcel Moolenaar.It Va .MAKE.PPID 10073955d011SMarcel MoolenaarThe parent process-id of 10083955d011SMarcel Moolenaar.Nm . 1009be19d90bSSimon J. Gerraty.It Va .MAKE.SAVE_DOLLARS 1010be19d90bSSimon J. Gerratyvalue should be a boolean that controls whether 1011be19d90bSSimon J. Gerraty.Ql $$ 1012be19d90bSSimon J. Gerratyare preserved when doing 1013be19d90bSSimon J. Gerraty.Ql := 1014be19d90bSSimon J. Gerratyassignments. 1015be19d90bSSimon J. GerratyThe default is false, for backwards compatibility. 1016be19d90bSSimon J. GerratySet to true for compatability with other makes. 1017be19d90bSSimon J. GerratyIf set to false, 1018be19d90bSSimon J. Gerraty.Ql $$ 1019be19d90bSSimon J. Gerratybecomes 1020be19d90bSSimon J. Gerraty.Ql $ 1021be19d90bSSimon J. Gerratyper normal evaluation rules. 102206b9b3e0SSimon J. Gerraty.It Va .MAKE.UID 102306b9b3e0SSimon J. GerratyThe user-id running 102406b9b3e0SSimon J. Gerraty.Nm . 102506b9b3e0SSimon J. Gerraty.It Va .MAKE.GID 102606b9b3e0SSimon J. GerratyThe group-id running 102706b9b3e0SSimon J. Gerraty.Nm . 10283955d011SMarcel Moolenaar.It Va MAKE_PRINT_VAR_ON_ERROR 10293955d011SMarcel MoolenaarWhen 10303955d011SMarcel Moolenaar.Nm 103195e3ed2cSSimon J. Gerratystops due to an error, it sets 103295e3ed2cSSimon J. Gerraty.Ql Va .ERROR_TARGET 103395e3ed2cSSimon J. Gerratyto the name of the target that failed, 103495e3ed2cSSimon J. Gerraty.Ql Va .ERROR_CMD 103595e3ed2cSSimon J. Gerratyto the commands of the failed target, 103695e3ed2cSSimon J. Gerratyand in "meta" mode, it also sets 103795e3ed2cSSimon J. Gerraty.Ql Va .ERROR_CWD 103895e3ed2cSSimon J. Gerratyto the 103995e3ed2cSSimon J. Gerraty.Xr getcwd 3 , 104095e3ed2cSSimon J. Gerratyand 104195e3ed2cSSimon J. Gerraty.Ql Va .ERROR_META_FILE 104295e3ed2cSSimon J. Gerratyto the path of the meta file (if any) describing the failed target. 104395e3ed2cSSimon J. GerratyIt then prints its name and the value of 10443955d011SMarcel Moolenaar.Ql Va .CURDIR 10453955d011SMarcel Moolenaaras well as the value of any variables named in 10463955d011SMarcel Moolenaar.Ql Va MAKE_PRINT_VAR_ON_ERROR . 10473955d011SMarcel Moolenaar.It Va .newline 10483955d011SMarcel MoolenaarThis variable is simply assigned a newline character as its value. 10493955d011SMarcel MoolenaarThis allows expansions using the 10503955d011SMarcel Moolenaar.Cm \&:@ 10513955d011SMarcel Moolenaarmodifier to put a newline between 10523955d011SMarcel Moolenaariterations of the loop rather than a space. 10533955d011SMarcel MoolenaarFor example, the printing of 10543955d011SMarcel Moolenaar.Ql Va MAKE_PRINT_VAR_ON_ERROR 10553955d011SMarcel Moolenaarcould be done as ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}. 10563955d011SMarcel Moolenaar.It Va .OBJDIR 10573955d011SMarcel MoolenaarA path to the directory where the targets are built. 10583955d011SMarcel MoolenaarIts value is determined by trying to 10593955d011SMarcel Moolenaar.Xr chdir 2 10603955d011SMarcel Moolenaarto the following directories in order and using the first match: 10613955d011SMarcel Moolenaar.Bl -enum 10623955d011SMarcel Moolenaar.It 10633955d011SMarcel Moolenaar.Ev ${MAKEOBJDIRPREFIX}${.CURDIR} 10643955d011SMarcel Moolenaar.Pp 10653955d011SMarcel Moolenaar(Only if 10663955d011SMarcel Moolenaar.Ql Ev MAKEOBJDIRPREFIX 10673955d011SMarcel Moolenaaris set in the environment or on the command line.) 10683955d011SMarcel Moolenaar.It 10693955d011SMarcel Moolenaar.Ev ${MAKEOBJDIR} 10703955d011SMarcel Moolenaar.Pp 10713955d011SMarcel Moolenaar(Only if 10723955d011SMarcel Moolenaar.Ql Ev MAKEOBJDIR 10733955d011SMarcel Moolenaaris set in the environment or on the command line.) 10743955d011SMarcel Moolenaar.It 10753955d011SMarcel Moolenaar.Ev ${.CURDIR} Ns Pa /obj. Ns Ev ${MACHINE} 10763955d011SMarcel Moolenaar.It 10773955d011SMarcel Moolenaar.Ev ${.CURDIR} Ns Pa /obj 10783955d011SMarcel Moolenaar.It 10793955d011SMarcel Moolenaar.Pa /usr/obj/ Ns Ev ${.CURDIR} 10803955d011SMarcel Moolenaar.It 10813955d011SMarcel Moolenaar.Ev ${.CURDIR} 10823955d011SMarcel Moolenaar.El 10833955d011SMarcel Moolenaar.Pp 10843955d011SMarcel MoolenaarVariable expansion is performed on the value before it's used, 10853955d011SMarcel Moolenaarso expressions such as 10863955d011SMarcel Moolenaar.Dl ${.CURDIR:S,^/usr/src,/var/obj,} 10873955d011SMarcel Moolenaarmay be used. 10883955d011SMarcel MoolenaarThis is especially useful with 10893955d011SMarcel Moolenaar.Ql Ev MAKEOBJDIR . 10903955d011SMarcel Moolenaar.Pp 10913955d011SMarcel Moolenaar.Ql Va .OBJDIR 1092128a4105SSimon J. Gerratymay be modified in the makefile via the special target 1093128a4105SSimon J. Gerraty.Ql Ic .OBJDIR . 10943955d011SMarcel MoolenaarIn all cases, 10953955d011SMarcel Moolenaar.Nm 10963955d011SMarcel Moolenaarwill 10973955d011SMarcel Moolenaar.Xr chdir 2 1098128a4105SSimon J. Gerratyto the specified directory if it exists, and set 10993955d011SMarcel Moolenaar.Ql Va .OBJDIR 1100128a4105SSimon J. Gerratyand 11013955d011SMarcel Moolenaar.Ql Ev PWD 11023955d011SMarcel Moolenaarto that directory before executing any targets. 1103e2eeea75SSimon J. Gerraty.Pp 1104e2eeea75SSimon J. GerratyExcept in the case of an explicit 1105e2eeea75SSimon J. Gerraty.Ql Ic .OBJDIR 1106e2eeea75SSimon J. Gerratytarget, 1107e2eeea75SSimon J. Gerraty.Nm 1108e2eeea75SSimon J. Gerratywill check that the specified directory is writable and ignore it if not. 1109e2eeea75SSimon J. GerratyThis check can be skipped by setting the environment variable 1110e2eeea75SSimon J. Gerraty.Ql Ev MAKE_OBJDIR_CHECK_WRITABLE 1111e2eeea75SSimon J. Gerratyto "no". 11123955d011SMarcel Moolenaar. 11133955d011SMarcel Moolenaar.It Va .PARSEDIR 11143955d011SMarcel MoolenaarA path to the directory of the current 11153955d011SMarcel Moolenaar.Ql Pa Makefile 11163955d011SMarcel Moolenaarbeing parsed. 11173955d011SMarcel Moolenaar.It Va .PARSEFILE 11183955d011SMarcel MoolenaarThe basename of the current 11193955d011SMarcel Moolenaar.Ql Pa Makefile 11203955d011SMarcel Moolenaarbeing parsed. 11213955d011SMarcel MoolenaarThis variable and 11223955d011SMarcel Moolenaar.Ql Va .PARSEDIR 11233955d011SMarcel Moolenaarare both set only while the 11243955d011SMarcel Moolenaar.Ql Pa Makefiles 11253955d011SMarcel Moolenaarare being parsed. 11263955d011SMarcel MoolenaarIf you want to retain their current values, assign them to a variable 11273955d011SMarcel Moolenaarusing assignment with expansion: 11283955d011SMarcel Moolenaar.Pq Ql Cm \&:= . 11293955d011SMarcel Moolenaar.It Va .PATH 11303955d011SMarcel MoolenaarA variable that represents the list of directories that 11313955d011SMarcel Moolenaar.Nm 11323955d011SMarcel Moolenaarwill search for files. 11333955d011SMarcel MoolenaarThe search list should be updated using the target 11343955d011SMarcel Moolenaar.Ql Va .PATH 11353955d011SMarcel Moolenaarrather than the variable. 11363955d011SMarcel Moolenaar.It Ev PWD 11373955d011SMarcel MoolenaarAlternate path to the current directory. 11383955d011SMarcel Moolenaar.Nm 11393955d011SMarcel Moolenaarnormally sets 11403955d011SMarcel Moolenaar.Ql Va .CURDIR 11413955d011SMarcel Moolenaarto the canonical path given by 11423955d011SMarcel Moolenaar.Xr getcwd 3 . 11433955d011SMarcel MoolenaarHowever, if the environment variable 11443955d011SMarcel Moolenaar.Ql Ev PWD 11453955d011SMarcel Moolenaaris set and gives a path to the current directory, then 11463955d011SMarcel Moolenaar.Nm 11473955d011SMarcel Moolenaarsets 11483955d011SMarcel Moolenaar.Ql Va .CURDIR 11493955d011SMarcel Moolenaarto the value of 11503955d011SMarcel Moolenaar.Ql Ev PWD 11513955d011SMarcel Moolenaarinstead. 1152be19d90bSSimon J. GerratyThis behavior is disabled if 11533955d011SMarcel Moolenaar.Ql Ev MAKEOBJDIRPREFIX 11543955d011SMarcel Moolenaaris set or 11553955d011SMarcel Moolenaar.Ql Ev MAKEOBJDIR 11563955d011SMarcel Moolenaarcontains a variable transform. 11573955d011SMarcel Moolenaar.Ql Ev PWD 11583955d011SMarcel Moolenaaris set to the value of 11593955d011SMarcel Moolenaar.Ql Va .OBJDIR 11603955d011SMarcel Moolenaarfor all programs which 11613955d011SMarcel Moolenaar.Nm 11623955d011SMarcel Moolenaarexecutes. 11632c3632d1SSimon J. Gerraty.It Ev .SHELL 11642c3632d1SSimon J. GerratyThe pathname of the shell used to run target scripts. 11652c3632d1SSimon J. GerratyIt is read-only. 1166*12904384SSimon J. Gerraty.It Ev .SUFFIXES 1167*12904384SSimon J. GerratyThe list of known suffixes. 1168*12904384SSimon J. GerratyIt is read-only. 11693955d011SMarcel Moolenaar.It Ev .TARGETS 11703955d011SMarcel MoolenaarThe list of targets explicitly specified on the command line, if any. 11713955d011SMarcel Moolenaar.It Ev VPATH 11723955d011SMarcel MoolenaarColon-separated 11733955d011SMarcel Moolenaar.Pq Dq \&: 11743955d011SMarcel Moolenaarlists of directories that 11753955d011SMarcel Moolenaar.Nm 11763955d011SMarcel Moolenaarwill search for files. 11773955d011SMarcel MoolenaarThe variable is supported for compatibility with old make programs only, 11783955d011SMarcel Moolenaaruse 11793955d011SMarcel Moolenaar.Ql Va .PATH 11803955d011SMarcel Moolenaarinstead. 11813955d011SMarcel Moolenaar.El 11823955d011SMarcel Moolenaar.Ss Variable modifiers 11833955d011SMarcel MoolenaarVariable expansion may be modified to select or modify each word of the 11843955d011SMarcel Moolenaarvariable (where a 11853955d011SMarcel Moolenaar.Dq word 11863955d011SMarcel Moolenaaris white-space delimited sequence of characters). 11873955d011SMarcel MoolenaarThe general format of a variable expansion is as follows: 11883955d011SMarcel Moolenaar.Pp 11893955d011SMarcel Moolenaar.Dl ${variable[:modifier[:...]]} 11903955d011SMarcel Moolenaar.Pp 11913955d011SMarcel MoolenaarEach modifier begins with a colon, 11923955d011SMarcel Moolenaarwhich may be escaped with a backslash 11933955d011SMarcel Moolenaar.Pq Ql \e . 11943955d011SMarcel Moolenaar.Pp 11953955d011SMarcel MoolenaarA set of modifiers can be specified via a variable, as follows: 11963955d011SMarcel Moolenaar.Pp 11973955d011SMarcel Moolenaar.Dl modifier_variable=modifier[:...] 11983955d011SMarcel Moolenaar.Dl ${variable:${modifier_variable}[:...]} 11993955d011SMarcel Moolenaar.Pp 12003955d011SMarcel MoolenaarIn this case the first modifier in the modifier_variable does not 12013955d011SMarcel Moolenaarstart with a colon, since that must appear in the referencing 12023955d011SMarcel Moolenaarvariable. 12033955d011SMarcel MoolenaarIf any of the modifiers in the modifier_variable contain a dollar sign 12043955d011SMarcel Moolenaar.Pq Ql $ , 12053955d011SMarcel Moolenaarthese must be doubled to avoid early expansion. 12063955d011SMarcel Moolenaar.Pp 12073955d011SMarcel MoolenaarThe supported modifiers are: 12083955d011SMarcel Moolenaar.Bl -tag -width EEE 12093955d011SMarcel Moolenaar.It Cm \&:E 12103955d011SMarcel MoolenaarReplaces each word in the variable with its suffix. 12113955d011SMarcel Moolenaar.It Cm \&:H 12123955d011SMarcel MoolenaarReplaces each word in the variable with everything but the last component. 12133955d011SMarcel Moolenaar.It Cm \&:M Ns Ar pattern 12142c3632d1SSimon J. GerratySelects only those words that match 12153955d011SMarcel Moolenaar.Ar pattern . 12163955d011SMarcel MoolenaarThe standard shell wildcard characters 12173955d011SMarcel Moolenaar.Pf ( Ql * , 12183955d011SMarcel Moolenaar.Ql \&? , 12193955d011SMarcel Moolenaarand 12203955d011SMarcel Moolenaar.Ql Oo Oc ) 12213955d011SMarcel Moolenaarmay 12223955d011SMarcel Moolenaarbe used. 12233955d011SMarcel MoolenaarThe wildcard characters may be escaped with a backslash 12243955d011SMarcel Moolenaar.Pq Ql \e . 12250dede8b0SSimon J. GerratyAs a consequence of the way values are split into words, matched, 12260dede8b0SSimon J. Gerratyand then joined, a construct like 12270dede8b0SSimon J. Gerraty.Dl ${VAR:M*} 1228be19d90bSSimon J. Gerratywill normalize the inter-word spacing, removing all leading and 12290dede8b0SSimon J. Gerratytrailing space, and converting multiple consecutive spaces 12300dede8b0SSimon J. Gerratyto single spaces. 12310dede8b0SSimon J. Gerraty. 12323955d011SMarcel Moolenaar.It Cm \&:N Ns Ar pattern 12333955d011SMarcel MoolenaarThis is identical to 12343955d011SMarcel Moolenaar.Ql Cm \&:M , 12353955d011SMarcel Moolenaarbut selects all words which do not match 12363955d011SMarcel Moolenaar.Ar pattern . 12373955d011SMarcel Moolenaar.It Cm \&:O 12382c3632d1SSimon J. GerratyOrders every word in variable alphabetically. 1239*12904384SSimon J. Gerraty.It Cm \&:On 1240*12904384SSimon J. GerratyOrders every word in variable numerically. 1241*12904384SSimon J. GerratyA number followed by one of 1242*12904384SSimon J. Gerraty.Ql k , 1243*12904384SSimon J. Gerraty.Ql M 1244*12904384SSimon J. Gerratyor 1245*12904384SSimon J. Gerraty.Ql G 1246*12904384SSimon J. Gerratyis multiplied by the appropriate factor (1024 (k), 1048576 (M), or 1247*12904384SSimon J. Gerraty1073741824 (G)). 1248*12904384SSimon J. GerratyBoth upper- and lower-case letters are accepted. 1249ef0b2538SSimon J. Gerraty.It Cm \&:Or 12502c3632d1SSimon J. GerratyOrders every word in variable in reverse alphabetical order. 1251*12904384SSimon J. Gerraty.It Cm \&:Orn 1252*12904384SSimon J. GerratyOrders every word in variable in reverse numerical order. 12533955d011SMarcel Moolenaar.It Cm \&:Ox 12542c3632d1SSimon J. GerratyShuffles the words in variable. 12553955d011SMarcel MoolenaarThe results will be different each time you are referring to the 12563955d011SMarcel Moolenaarmodified variable; use the assignment with expansion 12573955d011SMarcel Moolenaar.Pq Ql Cm \&:= 1258be19d90bSSimon J. Gerratyto prevent such behavior. 12593955d011SMarcel MoolenaarFor example, 12603955d011SMarcel Moolenaar.Bd -literal -offset indent 12613955d011SMarcel MoolenaarLIST= uno due tre quattro 12623955d011SMarcel MoolenaarRANDOM_LIST= ${LIST:Ox} 12633955d011SMarcel MoolenaarSTATIC_RANDOM_LIST:= ${LIST:Ox} 12643955d011SMarcel Moolenaar 12653955d011SMarcel Moolenaarall: 12663955d011SMarcel Moolenaar @echo "${RANDOM_LIST}" 12673955d011SMarcel Moolenaar @echo "${RANDOM_LIST}" 12683955d011SMarcel Moolenaar @echo "${STATIC_RANDOM_LIST}" 12693955d011SMarcel Moolenaar @echo "${STATIC_RANDOM_LIST}" 12703955d011SMarcel Moolenaar.Ed 12713955d011SMarcel Moolenaarmay produce output similar to: 12723955d011SMarcel Moolenaar.Bd -literal -offset indent 12733955d011SMarcel Moolenaarquattro due tre uno 12743955d011SMarcel Moolenaartre due quattro uno 12753955d011SMarcel Moolenaardue uno quattro tre 12763955d011SMarcel Moolenaardue uno quattro tre 12773955d011SMarcel Moolenaar.Ed 12783955d011SMarcel Moolenaar.It Cm \&:Q 12793955d011SMarcel MoolenaarQuotes every shell meta-character in the variable, so that it can be passed 12802eae894cSSimon J. Gerratysafely to the shell. 12812eae894cSSimon J. Gerraty.It Cm \&:q 12822eae894cSSimon J. GerratyQuotes every shell meta-character in the variable, and also doubles 12832eae894cSSimon J. Gerraty.Sq $ 12842eae894cSSimon J. Gerratycharacters so that it can be passed 12853955d011SMarcel Moolenaarsafely through recursive invocations of 12863955d011SMarcel Moolenaar.Nm . 12872eae894cSSimon J. GerratyThis is equivalent to: 12882eae894cSSimon J. Gerraty.Sq \&:S/\e\&$/&&/g:Q . 12893955d011SMarcel Moolenaar.It Cm \&:R 12903955d011SMarcel MoolenaarReplaces each word in the variable with everything but its suffix. 12911ce939a7SSimon J. Gerraty.It Cm \&:range[=count] 12921ce939a7SSimon J. GerratyThe value is an integer sequence representing the words of the original 12931ce939a7SSimon J. Gerratyvalue, or the supplied 12941ce939a7SSimon J. Gerraty.Va count . 12951ce939a7SSimon J. Gerraty.It Cm \&:gmtime[=utc] 12963955d011SMarcel MoolenaarThe value is a format string for 12973955d011SMarcel Moolenaar.Xr strftime 3 , 12981ce939a7SSimon J. Gerratyusing 12993955d011SMarcel Moolenaar.Xr gmtime 3 . 13001ce939a7SSimon J. GerratyIf a 13011ce939a7SSimon J. Gerraty.Va utc 13021ce939a7SSimon J. Gerratyvalue is not provided or is 0, the current time is used. 13033955d011SMarcel Moolenaar.It Cm \&:hash 13042c3632d1SSimon J. GerratyComputes a 32-bit hash of the value and encode it as hex digits. 13051ce939a7SSimon J. Gerraty.It Cm \&:localtime[=utc] 13063955d011SMarcel MoolenaarThe value is a format string for 13073955d011SMarcel Moolenaar.Xr strftime 3 , 13081ce939a7SSimon J. Gerratyusing 13093955d011SMarcel Moolenaar.Xr localtime 3 . 13101ce939a7SSimon J. GerratyIf a 13111ce939a7SSimon J. Gerraty.Va utc 13121ce939a7SSimon J. Gerratyvalue is not provided or is 0, the current time is used. 13133955d011SMarcel Moolenaar.It Cm \&:tA 13142c3632d1SSimon J. GerratyAttempts to convert variable to an absolute path using 13153955d011SMarcel Moolenaar.Xr realpath 3 , 13163955d011SMarcel Moolenaarif that fails, the value is unchanged. 13173955d011SMarcel Moolenaar.It Cm \&:tl 13183955d011SMarcel MoolenaarConverts variable to lower-case letters. 13193955d011SMarcel Moolenaar.It Cm \&:ts Ns Ar c 13203955d011SMarcel MoolenaarWords in the variable are normally separated by a space on expansion. 13213955d011SMarcel MoolenaarThis modifier sets the separator to the character 13223955d011SMarcel Moolenaar.Ar c . 13233955d011SMarcel MoolenaarIf 13243955d011SMarcel Moolenaar.Ar c 13253955d011SMarcel Moolenaaris omitted, then no separator is used. 13262c3632d1SSimon J. GerratyThe common escapes (including octal numeric codes) work as expected. 13273955d011SMarcel Moolenaar.It Cm \&:tu 13283955d011SMarcel MoolenaarConverts variable to upper-case letters. 13293955d011SMarcel Moolenaar.It Cm \&:tW 13303955d011SMarcel MoolenaarCauses the value to be treated as a single word 13313955d011SMarcel Moolenaar(possibly containing embedded white space). 13323955d011SMarcel MoolenaarSee also 13333955d011SMarcel Moolenaar.Ql Cm \&:[*] . 13343955d011SMarcel Moolenaar.It Cm \&:tw 13353955d011SMarcel MoolenaarCauses the value to be treated as a sequence of 13363955d011SMarcel Moolenaarwords delimited by white space. 13373955d011SMarcel MoolenaarSee also 13383955d011SMarcel Moolenaar.Ql Cm \&:[@] . 13393955d011SMarcel Moolenaar.Sm off 13403955d011SMarcel Moolenaar.It Cm \&:S No \&/ Ar old_string No \&/ Ar new_string No \&/ Op Cm 1gW 13413955d011SMarcel Moolenaar.Sm on 13422c3632d1SSimon J. GerratyModifies the first occurrence of 13433955d011SMarcel Moolenaar.Ar old_string 13442c3632d1SSimon J. Gerratyin each word of the variable's value, replacing it with 13453955d011SMarcel Moolenaar.Ar new_string . 13463955d011SMarcel MoolenaarIf a 13473955d011SMarcel Moolenaar.Ql g 13482c3632d1SSimon J. Gerratyis appended to the last delimiter of the pattern, all occurrences 13493955d011SMarcel Moolenaarin each word are replaced. 13503955d011SMarcel MoolenaarIf a 13513955d011SMarcel Moolenaar.Ql 1 13522c3632d1SSimon J. Gerratyis appended to the last delimiter of the pattern, only the first occurrence 13533955d011SMarcel Moolenaaris affected. 13543955d011SMarcel MoolenaarIf a 13553955d011SMarcel Moolenaar.Ql W 13562c3632d1SSimon J. Gerratyis appended to the last delimiter of the pattern, 13573955d011SMarcel Moolenaarthen the value is treated as a single word 13583955d011SMarcel Moolenaar(possibly containing embedded white space). 13593955d011SMarcel MoolenaarIf 13603955d011SMarcel Moolenaar.Ar old_string 13613955d011SMarcel Moolenaarbegins with a caret 13623955d011SMarcel Moolenaar.Pq Ql ^ , 13633955d011SMarcel Moolenaar.Ar old_string 13643955d011SMarcel Moolenaaris anchored at the beginning of each word. 13653955d011SMarcel MoolenaarIf 13663955d011SMarcel Moolenaar.Ar old_string 13673955d011SMarcel Moolenaarends with a dollar sign 13683955d011SMarcel Moolenaar.Pq Ql \&$ , 13693955d011SMarcel Moolenaarit is anchored at the end of each word. 13703955d011SMarcel MoolenaarInside 13713955d011SMarcel Moolenaar.Ar new_string , 13723955d011SMarcel Moolenaaran ampersand 13738695518cSSimon J. Gerraty.Pq Ql & 13743955d011SMarcel Moolenaaris replaced by 13753955d011SMarcel Moolenaar.Ar old_string 13763955d011SMarcel Moolenaar(without any 13773955d011SMarcel Moolenaar.Ql ^ 13783955d011SMarcel Moolenaaror 13793955d011SMarcel Moolenaar.Ql \&$ ) . 13803955d011SMarcel MoolenaarAny character may be used as a delimiter for the parts of the modifier 13813955d011SMarcel Moolenaarstring. 13823955d011SMarcel MoolenaarThe anchoring, ampersand and delimiter characters may be escaped with a 13833955d011SMarcel Moolenaarbackslash 13843955d011SMarcel Moolenaar.Pq Ql \e . 13853955d011SMarcel Moolenaar.Pp 13863955d011SMarcel MoolenaarVariable expansion occurs in the normal fashion inside both 13873955d011SMarcel Moolenaar.Ar old_string 13883955d011SMarcel Moolenaarand 13893955d011SMarcel Moolenaar.Ar new_string 13903955d011SMarcel Moolenaarwith the single exception that a backslash is used to prevent the expansion 13913955d011SMarcel Moolenaarof a dollar sign 13923955d011SMarcel Moolenaar.Pq Ql \&$ , 13933955d011SMarcel Moolenaarnot a preceding dollar sign as is usual. 13943955d011SMarcel Moolenaar.Sm off 13953955d011SMarcel Moolenaar.It Cm \&:C No \&/ Ar pattern No \&/ Ar replacement No \&/ Op Cm 1gW 13963955d011SMarcel Moolenaar.Sm on 13973955d011SMarcel MoolenaarThe 13983955d011SMarcel Moolenaar.Cm \&:C 13993955d011SMarcel Moolenaarmodifier is just like the 14003955d011SMarcel Moolenaar.Cm \&:S 14013955d011SMarcel Moolenaarmodifier except that the old and new strings, instead of being 14020dede8b0SSimon J. Gerratysimple strings, are an extended regular expression (see 14033955d011SMarcel Moolenaar.Xr regex 3 ) 14043955d011SMarcel Moolenaarstring 14053955d011SMarcel Moolenaar.Ar pattern 14063955d011SMarcel Moolenaarand an 14073955d011SMarcel Moolenaar.Xr ed 1 Ns \-style 14083955d011SMarcel Moolenaarstring 14093955d011SMarcel Moolenaar.Ar replacement . 14103955d011SMarcel MoolenaarNormally, the first occurrence of the pattern 14113955d011SMarcel Moolenaar.Ar pattern 14123955d011SMarcel Moolenaarin each word of the value is substituted with 14133955d011SMarcel Moolenaar.Ar replacement . 14143955d011SMarcel MoolenaarThe 14153955d011SMarcel Moolenaar.Ql 1 14163955d011SMarcel Moolenaarmodifier causes the substitution to apply to at most one word; the 14173955d011SMarcel Moolenaar.Ql g 14183955d011SMarcel Moolenaarmodifier causes the substitution to apply to as many instances of the 14193955d011SMarcel Moolenaarsearch pattern 14203955d011SMarcel Moolenaar.Ar pattern 14213955d011SMarcel Moolenaaras occur in the word or words it is found in; the 14223955d011SMarcel Moolenaar.Ql W 14233955d011SMarcel Moolenaarmodifier causes the value to be treated as a single word 14243955d011SMarcel Moolenaar(possibly containing embedded white space). 14255bcb7424SSimon J. Gerraty.Pp 14265bcb7424SSimon J. GerratyAs for the 14275bcb7424SSimon J. Gerraty.Cm \&:S 14285bcb7424SSimon J. Gerratymodifier, the 14295bcb7424SSimon J. Gerraty.Ar pattern 14305bcb7424SSimon J. Gerratyand 14315bcb7424SSimon J. Gerraty.Ar replacement 14325bcb7424SSimon J. Gerratyare subjected to variable expansion before being parsed as 14335bcb7424SSimon J. Gerratyregular expressions. 14343955d011SMarcel Moolenaar.It Cm \&:T 14352c3632d1SSimon J. GerratyReplaces each word in the variable with its last path component. 14363955d011SMarcel Moolenaar.It Cm \&:u 14372c3632d1SSimon J. GerratyRemoves adjacent duplicate words (like 14383955d011SMarcel Moolenaar.Xr uniq 1 ) . 14393955d011SMarcel Moolenaar.Sm off 14403955d011SMarcel Moolenaar.It Cm \&:\&? Ar true_string Cm \&: Ar false_string 14413955d011SMarcel Moolenaar.Sm on 14423955d011SMarcel MoolenaarIf the variable name (not its value), when parsed as a .if conditional 14433955d011SMarcel Moolenaarexpression, evaluates to true, return as its value the 14443955d011SMarcel Moolenaar.Ar true_string , 14453955d011SMarcel Moolenaarotherwise return the 14463955d011SMarcel Moolenaar.Ar false_string . 14473955d011SMarcel MoolenaarSince the variable name is used as the expression, \&:\&? must be the 14483955d011SMarcel Moolenaarfirst modifier after the variable name itself - which will, of course, 14493955d011SMarcel Moolenaarusually contain variable expansions. 14503955d011SMarcel MoolenaarA common error is trying to use expressions like 14513955d011SMarcel Moolenaar.Dl ${NUMBERS:M42:?match:no} 14523955d011SMarcel Moolenaarwhich actually tests defined(NUMBERS), 14532c3632d1SSimon J. Gerratyto determine if any words match "42" you need to use something like: 14543955d011SMarcel Moolenaar.Dl ${"${NUMBERS:M42}" != \&"\&":?match:no} . 14553955d011SMarcel Moolenaar.It Ar :old_string=new_string 14563955d011SMarcel MoolenaarThis is the 14573955d011SMarcel Moolenaar.At V 14583955d011SMarcel Moolenaarstyle variable substitution. 14593955d011SMarcel MoolenaarIt must be the last modifier specified. 14603955d011SMarcel MoolenaarIf 14613955d011SMarcel Moolenaar.Ar old_string 14623955d011SMarcel Moolenaaror 14633955d011SMarcel Moolenaar.Ar new_string 14643955d011SMarcel Moolenaardo not contain the pattern matching character 14653955d011SMarcel Moolenaar.Ar % 14663955d011SMarcel Moolenaarthen it is assumed that they are 14673955d011SMarcel Moolenaaranchored at the end of each word, so only suffixes or entire 14683955d011SMarcel Moolenaarwords may be replaced. 14693955d011SMarcel MoolenaarOtherwise 14703955d011SMarcel Moolenaar.Ar % 14713955d011SMarcel Moolenaaris the substring of 14723955d011SMarcel Moolenaar.Ar old_string 14733955d011SMarcel Moolenaarto be replaced in 14743955d011SMarcel Moolenaar.Ar new_string . 1475ef0b2538SSimon J. GerratyIf only 1476ef0b2538SSimon J. Gerraty.Ar old_string 1477ef0b2538SSimon J. Gerratycontains the pattern matching character 1478ef0b2538SSimon J. Gerraty.Ar % , 1479ef0b2538SSimon J. Gerratyand 1480ef0b2538SSimon J. Gerraty.Ar old_string 1481ef0b2538SSimon J. Gerratymatches, then the result is the 1482ef0b2538SSimon J. Gerraty.Ar new_string . 1483ef0b2538SSimon J. GerratyIf only the 1484ef0b2538SSimon J. Gerraty.Ar new_string 1485ef0b2538SSimon J. Gerratycontains the pattern matching character 1486ef0b2538SSimon J. Gerraty.Ar % , 1487ef0b2538SSimon J. Gerratythen it is not treated specially and it is printed as a literal 1488ef0b2538SSimon J. Gerraty.Ar % 1489ef0b2538SSimon J. Gerratyon match. 1490ef0b2538SSimon J. GerratyIf there is more than one pattern matching character 1491ef0b2538SSimon J. Gerraty.Ar ( % ) 1492ef0b2538SSimon J. Gerratyin either the 1493ef0b2538SSimon J. Gerraty.Ar new_string 1494ef0b2538SSimon J. Gerratyor 1495ef0b2538SSimon J. Gerraty.Ar old_string , 1496ef0b2538SSimon J. Gerratyonly the first instance is treated specially (as the pattern character); 14972c3632d1SSimon J. Gerratyall subsequent instances are treated as regular characters. 14983955d011SMarcel Moolenaar.Pp 14993955d011SMarcel MoolenaarVariable expansion occurs in the normal fashion inside both 15003955d011SMarcel Moolenaar.Ar old_string 15013955d011SMarcel Moolenaarand 15023955d011SMarcel Moolenaar.Ar new_string 15033955d011SMarcel Moolenaarwith the single exception that a backslash is used to prevent the 15043955d011SMarcel Moolenaarexpansion of a dollar sign 15053955d011SMarcel Moolenaar.Pq Ql \&$ , 15063955d011SMarcel Moolenaarnot a preceding dollar sign as is usual. 15073955d011SMarcel Moolenaar.Sm off 15083955d011SMarcel Moolenaar.It Cm \&:@ Ar temp Cm @ Ar string Cm @ 15093955d011SMarcel Moolenaar.Sm on 15103955d011SMarcel MoolenaarThis is the loop expansion mechanism from the OSF Development 15113955d011SMarcel MoolenaarEnvironment (ODE) make. 15123955d011SMarcel MoolenaarUnlike 15133955d011SMarcel Moolenaar.Cm \&.for 15142c3632d1SSimon J. Gerratyloops, expansion occurs at the time of reference. 15152c3632d1SSimon J. GerratyAssigns 15163955d011SMarcel Moolenaar.Ar temp 15172c3632d1SSimon J. Gerratyto each word in the variable and evaluates 15183955d011SMarcel Moolenaar.Ar string . 15193955d011SMarcel MoolenaarThe ODE convention is that 15203955d011SMarcel Moolenaar.Ar temp 15213955d011SMarcel Moolenaarshould start and end with a period. 15223955d011SMarcel MoolenaarFor example. 15233955d011SMarcel Moolenaar.Dl ${LINKS:@.LINK.@${LN} ${TARGET} ${.LINK.}@} 15243955d011SMarcel Moolenaar.Pp 152551ee2c1cSSimon J. GerratyHowever a single character variable is often more readable: 15263955d011SMarcel Moolenaar.Dl ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@} 15271ce939a7SSimon J. Gerraty.It Cm \&:_[=var] 15282c3632d1SSimon J. GerratySaves the current variable value in 15291ce939a7SSimon J. Gerraty.Ql $_ 15301ce939a7SSimon J. Gerratyor the named 15311ce939a7SSimon J. Gerraty.Va var 15321ce939a7SSimon J. Gerratyfor later reference. 15331ce939a7SSimon J. GerratyExample usage: 15341ce939a7SSimon J. Gerraty.Bd -literal -offset indent 15351ce939a7SSimon J. GerratyM_cmpv.units = 1 1000 1000000 15361ce939a7SSimon J. GerratyM_cmpv = S,., ,g:_:range:@i@+ $${_:[-$$i]} \&\\ 15371ce939a7SSimon J. Gerraty\\* $${M_cmpv.units:[$$i]}@:S,^,expr 0 ,1:sh 15381ce939a7SSimon J. Gerraty 15391ce939a7SSimon J. Gerraty.Dv .if ${VERSION:${M_cmpv}} < ${3.1.12:L:${M_cmpv}} 15401ce939a7SSimon J. Gerraty 15411ce939a7SSimon J. Gerraty.Ed 15421ce939a7SSimon J. GerratyHere 15431ce939a7SSimon J. Gerraty.Ql $_ 15441ce939a7SSimon J. Gerratyis used to save the result of the 15451ce939a7SSimon J. Gerraty.Ql :S 15461ce939a7SSimon J. Gerratymodifier which is later referenced using the index values from 15471ce939a7SSimon J. Gerraty.Ql :range . 15483955d011SMarcel Moolenaar.It Cm \&:U Ns Ar newval 15492c3632d1SSimon J. GerratyIf the variable is undefined, 15503955d011SMarcel Moolenaar.Ar newval 15513955d011SMarcel Moolenaaris the value. 15523955d011SMarcel MoolenaarIf the variable is defined, the existing value is returned. 15533955d011SMarcel MoolenaarThis is another ODE make feature. 15543955d011SMarcel MoolenaarIt is handy for setting per-target CFLAGS for instance: 15553955d011SMarcel Moolenaar.Dl ${_${.TARGET:T}_CFLAGS:U${DEF_CFLAGS}} 15563955d011SMarcel MoolenaarIf a value is only required if the variable is undefined, use: 15573955d011SMarcel Moolenaar.Dl ${VAR:D:Unewval} 15583955d011SMarcel Moolenaar.It Cm \&:D Ns Ar newval 15592c3632d1SSimon J. GerratyIf the variable is defined, 15603955d011SMarcel Moolenaar.Ar newval 15613955d011SMarcel Moolenaaris the value. 15623955d011SMarcel Moolenaar.It Cm \&:L 15633955d011SMarcel MoolenaarThe name of the variable is the value. 15643955d011SMarcel Moolenaar.It Cm \&:P 15653955d011SMarcel MoolenaarThe path of the node which has the same name as the variable 15663955d011SMarcel Moolenaaris the value. 15673955d011SMarcel MoolenaarIf no such node exists or its path is null, then the 15683955d011SMarcel Moolenaarname of the variable is used. 15693955d011SMarcel MoolenaarIn order for this modifier to work, the name (node) must at least have 15703955d011SMarcel Moolenaarappeared on the rhs of a dependency. 15713955d011SMarcel Moolenaar.Sm off 15723955d011SMarcel Moolenaar.It Cm \&:\&! Ar cmd Cm \&! 15733955d011SMarcel Moolenaar.Sm on 15743955d011SMarcel MoolenaarThe output of running 15753955d011SMarcel Moolenaar.Ar cmd 15763955d011SMarcel Moolenaaris the value. 15773955d011SMarcel Moolenaar.It Cm \&:sh 15783955d011SMarcel MoolenaarIf the variable is non-empty it is run as a command and the output 15793955d011SMarcel Moolenaarbecomes the new value. 15803955d011SMarcel Moolenaar.It Cm \&::= Ns Ar str 15813955d011SMarcel MoolenaarThe variable is assigned the value 15823955d011SMarcel Moolenaar.Ar str 15833955d011SMarcel Moolenaarafter substitution. 15843955d011SMarcel MoolenaarThis modifier and its variations are useful in 15853955d011SMarcel Moolenaarobscure situations such as wanting to set a variable when shell commands 15863955d011SMarcel Moolenaarare being parsed. 15873955d011SMarcel MoolenaarThese assignment modifiers always expand to 15883955d011SMarcel Moolenaarnothing, so if appearing in a rule line by themselves should be 15893955d011SMarcel Moolenaarpreceded with something to keep 15903955d011SMarcel Moolenaar.Nm 15913955d011SMarcel Moolenaarhappy. 15923955d011SMarcel Moolenaar.Pp 15933955d011SMarcel MoolenaarThe 15943955d011SMarcel Moolenaar.Ql Cm \&:: 15953955d011SMarcel Moolenaarhelps avoid false matches with the 15963955d011SMarcel Moolenaar.At V 15973955d011SMarcel Moolenaarstyle 15983955d011SMarcel Moolenaar.Cm \&:= 15993955d011SMarcel Moolenaarmodifier and since substitution always occurs the 16003955d011SMarcel Moolenaar.Cm \&::= 16013955d011SMarcel Moolenaarform is vaguely appropriate. 16023955d011SMarcel Moolenaar.It Cm \&::?= Ns Ar str 16033955d011SMarcel MoolenaarAs for 16043955d011SMarcel Moolenaar.Cm \&::= 16053955d011SMarcel Moolenaarbut only if the variable does not already have a value. 16063955d011SMarcel Moolenaar.It Cm \&::+= Ns Ar str 16073955d011SMarcel MoolenaarAppend 16083955d011SMarcel Moolenaar.Ar str 16093955d011SMarcel Moolenaarto the variable. 16103955d011SMarcel Moolenaar.It Cm \&::!= Ns Ar cmd 16113955d011SMarcel MoolenaarAssign the output of 16123955d011SMarcel Moolenaar.Ar cmd 16133955d011SMarcel Moolenaarto the variable. 16143955d011SMarcel Moolenaar.It Cm \&:\&[ Ns Ar range Ns Cm \&] 16153955d011SMarcel MoolenaarSelects one or more words from the value, 16163955d011SMarcel Moolenaaror performs other operations related to the way in which the 16173955d011SMarcel Moolenaarvalue is divided into words. 16183955d011SMarcel Moolenaar.Pp 16193955d011SMarcel MoolenaarOrdinarily, a value is treated as a sequence of words 16203955d011SMarcel Moolenaardelimited by white space. 1621be19d90bSSimon J. GerratySome modifiers suppress this behavior, 16223955d011SMarcel Moolenaarcausing a value to be treated as a single word 16233955d011SMarcel Moolenaar(possibly containing embedded white space). 16243955d011SMarcel MoolenaarAn empty value, or a value that consists entirely of white-space, 16253955d011SMarcel Moolenaaris treated as a single word. 16263955d011SMarcel MoolenaarFor the purposes of the 16273955d011SMarcel Moolenaar.Ql Cm \&:[] 16283955d011SMarcel Moolenaarmodifier, the words are indexed both forwards using positive integers 16293955d011SMarcel Moolenaar(where index 1 represents the first word), 16303955d011SMarcel Moolenaarand backwards using negative integers 16313955d011SMarcel Moolenaar(where index \-1 represents the last word). 16323955d011SMarcel Moolenaar.Pp 16333955d011SMarcel MoolenaarThe 16343955d011SMarcel Moolenaar.Ar range 16353955d011SMarcel Moolenaaris subjected to variable expansion, and the expanded result is 16363955d011SMarcel Moolenaarthen interpreted as follows: 16373955d011SMarcel Moolenaar.Bl -tag -width index 16383955d011SMarcel Moolenaar.\" :[n] 16393955d011SMarcel Moolenaar.It Ar index 16403955d011SMarcel MoolenaarSelects a single word from the value. 16413955d011SMarcel Moolenaar.\" :[start..end] 16423955d011SMarcel Moolenaar.It Ar start Ns Cm \&.. Ns Ar end 16433955d011SMarcel MoolenaarSelects all words from 16443955d011SMarcel Moolenaar.Ar start 16453955d011SMarcel Moolenaarto 16463955d011SMarcel Moolenaar.Ar end , 16473955d011SMarcel Moolenaarinclusive. 16483955d011SMarcel MoolenaarFor example, 16493955d011SMarcel Moolenaar.Ql Cm \&:[2..-1] 16503955d011SMarcel Moolenaarselects all words from the second word to the last word. 16513955d011SMarcel MoolenaarIf 16523955d011SMarcel Moolenaar.Ar start 16533955d011SMarcel Moolenaaris greater than 16543955d011SMarcel Moolenaar.Ar end , 16553955d011SMarcel Moolenaarthen the words are output in reverse order. 16563955d011SMarcel MoolenaarFor example, 16573955d011SMarcel Moolenaar.Ql Cm \&:[-1..1] 16583955d011SMarcel Moolenaarselects all the words from last to first. 1659ef0b2538SSimon J. GerratyIf the list is already ordered, then this effectively reverses 1660ef0b2538SSimon J. Gerratythe list, but it is more efficient to use 1661ef0b2538SSimon J. Gerraty.Ql Cm \&:Or 1662ef0b2538SSimon J. Gerratyinstead of 1663ef0b2538SSimon J. Gerraty.Ql Cm \&:O:[-1..1] . 16643955d011SMarcel Moolenaar.\" :[*] 16653955d011SMarcel Moolenaar.It Cm \&* 16663955d011SMarcel MoolenaarCauses subsequent modifiers to treat the value as a single word 16673955d011SMarcel Moolenaar(possibly containing embedded white space). 16683955d011SMarcel MoolenaarAnalogous to the effect of 16693955d011SMarcel Moolenaar\&"$*\&" 16703955d011SMarcel Moolenaarin Bourne shell. 16713955d011SMarcel Moolenaar.\" :[0] 16723955d011SMarcel Moolenaar.It 0 16733955d011SMarcel MoolenaarMeans the same as 16743955d011SMarcel Moolenaar.Ql Cm \&:[*] . 16753955d011SMarcel Moolenaar.\" :[*] 16763955d011SMarcel Moolenaar.It Cm \&@ 16773955d011SMarcel MoolenaarCauses subsequent modifiers to treat the value as a sequence of words 16783955d011SMarcel Moolenaardelimited by white space. 16793955d011SMarcel MoolenaarAnalogous to the effect of 16803955d011SMarcel Moolenaar\&"$@\&" 16813955d011SMarcel Moolenaarin Bourne shell. 16823955d011SMarcel Moolenaar.\" :[#] 16833955d011SMarcel Moolenaar.It Cm \&# 16843955d011SMarcel MoolenaarReturns the number of words in the value. 16853955d011SMarcel Moolenaar.El \" :[range] 16863955d011SMarcel Moolenaar.El 16873955d011SMarcel Moolenaar.Sh INCLUDE STATEMENTS, CONDITIONALS AND FOR LOOPS 16883955d011SMarcel MoolenaarMakefile inclusion, conditional structures and for loops reminiscent 16893955d011SMarcel Moolenaarof the C programming language are provided in 16903955d011SMarcel Moolenaar.Nm . 16913955d011SMarcel MoolenaarAll such structures are identified by a line beginning with a single 16923955d011SMarcel Moolenaardot 16933955d011SMarcel Moolenaar.Pq Ql \&. 16943955d011SMarcel Moolenaarcharacter. 16953955d011SMarcel MoolenaarFiles are included with either 1696ef0b2538SSimon J. Gerraty.Cm \&.include \&< Ns Ar file Ns Cm \&> 16973955d011SMarcel Moolenaaror 1698ef0b2538SSimon J. Gerraty.Cm \&.include \&\*q Ns Ar file Ns Cm \&\*q . 16993955d011SMarcel MoolenaarVariables between the angle brackets or double quotes are expanded 17003955d011SMarcel Moolenaarto form the file name. 17013955d011SMarcel MoolenaarIf angle brackets are used, the included makefile is expected to be in 17023955d011SMarcel Moolenaarthe system makefile directory. 17033955d011SMarcel MoolenaarIf double quotes are used, the including makefile's directory and any 17043955d011SMarcel Moolenaardirectories specified using the 17053955d011SMarcel Moolenaar.Fl I 17063955d011SMarcel Moolenaaroption are searched before the system 17073955d011SMarcel Moolenaarmakefile directory. 17083955d011SMarcel MoolenaarFor compatibility with other versions of 17093955d011SMarcel Moolenaar.Nm 17103955d011SMarcel Moolenaar.Ql include file ... 17113955d011SMarcel Moolenaaris also accepted. 1712be19d90bSSimon J. Gerraty.Pp 17133955d011SMarcel MoolenaarIf the include statement is written as 17143955d011SMarcel Moolenaar.Cm .-include 17153955d011SMarcel Moolenaaror as 17163955d011SMarcel Moolenaar.Cm .sinclude 17173955d011SMarcel Moolenaarthen errors locating and/or opening include files are ignored. 17183955d011SMarcel Moolenaar.Pp 1719be19d90bSSimon J. GerratyIf the include statement is written as 1720be19d90bSSimon J. Gerraty.Cm .dinclude 1721be19d90bSSimon J. Gerratynot only are errors locating and/or opening include files ignored, 1722be19d90bSSimon J. Gerratybut stale dependencies within the included file will be ignored 1723be19d90bSSimon J. Gerratyjust like 1724be19d90bSSimon J. Gerraty.Va .MAKE.DEPENDFILE . 1725be19d90bSSimon J. Gerraty.Pp 17263955d011SMarcel MoolenaarConditional expressions are also preceded by a single dot as the first 17273955d011SMarcel Moolenaarcharacter of a line. 17283955d011SMarcel MoolenaarThe possible conditionals are as follows: 17293955d011SMarcel Moolenaar.Bl -tag -width Ds 17303955d011SMarcel Moolenaar.It Ic .error Ar message 17313955d011SMarcel MoolenaarThe message is printed along with the name of the makefile and line number, 17323955d011SMarcel Moolenaarthen 17333955d011SMarcel Moolenaar.Nm 17342c3632d1SSimon J. Gerratywill exit immediately. 17353955d011SMarcel Moolenaar.It Ic .export Ar variable ... 17363955d011SMarcel MoolenaarExport the specified global variable. 17373955d011SMarcel MoolenaarIf no variable list is provided, all globals are exported 17383955d011SMarcel Moolenaarexcept for internal variables (those that start with 17393955d011SMarcel Moolenaar.Ql \&. ) . 17403955d011SMarcel MoolenaarThis is not affected by the 17413955d011SMarcel Moolenaar.Fl X 17423955d011SMarcel Moolenaarflag, so should be used with caution. 17433955d011SMarcel MoolenaarFor compatibility with other 17443955d011SMarcel Moolenaar.Nm 17453955d011SMarcel Moolenaarprograms 17463955d011SMarcel Moolenaar.Ql export variable=value 17473955d011SMarcel Moolenaaris also accepted. 17483955d011SMarcel Moolenaar.Pp 17493955d011SMarcel MoolenaarAppending a variable name to 17503955d011SMarcel Moolenaar.Va .MAKE.EXPORTED 17513955d011SMarcel Moolenaaris equivalent to exporting a variable. 17523955d011SMarcel Moolenaar.It Ic .export-env Ar variable ... 17533955d011SMarcel MoolenaarThe same as 17543955d011SMarcel Moolenaar.Ql .export , 17553955d011SMarcel Moolenaarexcept that the variable is not appended to 17563955d011SMarcel Moolenaar.Va .MAKE.EXPORTED . 17573955d011SMarcel MoolenaarThis allows exporting a value to the environment which is different from that 17583955d011SMarcel Moolenaarused by 17593955d011SMarcel Moolenaar.Nm 17603955d011SMarcel Moolenaarinternally. 1761be19d90bSSimon J. Gerraty.It Ic .export-literal Ar variable ... 1762be19d90bSSimon J. GerratyThe same as 1763be19d90bSSimon J. Gerraty.Ql .export-env , 1764be19d90bSSimon J. Gerratyexcept that variables in the value are not expanded. 17653955d011SMarcel Moolenaar.It Ic .info Ar message 17663955d011SMarcel MoolenaarThe message is printed along with the name of the makefile and line number. 176706b9b3e0SSimon J. Gerraty.It Ic .undef Ar variable ... 176806b9b3e0SSimon J. GerratyUn-define the specified global variables. 176906b9b3e0SSimon J. GerratyOnly global variables can be un-defined. 17703955d011SMarcel Moolenaar.It Ic .unexport Ar variable ... 17713955d011SMarcel MoolenaarThe opposite of 17723955d011SMarcel Moolenaar.Ql .export . 17733955d011SMarcel MoolenaarThe specified global 17743955d011SMarcel Moolenaar.Va variable 17753955d011SMarcel Moolenaarwill be removed from 17763955d011SMarcel Moolenaar.Va .MAKE.EXPORTED . 17773955d011SMarcel MoolenaarIf no variable list is provided, all globals are unexported, 17783955d011SMarcel Moolenaarand 17793955d011SMarcel Moolenaar.Va .MAKE.EXPORTED 17803955d011SMarcel Moolenaardeleted. 17813955d011SMarcel Moolenaar.It Ic .unexport-env 17823955d011SMarcel MoolenaarUnexport all globals previously exported and 17833955d011SMarcel Moolenaarclear the environment inherited from the parent. 17843955d011SMarcel MoolenaarThis operation will cause a memory leak of the original environment, 17853955d011SMarcel Moolenaarso should be used sparingly. 17863955d011SMarcel MoolenaarTesting for 17873955d011SMarcel Moolenaar.Va .MAKE.LEVEL 17883955d011SMarcel Moolenaarbeing 0, would make sense. 17893955d011SMarcel MoolenaarAlso note that any variables which originated in the parent environment 17903955d011SMarcel Moolenaarshould be explicitly preserved if desired. 17913955d011SMarcel MoolenaarFor example: 17923955d011SMarcel Moolenaar.Bd -literal -offset indent 17933955d011SMarcel Moolenaar.Li .if ${.MAKE.LEVEL} == 0 17943955d011SMarcel MoolenaarPATH := ${PATH} 17953955d011SMarcel Moolenaar.Li .unexport-env 17963955d011SMarcel Moolenaar.Li .export PATH 17973955d011SMarcel Moolenaar.Li .endif 17983955d011SMarcel Moolenaar.Pp 17993955d011SMarcel Moolenaar.Ed 18003955d011SMarcel MoolenaarWould result in an environment containing only 18013955d011SMarcel Moolenaar.Ql Ev PATH , 18023955d011SMarcel Moolenaarwhich is the minimal useful environment. 18033955d011SMarcel MoolenaarActually 18043955d011SMarcel Moolenaar.Ql Ev .MAKE.LEVEL 18053955d011SMarcel Moolenaarwill also be pushed into the new environment. 18063955d011SMarcel Moolenaar.It Ic .warning Ar message 18073955d011SMarcel MoolenaarThe message prefixed by 18083955d011SMarcel Moolenaar.Ql Pa warning: 18093955d011SMarcel Moolenaaris printed along with the name of the makefile and line number. 18103955d011SMarcel Moolenaar.It Ic \&.if Oo \&! Oc Ns Ar expression Op Ar operator expression ... 18113955d011SMarcel MoolenaarTest the value of an expression. 18123955d011SMarcel Moolenaar.It Ic .ifdef Oo \&! Oc Ns Ar variable Op Ar operator variable ... 18133955d011SMarcel MoolenaarTest the value of a variable. 18143955d011SMarcel Moolenaar.It Ic .ifndef Oo \&! Oc Ns Ar variable Op Ar operator variable ... 18153955d011SMarcel MoolenaarTest the value of a variable. 18163955d011SMarcel Moolenaar.It Ic .ifmake Oo \&! Oc Ns Ar target Op Ar operator target ... 18173955d011SMarcel MoolenaarTest the target being built. 18183955d011SMarcel Moolenaar.It Ic .ifnmake Oo \&! Ns Oc Ar target Op Ar operator target ... 18193955d011SMarcel MoolenaarTest the target being built. 18203955d011SMarcel Moolenaar.It Ic .else 18213955d011SMarcel MoolenaarReverse the sense of the last conditional. 18223955d011SMarcel Moolenaar.It Ic .elif Oo \&! Ns Oc Ar expression Op Ar operator expression ... 18233955d011SMarcel MoolenaarA combination of 18243955d011SMarcel Moolenaar.Ql Ic .else 18253955d011SMarcel Moolenaarfollowed by 18263955d011SMarcel Moolenaar.Ql Ic .if . 18273955d011SMarcel Moolenaar.It Ic .elifdef Oo \&! Oc Ns Ar variable Op Ar operator variable ... 18283955d011SMarcel MoolenaarA combination of 18293955d011SMarcel Moolenaar.Ql Ic .else 18303955d011SMarcel Moolenaarfollowed by 18313955d011SMarcel Moolenaar.Ql Ic .ifdef . 18323955d011SMarcel Moolenaar.It Ic .elifndef Oo \&! Oc Ns Ar variable Op Ar operator variable ... 18333955d011SMarcel MoolenaarA combination of 18343955d011SMarcel Moolenaar.Ql Ic .else 18353955d011SMarcel Moolenaarfollowed by 18363955d011SMarcel Moolenaar.Ql Ic .ifndef . 18373955d011SMarcel Moolenaar.It Ic .elifmake Oo \&! Oc Ns Ar target Op Ar operator target ... 18383955d011SMarcel MoolenaarA combination of 18393955d011SMarcel Moolenaar.Ql Ic .else 18403955d011SMarcel Moolenaarfollowed by 18413955d011SMarcel Moolenaar.Ql Ic .ifmake . 18423955d011SMarcel Moolenaar.It Ic .elifnmake Oo \&! Oc Ns Ar target Op Ar operator target ... 18433955d011SMarcel MoolenaarA combination of 18443955d011SMarcel Moolenaar.Ql Ic .else 18453955d011SMarcel Moolenaarfollowed by 18463955d011SMarcel Moolenaar.Ql Ic .ifnmake . 18473955d011SMarcel Moolenaar.It Ic .endif 18483955d011SMarcel MoolenaarEnd the body of the conditional. 18493955d011SMarcel Moolenaar.El 18503955d011SMarcel Moolenaar.Pp 18513955d011SMarcel MoolenaarThe 18523955d011SMarcel Moolenaar.Ar operator 18533955d011SMarcel Moolenaarmay be any one of the following: 18543955d011SMarcel Moolenaar.Bl -tag -width "Cm XX" 18553955d011SMarcel Moolenaar.It Cm \&|\&| 18563955d011SMarcel MoolenaarLogical OR. 18578695518cSSimon J. Gerraty.It Cm \&&& 18583955d011SMarcel MoolenaarLogical 18593955d011SMarcel Moolenaar.Tn AND ; 18603955d011SMarcel Moolenaarof higher precedence than 18613955d011SMarcel Moolenaar.Dq \&|\&| . 18623955d011SMarcel Moolenaar.El 18633955d011SMarcel Moolenaar.Pp 18643955d011SMarcel MoolenaarAs in C, 18653955d011SMarcel Moolenaar.Nm 18663955d011SMarcel Moolenaarwill only evaluate a conditional as far as is necessary to determine 18673955d011SMarcel Moolenaarits value. 18683955d011SMarcel MoolenaarParentheses may be used to change the order of evaluation. 18693955d011SMarcel MoolenaarThe boolean operator 18703955d011SMarcel Moolenaar.Ql Ic \&! 18713955d011SMarcel Moolenaarmay be used to logically negate an entire 18723955d011SMarcel Moolenaarconditional. 18733955d011SMarcel MoolenaarIt is of higher precedence than 18748695518cSSimon J. Gerraty.Ql Ic \&&& . 18753955d011SMarcel Moolenaar.Pp 18763955d011SMarcel MoolenaarThe value of 18773955d011SMarcel Moolenaar.Ar expression 18783955d011SMarcel Moolenaarmay be any of the following: 18793955d011SMarcel Moolenaar.Bl -tag -width defined 18803955d011SMarcel Moolenaar.It Ic defined 18813955d011SMarcel MoolenaarTakes a variable name as an argument and evaluates to true if the variable 18823955d011SMarcel Moolenaarhas been defined. 18833955d011SMarcel Moolenaar.It Ic make 18843955d011SMarcel MoolenaarTakes a target name as an argument and evaluates to true if the target 18853955d011SMarcel Moolenaarwas specified as part of 18863955d011SMarcel Moolenaar.Nm Ns 's 18873955d011SMarcel Moolenaarcommand line or was declared the default target (either implicitly or 18883955d011SMarcel Moolenaarexplicitly, see 18893955d011SMarcel Moolenaar.Va .MAIN ) 18903955d011SMarcel Moolenaarbefore the line containing the conditional. 18913955d011SMarcel Moolenaar.It Ic empty 18923955d011SMarcel MoolenaarTakes a variable, with possible modifiers, and evaluates to true if 18933955d011SMarcel Moolenaarthe expansion of the variable would result in an empty string. 18943955d011SMarcel Moolenaar.It Ic exists 18953955d011SMarcel MoolenaarTakes a file name as an argument and evaluates to true if the file exists. 18963955d011SMarcel MoolenaarThe file is searched for on the system search path (see 18973955d011SMarcel Moolenaar.Va .PATH ) . 18983955d011SMarcel Moolenaar.It Ic target 18993955d011SMarcel MoolenaarTakes a target name as an argument and evaluates to true if the target 19003955d011SMarcel Moolenaarhas been defined. 19013955d011SMarcel Moolenaar.It Ic commands 19023955d011SMarcel MoolenaarTakes a target name as an argument and evaluates to true if the target 19033955d011SMarcel Moolenaarhas been defined and has commands associated with it. 19043955d011SMarcel Moolenaar.El 19053955d011SMarcel Moolenaar.Pp 19063955d011SMarcel Moolenaar.Ar Expression 19073955d011SMarcel Moolenaarmay also be an arithmetic or string comparison. 19083955d011SMarcel MoolenaarVariable expansion is 1909956e45f6SSimon J. Gerratyperformed on both sides of the comparison, after which the numerical 19103955d011SMarcel Moolenaarvalues are compared. 19113955d011SMarcel MoolenaarA value is interpreted as hexadecimal if it is 19123955d011SMarcel Moolenaarpreceded by 0x, otherwise it is decimal; octal numbers are not supported. 19133955d011SMarcel MoolenaarThe standard C relational operators are all supported. 19143955d011SMarcel MoolenaarIf after 19153955d011SMarcel Moolenaarvariable expansion, either the left or right hand side of a 19163955d011SMarcel Moolenaar.Ql Ic == 19173955d011SMarcel Moolenaaror 19183955d011SMarcel Moolenaar.Ql Ic "!=" 1919956e45f6SSimon J. Gerratyoperator is not a numerical value, then 19203955d011SMarcel Moolenaarstring comparison is performed between the expanded 19213955d011SMarcel Moolenaarvariables. 19223955d011SMarcel MoolenaarIf no relational operator is given, it is assumed that the expanded 19232c3632d1SSimon J. Gerratyvariable is being compared against 0, or an empty string in the case 19243955d011SMarcel Moolenaarof a string comparison. 19253955d011SMarcel Moolenaar.Pp 19263955d011SMarcel MoolenaarWhen 19273955d011SMarcel Moolenaar.Nm 19283955d011SMarcel Moolenaaris evaluating one of these conditional expressions, and it encounters 19293955d011SMarcel Moolenaara (white-space separated) word it doesn't recognize, either the 19303955d011SMarcel Moolenaar.Dq make 19313955d011SMarcel Moolenaaror 19323955d011SMarcel Moolenaar.Dq defined 19333955d011SMarcel Moolenaarexpression is applied to it, depending on the form of the conditional. 19343955d011SMarcel MoolenaarIf the form is 19353955d011SMarcel Moolenaar.Ql Ic .ifdef , 19363955d011SMarcel Moolenaar.Ql Ic .ifndef , 19373955d011SMarcel Moolenaaror 19383955d011SMarcel Moolenaar.Ql Ic .if 19393955d011SMarcel Moolenaarthe 19403955d011SMarcel Moolenaar.Dq defined 19413955d011SMarcel Moolenaarexpression is applied. 19423955d011SMarcel MoolenaarSimilarly, if the form is 19433955d011SMarcel Moolenaar.Ql Ic .ifmake 19443955d011SMarcel Moolenaaror 1945494f7191SSimon J. Gerraty.Ql Ic .ifnmake , 1946494f7191SSimon J. Gerratythe 19473955d011SMarcel Moolenaar.Dq make 19483955d011SMarcel Moolenaarexpression is applied. 19493955d011SMarcel Moolenaar.Pp 19503955d011SMarcel MoolenaarIf the conditional evaluates to true the parsing of the makefile continues 19513955d011SMarcel Moolenaaras before. 19523955d011SMarcel MoolenaarIf it evaluates to false, the following lines are skipped. 19533955d011SMarcel MoolenaarIn both cases this continues until a 19543955d011SMarcel Moolenaar.Ql Ic .else 19553955d011SMarcel Moolenaaror 19563955d011SMarcel Moolenaar.Ql Ic .endif 19573955d011SMarcel Moolenaaris found. 19583955d011SMarcel Moolenaar.Pp 19593955d011SMarcel MoolenaarFor loops are typically used to apply a set of rules to a list of files. 19603955d011SMarcel MoolenaarThe syntax of a for loop is: 19613955d011SMarcel Moolenaar.Pp 19623955d011SMarcel Moolenaar.Bl -tag -compact -width Ds 19633955d011SMarcel Moolenaar.It Ic \&.for Ar variable Oo Ar variable ... Oc Ic in Ar expression 19642c3632d1SSimon J. Gerraty.It Aq make-lines 19653955d011SMarcel Moolenaar.It Ic \&.endfor 19663955d011SMarcel Moolenaar.El 19673955d011SMarcel Moolenaar.Pp 19683955d011SMarcel MoolenaarAfter the for 19693955d011SMarcel Moolenaar.Ic expression 19703955d011SMarcel Moolenaaris evaluated, it is split into words. 19713955d011SMarcel MoolenaarOn each iteration of the loop, one word is taken and assigned to each 19723955d011SMarcel Moolenaar.Ic variable , 19733955d011SMarcel Moolenaarin order, and these 19743955d011SMarcel Moolenaar.Ic variables 19753955d011SMarcel Moolenaarare substituted into the 19762c3632d1SSimon J. Gerraty.Ic make-lines 19773955d011SMarcel Moolenaarinside the body of the for loop. 19783955d011SMarcel MoolenaarThe number of words must come out even; that is, if there are three 19793955d011SMarcel Moolenaariteration variables, the number of words provided must be a multiple 19803955d011SMarcel Moolenaarof three. 19813955d011SMarcel Moolenaar.Sh COMMENTS 19823955d011SMarcel MoolenaarComments begin with a hash 19833955d011SMarcel Moolenaar.Pq Ql \&# 19843955d011SMarcel Moolenaarcharacter, anywhere but in a shell 19853955d011SMarcel Moolenaarcommand line, and continue to the end of an unescaped new line. 19863955d011SMarcel Moolenaar.Sh SPECIAL SOURCES (ATTRIBUTES) 19873955d011SMarcel Moolenaar.Bl -tag -width .IGNOREx 19883955d011SMarcel Moolenaar.It Ic .EXEC 19893955d011SMarcel MoolenaarTarget is never out of date, but always execute commands anyway. 19903955d011SMarcel Moolenaar.It Ic .IGNORE 19913955d011SMarcel MoolenaarIgnore any errors from the commands associated with this target, exactly 19923955d011SMarcel Moolenaaras if they all were preceded by a dash 19933955d011SMarcel Moolenaar.Pq Ql \- . 19943955d011SMarcel Moolenaar.\" .It Ic .INVISIBLE 19953955d011SMarcel Moolenaar.\" XXX 19963955d011SMarcel Moolenaar.\" .It Ic .JOIN 19973955d011SMarcel Moolenaar.\" XXX 19983955d011SMarcel Moolenaar.It Ic .MADE 19993955d011SMarcel MoolenaarMark all sources of this target as being up-to-date. 20003955d011SMarcel Moolenaar.It Ic .MAKE 20013955d011SMarcel MoolenaarExecute the commands associated with this target even if the 20023955d011SMarcel Moolenaar.Fl n 20033955d011SMarcel Moolenaaror 20043955d011SMarcel Moolenaar.Fl t 20053955d011SMarcel Moolenaaroptions were specified. 20063955d011SMarcel MoolenaarNormally used to mark recursive 20070dede8b0SSimon J. Gerraty.Nm Ns s . 20083955d011SMarcel Moolenaar.It Ic .META 20093955d011SMarcel MoolenaarCreate a meta file for the target, even if it is flagged as 20103955d011SMarcel Moolenaar.Ic .PHONY , 20113955d011SMarcel Moolenaar.Ic .MAKE , 20123955d011SMarcel Moolenaaror 20133955d011SMarcel Moolenaar.Ic .SPECIAL . 20143955d011SMarcel MoolenaarUsage in conjunction with 20153955d011SMarcel Moolenaar.Ic .MAKE 20163955d011SMarcel Moolenaaris the most likely case. 20173955d011SMarcel MoolenaarIn "meta" mode, the target is out-of-date if the meta file is missing. 20183955d011SMarcel Moolenaar.It Ic .NOMETA 20193955d011SMarcel MoolenaarDo not create a meta file for the target. 20203955d011SMarcel MoolenaarMeta files are also not created for 20213955d011SMarcel Moolenaar.Ic .PHONY , 20223955d011SMarcel Moolenaar.Ic .MAKE , 20233955d011SMarcel Moolenaaror 20243955d011SMarcel Moolenaar.Ic .SPECIAL 20253955d011SMarcel Moolenaartargets. 20263955d011SMarcel Moolenaar.It Ic .NOMETA_CMP 20273955d011SMarcel MoolenaarIgnore differences in commands when deciding if target is out of date. 20283955d011SMarcel MoolenaarThis is useful if the command contains a value which always changes. 20293955d011SMarcel MoolenaarIf the number of commands change, though, the target will still be out of date. 20301748de26SSimon J. GerratyThe same effect applies to any command line that uses the variable 20311748de26SSimon J. Gerraty.Va .OODATE , 20321748de26SSimon J. Gerratywhich can be used for that purpose even when not otherwise needed or desired: 20331748de26SSimon J. Gerraty.Bd -literal -offset indent 20341748de26SSimon J. Gerraty 20351748de26SSimon J. Gerratyskip-compare-for-some: 20361748de26SSimon J. Gerraty @echo this will be compared 20371748de26SSimon J. Gerraty @echo this will not ${.OODATE:M.NOMETA_CMP} 20381748de26SSimon J. Gerraty @echo this will also be compared 20391748de26SSimon J. Gerraty 20401748de26SSimon J. Gerraty.Ed 20411748de26SSimon J. GerratyThe 20421748de26SSimon J. Gerraty.Cm \&:M 20431748de26SSimon J. Gerratypattern suppresses any expansion of the unwanted variable. 20443955d011SMarcel Moolenaar.It Ic .NOPATH 20453955d011SMarcel MoolenaarDo not search for the target in the directories specified by 20463955d011SMarcel Moolenaar.Ic .PATH . 20473955d011SMarcel Moolenaar.It Ic .NOTMAIN 20483955d011SMarcel MoolenaarNormally 20493955d011SMarcel Moolenaar.Nm 20503955d011SMarcel Moolenaarselects the first target it encounters as the default target to be built 20513955d011SMarcel Moolenaarif no target was specified. 20523955d011SMarcel MoolenaarThis source prevents this target from being selected. 20533955d011SMarcel Moolenaar.It Ic .OPTIONAL 20543955d011SMarcel MoolenaarIf a target is marked with this attribute and 20553955d011SMarcel Moolenaar.Nm 20563955d011SMarcel Moolenaarcan't figure out how to create it, it will ignore this fact and assume 20573955d011SMarcel Moolenaarthe file isn't needed or already exists. 20583955d011SMarcel Moolenaar.It Ic .PHONY 20593955d011SMarcel MoolenaarThe target does not 20603955d011SMarcel Moolenaarcorrespond to an actual file; it is always considered to be out of date, 20613955d011SMarcel Moolenaarand will not be created with the 20623955d011SMarcel Moolenaar.Fl t 20633955d011SMarcel Moolenaaroption. 20643955d011SMarcel MoolenaarSuffix-transformation rules are not applied to 20653955d011SMarcel Moolenaar.Ic .PHONY 20663955d011SMarcel Moolenaartargets. 20673955d011SMarcel Moolenaar.It Ic .PRECIOUS 20683955d011SMarcel MoolenaarWhen 20693955d011SMarcel Moolenaar.Nm 20703955d011SMarcel Moolenaaris interrupted, it normally removes any partially made targets. 20713955d011SMarcel MoolenaarThis source prevents the target from being removed. 20723955d011SMarcel Moolenaar.It Ic .RECURSIVE 20733955d011SMarcel MoolenaarSynonym for 20743955d011SMarcel Moolenaar.Ic .MAKE . 20753955d011SMarcel Moolenaar.It Ic .SILENT 20763955d011SMarcel MoolenaarDo not echo any of the commands associated with this target, exactly 20773955d011SMarcel Moolenaaras if they all were preceded by an at sign 20783955d011SMarcel Moolenaar.Pq Ql @ . 20793955d011SMarcel Moolenaar.It Ic .USE 20803955d011SMarcel MoolenaarTurn the target into 20813955d011SMarcel Moolenaar.Nm Ns 's 20823955d011SMarcel Moolenaarversion of a macro. 20833955d011SMarcel MoolenaarWhen the target is used as a source for another target, the other target 20843955d011SMarcel Moolenaaracquires the commands, sources, and attributes (except for 20853955d011SMarcel Moolenaar.Ic .USE ) 20863955d011SMarcel Moolenaarof the 20873955d011SMarcel Moolenaarsource. 20883955d011SMarcel MoolenaarIf the target already has commands, the 20893955d011SMarcel Moolenaar.Ic .USE 20903955d011SMarcel Moolenaartarget's commands are appended 20913955d011SMarcel Moolenaarto them. 20923955d011SMarcel Moolenaar.It Ic .USEBEFORE 20933955d011SMarcel MoolenaarExactly like 20943955d011SMarcel Moolenaar.Ic .USE , 20953955d011SMarcel Moolenaarbut prepend the 20963955d011SMarcel Moolenaar.Ic .USEBEFORE 20973955d011SMarcel Moolenaartarget commands to the target. 20983955d011SMarcel Moolenaar.It Ic .WAIT 20993955d011SMarcel MoolenaarIf 21003955d011SMarcel Moolenaar.Ic .WAIT 21013955d011SMarcel Moolenaarappears in a dependency line, the sources that precede it are 21023955d011SMarcel Moolenaarmade before the sources that succeed it in the line. 21033955d011SMarcel MoolenaarSince the dependents of files are not made until the file itself 21043955d011SMarcel Moolenaarcould be made, this also stops the dependents being built unless they 21053955d011SMarcel Moolenaarare needed for another branch of the dependency tree. 21063955d011SMarcel MoolenaarSo given: 21073955d011SMarcel Moolenaar.Bd -literal 21083955d011SMarcel Moolenaarx: a .WAIT b 21093955d011SMarcel Moolenaar echo x 21103955d011SMarcel Moolenaara: 21113955d011SMarcel Moolenaar echo a 21123955d011SMarcel Moolenaarb: b1 21133955d011SMarcel Moolenaar echo b 21143955d011SMarcel Moolenaarb1: 21153955d011SMarcel Moolenaar echo b1 21163955d011SMarcel Moolenaar 21173955d011SMarcel Moolenaar.Ed 21183955d011SMarcel Moolenaarthe output is always 21193955d011SMarcel Moolenaar.Ql a , 21203955d011SMarcel Moolenaar.Ql b1 , 21213955d011SMarcel Moolenaar.Ql b , 21223955d011SMarcel Moolenaar.Ql x . 21233955d011SMarcel Moolenaar.br 21243955d011SMarcel MoolenaarThe ordering imposed by 21253955d011SMarcel Moolenaar.Ic .WAIT 21263955d011SMarcel Moolenaaris only relevant for parallel makes. 21273955d011SMarcel Moolenaar.El 21283955d011SMarcel Moolenaar.Sh SPECIAL TARGETS 21293955d011SMarcel MoolenaarSpecial targets may not be included with other targets, i.e. they must be 21303955d011SMarcel Moolenaarthe only target specified. 21313955d011SMarcel Moolenaar.Bl -tag -width .BEGINx 21323955d011SMarcel Moolenaar.It Ic .BEGIN 21333955d011SMarcel MoolenaarAny command lines attached to this target are executed before anything 21343955d011SMarcel Moolenaarelse is done. 21353955d011SMarcel Moolenaar.It Ic .DEFAULT 21363955d011SMarcel MoolenaarThis is sort of a 21373955d011SMarcel Moolenaar.Ic .USE 21383955d011SMarcel Moolenaarrule for any target (that was used only as a 21393955d011SMarcel Moolenaarsource) that 21403955d011SMarcel Moolenaar.Nm 21413955d011SMarcel Moolenaarcan't figure out any other way to create. 21423955d011SMarcel MoolenaarOnly the shell script is used. 21433955d011SMarcel MoolenaarThe 21443955d011SMarcel Moolenaar.Ic .IMPSRC 21453955d011SMarcel Moolenaarvariable of a target that inherits 21463955d011SMarcel Moolenaar.Ic .DEFAULT Ns 's 21473955d011SMarcel Moolenaarcommands is set 21483955d011SMarcel Moolenaarto the target's own name. 214945447996SSimon J. Gerraty.It Ic .DELETE_ON_ERROR 215045447996SSimon J. GerratyIf this target is present in the makefile, it globally causes make to 215145447996SSimon J. Gerratydelete targets whose commands fail. 215245447996SSimon J. Gerraty(By default, only targets whose commands are interrupted during 215345447996SSimon J. Gerratyexecution are deleted. 215445447996SSimon J. GerratyThis is the historical behavior.) 215545447996SSimon J. GerratyThis setting can be used to help prevent half-finished or malformed 215645447996SSimon J. Gerratytargets from being left around and corrupting future rebuilds. 21573955d011SMarcel Moolenaar.It Ic .END 21583955d011SMarcel MoolenaarAny command lines attached to this target are executed after everything 21593955d011SMarcel Moolenaarelse is done. 21603955d011SMarcel Moolenaar.It Ic .ERROR 21613955d011SMarcel MoolenaarAny command lines attached to this target are executed when another target fails. 21623955d011SMarcel MoolenaarThe 21633955d011SMarcel Moolenaar.Ic .ERROR_TARGET 21643955d011SMarcel Moolenaarvariable is set to the target that failed. 21653955d011SMarcel MoolenaarSee also 21663955d011SMarcel Moolenaar.Ic MAKE_PRINT_VAR_ON_ERROR . 21673955d011SMarcel Moolenaar.It Ic .IGNORE 21683955d011SMarcel MoolenaarMark each of the sources with the 21693955d011SMarcel Moolenaar.Ic .IGNORE 21703955d011SMarcel Moolenaarattribute. 21713955d011SMarcel MoolenaarIf no sources are specified, this is the equivalent of specifying the 21723955d011SMarcel Moolenaar.Fl i 21733955d011SMarcel Moolenaaroption. 21743955d011SMarcel Moolenaar.It Ic .INTERRUPT 21753955d011SMarcel MoolenaarIf 21763955d011SMarcel Moolenaar.Nm 21773955d011SMarcel Moolenaaris interrupted, the commands for this target will be executed. 21783955d011SMarcel Moolenaar.It Ic .MAIN 21793955d011SMarcel MoolenaarIf no target is specified when 21803955d011SMarcel Moolenaar.Nm 21813955d011SMarcel Moolenaaris invoked, this target will be built. 21823955d011SMarcel Moolenaar.It Ic .MAKEFLAGS 21833955d011SMarcel MoolenaarThis target provides a way to specify flags for 21843955d011SMarcel Moolenaar.Nm 21853955d011SMarcel Moolenaarwhen the makefile is used. 21863955d011SMarcel MoolenaarThe flags are as if typed to the shell, though the 21873955d011SMarcel Moolenaar.Fl f 21883955d011SMarcel Moolenaaroption will have 21893955d011SMarcel Moolenaarno effect. 21903955d011SMarcel Moolenaar.\" XXX: NOT YET!!!! 21913955d011SMarcel Moolenaar.\" .It Ic .NOTPARALLEL 21923955d011SMarcel Moolenaar.\" The named targets are executed in non parallel mode. 21933955d011SMarcel Moolenaar.\" If no targets are 21943955d011SMarcel Moolenaar.\" specified, then all targets are executed in non parallel mode. 21953955d011SMarcel Moolenaar.It Ic .NOPATH 21963955d011SMarcel MoolenaarApply the 21973955d011SMarcel Moolenaar.Ic .NOPATH 21983955d011SMarcel Moolenaarattribute to any specified sources. 21993955d011SMarcel Moolenaar.It Ic .NOTPARALLEL 22003955d011SMarcel MoolenaarDisable parallel mode. 22013955d011SMarcel Moolenaar.It Ic .NO_PARALLEL 22023955d011SMarcel MoolenaarSynonym for 22033955d011SMarcel Moolenaar.Ic .NOTPARALLEL , 22043955d011SMarcel Moolenaarfor compatibility with other pmake variants. 2205128a4105SSimon J. Gerraty.It Ic .OBJDIR 2206128a4105SSimon J. GerratyThe source is a new value for 2207128a4105SSimon J. Gerraty.Ql Va .OBJDIR . 2208128a4105SSimon J. GerratyIf it exists, 2209128a4105SSimon J. Gerraty.Nm 2210128a4105SSimon J. Gerratywill 2211128a4105SSimon J. Gerraty.Xr chdir 2 2212128a4105SSimon J. Gerratyto it and update the value of 2213128a4105SSimon J. Gerraty.Ql Va .OBJDIR . 22143955d011SMarcel Moolenaar.It Ic .ORDER 22153955d011SMarcel MoolenaarThe named targets are made in sequence. 22163955d011SMarcel MoolenaarThis ordering does not add targets to the list of targets to be made. 22173955d011SMarcel MoolenaarSince the dependents of a target do not get built until the target itself 22183955d011SMarcel Moolenaarcould be built, unless 22193955d011SMarcel Moolenaar.Ql a 22203955d011SMarcel Moolenaaris built by another part of the dependency graph, 22213955d011SMarcel Moolenaarthe following is a dependency loop: 22223955d011SMarcel Moolenaar.Bd -literal 22233955d011SMarcel Moolenaar\&.ORDER: b a 22243955d011SMarcel Moolenaarb: a 22253955d011SMarcel Moolenaar.Ed 22263955d011SMarcel Moolenaar.Pp 22273955d011SMarcel MoolenaarThe ordering imposed by 22283955d011SMarcel Moolenaar.Ic .ORDER 22293955d011SMarcel Moolenaaris only relevant for parallel makes. 22303955d011SMarcel Moolenaar.\" XXX: NOT YET!!!! 22313955d011SMarcel Moolenaar.\" .It Ic .PARALLEL 22323955d011SMarcel Moolenaar.\" The named targets are executed in parallel mode. 22333955d011SMarcel Moolenaar.\" If no targets are 22343955d011SMarcel Moolenaar.\" specified, then all targets are executed in parallel mode. 22353955d011SMarcel Moolenaar.It Ic .PATH 22363955d011SMarcel MoolenaarThe sources are directories which are to be searched for files not 22373955d011SMarcel Moolenaarfound in the current directory. 22383955d011SMarcel MoolenaarIf no sources are specified, any previously specified directories are 22393955d011SMarcel Moolenaardeleted. 22403955d011SMarcel MoolenaarIf the source is the special 22413955d011SMarcel Moolenaar.Ic .DOTLAST 22423955d011SMarcel Moolenaartarget, then the current working 22433955d011SMarcel Moolenaardirectory is searched last. 22441bbe5942SSimon J. Gerraty.It Ic .PATH. Ns Va suffix 22451bbe5942SSimon J. GerratyLike 22461bbe5942SSimon J. Gerraty.Ic .PATH 22471bbe5942SSimon J. Gerratybut applies only to files with a particular suffix. 22481bbe5942SSimon J. GerratyThe suffix must have been previously declared with 22491bbe5942SSimon J. Gerraty.Ic .SUFFIXES . 22503955d011SMarcel Moolenaar.It Ic .PHONY 22513955d011SMarcel MoolenaarApply the 22523955d011SMarcel Moolenaar.Ic .PHONY 22533955d011SMarcel Moolenaarattribute to any specified sources. 22543955d011SMarcel Moolenaar.It Ic .PRECIOUS 22553955d011SMarcel MoolenaarApply the 22563955d011SMarcel Moolenaar.Ic .PRECIOUS 22573955d011SMarcel Moolenaarattribute to any specified sources. 22583955d011SMarcel MoolenaarIf no sources are specified, the 22593955d011SMarcel Moolenaar.Ic .PRECIOUS 22603955d011SMarcel Moolenaarattribute is applied to every 22613955d011SMarcel Moolenaartarget in the file. 22623955d011SMarcel Moolenaar.It Ic .SHELL 22633955d011SMarcel MoolenaarSets the shell that 22643955d011SMarcel Moolenaar.Nm 22653955d011SMarcel Moolenaarwill use to execute commands. 22663955d011SMarcel MoolenaarThe sources are a set of 22673955d011SMarcel Moolenaar.Ar field=value 22683955d011SMarcel Moolenaarpairs. 22693955d011SMarcel Moolenaar.Bl -tag -width hasErrCtls 22703955d011SMarcel Moolenaar.It Ar name 2271be19d90bSSimon J. GerratyThis is the minimal specification, used to select one of the built-in 22723955d011SMarcel Moolenaarshell specs; 22733955d011SMarcel Moolenaar.Ar sh , 22743955d011SMarcel Moolenaar.Ar ksh , 22753955d011SMarcel Moolenaarand 22763955d011SMarcel Moolenaar.Ar csh . 22773955d011SMarcel Moolenaar.It Ar path 22783955d011SMarcel MoolenaarSpecifies the path to the shell. 22793955d011SMarcel Moolenaar.It Ar hasErrCtl 22803955d011SMarcel MoolenaarIndicates whether the shell supports exit on error. 22813955d011SMarcel Moolenaar.It Ar check 22823955d011SMarcel MoolenaarThe command to turn on error checking. 22833955d011SMarcel Moolenaar.It Ar ignore 22843955d011SMarcel MoolenaarThe command to disable error checking. 22853955d011SMarcel Moolenaar.It Ar echo 22863955d011SMarcel MoolenaarThe command to turn on echoing of commands executed. 22873955d011SMarcel Moolenaar.It Ar quiet 22883955d011SMarcel MoolenaarThe command to turn off echoing of commands executed. 22893955d011SMarcel Moolenaar.It Ar filter 22903955d011SMarcel MoolenaarThe output to filter after issuing the 22913955d011SMarcel Moolenaar.Ar quiet 22923955d011SMarcel Moolenaarcommand. 22933955d011SMarcel MoolenaarIt is typically identical to 22943955d011SMarcel Moolenaar.Ar quiet . 22953955d011SMarcel Moolenaar.It Ar errFlag 22963955d011SMarcel MoolenaarThe flag to pass the shell to enable error checking. 22973955d011SMarcel Moolenaar.It Ar echoFlag 22983955d011SMarcel MoolenaarThe flag to pass the shell to enable command echoing. 22993955d011SMarcel Moolenaar.It Ar newline 23003955d011SMarcel MoolenaarThe string literal to pass the shell that results in a single newline 23013955d011SMarcel Moolenaarcharacter when used outside of any quoting characters. 23023955d011SMarcel Moolenaar.El 23033955d011SMarcel MoolenaarExample: 23043955d011SMarcel Moolenaar.Bd -literal 23053955d011SMarcel Moolenaar\&.SHELL: name=ksh path=/bin/ksh hasErrCtl=true \e 23063955d011SMarcel Moolenaar check="set \-e" ignore="set +e" \e 23073955d011SMarcel Moolenaar echo="set \-v" quiet="set +v" filter="set +v" \e 23083955d011SMarcel Moolenaar echoFlag=v errFlag=e newline="'\en'" 23093955d011SMarcel Moolenaar.Ed 23103955d011SMarcel Moolenaar.It Ic .SILENT 23113955d011SMarcel MoolenaarApply the 23123955d011SMarcel Moolenaar.Ic .SILENT 23133955d011SMarcel Moolenaarattribute to any specified sources. 23143955d011SMarcel MoolenaarIf no sources are specified, the 23153955d011SMarcel Moolenaar.Ic .SILENT 23163955d011SMarcel Moolenaarattribute is applied to every 23173955d011SMarcel Moolenaarcommand in the file. 23181748de26SSimon J. Gerraty.It Ic .STALE 23191748de26SSimon J. GerratyThis target gets run when a dependency file contains stale entries, having 23201748de26SSimon J. Gerraty.Va .ALLSRC 23211748de26SSimon J. Gerratyset to the name of that dependency file. 23223955d011SMarcel Moolenaar.It Ic .SUFFIXES 23233955d011SMarcel MoolenaarEach source specifies a suffix to 23243955d011SMarcel Moolenaar.Nm . 23253955d011SMarcel MoolenaarIf no sources are specified, any previously specified suffixes are deleted. 23263955d011SMarcel MoolenaarIt allows the creation of suffix-transformation rules. 23273955d011SMarcel Moolenaar.Pp 23283955d011SMarcel MoolenaarExample: 23293955d011SMarcel Moolenaar.Bd -literal 23303955d011SMarcel Moolenaar\&.SUFFIXES: .o 23313955d011SMarcel Moolenaar\&.c.o: 23323955d011SMarcel Moolenaar cc \-o ${.TARGET} \-c ${.IMPSRC} 23333955d011SMarcel Moolenaar.Ed 23343955d011SMarcel Moolenaar.El 23353955d011SMarcel Moolenaar.Sh ENVIRONMENT 23363955d011SMarcel Moolenaar.Nm 23373955d011SMarcel Moolenaaruses the following environment variables, if they exist: 23383955d011SMarcel Moolenaar.Ev MACHINE , 23393955d011SMarcel Moolenaar.Ev MACHINE_ARCH , 23403955d011SMarcel Moolenaar.Ev MAKE , 23413955d011SMarcel Moolenaar.Ev MAKEFLAGS , 23423955d011SMarcel Moolenaar.Ev MAKEOBJDIR , 23433955d011SMarcel Moolenaar.Ev MAKEOBJDIRPREFIX , 23443955d011SMarcel Moolenaar.Ev MAKESYSPATH , 23453955d011SMarcel Moolenaar.Ev PWD , 23463955d011SMarcel Moolenaarand 23473955d011SMarcel Moolenaar.Ev TMPDIR . 23483955d011SMarcel Moolenaar.Pp 23493955d011SMarcel Moolenaar.Ev MAKEOBJDIRPREFIX 23503955d011SMarcel Moolenaarand 23513955d011SMarcel Moolenaar.Ev MAKEOBJDIR 23523955d011SMarcel Moolenaarmay only be set in the environment or on the command line to 23533955d011SMarcel Moolenaar.Nm 23543955d011SMarcel Moolenaarand not as makefile variables; 23553955d011SMarcel Moolenaarsee the description of 23563955d011SMarcel Moolenaar.Ql Va .OBJDIR 23573955d011SMarcel Moolenaarfor more details. 23583955d011SMarcel Moolenaar.Sh FILES 23593955d011SMarcel Moolenaar.Bl -tag -width /usr/share/mk -compact 23603955d011SMarcel Moolenaar.It .depend 23613955d011SMarcel Moolenaarlist of dependencies 23623955d011SMarcel Moolenaar.It Makefile 23633955d011SMarcel Moolenaarlist of dependencies 23643955d011SMarcel Moolenaar.It makefile 23653955d011SMarcel Moolenaarlist of dependencies 23663955d011SMarcel Moolenaar.It sys.mk 23673955d011SMarcel Moolenaarsystem makefile 23683955d011SMarcel Moolenaar.It /usr/share/mk 23693955d011SMarcel Moolenaarsystem makefile directory 23703955d011SMarcel Moolenaar.El 23713955d011SMarcel Moolenaar.Sh COMPATIBILITY 2372db29cad8SSimon J. GerratyThe basic make syntax is compatible between different versions of make; 23733955d011SMarcel Moolenaarhowever the special variables, variable modifiers and conditionals are not. 2374db29cad8SSimon J. Gerraty.Ss Older versions 2375db29cad8SSimon J. GerratyAn incomplete list of changes in older versions of 2376db29cad8SSimon J. Gerraty.Nm : 23773955d011SMarcel Moolenaar.Pp 23783955d011SMarcel MoolenaarThe way that .for loop variables are substituted changed after 23793955d011SMarcel MoolenaarNetBSD 5.0 23803955d011SMarcel Moolenaarso that they still appear to be variable expansions. 23813955d011SMarcel MoolenaarIn particular this stops them being treated as syntax, and removes some 23823955d011SMarcel Moolenaarobscure problems using them in .if statements. 2383db29cad8SSimon J. Gerraty.Pp 2384db29cad8SSimon J. GerratyThe way that parallel makes are scheduled changed in 2385db29cad8SSimon J. GerratyNetBSD 4.0 2386db29cad8SSimon J. Gerratyso that .ORDER and .WAIT apply recursively to the dependent nodes. 2387db29cad8SSimon J. GerratyThe algorithms used may change again in the future. 2388db29cad8SSimon J. Gerraty.Ss Other make dialects 2389db29cad8SSimon J. GerratyOther make dialects (GNU make, SVR4 make, POSIX make, etc.) do not 2390db29cad8SSimon J. Gerratysupport most of the features of 2391db29cad8SSimon J. Gerraty.Nm 2392db29cad8SSimon J. Gerratyas described in this manual. 2393db29cad8SSimon J. GerratyMost notably: 2394db29cad8SSimon J. Gerraty.Bl -bullet -offset indent 2395db29cad8SSimon J. Gerraty.It 2396db29cad8SSimon J. GerratyThe 2397db29cad8SSimon J. Gerraty.Ic .WAIT 2398db29cad8SSimon J. Gerratyand 2399db29cad8SSimon J. Gerraty.Ic .ORDER 2400db29cad8SSimon J. Gerratydeclarations and most functionality pertaining to parallelization. 2401db29cad8SSimon J. Gerraty(GNU make supports parallelization but lacks these features needed to 2402db29cad8SSimon J. Gerratycontrol it effectively.) 2403db29cad8SSimon J. Gerraty.It 2404db29cad8SSimon J. GerratyDirectives, including for loops and conditionals and most of the 2405db29cad8SSimon J. Gerratyforms of include files. 2406db29cad8SSimon J. Gerraty(GNU make has its own incompatible and less powerful syntax for 2407db29cad8SSimon J. Gerratyconditionals.) 2408db29cad8SSimon J. Gerraty.It 2409db29cad8SSimon J. GerratyAll built-in variables that begin with a dot. 2410db29cad8SSimon J. Gerraty.It 2411db29cad8SSimon J. GerratyMost of the special sources and targets that begin with a dot, 2412db29cad8SSimon J. Gerratywith the notable exception of 2413db29cad8SSimon J. Gerraty.Ic .PHONY , 2414db29cad8SSimon J. Gerraty.Ic .PRECIOUS , 2415db29cad8SSimon J. Gerratyand 2416db29cad8SSimon J. Gerraty.Ic .SUFFIXES . 2417db29cad8SSimon J. Gerraty.It 2418db29cad8SSimon J. GerratyVariable modifiers, except for the 2419db29cad8SSimon J. Gerraty.Dl :old=new 2420db29cad8SSimon J. Gerratystring substitution, which does not portably support globbing with 2421db29cad8SSimon J. Gerraty.Ql % 2422db29cad8SSimon J. Gerratyand historically only works on declared suffixes. 2423db29cad8SSimon J. Gerraty.It 2424db29cad8SSimon J. GerratyThe 2425db29cad8SSimon J. Gerraty.Ic $> 2426db29cad8SSimon J. Gerratyvariable even in its short form; most makes support this functionality 2427db29cad8SSimon J. Gerratybut its name varies. 2428db29cad8SSimon J. Gerraty.El 2429db29cad8SSimon J. Gerraty.Pp 2430db29cad8SSimon J. GerratySome features are somewhat more portable, such as assignment with 2431db29cad8SSimon J. Gerraty.Ic += , 2432db29cad8SSimon J. Gerraty.Ic ?= , 2433db29cad8SSimon J. Gerratyand 2434db29cad8SSimon J. Gerraty.Ic != . 2435db29cad8SSimon J. GerratyThe 2436db29cad8SSimon J. Gerraty.Ic .PATH 2437db29cad8SSimon J. Gerratyfunctionality is based on an older feature 2438db29cad8SSimon J. Gerraty.Ic VPATH 2439db29cad8SSimon J. Gerratyfound in GNU make and many versions of SVR4 make; however, 2440db29cad8SSimon J. Gerratyhistorically its behavior is too ill-defined (and too buggy) to rely 2441db29cad8SSimon J. Gerratyupon. 2442db29cad8SSimon J. Gerraty.Pp 2443db29cad8SSimon J. GerratyThe 2444db29cad8SSimon J. Gerraty.Ic $@ 2445db29cad8SSimon J. Gerratyand 2446db29cad8SSimon J. Gerraty.Ic $< 2447db29cad8SSimon J. Gerratyvariables are more or less universally portable, as is the 2448db29cad8SSimon J. Gerraty.Ic $(MAKE) 2449db29cad8SSimon J. Gerratyvariable. 2450db29cad8SSimon J. GerratyBasic use of suffix rules (for files only in the current directory, 2451db29cad8SSimon J. Gerratynot trying to chain transformations together, etc.) is also reasonably 2452db29cad8SSimon J. Gerratyportable. 24533955d011SMarcel Moolenaar.Sh SEE ALSO 24543955d011SMarcel Moolenaar.Xr mkdep 1 24553955d011SMarcel Moolenaar.Sh HISTORY 24563955d011SMarcel Moolenaar.Nm 24573955d011SMarcel Moolenaaris derived from NetBSD 24583955d011SMarcel Moolenaar.Xr make 1 . 24593955d011SMarcel MoolenaarIt uses autoconf to facilitate portability to other platforms. 246093036677SSimon J. Gerraty.Pp 246193036677SSimon J. GerratyA 246293036677SSimon J. Gerratymake 246393036677SSimon J. Gerratycommand appeared in 246493036677SSimon J. Gerraty.At v7 . 246593036677SSimon J. GerratyThis 246693036677SSimon J. Gerratymake 246793036677SSimon J. Gerratyimplementation is based on Adam De Boor's pmake program which was written 246893036677SSimon J. Gerratyfor Sprite at Berkeley. 246993036677SSimon J. GerratyIt was designed to be a parallel distributed make running jobs on different 247093036677SSimon J. Gerratymachines using a daemon called 247193036677SSimon J. Gerraty.Dq customs . 247251ee2c1cSSimon J. Gerraty.Pp 247351ee2c1cSSimon J. GerratyHistorically the target/dependency 247451ee2c1cSSimon J. Gerraty.Dq FRC 247551ee2c1cSSimon J. Gerratyhas been used to FoRCe rebuilding (since the target/dependency 247651ee2c1cSSimon J. Gerratydoes not exist... unless someone creates an 247751ee2c1cSSimon J. Gerraty.Dq FRC 247851ee2c1cSSimon J. Gerratyfile). 247993036677SSimon J. Gerraty.Sh BUGS 248093036677SSimon J. GerratyThe 248193036677SSimon J. Gerratymake 2482ef0b2538SSimon J. Gerratysyntax is difficult to parse without actually acting on the data. 2483ef0b2538SSimon J. GerratyFor instance, finding the end of a variable's use should involve scanning 2484ef0b2538SSimon J. Gerratyeach of the modifiers, using the correct terminator for each field. 248593036677SSimon J. GerratyIn many places 248693036677SSimon J. Gerratymake 248793036677SSimon J. Gerratyjust counts {} and () in order to find the end of a variable expansion. 248893036677SSimon J. Gerraty.Pp 248993036677SSimon J. GerratyThere is no way of escaping a space character in a filename. 2490