[BACK]Return to make.1 CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / usr.bin / make

Annotation of src/usr.bin/make/make.1, Revision 1.241

1.241   ! dholland    1: .\"    $NetBSD: make.1,v 1.240 2014/09/14 03:50:28 dholland Exp $
1.15      thorpej     2: .\"
1.16      christos    3: .\" Copyright (c) 1990, 1993
                      4: .\"    The Regents of the University of California.  All rights reserved.
1.1       cgd         5: .\"
                      6: .\" Redistribution and use in source and binary forms, with or without
                      7: .\" modification, are permitted provided that the following conditions
                      8: .\" are met:
                      9: .\" 1. Redistributions of source code must retain the above copyright
                     10: .\"    notice, this list of conditions and the following disclaimer.
                     11: .\" 2. Redistributions in binary form must reproduce the above copyright
                     12: .\"    notice, this list of conditions and the following disclaimer in the
                     13: .\"    documentation and/or other materials provided with the distribution.
1.84      agc        14: .\" 3. Neither the name of the University nor the names of its contributors
1.1       cgd        15: .\"    may be used to endorse or promote products derived from this software
                     16: .\"    without specific prior written permission.
                     17: .\"
                     18: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     19: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     20: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     21: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     22: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     23: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     24: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     25: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     26: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     27: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     28: .\" SUCH DAMAGE.
                     29: .\"
1.16      christos   30: .\"    from: @(#)make.1        8.4 (Berkeley) 3/19/94
1.1       cgd        31: .\"
1.238     dholland   32: .Dd September 9, 2014
1.1       cgd        33: .Dt MAKE 1
                     34: .Os
                     35: .Sh NAME
                     36: .Nm make
                     37: .Nd maintain program dependencies
                     38: .Sh SYNOPSIS
1.74      wiz        39: .Nm
1.219     christos   40: .Op Fl BeikNnqrstWwX
1.159     sjg        41: .Op Fl C Ar directory
1.1       cgd        42: .Op Fl D Ar variable
                     43: .Op Fl d Ar flags
                     44: .Op Fl f Ar makefile
                     45: .Op Fl I Ar directory
1.104     wiz        46: .Op Fl J Ar private
                     47: .Op Fl j Ar max_jobs
1.13      christos   48: .Op Fl m Ar directory
1.44      sommerfe   49: .Op Fl T Ar file
1.16      christos   50: .Op Fl V Ar variable
1.1       cgd        51: .Op Ar variable=value
                     52: .Op Ar target ...
                     53: .Sh DESCRIPTION
1.25      lukem      54: .Nm
1.1       cgd        55: is a program designed to simplify the maintenance of other programs.
                     56: Its input is a list of specifications as to the files upon which programs
                     57: and other files depend.
1.128     dsl        58: If no
                     59: .Fl f Ar makefile
                     60: makefile option is given,
                     61: .Nm
                     62: will try to open
1.1       cgd        63: .Ql Pa makefile
1.128     dsl        64: then
1.1       cgd        65: .Ql Pa Makefile
1.128     dsl        66: in order to find the specifications.
1.1       cgd        67: If the file
                     68: .Ql Pa .depend
                     69: exists, it is read (see
1.66      wiz        70: .Xr mkdep 1 ) .
1.1       cgd        71: .Pp
                     72: This manual page is intended as a reference document only.
                     73: For a more thorough description of
1.25      lukem      74: .Nm
1.1       cgd        75: and makefiles, please refer to
1.197     dholland   76: .%T "PMake \- A Tutorial" .
1.1       cgd        77: .Pp
1.128     dsl        78: .Nm
                     79: will prepend the contents of the
                     80: .Va MAKEFLAGS
                     81: environment variable to the command line arguments before parsing them.
                     82: .Pp
1.1       cgd        83: The options are as follows:
                     84: .Bl -tag -width Ds
1.16      christos   85: .It Fl B
1.10      christos   86: Try to be backwards compatible by executing a single shell per command and
                     87: by executing the commands to make the sources of a dependency line in sequence.
1.159     sjg        88: .It Fl C Ar directory
                     89: Change to
                     90: .Ar directory
                     91: before reading the makefiles or doing anything else.
                     92: If multiple
                     93: .Fl C
                     94: options are specified, each is interpreted relative to the previous one:
                     95: .Fl C Pa / Fl C Pa etc
                     96: is equivalent to
                     97: .Fl C Pa /etc .
1.1       cgd        98: .It Fl D Ar variable
1.8       christos   99: Define
                    100: .Ar variable
1.1       cgd       101: to be 1, in the global context.
1.128     dsl       102: .It Fl d Ar [-]flags
1.1       cgd       103: Turn on debugging, and specify which portions of
1.25      lukem     104: .Nm
1.1       cgd       105: are to print debugging information.
1.128     dsl       106: Unless the flags are preceded by
1.194     sjg       107: .Ql \-
1.128     dsl       108: they are added to the
                    109: .Va MAKEFLAGS
                    110: environment variable and will be processed by any child make processes.
1.141     apb       111: By default, debugging information is printed to standard error,
1.138     apb       112: but this can be changed using the
1.140     wiz       113: .Ar F
1.138     apb       114: debugging flag.
1.139     apb       115: The debugging output is always unbuffered; in addition, if debugging
                    116: is enabled but debugging output is not directed to standard output,
                    117: then the standard output is line buffered.
1.1       cgd       118: .Ar Flags
                    119: is one or more of the following:
                    120: .Bl -tag -width Ds
                    121: .It Ar A
                    122: Print all possible debugging information;
                    123: equivalent to specifying all of the debugging flags.
                    124: .It Ar a
                    125: Print debugging information about archive searching and caching.
1.147     christos  126: .It Ar C
                    127: Print debugging information about current working directory.
1.1       cgd       128: .It Ar c
                    129: Print debugging information about conditional evaluation.
                    130: .It Ar d
                    131: Print debugging information about directory searching and caching.
1.88      jmmv      132: .It Ar e
                    133: Print debugging information about failed commands and targets.
1.138     apb       134: .It Ar F Ns Oo Sy \&+ Oc Ns Ar filename
                    135: Specify where debugging output is written.
                    136: This must be the last flag, because it consumes the remainder of
                    137: the argument.
                    138: If the character immediately after the
                    139: .Ql F
                    140: flag is
                    141: .Ql \&+ ,
                    142: then the file will be opened in append mode;
                    143: otherwise the file will be overwritten.
                    144: If the file name is
                    145: .Ql stdout
                    146: or
                    147: .Ql stderr
                    148: then debugging output will be written to the
                    149: standard output or standard error output file descriptors respectively
                    150: (and the
                    151: .Ql \&+
                    152: option has no effect).
                    153: Otherwise, the output will be written to the named file.
                    154: If the file name ends
1.128     dsl       155: .Ql .%d
                    156: then the
                    157: .Ql %d
                    158: is replaced by the pid.
1.87      jmmv      159: .It Ar f
                    160: Print debugging information about loop evaluation.
1.1       cgd       161: .It Ar "g1"
                    162: Print the input graph before making anything.
                    163: .It Ar "g2"
                    164: Print the input graph after making everything, or before exiting
1.93      dsl       165: on error.
1.92      dsl       166: .It Ar "g3"
                    167: Print the input graph before exiting on error.
1.1       cgd       168: .It Ar j
                    169: Print debugging information about running multiple shells.
1.135     sjg       170: .It Ar l
                    171: Print commands in Makefiles regardless of whether or not they are prefixed by
1.137     wiz       172: .Ql @
1.135     sjg       173: or other "quiet" flags.
                    174: Also known as "loud" behavior.
1.180     sjg       175: .It Ar M
                    176: Print debugging information about "meta" mode decisions about targets.
1.1       cgd       177: .It Ar m
                    178: Print debugging information about making targets, including modification
                    179: dates.
1.111     jmc       180: .It Ar n
1.154     apb       181: Don't delete the temporary command scripts created when running commands.
                    182: These temporary scripts are created in the directory
                    183: referred to by the
                    184: .Ev TMPDIR
                    185: environment variable, or in
1.112     wiz       186: .Pa /tmp
1.154     apb       187: if
                    188: .Ev TMPDIR
                    189: is unset or set to the empty string.
                    190: The temporary scripts are created by
                    191: .Xr mkstemp 3 ,
1.112     wiz       192: and have names of the form
1.154     apb       193: .Pa makeXXXXXX .
1.123     wiz       194: .Em NOTE :
1.156     snj       195: This can create many files in
1.154     apb       196: .Ev TMPDIR
                    197: or
                    198: .Pa /tmp ,
1.123     wiz       199: so use with care.
1.119     dsl       200: .It Ar p
                    201: Print debugging information about makefile parsing.
1.1       cgd       202: .It Ar s
                    203: Print debugging information about suffix-transformation rules.
                    204: .It Ar t
                    205: Print debugging information about target list maintenance.
1.205     sjg       206: .It Ar V
                    207: Force the
                    208: .Fl V
1.206     wiz       209: option to print raw values of variables.
1.1       cgd       210: .It Ar v
                    211: Print debugging information about variable assignment.
1.49      sjg       212: .It Ar x
1.57      wiz       213: Run shell commands with
                    214: .Fl x
                    215: so the actual commands are printed as they are executed.
1.1       cgd       216: .El
                    217: .It Fl e
1.68      perry     218: Specify that environment variables override macro assignments within
1.1       cgd       219: makefiles.
                    220: .It Fl f Ar makefile
                    221: Specify a makefile to read instead of the default
1.103     wiz       222: .Ql Pa makefile .
1.1       cgd       223: If
                    224: .Ar makefile
                    225: is
                    226: .Ql Fl ,
                    227: standard input is read.
1.103     wiz       228: Multiple makefiles may be specified, and are read in the order specified.
1.1       cgd       229: .It Fl I Ar directory
                    230: Specify a directory in which to search for makefiles and included makefiles.
1.13      christos  231: The system makefile directory (or directories, see the
                    232: .Fl m
                    233: option) is automatically included as part of this list.
1.1       cgd       234: .It Fl i
                    235: Ignore non-zero exit of shell commands in the makefile.
                    236: Equivalent to specifying
                    237: .Ql Fl
                    238: before each command line in the makefile.
1.44      sommerfe  239: .It Fl J Ar private
                    240: This option should
                    241: .Em not
                    242: be specified by the user.
                    243: .Pp
                    244: When the
                    245: .Ar j
                    246: option is in use in a recursive build, this option is passed by a make
                    247: to child makes to allow all the make processes in the build to
                    248: cooperate to avoid overloading the system.
1.1       cgd       249: .It Fl j Ar max_jobs
                    250: Specify the maximum number of jobs that
1.25      lukem     251: .Nm
1.67      grant     252: may have running at any one time.
1.180     sjg       253: The value is saved in
                    254: .Va .MAKE.JOBS .
1.67      grant     255: Turns compatibility mode off, unless the
1.11      christos  256: .Ar B
                    257: flag is also specified.
1.148     christos  258: When compatibility mode is off, all commands associated with a
                    259: target are executed in a single shell invocation as opposed to the
                    260: traditional one shell invocation per line.
                    261: This can break traditional scripts which change directories on each
                    262: command invocation and then expect to start with a fresh environment
                    263: on the next line.
                    264: It is more efficient to correct the scripts rather than turn backwards
                    265: compatibility on.
1.1       cgd       266: .It Fl k
                    267: Continue processing after errors are encountered, but only on those targets
                    268: that do not depend on the target whose creation caused the error.
1.13      christos  269: .It Fl m Ar directory
                    270: Specify a directory in which to search for sys.mk and makefiles included
1.99      wiz       271: via the
                    272: .Ao Ar file Ac Ns -style
                    273: include statement.
1.98      chuck     274: The
                    275: .Fl m
                    276: option can be used multiple times to form a search path.
1.13      christos  277: This path will override the default system include path: /usr/share/mk.
                    278: Furthermore the system include path will be appended to the search path used
1.99      wiz       279: for
                    280: .Qo Ar file Qc Ns -style
                    281: include statements (see the
1.13      christos  282: .Fl I
                    283: option).
1.98      chuck     284: .Pp
                    285: If a file or directory name in the
                    286: .Fl m
1.99      wiz       287: argument (or the
                    288: .Ev MAKESYSPATH
                    289: environment variable) starts with the string
                    290: .Qq \&.../
                    291: then
                    292: .Nm
                    293: will search for the specified file or directory named in the remaining part
                    294: of the argument string.
                    295: The search starts with the current directory of
1.98      chuck     296: the Makefile and then works upward towards the root of the filesystem.
1.99      wiz       297: If the search is successful, then the resulting directory replaces the
                    298: .Qq \&.../
                    299: specification in the
1.98      chuck     300: .Fl m
1.99      wiz       301: argument.
                    302: If used, this feature allows
1.98      chuck     303: .Nm
                    304: to easily search in the current source tree for customized sys.mk files
1.99      wiz       305: (e.g., by using
                    306: .Qq \&.../mk/sys.mk
                    307: as an argument).
1.1       cgd       308: .It Fl n
1.45      sommerfe  309: Display the commands that would have been executed, but do not
                    310: actually execute them unless the target depends on the .MAKE special
1.64      wiz       311: source (see below).
1.45      sommerfe  312: .It Fl N
                    313: Display the commands which would have been executed, but do not
                    314: actually execute any of them; useful for debugging top-level makefiles
                    315: without descending into subdirectories.
1.1       cgd       316: .It Fl q
                    317: Do not execute any commands, but exit 0 if the specified targets are
                    318: up-to-date and 1, otherwise.
                    319: .It Fl r
                    320: Do not use the built-in rules specified in the system makefile.
                    321: .It Fl s
                    322: Do not echo any commands as they are executed.
                    323: Equivalent to specifying
                    324: .Ql Ic @
                    325: before each command line in the makefile.
1.44      sommerfe  326: .It Fl T Ar tracefile
                    327: When used with the
1.48      wiz       328: .Fl j
1.44      sommerfe  329: flag,
                    330: append a trace record to
                    331: .Ar tracefile
                    332: for each job started and completed.
1.1       cgd       333: .It Fl t
                    334: Rather than re-building a target as specified in the makefile, create it
                    335: or update its modification time to make it appear up-to-date.
1.16      christos  336: .It Fl V Ar variable
                    337: Print
1.74      wiz       338: .Nm Ns 's
1.16      christos  339: idea of the value of
                    340: .Ar variable ,
                    341: in the global context.
                    342: Do not build any targets.
                    343: Multiple instances of this option may be specified;
                    344: the variables will be printed one per line,
                    345: with a blank line for each null or undefined variable.
1.85      sjg       346: If
                    347: .Ar variable
                    348: contains a
                    349: .Ql \&$
                    350: then the value will be expanded before printing.
1.46      christos  351: .It Fl W
                    352: Treat any warnings during makefile parsing as errors.
1.238     dholland  353: .It Fl w
                    354: Print entering and leaving directory messages, pre and post processing.
1.75      thorpej   355: .It Fl X
                    356: Don't export variables passed on the command line to the environment
                    357: individually.
                    358: Variables passed on the command line are still exported
                    359: via the
                    360: .Va MAKEFLAGS
                    361: environment variable.
                    362: This option may be useful on systems which have a small limit on the
                    363: size of command arguments.
1.1       cgd       364: .It Ar variable=value
                    365: Set the value of the variable
                    366: .Ar variable
                    367: to
                    368: .Ar value .
1.75      thorpej   369: Normally, all values passed on the command line are also exported to
                    370: sub-makes in the environment.
                    371: The
                    372: .Fl X
                    373: flag disables this behavior.
1.101     wiz       374: Variable assignments should follow options for POSIX compatibility
1.100     ross      375: but no ordering is enforced.
1.1       cgd       376: .El
                    377: .Pp
1.6       cgd       378: There are seven different types of lines in a makefile: file dependency
1.1       cgd       379: specifications, shell commands, variable assignments, include statements,
1.6       cgd       380: conditional directives, for loops, and comments.
1.1       cgd       381: .Pp
                    382: In general, lines may be continued from one line to the next by ending
                    383: them with a backslash
                    384: .Pq Ql \e .
1.237     dholland  385: The trailing newline character and initial whitespace on the following
                    386: line are compressed into a single space.
1.1       cgd       387: .Sh FILE DEPENDENCY SPECIFICATIONS
1.237     dholland  388: Dependency lines consist of one or more targets, an operator, and zero
                    389: or more sources.
1.137     wiz       390: This creates a relationship where the targets
                    391: .Dq depend
                    392: on the sources
1.1       cgd       393: and are usually created from them.
                    394: The exact relationship between the target and the source is determined
1.237     dholland  395: by the operator that separates them.
1.1       cgd       396: The three operators are as follows:
                    397: .Bl -tag -width flag
                    398: .It Ic \&:
                    399: A target is considered out-of-date if its modification time is less than
                    400: those of any of its sources.
                    401: Sources for a target accumulate over dependency lines when this operator
                    402: is used.
                    403: The target is removed if
1.25      lukem     404: .Nm
1.1       cgd       405: is interrupted.
                    406: .It Ic \&!
                    407: Targets are always re-created, but not until all sources have been
                    408: examined and re-created as necessary.
                    409: Sources for a target accumulate over dependency lines when this operator
                    410: is used.
                    411: The target is removed if
1.25      lukem     412: .Nm
1.1       cgd       413: is interrupted.
                    414: .It Ic \&::
                    415: If no sources are specified, the target is always re-created.
                    416: Otherwise, a target is considered out-of-date if any of its sources has
                    417: been modified more recently than the target.
                    418: Sources for a target do not accumulate over dependency lines when this
1.237     dholland  419: operator is used.
1.1       cgd       420: The target will not be removed if
1.25      lukem     421: .Nm
1.1       cgd       422: is interrupted.
                    423: .El
                    424: .Pp
                    425: Targets and sources may contain the shell wildcard values
1.80      wiz       426: .Ql \&? ,
1.1       cgd       427: .Ql * ,
1.103     wiz       428: .Ql [] ,
1.1       cgd       429: and
                    430: .Ql {} .
                    431: The values
1.80      wiz       432: .Ql \&? ,
1.103     wiz       433: .Ql * ,
1.1       cgd       434: and
                    435: .Ql []
                    436: may only be used as part of the final
                    437: component of the target or source, and must be used to describe existing
                    438: files.
                    439: The value
                    440: .Ql {}
                    441: need not necessarily be used to describe existing files.
                    442: Expansion is in directory order, not alphabetically as done in the shell.
                    443: .Sh SHELL COMMANDS
1.239     dholland  444: Each target may have associated with it one or more lines of shell
                    445: commands, normally
1.237     dholland  446: used to create the target.
1.239     dholland  447: Each of the lines in this script
1.1       cgd       448: .Em must
                    449: be preceded by a tab.
1.239     dholland  450: (For historical reasons, spaces are not accepted.)
                    451: While targets can appear in many dependency lines if desired, by
                    452: default only one of these rules may be followed by a creation
                    453: script.
                    454: If the
1.91      lukem     455: .Ql Ic \&::
1.239     dholland  456: operator is used, however, all rules may include scripts and the
                    457: scripts are executed in the order found.
1.1       cgd       458: .Pp
1.239     dholland  459: Each line is treated as a separate shell command, unless the end of
                    460: line is escaped with a backslash
                    461: .Pq Ql \e
                    462: in which case that line and the next are combined.
                    463: .\" The escaped newline is retained and passed to the shell, which
                    464: .\" normally ignores it.
                    465: .\" However, the tab at the beginning of the following line is removed.
                    466: If the first characters of the command are any combination of
1.102     sjg       467: .Ql Ic @ ,
1.103     wiz       468: .Ql Ic + ,
1.102     sjg       469: or
1.1       cgd       470: .Ql Ic \- ,
                    471: the command is treated specially.
                    472: A
                    473: .Ql Ic @
                    474: causes the command not to be echoed before it is executed.
                    475: A
1.102     sjg       476: .Ql Ic +
                    477: causes the command to be executed even when
                    478: .Fl n
                    479: is given.
                    480: This is similar to the effect of the .MAKE special source,
                    481: except that the effect can be limited to a single line of a script.
                    482: A
1.1       cgd       483: .Ql Ic \-
                    484: causes any non-zero exit status of the command line to be ignored.
1.210     sjg       485: .Pp
                    486: When
                    487: .Nm
                    488: is run in jobs mode with
                    489: .Fl j Ar max_jobs ,
                    490: the entire script for the target is fed to a
                    491: single instance of the shell.
                    492: In compatibility (non-jobs) mode, each command is run in a separate process.
                    493: If the command contains any shell meta characters
                    494: .Pq Ql #=|^(){};&<>*?[]:$`\e\en
1.239     dholland  495: it will be passed to the shell; otherwise
1.210     sjg       496: .Nm
                    497: will attempt direct execution.
                    498: .Pp
                    499: Makefiles should be written so that the mode of
                    500: .Nm
                    501: operation does not change their behavior.
                    502: For example, any command which needs to use
                    503: .Dq cd
                    504: or
1.239     dholland  505: .Dq chdir
                    506: without potentially changing the directory for subsequent commands
                    507: should be put in parentheses so it executes in a subshell.
                    508: To force the use of one shell, escape the line breaks so as to make
                    509: the whole script one command.
                    510: For example:
1.210     sjg       511: .Bd -literal -offset indent
                    512: avoid-chdir-side-effects:
                    513:        @echo Building $@ in `pwd`
1.239     dholland  514:        @(cd ${.CURDIR} && ${MAKE} $@)
1.210     sjg       515:        @echo Back in `pwd`
                    516:
                    517: ensure-one-shell-regardless-of-mode:
                    518:        @echo Building $@ in `pwd`; \\
1.239     dholland  519:        (cd ${.CURDIR} && ${MAKE} $@); \\
1.210     sjg       520:        echo Back in `pwd`
                    521: .Ed
1.239     dholland  522: .Pp
                    523: Since
                    524: .Nm
                    525: will
                    526: .Xr chdir 2
                    527: to
                    528: .Ql Va .OBJDIR
                    529: before executing any targets, each child process
                    530: starts with that as its current working directory.
1.1       cgd       531: .Sh VARIABLE ASSIGNMENTS
                    532: Variables in make are much like variables in the shell, and, by tradition,
                    533: consist of all upper-case letters.
1.91      lukem     534: .Ss Variable assignment modifiers
1.1       cgd       535: The five operators that can be used to assign values to variables are as
                    536: follows:
                    537: .Bl -tag -width Ds
                    538: .It Ic \&=
                    539: Assign the value to the variable.
                    540: Any previous value is overridden.
                    541: .It Ic \&+=
                    542: Append the value to the current value of the variable.
                    543: .It Ic \&?=
                    544: Assign the value to the variable if it is not already defined.
                    545: .It Ic \&:=
                    546: Assign with expansion, i.e. expand the value before assigning it
                    547: to the variable.
                    548: Normally, expansion is not done until the variable is referenced.
1.124     sjg       549: .Em NOTE :
                    550: References to undefined variables are
                    551: .Em not
1.125     wiz       552: expanded.
                    553: This can cause problems when variable modifiers are used.
1.1       cgd       554: .It Ic \&!=
                    555: Expand the value and pass it to the shell for execution and assign
                    556: the result to the variable.
                    557: Any newlines in the result are replaced with spaces.
                    558: .El
                    559: .Pp
                    560: Any white-space before the assigned
                    561: .Ar value
                    562: is removed; if the value is being appended, a single space is inserted
                    563: between the previous contents of the variable and the appended value.
                    564: .Pp
                    565: Variables are expanded by surrounding the variable name with either
                    566: curly braces
                    567: .Pq Ql {}
1.7       mycroft   568: or parentheses
1.1       cgd       569: .Pq Ql ()
                    570: and preceding it with
                    571: a dollar sign
                    572: .Pq Ql \&$ .
                    573: If the variable name contains only a single letter, the surrounding
1.7       mycroft   574: braces or parentheses are not required.
1.1       cgd       575: This shorter form is not recommended.
                    576: .Pp
1.149     dsl       577: If the variable name contains a dollar, then the name itself is expanded first.
                    578: This allows almost arbitrary variable names, however names containing dollar,
                    579: braces, parenthesis, or whitespace are really best avoided!
                    580: .Pp
                    581: If the result of expanding a variable contains a dollar sign
                    582: .Pq Ql \&$
                    583: the string is expanded again.
                    584: .Pp
1.175     christos  585: Variable substitution occurs at three distinct times, depending on where
1.1       cgd       586: the variable is being used.
1.175     christos  587: .Bl -enum
1.176     wiz       588: .It
1.1       cgd       589: Variables in dependency lines are expanded as the line is read.
1.175     christos  590: .It
1.1       cgd       591: Variables in shell commands are expanded when the shell command is
                    592: executed.
1.175     christos  593: .It
                    594: .Dq .for
1.176     wiz       595: loop index variables are expanded on each loop iteration.
                    596: Note that other variables are not expanded inside loops so
1.175     christos  597: the following example code:
                    598: .Bd -literal -offset indent
                    599:
                    600: .Dv .for i in 1 2 3
                    601: a+=     ${i}
                    602: j=      ${i}
                    603: b+=     ${j}
                    604: .Dv .endfor
                    605:
                    606: all:
1.176     wiz       607:        @echo ${a}
1.175     christos  608:        @echo ${b}
                    609:
                    610: .Ed
                    611: will print:
                    612: .Bd -literal -offset indent
                    613: 1 2 3
                    614: 3 3 3
                    615:
                    616: .Ed
                    617: Because while ${a} contains
                    618: .Dq 1 2 3
                    619: after the loop is executed, ${b}
                    620: contains
                    621: .Dq ${j} ${j} ${j}
                    622: which expands to
                    623: .Dq 3 3 3
                    624: since after the loop completes ${j} contains
                    625: .Dq 3 .
                    626: .El
1.91      lukem     627: .Ss Variable classes
1.1       cgd       628: The four different classes of variables (in order of increasing precedence)
                    629: are:
                    630: .Bl -tag -width Ds
                    631: .It Environment variables
                    632: Variables defined as part of
1.74      wiz       633: .Nm Ns 's
1.1       cgd       634: environment.
                    635: .It Global variables
                    636: Variables defined in the makefile or in included makefiles.
                    637: .It Command line variables
                    638: Variables defined as part of the command line.
                    639: .It Local variables
1.237     dholland  640: Variables that are defined specific to a certain target.
1.240     dholland  641: .El
                    642: .Pp
                    643: Local variables are all built in and their values vary magically from
                    644: target to target.
                    645: It is not currently possible to define new local variables.
1.237     dholland  646: The seven local variables are as follows:
1.240     dholland  647: .Bl -tag -width ".ARCHIVE" -offset indent
1.1       cgd       648: .It Va .ALLSRC
                    649: The list of all sources for this target; also known as
1.62      ross      650: .Ql Va \&\*[Gt] .
1.1       cgd       651: .It Va .ARCHIVE
1.240     dholland  652: The name of the archive file; also known as
                    653: .Ql Va \&! .
1.1       cgd       654: .It Va .IMPSRC
1.237     dholland  655: In suffix-transformation rules, the name/path of the source from which the
1.137     wiz       656: target is to be transformed (the
                    657: .Dq implied
1.237     dholland  658: source); also known as
1.62      ross      659: .Ql Va \&\*[Lt] .
1.237     dholland  660: It is not defined in explicit rules.
1.1       cgd       661: .It Va .MEMBER
1.240     dholland  662: The name of the archive member; also known as
                    663: .Ql Va % .
1.1       cgd       664: .It Va .OODATE
                    665: The list of sources for this target that were deemed out-of-date; also
                    666: known as
                    667: .Ql Va \&? .
                    668: .It Va .PREFIX
1.177     dholland  669: The file prefix of the target, containing only the file portion, no suffix
1.1       cgd       670: or preceding directory components; also known as
                    671: .Ql Va * .
1.240     dholland  672: The suffix must be one of the known suffixes declared with
                    673: .Ic .SUFFIXES
                    674: or it will not be recognized.
1.1       cgd       675: .It Va .TARGET
                    676: The name of the target; also known as
                    677: .Ql Va @ .
                    678: .El
                    679: .Pp
1.237     dholland  680: The shorter forms
1.240     dholland  681: .Ql ( Va \*[Gt] ,
                    682: .Ql Va \&! ,
                    683: .Ql Va \*[Lt] ,
                    684: .Ql Va % ,
1.80      wiz       685: .Ql Va \&? ,
1.240     dholland  686: .Ql Va * ,
1.1       cgd       687: and
1.240     dholland  688: .Ql Va @ )
1.237     dholland  689: are permitted for backward
1.240     dholland  690: compatibility with historical makefiles and legacy POSIX make and are
                    691: not recommended.
                    692: .Pp
                    693: Variants of these variables with the punctuation followed immediately by
                    694: .Ql D
                    695: or
                    696: .Ql F ,
                    697: e.g.
                    698: .Ql Va $(@D) ,
                    699: are legacy forms equivalent to using the
                    700: .Ql :H
1.1       cgd       701: and
1.240     dholland  702: .Ql :T
                    703: modifiers.
                    704: These forms are accepted for compatibility with
1.237     dholland  705: .At V
1.240     dholland  706: makefiles and POSIX but are not recommended.
1.1       cgd       707: .Pp
                    708: Four of the local variables may be used in sources on dependency lines
                    709: because they expand to the proper value for each target on the line.
                    710: These variables are
                    711: .Ql Va .TARGET ,
                    712: .Ql Va .PREFIX ,
                    713: .Ql Va .ARCHIVE ,
                    714: and
                    715: .Ql Va .MEMBER .
1.145     christos  716: .Ss Additional built-in variables
1.1       cgd       717: In addition,
1.25      lukem     718: .Nm
1.1       cgd       719: sets or knows about the following variables:
1.50      sjg       720: .Bl -tag -width .MAKEOVERRIDES
1.1       cgd       721: .It Va \&$
                    722: A single dollar sign
                    723: .Ql \&$ ,
                    724: i.e.
                    725: .Ql \&$$
                    726: expands to a single dollar
                    727: sign.
1.56      tv        728: .It Va .ALLTARGETS
1.67      grant     729: The list of all targets encountered in the Makefile.
                    730: If evaluated during
1.56      tv        731: Makefile parsing, lists only those targets encountered thus far.
1.1       cgd       732: .It Va .CURDIR
                    733: A path to the directory where
1.25      lukem     734: .Nm
1.1       cgd       735: was executed.
1.117     lukem     736: Refer to the description of
                    737: .Ql Ev PWD
                    738: for more details.
1.230     sjg       739: .It Va .INCLUDEDFROMDIR
                    740: The directory of the file this Makefile was included from.
                    741: .It Va .INCLUDEDFROMFILE
                    742: The filename of the file this Makefile was included from.
1.78      christos  743: .It Ev MAKE
1.55      tv        744: The name that
                    745: .Nm
1.89      sjg       746: was executed with
                    747: .Pq Va argv[0] .
1.126     reed      748: For compatibility
1.78      christos  749: .Nm
                    750: also sets
                    751: .Va .MAKE
                    752: with the same value.
1.97      lukem     753: The preferred variable to use is the environment variable
1.78      christos  754: .Ev MAKE
                    755: because it is more compatible with other versions of
                    756: .Nm
                    757: and cannot be confused with the special target with the same name.
1.168     sjg       758: .It Va .MAKE.DEPENDFILE
1.169     wiz       759: Names the makefile (default
1.168     sjg       760: .Ql Pa .depend )
                    761: from which generated dependencies are read.
1.205     sjg       762: .It Va .MAKE.EXPAND_VARIABLES
                    763: A boolean that controls the default behavior of the
                    764: .Fl V
                    765: option.
1.134     sjg       766: .It Va .MAKE.EXPORTED
                    767: The list of variables exported by
                    768: .Nm .
1.171     sjg       769: .It Va .MAKE.JOBS
1.172     joerg     770: The argument to the
1.171     sjg       771: .Fl j
                    772: option.
1.132     sjg       773: .It Va .MAKE.JOB.PREFIX
1.137     wiz       774: If
1.132     sjg       775: .Nm
                    776: is run with
                    777: .Ar j
1.137     wiz       778: then output for each target is prefixed with a token
1.132     sjg       779: .Ql --- target ---
                    780: the first part of which can be controlled via
                    781: .Va .MAKE.JOB.PREFIX .
1.225     wiz       782: If
1.220     sjg       783: .Va .MAKE.JOB.PREFIX
                    784: is empty, no token is printed.
1.132     sjg       785: .br
1.137     wiz       786: For example:
1.132     sjg       787: .Li .MAKE.JOB.PREFIX=${.newline}---${.MAKE:T}[${.MAKE.PID}]
                    788: would produce tokens like
                    789: .Ql ---make[1234] target ---
                    790: making it easier to track the degree of parallelism being achieved.
1.1       cgd       791: .It Ev MAKEFLAGS
                    792: The environment variable
                    793: .Ql Ev MAKEFLAGS
                    794: may contain anything that
                    795: may be specified on
1.74      wiz       796: .Nm Ns 's
1.1       cgd       797: command line.
                    798: Anything specified on
1.74      wiz       799: .Nm Ns 's
1.1       cgd       800: command line is appended to the
                    801: .Ql Ev MAKEFLAGS
                    802: variable which is then
                    803: entered into the environment for all programs which
1.25      lukem     804: .Nm
1.1       cgd       805: executes.
1.169     wiz       806: .It Va .MAKE.LEVEL
                    807: The recursion depth of
                    808: .Nm .
                    809: The initial instance of
                    810: .Nm
                    811: will be 0, and an incremented value is put into the environment
                    812: to be seen by the next generation.
                    813: This allows tests like:
                    814: .Li .if ${.MAKE.LEVEL} == 0
                    815: to protect things which should only be evaluated in the initial instance of
                    816: .Nm .
                    817: .It Va .MAKE.MAKEFILE_PREFERENCE
                    818: The ordered list of makefile names
                    819: (default
                    820: .Ql Pa makefile ,
                    821: .Ql Pa Makefile )
                    822: that
                    823: .Nm
                    824: will look for.
                    825: .It Va .MAKE.MAKEFILES
                    826: The list of makefiles read by
                    827: .Nm ,
                    828: which is useful for tracking dependencies.
1.204     sjg       829: Each makefile is recorded only once, regardless of the number of times read.
1.169     wiz       830: .It Va .MAKE.MODE
                    831: Processed after reading all makefiles.
                    832: Can affect the mode that
                    833: .Nm
                    834: runs in.
1.180     sjg       835: It can contain a number of keywords:
                    836: .Bl -hang -width ignore-cmd
                    837: .It Pa compat
1.182     wiz       838: Like
1.184     sjg       839: .Fl B ,
1.182     wiz       840: puts
1.180     sjg       841: .Nm
                    842: into "compat" mode.
                    843: .It Pa meta
                    844: Puts
                    845: .Nm
1.182     wiz       846: into "meta" mode, where meta files are created for each target
1.180     sjg       847: to capture the command run, the output generated and if
                    848: .Xr filemon 4
                    849: is available, the system calls which are of interest to
                    850: .Nm .
                    851: The captured output can be very useful when diagnosing errors.
1.185     sjg       852: .It Pa curdirOk= Ar bf
1.184     sjg       853: Normally
                    854: .Nm
                    855: will not create .meta files in
                    856: .Ql Va .CURDIR .
                    857: This can be overridden by setting
1.188     wiz       858: .Va bf
1.184     sjg       859: to a value which represents True.
1.200     sjg       860: .It Pa env
                    861: For debugging, it can be useful to inlcude the environment
                    862: in the .meta file.
1.180     sjg       863: .It Pa verbose
                    864: If in "meta" mode, print a clue about the target being built.
                    865: This is useful if the build is otherwise running silently.
                    866: The message printed the value of:
                    867: .Va .MAKE.META.PREFIX .
                    868: .It Pa ignore-cmd
                    869: Some makefiles have commands which are simply not stable.
1.182     wiz       870: This keyword causes them to be ignored for
1.180     sjg       871: determining whether a target is out of date in "meta" mode.
                    872: See also
                    873: .Ic .NOMETA_CMP .
1.195     sjg       874: .It Pa silent= Ar bf
                    875: If
                    876: .Va bf
                    877: is True, when a .meta file is created, mark the target
1.200     sjg       878: .Ic .SILENT .
1.180     sjg       879: .El
1.189     sjg       880: .It Va .MAKE.META.BAILIWICK
                    881: In "meta" mode, provides a list of prefixes which
                    882: match the directories controlled by
                    883: .Nm .
                    884: If a file that was generated outside of
                    885: .Va .OBJDIR
                    886: but within said bailiwick is missing,
                    887: the current target is considered out-of-date.
1.180     sjg       888: .It Va .MAKE.META.CREATED
                    889: In "meta" mode, this variable contains a list of all the meta files
                    890: updated.
                    891: If not empty, it can be used to trigger processing of
                    892: .Va .MAKE.META.FILES .
                    893: .It Va .MAKE.META.FILES
                    894: In "meta" mode, this variable contains a list of all the meta files
                    895: used (updated or not).
1.182     wiz       896: This list can be used to process the meta files to extract dependency
1.180     sjg       897: information.
1.216     sjg       898: .It Va .MAKE.META.IGNORE_PATHS
                    899: Provides a list of path prefixes that should be ignored;
                    900: because the contents are expected to change over time.
                    901: The default list includes:
                    902: .Ql Pa /dev /etc /proc /tmp /var/run /var/tmp
1.180     sjg       903: .It Va .MAKE.META.PREFIX
                    904: Defines the message printed for each meta file updated in "meta verbose" mode.
                    905: The default value is:
                    906: .Dl Building ${.TARGET:H:tA}/${.TARGET:T}
1.50      sjg       907: .It Va .MAKEOVERRIDES
1.57      wiz       908: This variable is used to record the names of variables assigned to
                    909: on the command line, so that they may be exported as part of
1.50      sjg       910: .Ql Ev MAKEFLAGS .
1.57      wiz       911: This behaviour can be disabled by assigning an empty value to
1.50      sjg       912: .Ql Va .MAKEOVERRIDES
1.67      grant     913: within a makefile.
                    914: Extra variables can be exported from a makefile
1.57      wiz       915: by appending their names to
1.51      sjg       916: .Ql Va .MAKEOVERRIDES .
                    917: .Ql Ev MAKEFLAGS
1.57      wiz       918: is re-exported whenever
1.51      sjg       919: .Ql Va .MAKEOVERRIDES
                    920: is modified.
1.212     sjg       921: .It Va .MAKE.PATH_FILEMON
                    922: If
                    923: .Nm
1.217     wiz       924: was built with
1.212     sjg       925: .Xr filemon 4
                    926: support, this is set to the path of the device node.
                    927: This allows makefiles to test for this support.
1.169     wiz       928: .It Va .MAKE.PID
                    929: The process-id of
                    930: .Nm .
                    931: .It Va .MAKE.PPID
                    932: The parent process-id of
                    933: .Nm .
1.55      tv        934: .It Va MAKE_PRINT_VAR_ON_ERROR
1.57      wiz       935: When
1.55      tv        936: .Nm
                    937: stops due to an error, it prints its name and the value of
                    938: .Ql Va .CURDIR
1.57      wiz       939: as well as the value of any variables named in
1.55      tv        940: .Ql Va MAKE_PRINT_VAR_ON_ERROR .
                    941: .It Va .newline
                    942: This variable is simply assigned a newline character as its value.
1.91      lukem     943: This allows expansions using the
                    944: .Cm \&:@
                    945: modifier to put a newline between
1.67      grant     946: iterations of the loop rather than a space.
                    947: For example, the printing of
1.55      tv        948: .Ql Va MAKE_PRINT_VAR_ON_ERROR
                    949: could be done as ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}.
                    950: .It Va .OBJDIR
                    951: A path to the directory where the targets are built.
1.117     lukem     952: Its value is determined by trying to
                    953: .Xr chdir 2
                    954: to the following directories in order and using the first match:
                    955: .Bl -enum
                    956: .It
1.118     wiz       957: .Ev ${MAKEOBJDIRPREFIX}${.CURDIR}
                    958: .Pp
1.117     lukem     959: (Only if
                    960: .Ql Ev MAKEOBJDIRPREFIX
                    961: is set in the environment or on the command line.)
                    962: .It
1.118     wiz       963: .Ev ${MAKEOBJDIR}
                    964: .Pp
1.117     lukem     965: (Only if
                    966: .Ql Ev MAKEOBJDIR
                    967: is set in the environment or on the command line.)
                    968: .It
                    969: .Ev ${.CURDIR} Ns Pa /obj. Ns Ev ${MACHINE}
                    970: .It
                    971: .Ev ${.CURDIR} Ns Pa /obj
                    972: .It
                    973: .Pa /usr/obj/ Ns Ev ${.CURDIR}
                    974: .It
                    975: .Ev ${.CURDIR}
                    976: .El
                    977: .Pp
                    978: Variable expansion is performed on the value before it's used,
                    979: so expressions such as
1.173     sjg       980: .Dl ${.CURDIR:S,^/usr/src,/var/obj,}
1.117     lukem     981: may be used.
1.173     sjg       982: This is especially useful with
                    983: .Ql Ev MAKEOBJDIR .
1.117     lukem     984: .Pp
                    985: .Ql Va .OBJDIR
                    986: may be modified in the makefile as a global variable.
1.137     wiz       987: In all cases,
1.117     lukem     988: .Nm
                    989: will
                    990: .Xr chdir 2
                    991: to
                    992: .Ql Va .OBJDIR
                    993: and set
                    994: .Ql Ev PWD
                    995: to that directory before executing any targets.
                    996: .
1.55      tv        997: .It Va .PARSEDIR
                    998: A path to the directory of the current
                    999: .Ql Pa Makefile
                   1000: being parsed.
                   1001: .It Va .PARSEFILE
                   1002: The basename of the current
                   1003: .Ql Pa Makefile
                   1004: being parsed.
                   1005: This variable and
                   1006: .Ql Va .PARSEDIR
                   1007: are both set only while the
                   1008: .Ql Pa Makefiles
                   1009: are being parsed.
1.196     christos 1010: If you want to retain their current values, assign them to a variable
                   1011: using assignment with expansion:
                   1012: .Pq Ql Cm \&:= .
1.69      sjg      1013: .It Va .PATH
1.82      wiz      1014: A variable that represents the list of directories that
1.69      sjg      1015: .Nm
1.70      wiz      1016: will search for files.
                   1017: The search list should be updated using the target
1.69      sjg      1018: .Ql Va .PATH
                   1019: rather than the variable.
1.16      christos 1020: .It Ev PWD
                   1021: Alternate path to the current directory.
1.25      lukem    1022: .Nm
1.16      christos 1023: normally sets
                   1024: .Ql Va .CURDIR
                   1025: to the canonical path given by
1.48      wiz      1026: .Xr getcwd 3 .
1.16      christos 1027: However, if the environment variable
                   1028: .Ql Ev PWD
                   1029: is set and gives a path to the current directory, then
1.25      lukem    1030: .Nm
1.16      christos 1031: sets
                   1032: .Ql Va .CURDIR
                   1033: to the value of
                   1034: .Ql Ev PWD
1.67      grant    1035: instead.
                   1036: This behaviour is disabled if
1.40      sjg      1037: .Ql Ev MAKEOBJDIRPREFIX
1.117     lukem    1038: is set or
                   1039: .Ql Ev MAKEOBJDIR
                   1040: contains a variable transform.
1.16      christos 1041: .Ql Ev PWD
                   1042: is set to the value of
                   1043: .Ql Va .OBJDIR
                   1044: for all programs which
1.25      lukem    1045: .Nm
1.16      christos 1046: executes.
1.179     dholland 1047: .It Ev .TARGETS
                   1048: The list of targets explicitly specified on the command line, if any.
1.145     christos 1049: .It Ev VPATH
1.146     wiz      1050: Colon-separated
                   1051: .Pq Dq \&:
                   1052: lists of directories that
                   1053: .Nm
                   1054: will search for files.
1.145     christos 1055: The variable is supported for compatibility with old make programs only,
                   1056: use
                   1057: .Ql Va .PATH
                   1058: instead.
1.1       cgd      1059: .El
1.91      lukem    1060: .Ss Variable modifiers
1.1       cgd      1061: Variable expansion may be modified to select or modify each word of the
1.137     wiz      1062: variable (where a
                   1063: .Dq word
                   1064: is white-space delimited sequence of characters).
1.1       cgd      1065: The general format of a variable expansion is as follows:
                   1066: .Pp
1.120     sjg      1067: .Dl ${variable[:modifier[:...]]}
1.1       cgd      1068: .Pp
1.97      lukem    1069: Each modifier begins with a colon,
                   1070: which may be escaped with a backslash
1.1       cgd      1071: .Pq Ql \e .
1.120     sjg      1072: .Pp
                   1073: A set of modifiers can be specified via a variable, as follows:
                   1074: .Pp
                   1075: .Dl modifier_variable=modifier[:...]
                   1076: .Dl ${variable:${modifier_variable}[:...]}
                   1077: .Pp
                   1078: In this case the first modifier in the modifier_variable does not
                   1079: start with a colon, since that must appear in the referencing
                   1080: variable.
                   1081: If any of the modifiers in the modifier_variable contain a dollar sign
                   1082: .Pq Ql $ ,
                   1083: these must be doubled to avoid early expansion.
                   1084: .Pp
1.97      lukem    1085: The supported modifiers are:
1.61      ross     1086: .Bl -tag -width EEE
1.91      lukem    1087: .It Cm \&:E
1.1       cgd      1088: Replaces each word in the variable with its suffix.
1.91      lukem    1089: .It Cm \&:H
1.237     dholland 1090: Replaces each word in the variable with everything but the last component.
1.91      lukem    1091: .It Cm \&:M Ns Ar pattern
1.72      uebayasi 1092: Select only those words that match
                   1093: .Ar pattern .
1.1       cgd      1094: The standard shell wildcard characters
                   1095: .Pf ( Ql * ,
1.80      wiz      1096: .Ql \&? ,
1.1       cgd      1097: and
1.172     joerg    1098: .Ql Oo Oc )
1.1       cgd      1099: may
                   1100: be used.
                   1101: The wildcard characters may be escaped with a backslash
                   1102: .Pq Ql \e .
1.224     apb      1103: As a consequence of the way values are split into words, matched,
                   1104: and then joined, a construct like
                   1105: .Dl ${VAR:M*}
                   1106: will normalise the inter-word spacing, removing all leading and
                   1107: trailing space, and converting multiple consecutive spaces
                   1108: to single spaces.
                   1109: .
1.91      lukem    1110: .It Cm \&:N Ns Ar pattern
1.1       cgd      1111: This is identical to
1.91      lukem    1112: .Ql Cm \&:M ,
1.1       cgd      1113: but selects all words which do not match
1.72      uebayasi 1114: .Ar pattern .
1.91      lukem    1115: .It Cm \&:O
1.109     wiz      1116: Order every word in variable alphabetically.
                   1117: To sort words in
                   1118: reverse order use the
1.108     sjg      1119: .Ql Cm \&:O:[-1..1]
                   1120: combination of modifiers.
                   1121: .It Cm \&:Ox
1.109     wiz      1122: Randomize words in variable.
                   1123: The results will be different each time you are referring to the
                   1124: modified variable; use the assignment with expansion
1.108     sjg      1125: .Pq Ql Cm \&:=
1.109     wiz      1126: to prevent such behaviour.
                   1127: For example,
1.108     sjg      1128: .Bd -literal -offset indent
                   1129: LIST=                  uno due tre quattro
                   1130: RANDOM_LIST=           ${LIST:Ox}
                   1131: STATIC_RANDOM_LIST:=   ${LIST:Ox}
                   1132:
                   1133: all:
                   1134:        @echo "${RANDOM_LIST}"
                   1135:        @echo "${RANDOM_LIST}"
                   1136:        @echo "${STATIC_RANDOM_LIST}"
                   1137:        @echo "${STATIC_RANDOM_LIST}"
                   1138: .Ed
1.109     wiz      1139: may produce output similar to:
1.108     sjg      1140: .Bd -literal -offset indent
                   1141: quattro due tre uno
                   1142: tre due quattro uno
                   1143: due uno quattro tre
                   1144: due uno quattro tre
                   1145: .Ed
1.91      lukem    1146: .It Cm \&:Q
1.17      christos 1147: Quotes every shell meta-character in the variable, so that it can be passed
                   1148: safely through recursive invocations of
1.74      wiz      1149: .Nm .
1.91      lukem    1150: .It Cm \&:R
1.1       cgd      1151: Replaces each word in the variable with everything but its suffix.
1.187     sjg      1152: .It Cm \&:gmtime
1.188     wiz      1153: The value is a format string for
1.187     sjg      1154: .Xr strftime 3 ,
1.188     wiz      1155: using the current
1.187     sjg      1156: .Xr gmtime 3 .
1.186     joerg    1157: .It Cm \&:hash
                   1158: Compute a 32bit hash of the value and encode it as hex digits.
1.187     sjg      1159: .It Cm \&:localtime
1.188     wiz      1160: The value is a format string for
1.187     sjg      1161: .Xr strftime 3 ,
1.188     wiz      1162: using the current
1.187     sjg      1163: .Xr localtime 3 .
1.170     sjg      1164: .It Cm \&:tA
                   1165: Attempt to convert variable to an absolute path using
                   1166: .Xr realpath 3 ,
                   1167: if that fails, the value is unchanged.
1.91      lukem    1168: .It Cm \&:tl
1.60      pk       1169: Converts variable to lower-case letters.
1.91      lukem    1170: .It Cm \&:ts Ns Ar c
1.81      sjg      1171: Words in the variable are normally separated by a space on expansion.
                   1172: This modifier sets the separator to the character
                   1173: .Ar c .
                   1174: If
                   1175: .Ar c
                   1176: is omitted, then no separator is used.
1.170     sjg      1177: The common escapes (including octal numeric codes), work as expected.
1.91      lukem    1178: .It Cm \&:tu
1.82      wiz      1179: Converts variable to upper-case letters.
1.91      lukem    1180: .It Cm \&:tW
1.89      sjg      1181: Causes the value to be treated as a single word
                   1182: (possibly containing embedded white space).
                   1183: See also
1.91      lukem    1184: .Ql Cm \&:[*] .
                   1185: .It Cm \&:tw
1.89      sjg      1186: Causes the value to be treated as a sequence of
                   1187: words delimited by white space.
                   1188: See also
1.91      lukem    1189: .Ql Cm \&:[@] .
1.1       cgd      1190: .Sm off
1.164     joerg    1191: .It Cm \&:S No \&/ Ar old_string No \&/ Ar new_string No \&/ Op Cm 1gW
1.1       cgd      1192: .Sm on
                   1193: Modify the first occurrence of
1.17      christos 1194: .Ar old_string
                   1195: in the variable's value, replacing it with
                   1196: .Ar new_string .
1.1       cgd      1197: If a
                   1198: .Ql g
                   1199: is appended to the last slash of the pattern, all occurrences
                   1200: in each word are replaced.
1.17      christos 1201: If a
                   1202: .Ql 1
                   1203: is appended to the last slash of the pattern, only the first word
                   1204: is affected.
1.89      sjg      1205: If a
                   1206: .Ql W
                   1207: is appended to the last slash of the pattern,
                   1208: then the value is treated as a single word
                   1209: (possibly containing embedded white space).
1.1       cgd      1210: If
1.17      christos 1211: .Ar old_string
                   1212: begins with a caret
1.1       cgd      1213: .Pq Ql ^ ,
1.17      christos 1214: .Ar old_string
1.1       cgd      1215: is anchored at the beginning of each word.
                   1216: If
1.17      christos 1217: .Ar old_string
1.1       cgd      1218: ends with a dollar sign
                   1219: .Pq Ql \&$ ,
                   1220: it is anchored at the end of each word.
                   1221: Inside
                   1222: .Ar new_string ,
                   1223: an ampersand
1.62      ross     1224: .Pq Ql \*[Am]
1.1       cgd      1225: is replaced by
1.17      christos 1226: .Ar old_string
                   1227: (without any
                   1228: .Ql ^
                   1229: or
                   1230: .Ql \&$ ) .
1.1       cgd      1231: Any character may be used as a delimiter for the parts of the modifier
                   1232: string.
                   1233: The anchoring, ampersand and delimiter characters may be escaped with a
                   1234: backslash
                   1235: .Pq Ql \e .
                   1236: .Pp
                   1237: Variable expansion occurs in the normal fashion inside both
                   1238: .Ar old_string
                   1239: and
                   1240: .Ar new_string
                   1241: with the single exception that a backslash is used to prevent the expansion
                   1242: of a dollar sign
1.17      christos 1243: .Pq Ql \&$ ,
1.1       cgd      1244: not a preceding dollar sign as is usual.
1.17      christos 1245: .Sm off
1.164     joerg    1246: .It Cm \&:C No \&/ Ar pattern No \&/ Ar replacement No \&/ Op Cm 1gW
1.17      christos 1247: .Sm on
                   1248: The
1.91      lukem    1249: .Cm \&:C
1.17      christos 1250: modifier is just like the
1.91      lukem    1251: .Cm \&:S
1.37      msaitoh  1252: modifier except that the old and new strings, instead of being
1.223     apb      1253: simple strings, are an extended regular expression (see
1.17      christos 1254: .Xr regex 3 )
1.72      uebayasi 1255: string
                   1256: .Ar pattern
1.17      christos 1257: and an
                   1258: .Xr ed 1 Ns \-style
1.72      uebayasi 1259: string
                   1260: .Ar replacement .
                   1261: Normally, the first occurrence of the pattern
                   1262: .Ar pattern
                   1263: in each word of the value is substituted with
                   1264: .Ar replacement .
1.67      grant    1265: The
1.17      christos 1266: .Ql 1
                   1267: modifier causes the substitution to apply to at most one word; the
                   1268: .Ql g
                   1269: modifier causes the substitution to apply to as many instances of the
1.72      uebayasi 1270: search pattern
                   1271: .Ar pattern
1.89      sjg      1272: as occur in the word or words it is found in; the
                   1273: .Ql W
                   1274: modifier causes the value to be treated as a single word
                   1275: (possibly containing embedded white space).
1.67      grant    1276: Note that
1.17      christos 1277: .Ql 1
                   1278: and
                   1279: .Ql g
                   1280: are orthogonal; the former specifies whether multiple words are
                   1281: potentially affected, the latter whether multiple substitutions can
                   1282: potentially occur within each affected word.
1.229     apb      1283: .Pp
                   1284: As for the
                   1285: .Cm \&:S
                   1286: modifier, the
                   1287: .Ar pattern
                   1288: and
                   1289: .Ar replacement
                   1290: are subjected to variable expansion before being parsed as
                   1291: regular expressions.
1.91      lukem    1292: .It Cm \&:T
1.237     dholland 1293: Replaces each word in the variable with its last component.
1.91      lukem    1294: .It Cm \&:u
1.43      christos 1295: Remove adjacent duplicate words (like
1.57      wiz      1296: .Xr uniq 1 ) .
1.91      lukem    1297: .Sm off
                   1298: .It Cm \&:\&? Ar true_string Cm \&: Ar false_string
                   1299: .Sm on
1.152     dsl      1300: If the variable name (not its value), when parsed as a .if conditional
                   1301: expression, evaluates to true, return as its value the
1.57      wiz      1302: .Ar true_string ,
1.27      christos 1303: otherwise return the
1.57      wiz      1304: .Ar false_string .
1.152     dsl      1305: Since the variable name is used as the expression, \&:\&? must be the
                   1306: first modifier after the variable name itself - which will, of course,
                   1307: usually contain variable expansions.
1.162     dsl      1308: A common error is trying to use expressions like
                   1309: .Dl ${NUMBERS:M42:?match:no}
                   1310: which actually tests defined(NUMBERS),
                   1311: to determine is any words match "42" you need to use something like:
1.183     sjg      1312: .Dl ${"${NUMBERS:M42}" != \&"\&":?match:no} .
1.91      lukem    1313: .It Ar :old_string=new_string
1.1       cgd      1314: This is the
                   1315: .At V
1.237     dholland 1316: style variable substitution.
1.1       cgd      1317: It must be the last modifier specified.
1.16      christos 1318: If
1.6       cgd      1319: .Ar old_string
                   1320: or
                   1321: .Ar new_string
                   1322: do not contain the pattern matching character
                   1323: .Ar %
1.16      christos 1324: then it is assumed that they are
1.6       cgd      1325: anchored at the end of each word, so only suffixes or entire
1.67      grant    1326: words may be replaced.
                   1327: Otherwise
1.6       cgd      1328: .Ar %
1.16      christos 1329: is the substring of
                   1330: .Ar old_string
1.6       cgd      1331: to be replaced in
1.64      wiz      1332: .Ar new_string .
1.95      jmc      1333: .Pp
                   1334: Variable expansion occurs in the normal fashion inside both
                   1335: .Ar old_string
                   1336: and
                   1337: .Ar new_string
1.96      wiz      1338: with the single exception that a backslash is used to prevent the
                   1339: expansion of a dollar sign
                   1340: .Pq Ql \&$ ,
                   1341: not a preceding dollar sign as is usual.
1.91      lukem    1342: .Sm off
1.164     joerg    1343: .It Cm \&:@ Ar temp Cm @ Ar string Cm @
1.91      lukem    1344: .Sm on
1.40      sjg      1345: This is the loop expansion mechanism from the OSF Development
1.67      grant    1346: Environment (ODE) make.
                   1347: Unlike
1.48      wiz      1348: .Cm \&.for
1.40      sjg      1349: loops expansion occurs at the time of
1.67      grant    1350: reference.
                   1351: Assign
1.40      sjg      1352: .Ar temp
                   1353: to each word in the variable and evaluate
                   1354: .Ar string .
1.48      wiz      1355: The ODE convention is that
1.40      sjg      1356: .Ar temp
1.67      grant    1357: should start and end with a period.
                   1358: For example.
1.40      sjg      1359: .Dl ${LINKS:@.LINK.@${LN} ${TARGET} ${.LINK.}@}
1.198     sjg      1360: .Pp
1.218     agc      1361: However a single character variable is often more readable:
1.198     sjg      1362: .Dl ${MAKE_PRINT_VAR_ON_ERROR:@v@$v='${$v}'${.newline}@}
1.91      lukem    1363: .It Cm \&:U Ns Ar newval
1.40      sjg      1364: If the variable is undefined
                   1365: .Ar newval
1.63      lukem    1366: is the value.
                   1367: If the variable is defined, the existing value is returned.
1.67      grant    1368: This is another ODE make feature.
                   1369: It is handy for setting per-target CFLAGS for instance:
1.40      sjg      1370: .Dl ${_${.TARGET:T}_CFLAGS:U${DEF_CFLAGS}}
1.63      lukem    1371: If a value is only required if the variable is undefined, use:
                   1372: .Dl ${VAR:D:Unewval}
1.91      lukem    1373: .It Cm \&:D Ns Ar newval
1.40      sjg      1374: If the variable is defined
                   1375: .Ar newval
                   1376: is the value.
1.91      lukem    1377: .It Cm \&:L
1.40      sjg      1378: The name of the variable is the value.
1.91      lukem    1379: .It Cm \&:P
1.40      sjg      1380: The path of the node which has the same name as the variable
1.67      grant    1381: is the value.
                   1382: If no such node exists or its path is null, then the
1.40      sjg      1383: name of the variable is used.
1.217     wiz      1384: In order for this modifier to work, the name (node) must at least have
1.199     sjg      1385: appeared on the rhs of a dependency.
1.91      lukem    1386: .Sm off
                   1387: .It Cm \&:\&! Ar cmd Cm \&!
                   1388: .Sm on
1.40      sjg      1389: The output of running
                   1390: .Ar cmd
                   1391: is the value.
1.91      lukem    1392: .It Cm \&:sh
1.40      sjg      1393: If the variable is non-empty it is run as a command and the output
                   1394: becomes the new value.
1.91      lukem    1395: .It Cm \&::= Ns Ar str
1.48      wiz      1396: The variable is assigned the value
1.41      sjg      1397: .Ar str
1.67      grant    1398: after substitution.
                   1399: This modifier and its variations are useful in
1.149     dsl      1400: obscure situations such as wanting to set a variable when shell commands
                   1401: are being parsed.
1.67      grant    1402: These assignment modifiers always expand to
1.41      sjg      1403: nothing, so if appearing in a rule line by themselves should be
1.48      wiz      1404: preceded with something to keep
1.41      sjg      1405: .Nm
1.67      grant    1406: happy.
1.149     dsl      1407: .Pp
1.91      lukem    1408: The
                   1409: .Ql Cm \&::
1.42      sjg      1410: helps avoid false matches with the
                   1411: .At V
1.48      wiz      1412: style
1.91      lukem    1413: .Cm \&:=
1.48      wiz      1414: modifier and since substitution always occurs the
1.91      lukem    1415: .Cm \&::=
1.42      sjg      1416: form is vaguely appropriate.
1.91      lukem    1417: .It Cm \&::?= Ns Ar str
1.41      sjg      1418: As for
1.91      lukem    1419: .Cm \&::=
1.41      sjg      1420: but only if the variable does not already have a value.
1.91      lukem    1421: .It Cm \&::+= Ns Ar str
1.48      wiz      1422: Append
1.41      sjg      1423: .Ar str
                   1424: to the variable.
1.91      lukem    1425: .It Cm \&::!= Ns Ar cmd
1.48      wiz      1426: Assign the output of
1.41      sjg      1427: .Ar cmd
                   1428: to the variable.
1.91      lukem    1429: .It Cm \&:\&[ Ns Ar range Ns Cm \&]
1.89      sjg      1430: Selects one or more words from the value,
                   1431: or performs other operations related to the way in which the
                   1432: value is divided into words.
                   1433: .Pp
                   1434: Ordinarily, a value is treated as a sequence of words
                   1435: delimited by white space.
                   1436: Some modifiers suppress this behaviour,
                   1437: causing a value to be treated as a single word
                   1438: (possibly containing embedded white space).
                   1439: An empty value, or a value that consists entirely of white-space,
                   1440: is treated as a single word.
                   1441: For the purposes of the
1.91      lukem    1442: .Ql Cm \&:[]
1.89      sjg      1443: modifier, the words are indexed both forwards using positive integers
                   1444: (where index 1 represents the first word),
                   1445: and backwards using negative integers
1.194     sjg      1446: (where index \-1 represents the last word).
1.89      sjg      1447: .Pp
                   1448: The
                   1449: .Ar range
                   1450: is subjected to variable expansion, and the expanded result is
                   1451: then interpreted as follows:
                   1452: .Bl -tag -width index
1.90      jdolecek 1453: .\" :[n]
1.89      sjg      1454: .It Ar index
                   1455: Selects a single word from the value.
1.90      jdolecek 1456: .\" :[start..end]
1.89      sjg      1457: .It Ar start Ns Cm \&.. Ns Ar end
                   1458: Selects all words from
                   1459: .Ar start
                   1460: to
                   1461: .Ar end ,
                   1462: inclusive.
                   1463: For example,
1.91      lukem    1464: .Ql Cm \&:[2..-1]
1.89      sjg      1465: selects all words from the second word to the last word.
                   1466: If
                   1467: .Ar start
                   1468: is greater than
                   1469: .Ar end ,
1.91      lukem    1470: then the words are output in reverse order.
                   1471: For example,
                   1472: .Ql Cm \&:[-1..1]
1.89      sjg      1473: selects all the words from last to first.
1.90      jdolecek 1474: .\" :[*]
1.89      sjg      1475: .It Cm \&*
                   1476: Causes subsequent modifiers to treat the value as a single word
1.109     wiz      1477: (possibly containing embedded white space).
                   1478: Analogous to the effect of
1.94      wiz      1479: \&"$*\&"
1.89      sjg      1480: in Bourne shell.
1.90      jdolecek 1481: .\" :[0]
1.89      sjg      1482: .It 0
                   1483: Means the same as
1.91      lukem    1484: .Ql Cm \&:[*] .
1.90      jdolecek 1485: .\" :[*]
1.89      sjg      1486: .It Cm \&@
                   1487: Causes subsequent modifiers to treat the value as a sequence of words
1.109     wiz      1488: delimited by white space.
                   1489: Analogous to the effect of
1.94      wiz      1490: \&"$@\&"
1.89      sjg      1491: in Bourne shell.
1.90      jdolecek 1492: .\" :[#]
1.89      sjg      1493: .It Cm \&#
                   1494: Returns the number of words in the value.
                   1495: .El \" :[range]
1.6       cgd      1496: .El
                   1497: .Sh INCLUDE STATEMENTS, CONDITIONALS AND FOR LOOPS
1.16      christos 1498: Makefile inclusion, conditional structures and for loops  reminiscent
1.6       cgd      1499: of the C programming language are provided in
1.74      wiz      1500: .Nm .
1.1       cgd      1501: All such structures are identified by a line beginning with a single
                   1502: dot
                   1503: .Pq Ql \&.
                   1504: character.
                   1505: Files are included with either
1.29      ross     1506: .Cm \&.include Aq Ar file
1.1       cgd      1507: or
1.29      ross     1508: .Cm \&.include Pf \*q Ar file Ns \*q .
1.1       cgd      1509: Variables between the angle brackets or double quotes are expanded
                   1510: to form the file name.
                   1511: If angle brackets are used, the included makefile is expected to be in
                   1512: the system makefile directory.
                   1513: If double quotes are used, the including makefile's directory and any
                   1514: directories specified using the
                   1515: .Fl I
                   1516: option are searched before the system
                   1517: makefile directory.
1.28      christos 1518: For compatibility with other versions of
                   1519: .Nm
                   1520: .Ql include file ...
1.67      grant    1521: is also accepted.
                   1522: If the include statement is written as
1.29      ross     1523: .Cm .-include
                   1524: or as
                   1525: .Cm .sinclude
1.28      christos 1526: then errors locating and/or opening include files are ignored.
1.1       cgd      1527: .Pp
                   1528: Conditional expressions are also preceded by a single dot as the first
1.5       jtc      1529: character of a line.
1.1       cgd      1530: The possible conditionals are as follows:
                   1531: .Bl -tag -width Ds
1.168     sjg      1532: .It Ic .error Ar message
                   1533: The message is printed along with the name of the makefile and line number,
                   1534: then
                   1535: .Nm
                   1536: will exit.
1.165     sjg      1537: .It Ic .export Ar variable ...
1.133     sjg      1538: Export the specified global variable.
1.165     sjg      1539: If no variable list is provided, all globals are exported
1.133     sjg      1540: except for internal variables (those that start with
1.157     wiz      1541: .Ql \&. ) .
1.133     sjg      1542: This is not affected by the
                   1543: .Fl X
                   1544: flag, so should be used with caution.
1.201     christos 1545: For compatibility with other
                   1546: .Nm
                   1547: programs
                   1548: .Ql export variable=value
                   1549: is also accepted.
1.165     sjg      1550: .Pp
1.133     sjg      1551: Appending a variable name to
                   1552: .Va .MAKE.EXPORTED
                   1553: is equivalent to exporting a variable.
1.173     sjg      1554: .It Ic .export-env Ar variable ...
1.176     wiz      1555: The same as
1.173     sjg      1556: .Ql .export ,
1.176     wiz      1557: except that the variable is not appended to
1.173     sjg      1558: .Va .MAKE.EXPORTED .
1.176     wiz      1559: This allows exporting a value to the environment which is different from that
                   1560: used by
1.173     sjg      1561: .Nm
                   1562: internally.
1.168     sjg      1563: .It Ic .info Ar message
                   1564: The message is printed along with the name of the makefile and line number.
1.169     wiz      1565: .It Ic .undef Ar variable
                   1566: Un-define the specified global variable.
                   1567: Only global variables may be un-defined.
1.165     sjg      1568: .It Ic .unexport Ar variable ...
                   1569: The opposite of
                   1570: .Ql .export .
                   1571: The specified global
1.166     wiz      1572: .Va variable
                   1573: will be removed from
1.165     sjg      1574: .Va .MAKE.EXPORTED .
                   1575: If no variable list is provided, all globals are unexported,
                   1576: and
1.166     wiz      1577: .Va .MAKE.EXPORTED
1.165     sjg      1578: deleted.
                   1579: .It Ic .unexport-env
                   1580: Unexport all globals previously exported and
                   1581: clear the environment inherited from the parent.
1.166     wiz      1582: This operation will cause a memory leak of the original environment,
                   1583: so should be used sparingly.
                   1584: Testing for
1.165     sjg      1585: .Va .MAKE.LEVEL
                   1586: being 0, would make sense.
1.166     wiz      1587: Also note that any variables which originated in the parent environment
1.165     sjg      1588: should be explicitly preserved if desired.
                   1589: For example:
                   1590: .Bd -literal -offset indent
                   1591: .Li .if ${.MAKE.LEVEL} == 0
                   1592: PATH := ${PATH}
                   1593: .Li .unexport-env
                   1594: .Li .export PATH
                   1595: .Li .endif
                   1596: .Pp
                   1597: .Ed
1.166     wiz      1598: Would result in an environment containing only
1.165     sjg      1599: .Ql Ev PATH ,
                   1600: which is the minimal useful environment.
                   1601: Actually
1.166     wiz      1602: .Ql Ev .MAKE.LEVEL
1.165     sjg      1603: will also be pushed into the new environment.
1.168     sjg      1604: .It Ic .warning Ar message
                   1605: The message prefixed by
                   1606: .Ql Pa warning:
                   1607: is printed along with the name of the makefile and line number.
1.164     joerg    1608: .It Ic \&.if Oo \&! Oc Ns Ar expression Op Ar operator expression ...
1.1       cgd      1609: Test the value of an expression.
1.164     joerg    1610: .It Ic .ifdef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1.7       mycroft  1611: Test the value of a variable.
1.164     joerg    1612: .It Ic .ifndef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1.7       mycroft  1613: Test the value of a variable.
1.164     joerg    1614: .It Ic .ifmake Oo \&! Oc Ns Ar target Op Ar operator target ...
1.7       mycroft  1615: Test the target being built.
1.164     joerg    1616: .It Ic .ifnmake Oo \&! Ns Oc Ar target Op Ar operator target ...
1.1       cgd      1617: Test the target being built.
                   1618: .It Ic .else
                   1619: Reverse the sense of the last conditional.
1.164     joerg    1620: .It Ic .elif Oo \&! Ns Oc Ar expression Op Ar operator expression ...
1.1       cgd      1621: A combination of
                   1622: .Ql Ic .else
                   1623: followed by
                   1624: .Ql Ic .if .
1.164     joerg    1625: .It Ic .elifdef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1.1       cgd      1626: A combination of
                   1627: .Ql Ic .else
                   1628: followed by
                   1629: .Ql Ic .ifdef .
1.164     joerg    1630: .It Ic .elifndef Oo \&! Oc Ns Ar variable Op Ar operator variable ...
1.1       cgd      1631: A combination of
                   1632: .Ql Ic .else
                   1633: followed by
                   1634: .Ql Ic .ifndef .
1.164     joerg    1635: .It Ic .elifmake Oo \&! Oc Ns Ar target Op Ar operator target ...
1.1       cgd      1636: A combination of
                   1637: .Ql Ic .else
                   1638: followed by
                   1639: .Ql Ic .ifmake .
1.164     joerg    1640: .It Ic .elifnmake Oo \&! Oc Ns Ar target Op Ar operator target ...
1.1       cgd      1641: A combination of
                   1642: .Ql Ic .else
                   1643: followed by
                   1644: .Ql Ic .ifnmake .
                   1645: .It Ic .endif
                   1646: End the body of the conditional.
                   1647: .El
                   1648: .Pp
                   1649: The
                   1650: .Ar operator
                   1651: may be any one of the following:
                   1652: .Bl -tag -width "Cm XX"
                   1653: .It Cm \&|\&|
1.64      wiz      1654: Logical OR.
1.62      ross     1655: .It Cm \&\*[Am]\*[Am]
1.1       cgd      1656: Logical
                   1657: .Tn AND ;
                   1658: of higher precedence than
1.26      hubertf  1659: .Dq \&|\&| .
1.1       cgd      1660: .El
                   1661: .Pp
                   1662: As in C,
1.25      lukem    1663: .Nm
1.1       cgd      1664: will only evaluate a conditional as far as is necessary to determine
                   1665: its value.
1.16      christos 1666: Parentheses may be used to change the order of evaluation.
1.1       cgd      1667: The boolean operator
                   1668: .Ql Ic \&!
                   1669: may be used to logically negate an entire
                   1670: conditional.
1.5       jtc      1671: It is of higher precedence than
1.62      ross     1672: .Ql Ic \&\*[Am]\*[Am] .
1.1       cgd      1673: .Pp
                   1674: The value of
                   1675: .Ar expression
                   1676: may be any of the following:
1.61      ross     1677: .Bl -tag -width defined
1.1       cgd      1678: .It Ic defined
                   1679: Takes a variable name as an argument and evaluates to true if the variable
                   1680: has been defined.
                   1681: .It Ic make
                   1682: Takes a target name as an argument and evaluates to true if the target
                   1683: was specified as part of
1.74      wiz      1684: .Nm Ns 's
1.1       cgd      1685: command line or was declared the default target (either implicitly or
                   1686: explicitly, see
                   1687: .Va .MAIN )
                   1688: before the line containing the conditional.
                   1689: .It Ic empty
1.5       jtc      1690: Takes a variable, with possible modifiers, and evaluates to true if
1.1       cgd      1691: the expansion of the variable would result in an empty string.
                   1692: .It Ic exists
                   1693: Takes a file name as an argument and evaluates to true if the file exists.
                   1694: The file is searched for on the system search path (see
                   1695: .Va .PATH ) .
                   1696: .It Ic target
                   1697: Takes a target name as an argument and evaluates to true if the target
                   1698: has been defined.
1.47      christos 1699: .It Ic commands
                   1700: Takes a target name as an argument and evaluates to true if the target
                   1701: has been defined and has commands associated with it.
1.1       cgd      1702: .El
                   1703: .Pp
                   1704: .Ar Expression
1.67      grant    1705: may also be an arithmetic or string comparison.
                   1706: Variable expansion is
1.6       cgd      1707: performed on both sides of the comparison, after which the integral
1.67      grant    1708: values are compared.
                   1709: A value is interpreted as hexadecimal if it is
1.6       cgd      1710: preceded by 0x, otherwise it is decimal; octal numbers are not supported.
1.67      grant    1711: The standard C relational operators are all supported.
                   1712: If after
1.6       cgd      1713: variable expansion, either the left or right hand side of a
1.1       cgd      1714: .Ql Ic ==
                   1715: or
                   1716: .Ql Ic "!="
1.6       cgd      1717: operator is not an integral value, then
                   1718: string comparison is performed between the expanded
                   1719: variables.
1.1       cgd      1720: If no relational operator is given, it is assumed that the expanded
1.102     sjg      1721: variable is being compared against 0 or an empty string in the case
                   1722: of a string comparison.
1.1       cgd      1723: .Pp
                   1724: When
1.25      lukem    1725: .Nm
1.150     dsl      1726: is evaluating one of these conditional expressions, and it encounters
                   1727: a (white-space separated) word it doesn't recognize, either the
1.137     wiz      1728: .Dq make
                   1729: or
                   1730: .Dq defined
1.1       cgd      1731: expression is applied to it, depending on the form of the conditional.
                   1732: If the form is
1.150     dsl      1733: .Ql Ic .ifdef ,
                   1734: .Ql Ic .ifndef ,
1.1       cgd      1735: or
1.150     dsl      1736: .Ql Ic .if
1.137     wiz      1737: the
                   1738: .Dq defined
                   1739: expression is applied.
1.1       cgd      1740: Similarly, if the form is
                   1741: .Ql Ic .ifmake
                   1742: or
1.237     dholland 1743: .Ql Ic .ifnmake , the
1.137     wiz      1744: .Dq make
1.1       cgd      1745: expression is applied.
                   1746: .Pp
                   1747: If the conditional evaluates to true the parsing of the makefile continues
                   1748: as before.
                   1749: If it evaluates to false, the following lines are skipped.
                   1750: In both cases this continues until a
                   1751: .Ql Ic .else
                   1752: or
                   1753: .Ql Ic .endif
                   1754: is found.
1.16      christos 1755: .Pp
1.6       cgd      1756: For loops are typically used to apply a set of rules to a list of files.
                   1757: The syntax of a for loop is:
1.59      bgrayson 1758: .Pp
                   1759: .Bl -tag -compact -width Ds
1.164     joerg    1760: .It Ic \&.for Ar variable Oo Ar variable ... Oc Ic in Ar expression
1.80      wiz      1761: .It Aq make-rules
                   1762: .It Ic \&.endfor
1.6       cgd      1763: .El
1.59      bgrayson 1764: .Pp
1.6       cgd      1765: After the for
1.16      christos 1766: .Ic expression
1.67      grant    1767: is evaluated, it is split into words.
                   1768: On each iteration of the loop, one word is taken and assigned to each
1.39      christos 1769: .Ic variable ,
                   1770: in order, and these
                   1771: .Ic variables
                   1772: are substituted into the
1.16      christos 1773: .Ic make-rules
1.6       cgd      1774: inside the body of the for loop.
1.39      christos 1775: The number of words must come out even; that is, if there are three
                   1776: iteration variables, the number of words provided must be a multiple
                   1777: of three.
1.1       cgd      1778: .Sh COMMENTS
                   1779: Comments begin with a hash
                   1780: .Pq Ql \&#
                   1781: character, anywhere but in a shell
1.237     dholland 1782: command line, and continue to the end of an unescaped new line.
1.97      lukem    1783: .Sh SPECIAL SOURCES (ATTRIBUTES)
1.61      ross     1784: .Bl -tag -width .IGNOREx
1.97      lukem    1785: .It Ic .EXEC
                   1786: Target is never out of date, but always execute commands anyway.
1.1       cgd      1787: .It Ic .IGNORE
                   1788: Ignore any errors from the commands associated with this target, exactly
                   1789: as if they all were preceded by a dash
                   1790: .Pq Ql \- .
1.237     dholland 1791: .\" .It Ic .INVISIBLE
                   1792: .\" XXX
                   1793: .\" .It Ic .JOIN
                   1794: .\" XXX
1.18      christos 1795: .It Ic .MADE
1.48      wiz      1796: Mark all sources of this target as being up-to-date.
1.1       cgd      1797: .It Ic .MAKE
                   1798: Execute the commands associated with this target even if the
                   1799: .Fl n
                   1800: or
                   1801: .Fl t
                   1802: options were specified.
                   1803: Normally used to mark recursive
1.226     dholland 1804: .Nm Ns s .
1.180     sjg      1805: .It Ic .META
                   1806: Create a meta file for the target, even if it is flagged as
                   1807: .Ic .PHONY ,
1.182     wiz      1808: .Ic .MAKE ,
1.180     sjg      1809: or
                   1810: .Ic .SPECIAL .
                   1811: Usage in conjunction with
                   1812: .Ic .MAKE
                   1813: is the most likely case.
1.194     sjg      1814: In "meta" mode, the target is out-of-date if the meta file is missing.
1.180     sjg      1815: .It Ic .NOMETA
                   1816: Do not create a meta file for the target.
                   1817: Meta files are also not created for
                   1818: .Ic .PHONY ,
1.182     wiz      1819: .Ic .MAKE ,
1.180     sjg      1820: or
                   1821: .Ic .SPECIAL
                   1822: targets.
                   1823: .It Ic .NOMETA_CMP
                   1824: Ignore differences in commands when deciding if target is out of date.
                   1825: This is useful if the command contains a value which always changes.
1.182     wiz      1826: If the number of commands change, though, the target will still be out of date.
1.213     sjg      1827: The same effect applies to any command line that uses the variable
                   1828: .Va .OODATE ,
                   1829: which can be used for that purpose even when not otherwise needed or desired:
                   1830: .Bd -literal -offset indent
                   1831:
                   1832: skip-compare-for-some:
                   1833:        @echo this will be compared
                   1834:        @echo this will not ${.OODATE:M.NOMETA_CMP}
                   1835:        @echo this will also be compared
                   1836:
                   1837: .Ed
                   1838: The
                   1839: .Cm \&:M
                   1840: pattern suppresses any expansion of the unwanted variable.
1.97      lukem    1841: .It Ic .NOPATH
                   1842: Do not search for the target in the directories specified by
                   1843: .Ic .PATH .
1.1       cgd      1844: .It Ic .NOTMAIN
                   1845: Normally
1.25      lukem    1846: .Nm
1.1       cgd      1847: selects the first target it encounters as the default target to be built
                   1848: if no target was specified.
                   1849: This source prevents this target from being selected.
                   1850: .It Ic .OPTIONAL
                   1851: If a target is marked with this attribute and
1.25      lukem    1852: .Nm
1.1       cgd      1853: can't figure out how to create it, it will ignore this fact and assume
                   1854: the file isn't needed or already exists.
1.97      lukem    1855: .It Ic .PHONY
                   1856: The target does not
                   1857: correspond to an actual file; it is always considered to be out of date,
                   1858: and will not be created with the
                   1859: .Fl t
                   1860: option.
1.179     dholland 1861: Suffix-transformation rules are not applied to
                   1862: .Ic .PHONY
                   1863: targets.
1.1       cgd      1864: .It Ic .PRECIOUS
                   1865: When
1.25      lukem    1866: .Nm
1.131     rillig   1867: is interrupted, it normally removes any partially made targets.
1.1       cgd      1868: This source prevents the target from being removed.
1.97      lukem    1869: .It Ic .RECURSIVE
                   1870: Synonym for
                   1871: .Ic .MAKE .
1.1       cgd      1872: .It Ic .SILENT
                   1873: Do not echo any of the commands associated with this target, exactly
                   1874: as if they all were preceded by an at sign
                   1875: .Pq Ql @ .
                   1876: .It Ic .USE
                   1877: Turn the target into
1.74      wiz      1878: .Nm Ns 's
1.1       cgd      1879: version of a macro.
                   1880: When the target is used as a source for another target, the other target
                   1881: acquires the commands, sources, and attributes (except for
                   1882: .Ic .USE )
                   1883: of the
                   1884: source.
                   1885: If the target already has commands, the
                   1886: .Ic .USE
                   1887: target's commands are appended
                   1888: to them.
1.52      christos 1889: .It Ic .USEBEFORE
                   1890: Exactly like
                   1891: .Ic .USE ,
1.57      wiz      1892: but prepend the
1.52      christos 1893: .Ic .USEBEFORE
                   1894: target commands to the target.
1.12      christos 1895: .It Ic .WAIT
1.71      mjl      1896: If
1.12      christos 1897: .Ic .WAIT
1.71      mjl      1898: appears in a dependency line, the sources that precede it are
1.67      grant    1899: made before the sources that succeed it in the line.
1.128     dsl      1900: Since the dependents of files are not made until the file itself
                   1901: could be made, this also stops the dependents being built unless they
                   1902: are needed for another branch of the dependency tree.
                   1903: So given:
                   1904: .Bd -literal
                   1905: x: a .WAIT b
                   1906:        echo x
                   1907: a:
                   1908:        echo a
                   1909: b: b1
                   1910:        echo b
                   1911: b1:
                   1912:        echo b1
                   1913:
                   1914: .Ed
                   1915: the output is always
1.151     dholland 1916: .Ql a ,
1.128     dsl      1917: .Ql b1 ,
                   1918: .Ql b ,
                   1919: .Ql x .
                   1920: .br
1.122     apb      1921: The ordering imposed by
                   1922: .Ic .WAIT
1.128     dsl      1923: is only relevant for parallel makes.
1.1       cgd      1924: .El
1.57      wiz      1925: .Sh SPECIAL TARGETS
1.1       cgd      1926: Special targets may not be included with other targets, i.e. they must be
                   1927: the only target specified.
1.61      ross     1928: .Bl -tag -width .BEGINx
1.1       cgd      1929: .It Ic .BEGIN
                   1930: Any command lines attached to this target are executed before anything
                   1931: else is done.
                   1932: .It Ic .DEFAULT
                   1933: This is sort of a
                   1934: .Ic .USE
                   1935: rule for any target (that was used only as a
                   1936: source) that
1.25      lukem    1937: .Nm
1.1       cgd      1938: can't figure out any other way to create.
                   1939: Only the shell script is used.
                   1940: The
                   1941: .Ic .IMPSRC
                   1942: variable of a target that inherits
                   1943: .Ic .DEFAULT Ns 's
                   1944: commands is set
                   1945: to the target's own name.
                   1946: .It Ic .END
                   1947: Any command lines attached to this target are executed after everything
                   1948: else is done.
1.168     sjg      1949: .It Ic .ERROR
                   1950: Any command lines attached to this target are executed when another target fails.
                   1951: The
                   1952: .Ic .ERROR_TARGET
                   1953: variable is set to the target that failed.
1.169     wiz      1954: See also
1.168     sjg      1955: .Ic MAKE_PRINT_VAR_ON_ERROR .
1.1       cgd      1956: .It Ic .IGNORE
                   1957: Mark each of the sources with the
                   1958: .Ic .IGNORE
                   1959: attribute.
                   1960: If no sources are specified, this is the equivalent of specifying the
                   1961: .Fl i
                   1962: option.
                   1963: .It Ic .INTERRUPT
                   1964: If
1.25      lukem    1965: .Nm
1.1       cgd      1966: is interrupted, the commands for this target will be executed.
                   1967: .It Ic .MAIN
                   1968: If no target is specified when
1.25      lukem    1969: .Nm
1.1       cgd      1970: is invoked, this target will be built.
                   1971: .It Ic .MAKEFLAGS
                   1972: This target provides a way to specify flags for
1.25      lukem    1973: .Nm
1.1       cgd      1974: when the makefile is used.
                   1975: The flags are as if typed to the shell, though the
                   1976: .Fl f
                   1977: option will have
                   1978: no effect.
1.12      christos 1979: .\" XXX: NOT YET!!!!
                   1980: .\" .It Ic .NOTPARALLEL
1.70      wiz      1981: .\" The named targets are executed in non parallel mode.
                   1982: .\" If no targets are
1.12      christos 1983: .\" specified, then all targets are executed in non parallel mode.
1.20      gwr      1984: .It Ic .NOPATH
                   1985: Apply the
                   1986: .Ic .NOPATH
1.67      grant    1987: attribute to any specified sources.
1.12      christos 1988: .It Ic .NOTPARALLEL
                   1989: Disable parallel mode.
                   1990: .It Ic .NO_PARALLEL
1.97      lukem    1991: Synonym for
                   1992: .Ic .NOTPARALLEL ,
                   1993: for compatibility with other pmake variants.
1.12      christos 1994: .It Ic .ORDER
                   1995: The named targets are made in sequence.
1.128     dsl      1996: This ordering does not add targets to the list of targets to be made.
                   1997: Since the dependents of a target do not get built until the target itself
                   1998: could be built, unless
                   1999: .Ql a
1.129     wiz      2000: is built by another part of the dependency graph,
1.128     dsl      2001: the following is a dependency loop:
                   2002: .Bd -literal
1.192     cheusov  2003: \&.ORDER: b a
1.128     dsl      2004: b: a
                   2005: .Ed
1.129     wiz      2006: .Pp
1.122     apb      2007: The ordering imposed by
                   2008: .Ic .ORDER
1.128     dsl      2009: is only relevant for parallel makes.
1.12      christos 2010: .\" XXX: NOT YET!!!!
                   2011: .\" .It Ic .PARALLEL
1.70      wiz      2012: .\" The named targets are executed in parallel mode.
                   2013: .\" If no targets are
1.12      christos 2014: .\" specified, then all targets are executed in parallel mode.
1.1       cgd      2015: .It Ic .PATH
                   2016: The sources are directories which are to be searched for files not
                   2017: found in the current directory.
                   2018: If no sources are specified, any previously specified directories are
                   2019: deleted.
1.34      thorpej  2020: If the source is the special
                   2021: .Ic .DOTLAST
                   2022: target, then the current working
1.33      thorpej  2023: directory is searched last.
1.222     apb      2024: .It Ic .PATH. Ns Va suffix
1.221     dholland 2025: Like
                   2026: .Ic .PATH
                   2027: but applies only to files with a particular suffix.
                   2028: The suffix must have been previously declared with
                   2029: .Ic .SUFFIXES .
1.14      christos 2030: .It Ic .PHONY
                   2031: Apply the
                   2032: .Ic .PHONY
1.67      grant    2033: attribute to any specified sources.
1.1       cgd      2034: .It Ic .PRECIOUS
                   2035: Apply the
                   2036: .Ic .PRECIOUS
                   2037: attribute to any specified sources.
                   2038: If no sources are specified, the
                   2039: .Ic .PRECIOUS
                   2040: attribute is applied to every
                   2041: target in the file.
1.83      sjg      2042: .It Ic .SHELL
1.86      wiz      2043: Sets the shell that
1.83      sjg      2044: .Nm
1.86      wiz      2045: will use to execute commands.
                   2046: The sources are a set of
1.83      sjg      2047: .Ar field=value
1.86      wiz      2048: pairs.
1.83      sjg      2049: .Bl -tag -width hasErrCtls
                   2050: .It Ar name
                   2051: This is the minimal specification, used to select one of the builtin
                   2052: shell specs;
                   2053: .Ar sh ,
                   2054: .Ar ksh ,
                   2055: and
                   2056: .Ar csh .
                   2057: .It Ar path
                   2058: Specifies the path to the shell.
                   2059: .It Ar hasErrCtl
                   2060: Indicates whether the shell supports exit on error.
                   2061: .It Ar check
                   2062: The command to turn on error checking.
                   2063: .It Ar ignore
                   2064: The command to disable error checking.
                   2065: .It Ar echo
                   2066: The command to turn on echoing of commands executed.
                   2067: .It Ar quiet
                   2068: The command to turn off echoing of commands executed.
                   2069: .It Ar filter
                   2070: The output to filter after issuing the
                   2071: .Ar quiet
1.86      wiz      2072: command.
                   2073: It is typically identical to
1.83      sjg      2074: .Ar quiet .
                   2075: .It Ar errFlag
                   2076: The flag to pass the shell to enable error checking.
                   2077: .It Ar echoFlag
                   2078: The flag to pass the shell to enable command echoing.
1.127     rillig   2079: .It Ar newline
                   2080: The string literal to pass the shell that results in a single newline
                   2081: character when used outside of any quoting characters.
1.83      sjg      2082: .El
                   2083: Example:
                   2084: .Bd -literal
1.167     joerg    2085: \&.SHELL: name=ksh path=/bin/ksh hasErrCtl=true \e
1.194     sjg      2086:        check="set \-e" ignore="set +e" \e
                   2087:        echo="set \-v" quiet="set +v" filter="set +v" \e
1.167     joerg    2088:        echoFlag=v errFlag=e newline="'\en'"
1.83      sjg      2089: .Ed
1.1       cgd      2090: .It Ic .SILENT
                   2091: Apply the
                   2092: .Ic .SILENT
                   2093: attribute to any specified sources.
                   2094: If no sources are specified, the
                   2095: .Ic .SILENT
                   2096: attribute is applied to every
                   2097: command in the file.
1.211     christos 2098: .It Ic .STALE
                   2099: This target gets run when a dependency file contains stale entries, having
                   2100: .Va .ALLSRC
                   2101: set to the name of that dependency file.
1.1       cgd      2102: .It Ic .SUFFIXES
1.237     dholland 2103: Each source specifies a suffix to
1.233     christos 2104: .Nm .
1.237     dholland 2105: If no sources are specified, any previously specified suffixes are deleted.
                   2106: It allows the creation of suffix-transformation rules.
1.136     cube     2107: .Pp
                   2108: Example:
                   2109: .Bd -literal
1.237     dholland 2110: \&.SUFFIXES: .o
                   2111: \&.c.o:
1.194     sjg      2112:        cc \-o ${.TARGET} \-c ${.IMPSRC}
1.136     cube     2113: .Ed
1.31      ross     2114: .El
1.1       cgd      2115: .Sh ENVIRONMENT
1.25      lukem    2116: .Nm
1.73      perry    2117: uses the following environment variables, if they exist:
1.16      christos 2118: .Ev MACHINE ,
1.26      hubertf  2119: .Ev MACHINE_ARCH ,
1.1       cgd      2120: .Ev MAKE ,
1.16      christos 2121: .Ev MAKEFLAGS ,
                   2122: .Ev MAKEOBJDIR ,
1.38      sjg      2123: .Ev MAKEOBJDIRPREFIX ,
1.76      jrf      2124: .Ev MAKESYSPATH ,
1.154     apb      2125: .Ev PWD ,
1.1       cgd      2126: and
1.154     apb      2127: .Ev TMPDIR .
1.57      wiz      2128: .Pp
1.38      sjg      2129: .Ev MAKEOBJDIRPREFIX
1.117     lukem    2130: and
1.38      sjg      2131: .Ev MAKEOBJDIR
1.117     lukem    2132: may only be set in the environment or on the command line to
1.38      sjg      2133: .Nm
1.117     lukem    2134: and not as makefile variables;
                   2135: see the description of
                   2136: .Ql Va .OBJDIR
                   2137: for more details.
1.1       cgd      2138: .Sh FILES
                   2139: .Bl -tag -width /usr/share/mk -compact
                   2140: .It .depend
                   2141: list of dependencies
                   2142: .It Makefile
                   2143: list of dependencies
                   2144: .It makefile
                   2145: list of dependencies
                   2146: .It sys.mk
                   2147: system makefile
                   2148: .It /usr/share/mk
                   2149: system makefile directory
                   2150: .El
1.128     dsl      2151: .Sh COMPATIBILITY
1.241   ! dholland 2152: The basic make syntax is compatible between different versions of make;
1.128     dsl      2153: however the special variables, variable modifiers and conditionals are not.
1.241   ! dholland 2154: .Ss Older versions
        !          2155: An incomplete list of changes in older versions of
        !          2156: .Nm :
        !          2157: .Pp
        !          2158: The way that .for loop variables are substituted changed after
        !          2159: .Nx 5.0
        !          2160: so that they still appear to be variable expansions.
        !          2161: In particular this stops them being treated as syntax, and removes some
        !          2162: obscure problems using them in .if statements.
1.128     dsl      2163: .Pp
1.129     wiz      2164: The way that parallel makes are scheduled changed in
1.130     wiz      2165: .Nx 4.0
1.193     wiz      2166: so that .ORDER and .WAIT apply recursively to the dependent nodes.
1.128     dsl      2167: The algorithms used may change again in the future.
1.241   ! dholland 2168: .Ss Other make dialects
        !          2169: Other make dialects (GNU make, SVR4 make, POSIX make, etc.) do not
        !          2170: support most of the features of
        !          2171: .Nm
        !          2172: as described in this manual.
        !          2173: Most notably:
        !          2174: .Bl -bullet -offset indent
        !          2175: .It
        !          2176: The
        !          2177: .Ic .WAIT
        !          2178: and
        !          2179: .Ic .ORDER
        !          2180: declarations and most functionality pertaining to parallelization.
        !          2181: (GNU make supports parallelization but lacks these features needed to
        !          2182: control it effectively.)
        !          2183: .It
        !          2184: Directives, including for loops and conditionals and most of the
        !          2185: forms of include files.
        !          2186: (GNU make has its own incompatible and less powerful syntax for
        !          2187: conditionals.)
        !          2188: .It
        !          2189: All built-in variables that begin with a dot.
        !          2190: .It
        !          2191: Most of the special sources and targets that begin with a dot,
        !          2192: with the notable exception of
        !          2193: .Ic .PHONY ,
        !          2194: .Ic .PRECIOUS ,
        !          2195: and
        !          2196: .SUFFIXES .
        !          2197: .It
        !          2198: Variable modifiers, except for the
        !          2199: .Dl :old=new
        !          2200: string substitution, which does not portably support globbing with
        !          2201: .Ql %
        !          2202: and historically only works on declared suffixes.
        !          2203: .It
        !          2204: The
        !          2205: .Ic $>
        !          2206: variable even in its short form; most makes support this functionality
        !          2207: but its name varies.
        !          2208: .El
        !          2209: .Pp
        !          2210: Some features are somewhat more portable, such as assignment with
        !          2211: .Ic += ,
        !          2212: .Ic ?= ,
        !          2213: and
        !          2214: .Ic != .
        !          2215: The
        !          2216: .Ic .PATH
        !          2217: functionality is based on an older feature
        !          2218: .Ic VPATH
        !          2219: found in GNU make and many versions of SVR4 make; however,
        !          2220: historically its behavior is too ill-defined (and too buggy) to rely
        !          2221: upon.
1.152     dsl      2222: .Pp
1.241   ! dholland 2223: The
        !          2224: .Ic $@
        !          2225: and
        !          2226: .Ic $<
        !          2227: variables are more or less universally portable, as is the
        !          2228: .Ic $(MAKE)
        !          2229: variable.
        !          2230: Basic use of suffix rules (for files only in the current directory,
        !          2231: not trying to chain transformations together, etc.) is also reasonably
        !          2232: portable.
1.153     wiz      2233: .Sh SEE ALSO
                   2234: .Xr mkdep 1
                   2235: .Sh HISTORY
                   2236: A
                   2237: .Nm
                   2238: command appeared in
                   2239: .At v7 .
1.190     christos 2240: This
                   2241: .Nm
                   2242: implementation is based on Adam De Boor's pmake program which was written
1.209     christos 2243: for Sprite at Berkeley.
1.190     christos 2244: It was designed to be a parallel distributed make running jobs on different
1.191     wiz      2245: machines using a daemon called
1.190     christos 2246: .Dq customs .
1.237     dholland 2247: .Pp
                   2248: Historically the target/dependency
                   2249: .Dq FRC
                   2250: has been used to FoRCe rebuilding (since the target/dependency
                   2251: does not exist... unless someone creates an
                   2252: .Dq FRC
                   2253: file).
1.152     dsl      2254: .Sh BUGS
                   2255: The
                   2256: .Nm
                   2257: syntax is difficult to parse without actually acting of the data.
                   2258: For instance finding the end of a variable use should involve scanning each
                   2259: the modifiers using the correct terminator for each field.
                   2260: In many places
                   2261: .Nm
                   2262: just counts {} and () in order to find the end of a variable expansion.
                   2263: .Pp
1.153     wiz      2264: There is no way of escaping a space character in a filename.

CVSweb <webmaster@jp.NetBSD.org>