/usr/share/doc/make-doc/make

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
<html>
<!-- This file documents the GNU make utility, which determines
automatically which pieces of a large program need to be recompiled,
and issues the commands to recompile them.

This is Edition 0.70, last updated 1 April 2006,
of The GNU Make Manual, for GNU make version 3.81.

Copyright C 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
1996, 1997, 1998, 1999, 2000, 2002, 2003, 2004, 2005, 2006
Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with the Front-Cover Texts being "A GNU Manual,"
and with the Back-Cover Texts as in (a) below.  A copy of the
license is included in the section entitled "GNU Free Documentation
License."

(a) The FSF's Back-Cover Text is: "You have freedom to copy and modify
this GNU Manual, like GNU software.  Copies published by the Free
Software Foundation raise funds for GNU development."

 -->
<!-- Created on August, 17 2009 by texi2html 1.78 -->
<!--
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
            Karl Berry  <karl@freefriends.org>
            Olaf Bachmann <obachman@mathematik.uni-kl.de>
            and many others.
Maintained by: Many creative people.
Send bugs and suggestions to <texi2html-bug@nongnu.org>

-->
<head>
<title>GNU make: A. Quick Reference</title>

<meta name="description" content="GNU make: A. Quick Reference">
<meta name="keywords" content="GNU make: A. Quick Reference">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2html 1.78">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
pre.display {font-family: serif}
pre.format {font-family: serif}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: serif; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: serif; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.roman {font-family:serif; font-weight:normal;}
span.sansserif {font-family:sans-serif; font-weight:normal;}
ul.toc {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">

<a name="Quick-Reference"></a>
<a name="SEC143"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="make_14.html#SEC142" title="Previous section in reading order"> &lt; </a>]</td>
<td valign="middle" align="left">[<a href="make_16.html#SEC144" title="Next section in reading order"> &gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="make_14.html#SEC136" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
<td valign="middle" align="left">[<a href="make.html#SEC_Top" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="make_16.html#SEC144" title="Next chapter"> &gt;&gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="make.html#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="make_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="make_19.html#SEC148" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="make_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<h1 class="appendix"> A. Quick Reference </h1>

<p>This appendix summarizes the directives, text manipulation functions,
and special variables which GNU <code>make</code> understands.
See section <a href="make_4.html#SEC48">Special Built-in Target Names</a>, <a href="make_10.html#SEC115">Catalogue of Implicit Rules</a>,
and <a href="make_9.html#SEC112">Summary of Options</a>,
for other summaries.
</p>
<p>Here is a summary of the directives GNU <code>make</code> recognizes:
</p>
<dl compact="compact">
<dt> <code>define <var>variable</var></code></dt>
<dt> <code>endef</code></dt>
<dd>
<p>Define a multi-line, recursively-expanded variable.<br>
See section <a href="make_5.html#SEC72">Defining Canned Command Sequences</a>.
</p>
</dd>
<dt> <code>ifdef <var>variable</var></code></dt>
<dt> <code>ifndef <var>variable</var></code></dt>
<dt> <code>ifeq (<var>a</var>,<var>b</var>)</code></dt>
<dt> <code>ifeq &quot;<var>a</var>&quot; &quot;<var>b</var>&quot;</code></dt>
<dt> <code>ifeq '<var>a</var>' '<var>b</var>'</code></dt>
<dt> <code>ifneq (<var>a</var>,<var>b</var>)</code></dt>
<dt> <code>ifneq &quot;<var>a</var>&quot; &quot;<var>b</var>&quot;</code></dt>
<dt> <code>ifneq '<var>a</var>' '<var>b</var>'</code></dt>
<dt> <code>else</code></dt>
<dt> <code>endif</code></dt>
<dd>
<p>Conditionally evaluate part of the makefile.<br>
See section <a href="make_7.html#SEC88">Conditional Parts of Makefiles</a>.
</p>
</dd>
<dt> <code>include <var>file</var></code></dt>
<dt> <code>-include <var>file</var></code></dt>
<dt> <code>sinclude <var>file</var></code></dt>
<dd>
<p>Include another makefile.<br>
See section <a href="make_3.html#SEC16">Including Other Makefiles</a>.
</p>
</dd>
<dt> <code>override <var>variable</var> = <var>value</var></code></dt>
<dt> <code>override <var>variable</var> := <var>value</var></code></dt>
<dt> <code>override <var>variable</var> += <var>value</var></code></dt>
<dt> <code>override <var>variable</var> ?= <var>value</var></code></dt>
<dt> <code>override define <var>variable</var></code></dt>
<dt> <code>endef</code></dt>
<dd>
<p>Define a variable, overriding any previous definition, even one from
the command line.<br>
See section <a href="make_6.html#SEC83">The <code>override</code> Directive</a>.
</p>
</dd>
<dt> <code>export</code></dt>
<dd>
<p>Tell <code>make</code> to export all variables to child processes by default.<br>
See section <a href="make_5.html#SEC69">Communicating Variables to a Sub-<code>make</code></a>.
</p>
</dd>
<dt> <code>export <var>variable</var></code></dt>
<dt> <code>export <var>variable</var> = <var>value</var></code></dt>
<dt> <code>export <var>variable</var> := <var>value</var></code></dt>
<dt> <code>export <var>variable</var> += <var>value</var></code></dt>
<dt> <code>export <var>variable</var> ?= <var>value</var></code></dt>
<dt> <code>unexport <var>variable</var></code></dt>
<dd><p>Tell <code>make</code> whether or not to export a particular variable to child
processes.<br>
See section <a href="make_5.html#SEC69">Communicating Variables to a Sub-<code>make</code></a>.
</p>
</dd>
<dt> <code>vpath <var>pattern</var> <var>path</var></code></dt>
<dd><p>Specify a search path for files matching a &lsquo;<samp>%</samp>&rsquo; pattern.<br>
See section <a href="make_4.html#SEC40">The <code>vpath</code> Directive</a>.
</p>
</dd>
<dt> <code>vpath <var>pattern</var></code></dt>
<dd><p>Remove all search paths previously specified for <var>pattern</var>.
</p>
</dd>
<dt> <code>vpath</code></dt>
<dd><p>Remove all search paths previously specified in any <code>vpath</code>
directive.
</p></dd>
</dl>

<p>Here is a summary of the built-in functions (see section <a href="make_8.html#SEC92">Functions for Transforming Text</a>):
</p>
<dl compact="compact">
<dt> <code>$(subst <var>from</var>,<var>to</var>,<var>text</var>)</code></dt>
<dd><p>Replace <var>from</var> with <var>to</var> in <var>text</var>.<br>
See section <a href="make_8.html#SEC94">Functions for String Substitution and Analysis</a>.
</p>
</dd>
<dt> <code>$(patsubst <var>pattern</var>,<var>replacement</var>,<var>text</var>)</code></dt>
<dd><p>Replace words matching <var>pattern</var> with <var>replacement</var> in <var>text</var>.<br>
See section <a href="make_8.html#SEC94">Functions for String Substitution and Analysis</a>.
</p>
</dd>
<dt> <code>$(strip <var>string</var>)</code></dt>
<dd><p>Remove excess whitespace characters from <var>string</var>.<br>
See section <a href="make_8.html#SEC94">Functions for String Substitution and Analysis</a>.
</p>
</dd>
<dt> <code>$(findstring <var>find</var>,<var>text</var>)</code></dt>
<dd><p>Locate <var>find</var> in <var>text</var>.<br>
See section <a href="make_8.html#SEC94">Functions for String Substitution and Analysis</a>.
</p>
</dd>
<dt> <code>$(filter <var>pattern</var>&hellip;,<var>text</var>)</code></dt>
<dd><p>Select words in <var>text</var> that match one of the <var>pattern</var> words.<br>
See section <a href="make_8.html#SEC94">Functions for String Substitution and Analysis</a>.
</p>
</dd>
<dt> <code>$(filter-out <var>pattern</var>&hellip;,<var>text</var>)</code></dt>
<dd><p>Select words in <var>text</var> that <em>do not</em> match any of the <var>pattern</var> words.<br>
See section <a href="make_8.html#SEC94">Functions for String Substitution and Analysis</a>.
</p>
</dd>
<dt> <code>$(sort <var>list</var>)</code></dt>
<dd><p>Sort the words in <var>list</var> lexicographically, removing duplicates.<br>
See section <a href="make_8.html#SEC94">Functions for String Substitution and Analysis</a>.
</p>
</dd>
<dt> <code>$(word <var>n</var>,<var>text</var>)</code></dt>
<dd><p>Extract the <var>n</var>th word (one-origin) of <var>text</var>.<br>
See section <a href="make_8.html#SEC94">Functions for String Substitution and Analysis</a>.
</p>
</dd>
<dt> <code>$(words <var>text</var>)</code></dt>
<dd><p>Count the number of words in <var>text</var>.<br>
See section <a href="make_8.html#SEC94">Functions for String Substitution and Analysis</a>.
</p>
</dd>
<dt> <code>$(wordlist <var>s</var>,<var>e</var>,<var>text</var>)</code></dt>
<dd><p>Returns the list of words in <var>text</var> from <var>s</var> to <var>e</var>.<br>
See section <a href="make_8.html#SEC94">Functions for String Substitution and Analysis</a>.
</p>
</dd>
<dt> <code>$(firstword <var>names</var>&hellip;)</code></dt>
<dd><p>Extract the first word of <var>names</var>.<br>
See section <a href="make_8.html#SEC94">Functions for String Substitution and Analysis</a>.
</p>
</dd>
<dt> <code>$(lastword <var>names</var>&hellip;)</code></dt>
<dd><p>Extract the last word of <var>names</var>.<br>
See section <a href="make_8.html#SEC94">Functions for String Substitution and Analysis</a>.
</p>
</dd>
<dt> <code>$(dir <var>names</var>&hellip;)</code></dt>
<dd><p>Extract the directory part of each file name.<br>
See section <a href="make_8.html#SEC95">Functions for File Names</a>.
</p>
</dd>
<dt> <code>$(notdir <var>names</var>&hellip;)</code></dt>
<dd><p>Extract the non-directory part of each file name.<br>
See section <a href="make_8.html#SEC95">Functions for File Names</a>.
</p>
</dd>
<dt> <code>$(suffix <var>names</var>&hellip;)</code></dt>
<dd><p>Extract the suffix (the last &lsquo;<samp>.</samp>&rsquo; and following characters) of each file name.<br>
See section <a href="make_8.html#SEC95">Functions for File Names</a>.
</p>
</dd>
<dt> <code>$(basename <var>names</var>&hellip;)</code></dt>
<dd><p>Extract the base name (name without suffix) of each file name.<br>
See section <a href="make_8.html#SEC95">Functions for File Names</a>.
</p>
</dd>
<dt> <code>$(addsuffix <var>suffix</var>,<var>names</var>&hellip;)</code></dt>
<dd><p>Append <var>suffix</var> to each word in <var>names</var>.<br>
See section <a href="make_8.html#SEC95">Functions for File Names</a>.
</p>
</dd>
<dt> <code>$(addprefix <var>prefix</var>,<var>names</var>&hellip;)</code></dt>
<dd><p>Prepend <var>prefix</var> to each word in <var>names</var>.<br>
See section <a href="make_8.html#SEC95">Functions for File Names</a>.
</p>
</dd>
<dt> <code>$(join <var>list1</var>,<var>list2</var>)</code></dt>
<dd><p>Join two parallel lists of words.<br>
See section <a href="make_8.html#SEC95">Functions for File Names</a>.
</p>
</dd>
<dt> <code>$(wildcard <var>pattern</var>&hellip;)</code></dt>
<dd><p>Find file names matching a shell file name pattern (<em>not</em> a
&lsquo;<samp>%</samp>&rsquo; pattern).<br>
See section <a href="make_4.html#SEC37">The Function <code>wildcard</code></a>.
</p>
</dd>
<dt> <code>$(realpath <var>names</var>&hellip;)</code></dt>
<dd><p>For each file name in <var>names</var>, expand to an absolute name that
does not contain any <code>.</code>, <code>..</code>, nor symlinks.<br>
See section <a href="make_8.html#SEC95">Functions for File Names</a>.
</p>
</dd>
<dt> <code>$(abspath <var>names</var>&hellip;)</code></dt>
<dd><p>For each file name in <var>names</var>, expand to an absolute name that
does not contain any <code>.</code> or <code>..</code> components, but preserves
symlinks.<br>
See section <a href="make_8.html#SEC95">Functions for File Names</a>.
</p>
</dd>
<dt> <code>$(error <var>text</var>&hellip;)</code></dt>
<dd>
<p>When this function is evaluated, <code>make</code> generates a fatal error
with the message <var>text</var>.<br>
See section <a href="make_8.html#SEC104">Functions That Control Make</a>.
</p>
</dd>
<dt> <code>$(warning <var>text</var>&hellip;)</code></dt>
<dd>
<p>When this function is evaluated, <code>make</code> generates a warning with
the message <var>text</var>.<br>
See section <a href="make_8.html#SEC104">Functions That Control Make</a>.
</p>
</dd>
<dt> <code>$(shell <var>command</var>)</code></dt>
<dd>
<p>Execute a shell command and return its output.<br>
See section <a href="make_8.html#SEC103">The <code>shell</code> Function</a>.
</p>
</dd>
<dt> <code>$(origin <var>variable</var>)</code></dt>
<dd>
<p>Return a string describing how the <code>make</code> variable <var>variable</var> was
defined.<br>
See section <a href="make_8.html#SEC101">The <code>origin</code> Function</a>.
</p>
</dd>
<dt> <code>$(flavor <var>variable</var>)</code></dt>
<dd>
<p>Return a string describing the flavor of the <code>make</code> variable
<var>variable</var>.<br>
See section <a href="make_8.html#SEC102">The <code>flavor</code> Function</a>.
</p>
</dd>
<dt> <code>$(foreach <var>var</var>,<var>words</var>,<var>text</var>)</code></dt>
<dd>
<p>Evaluate <var>text</var> with <var>var</var> bound to each word in <var>words</var>,
and concatenate the results.<br>
See section <a href="make_8.html#SEC97">The <code>foreach</code> Function</a>.
</p>
</dd>
<dt> <code>$(call <var>var</var>,<var>param</var>,&hellip;)</code></dt>
<dd>
<p>Evaluate the variable <var>var</var> replacing any references to <code>$(1)</code>,
<code>$(2)</code> with the first, second, etc. <var>param</var> values.<br>
See section <a href="make_8.html#SEC98">The <code>call</code> Function</a>.
</p>
</dd>
<dt> <code>$(eval <var>text</var>)</code></dt>
<dd>
<p>Evaluate <var>text</var> then read the results as makefile commands.
Expands to the empty string.<br>
See section <a href="make_8.html#SEC100">The <code>eval</code> Function</a>.
</p>
</dd>
<dt> <code>$(value <var>var</var>)</code></dt>
<dd>
<p>Evaluates to the contents of the variable <var>var</var>, with no expansion
performed on it.<br>
See section <a href="make_8.html#SEC99">The <code>value</code> Function</a>.
</p></dd>
</dl>

<p>Here is a summary of the automatic variables.
See section <a href="make_10.html#SEC121">Automatic Variables</a>,
for full information.
</p>
<dl compact="compact">
<dt> <code>$@</code></dt>
<dd><p>The file name of the target.
</p>
</dd>
<dt> <code>$%</code></dt>
<dd><p>The target member name, when the target is an archive member.
</p>
</dd>
<dt> <code>$&lt;</code></dt>
<dd><p>The name of the first prerequisite.
</p>
</dd>
<dt> <code>$?</code></dt>
<dd><p>The names of all the prerequisites that are
newer than the target, with spaces between them.
For prerequisites which are archive members, only
the member named is used (see section <a href="make_11.html#SEC128">Using <code>make</code> to Update Archive Files</a>).
</p>
</dd>
<dt> <code>$^</code></dt>
<dt> <code>$+</code></dt>
<dd><p>The names of all the prerequisites, with spaces between them.  For
prerequisites which are archive members, only the member named is used
(see section <a href="make_11.html#SEC128">Using <code>make</code> to Update Archive Files</a>).  The value of <code>$^</code> omits duplicate
prerequisites, while <code>$+</code> retains them and preserves their order.
</p>
</dd>
<dt> <code>$*</code></dt>
<dd><p>The stem with which an implicit rule matches
(see section <a href="make_10.html#SEC122">How Patterns Match</a>).
</p>
</dd>
<dt> <code>$(@D)</code></dt>
<dt> <code>$(@F)</code></dt>
<dd><p>The directory part and the file-within-directory part of <code>$@</code>.
</p>
</dd>
<dt> <code>$(*D)</code></dt>
<dt> <code>$(*F)</code></dt>
<dd><p>The directory part and the file-within-directory part of <code>$*</code>.
</p>
</dd>
<dt> <code>$(%D)</code></dt>
<dt> <code>$(%F)</code></dt>
<dd><p>The directory part and the file-within-directory part of <code>$%</code>.
</p>
</dd>
<dt> <code>$(&lt;D)</code></dt>
<dt> <code>$(&lt;F)</code></dt>
<dd><p>The directory part and the file-within-directory part of <code>$&lt;</code>.
</p>
</dd>
<dt> <code>$(^D)</code></dt>
<dt> <code>$(^F)</code></dt>
<dd><p>The directory part and the file-within-directory part of <code>$^</code>.
</p>
</dd>
<dt> <code>$(+D)</code></dt>
<dt> <code>$(+F)</code></dt>
<dd><p>The directory part and the file-within-directory part of <code>$+</code>.
</p>
</dd>
<dt> <code>$(?D)</code></dt>
<dt> <code>$(?F)</code></dt>
<dd><p>The directory part and the file-within-directory part of <code>$?</code>.
</p></dd>
</dl>

<p>These variables are used specially by GNU <code>make</code>:
</p>
<dl compact="compact">
<dt> <code>MAKEFILES</code></dt>
<dd>
<p>Makefiles to be read on every invocation of <code>make</code>.<br>
See section <a href="make_3.html#SEC17">The Variable <code>MAKEFILES</code></a>.
</p>
</dd>
<dt> <code>VPATH</code></dt>
<dd>
<p>Directory search path for files not found in the current directory.<br>
See section <a href="make_4.html#SEC39"><code>VPATH</code> Search Path for All Prerequisites</a>.
</p>
</dd>
<dt> <code>SHELL</code></dt>
<dd>
<p>The name of the system default command interpreter, usually &lsquo;<tt>/bin/sh</tt>&rsquo;.
You can set <code>SHELL</code> in the makefile to change the shell used to run
commands.  See section <a href="make_5.html#SEC61">Command Execution</a>.  The <code>SHELL</code>
variable is handled specially when importing from and exporting to the
environment.  See section <a href="make_5.html#SEC62">Choosing the Shell</a>.
</p>
</dd>
<dt> <code>MAKESHELL</code></dt>
<dd>
<p>On MS-DOS only, the name of the command interpreter that is to be used
by <code>make</code>.  This value takes precedence over the value of
<code>SHELL</code>.  See section <a href="make_5.html#SEC61">MAKESHELL variable</a>.
</p>
</dd>
<dt> <code>MAKE</code></dt>
<dd>
<p>The name with which <code>make</code> was invoked.
Using this variable in commands has special meaning.
See section <a href="make_5.html#SEC68">How the <code>MAKE</code> Variable Works</a>.
</p>
</dd>
<dt> <code>MAKELEVEL</code></dt>
<dd>
<p>The number of levels of recursion (sub-<code>make</code>s).<br>
See section <a href="make_5.html#SEC69">Communicating Variables to a Sub-<code>make</code></a>.
</p>
</dd>
<dt> <code>MAKEFLAGS</code></dt>
<dd>
<p>The flags given to <code>make</code>.  You can set this in the environment or
a makefile to set flags.<br>
See section <a href="make_5.html#SEC70">Communicating Options to a Sub-<code>make</code></a>.
</p>
<p>It is <em>never</em> appropriate to use <code>MAKEFLAGS</code> directly on a
command line: its contents may not be quoted correctly for use in the
shell.  Always allow recursive <code>make</code>'s to obtain these values
through the environment from its parent.
</p>
</dd>
<dt> <code>MAKECMDGOALS</code></dt>
<dd>
<p>The targets given to <code>make</code> on the command line.  Setting this
variable has no effect on the operation of <code>make</code>.<br>
See section <a href="make_9.html#SEC107">Arguments to Specify the Goals</a>.
</p>
</dd>
<dt> <code>CURDIR</code></dt>
<dd>
<p>Set to the pathname of the current working directory (after all
<code>-C</code> options are processed, if any).  Setting this variable has no
effect on the operation of <code>make</code>.<br>
See section <a href="make_5.html#SEC67">Recursive Use of <code>make</code></a>.
</p>
</dd>
<dt> <code>SUFFIXES</code></dt>
<dd>
<p>The default list of suffixes before <code>make</code> reads any makefiles.
</p>
</dd>
<dt> <code>.LIBPATTERNS</code></dt>
<dd><p>Defines the naming of the libraries <code>make</code> searches for, and their
order.<br>
See section <a href="make_4.html#SEC44">Directory Search for Link Libraries</a>.
</p></dd>
</dl>

<hr size="6">
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="make_14.html#SEC136" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
<td valign="middle" align="left">[<a href="make_16.html#SEC144" title="Next chapter"> &gt;&gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left">[<a href="make.html#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="make_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="make_19.html#SEC148" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="make_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<p>
 <font size="-1">
  This document was generated by <em>Manoj Srivastava</em> on <em>August, 17 2009</em> using <a href="http://www.nongnu.org/texi2html/"><em>texi2html 1.78</em></a>.
 </font>
 <br>

</p>
</body>
</html>
make-doc 3.81-5.1 / usr / share / doc / make-doc / make_15.html
