<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 35. Common Variables</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"><link rel="start" href="index.html" title="A-A-P Recipe Executive"><link rel="up" href="reference.html" title="Part III. Reference Manual"><link rel="prev" href="ref-varscope.html" title="Chapter 34. Variables and Scopes"><link rel="next" href="ref-assign.html" title="Chapter 36. Assignments"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table width="100%" id="navtable"><tbody><tr><td align="left" class="left" width="33%"><b><a href="http://www.a-a-p.org">A-A-P home page</a></b></td><td align="center" class="center" width="34%"><b><a href="index.html">A-A-P Recipe Executive</a></b></td><td align="right" class="right" width="33%"></td></tr><tr><td align="left" class="left"><a accesskey="p" href="ref-varscope.html">Prev</a></td><td align="center" class="center">Reference Manual</td><td align="right" class="right"><a accesskey="n" href="ref-assign.html">Next</a></td></tr></tbody></table><hr><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="ref-variables"></a>Chapter 35. Common Variables</h2></div></div></div><p>
This is a complete list of the variables that are currently used inside <span class="application">Aap</span>,
except the variables specifically used for porting, see
<a href="user-porting.html" title="Chapter 22. Porting an Application">Chapter 22, <i>Porting an Application</i></a> for that.
</p><p>
This list will be extended when more features are being added.
To avoid the problem that your own variables interfere with the use of common
<span class="application">Aap</span> variables, do not use variable names with only upper case letters.
Suggested scheme:
</p><div class="table"><a name="id2672693"></a><p class="title"><b>Table 35.1. Naming scheme for variables</b></p><div class="table-contents"><table summary="Naming scheme for variables" border="0"><colgroup><col width="200"><col></colgroup><tbody><tr><td>$STANDARD_VARIABLE</td><td>global variable defined by <span class="application">Aap</span></td></tr><tr><td>$YourVariable</td><td>global variable used in your recipe(s)</td></tr><tr><td>$local_variable</td><td>local variable used in build commands</td></tr></tbody></table></div></div><p><br class="table-break">
</p><p>
The following table lists the predefined variables. These types are used:
</p><div class="informaltable"><table border="0"><colgroup><col width="100"><col></colgroup><tbody><tr><td><span class="application">Aap</span></td><td>set by <span class="application">Aap</span> and mostly not changed by the user</td></tr><tr><td>conf</td><td>set depending on the configuration of the system, may be
modified by the user</td></tr><tr><td>user</td><td>set by the user</td></tr><tr><td>auto</td><td>value updated when using commands (e.g.,
<code class="computeroutput">:program</code>), may also
be appended to by the user</td></tr></tbody></table></div><p>
</p><div class="table"><a name="id2673646"></a><p class="title"><b>Table 35.2. Standard Variables</b></p><div class="table-contents"><table summary="Standard Variables" border="0"><colgroup><col width="170"><col></colgroup><thead><tr><th>name</th><th>type </th><th>description</th></tr></thead><tbody><tr><td valign="top"><a name="var-hash"></a> $# </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> A single #. OBSOLETE, use $(#) </td></tr><tr><td valign="top"><a name="var-dollar"></a> $$ </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> A single $. OBSOLETE, use $($) </td></tr><tr><td valign="top"><a name="var-aap"></a> $AAP </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Command that was used to start <span class="application">Aap</span>, including the Python
interpreter used. Example:
<pre class="programlisting">
:asroot $AAP install
</pre>
Note that this can be a command and an argument, e.g.:
"/usr/local/bin/python1.5 /usr/local/share/aap/Main.py".
</td></tr><tr><td valign="top"><a name="var-aapsysdir"></a> $AAPSYSDIR </td><td valign="top"> conf </td><td valign="top"> List of system directories to search for startup recipes,
modules and tools. Default value is
<code class="filename">/usr/local/share/aap</code>, although this may be different on
some systems. When the directory doesn't exist the default is empty.
</td></tr><tr><td valign="top"><a name="var-aapversion"></a> $AAPVERSION </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Version number of <span class="application">Aap</span>. E.g., 31 (version 0.031) or 1003 (version
1.003). Also see <a href="ref-variables.html#var-versionstr">$VERSIONSTR</a>.
</td></tr><tr><td valign="top"><a name="var-ar"></a> $AR </td><td valign="top"> conf </td><td valign="top"> Name of archiver program: combines object files into a static libray.
</td></tr><tr><td valign="top"><a name="var-arflags"></a> $ARFLAGS </td><td valign="top"> user </td><td valign="top"> Arguments for $AR (default: "r" or "/nologo"). </td></tr><tr><td valign="top"><a name="var-bdir"></a> $BDIR </td><td valign="top"> conf </td><td valign="top"> Directory to write build files in. Modified by the
<a href="ref-commands.html#cmd-variant">:variant</a> command. </td></tr><tr><td valign="top"><a name="var-br"></a> $BR </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> A line break. </td></tr><tr><td valign="top"><a name="var-browser"></a> $BROWSER </td><td valign="top"> conf </td><td valign="top"> HTML browser to be used for the "view" action for HTML, XML and PHP
files. The default value
comes from the "BROWSER" environment variable or a list of known browser
commands (netscape mozilla konquerer grail iexplore mosaic lynx w3m).
</td></tr><tr><td valign="top"><a name="var-build-action"></a> $BUILD_ACTION </td><td valign="top"> conf </td><td valign="top"> When not empty, specifies the action name to be executed for building.
Usually for building a program from object files with a specific tool.
A "buildaction" attribute on one of the object files is used before
$BUILD_ACTION.
See <a href="user-tools.html" title="Chapter 30. Customizing Default Tools">Chapter 30, <i>Customizing Default Tools</i></a>.</td></tr><tr><td valign="top"><a name="var-builddll-action"></a> $BUILDDLL_ACTION </td><td valign="top"> conf </td><td valign="top"> When not empty, specifies the action name to be executed
for building a dynamic (shared) library.
A "buildaction" attribute on one of the object files should be respected by
the action specified with $BUILDDLL_ACTION.
See <a href="user-tools.html" title="Chapter 30. Customizing Default Tools">Chapter 30, <i>Customizing Default Tools</i></a>.</td></tr><tr><td valign="top"><a name="var-buildlib-action"></a> $BUILDLIB_ACTION </td><td valign="top"> conf </td><td valign="top"> When not empty, specifies the action name to be executed
for building a static library.
A "buildaction" attribute on one of the object files should be respected by
the action specified with $BUILDLIB_ACTION.
See <a href="user-tools.html" title="Chapter 30. Customizing Default Tools">Chapter 30, <i>Customizing Default Tools</i></a>.</td></tr><tr><td valign="top"><a name="var-bunzip2"></a> $BUNZIP2 </td><td valign="top"> conf </td><td valign="top"> Program to use for ".bz2" compressed files. Default value
is "bunzip2". </td></tr><tr><td valign="top"><a name="var-c-compile-action"></a> $C_COMPILE_ACTION </td><td valign="top"> conf </td><td valign="top"> When not empty, specifies the action name to be executed for compiling
a C file into an object, dllobject, libobject or ltobject file. See
<a href="user-tools.html" title="Chapter 30. Customizing Default Tools">Chapter 30, <i>Customizing Default Tools</i></a>.</td></tr><tr><td valign="top"><a name="var-cxx-compile-action"></a> $CXX_COMPILE_ACTION </td><td valign="top"> conf </td><td valign="top"> When not empty, specifies the action name to be executed for compiling
a C++ file into an object, dllobject, libobject or ltobject file. See
<a href="user-tools.html" title="Chapter 30. Customizing Default Tools">Chapter 30, <i>Customizing Default Tools</i></a>.</td></tr><tr><td valign="top"><a name="var-cachepath"></a> $CACHEPATH </td><td valign="top"> conf </td><td valign="top"> List of directories to search for cached downloaded
files.
Default for Unix:
<div class="literallayout"><p> /var/aap/cache<br>
~/.aap/cache<br>
aap/cache<br>
</p></div>
For MS-Windows, OS/2:
<div class="literallayout"><p> $HOME/aap/cache<br>
aap/cache<br>
</p></div>
Directories that don't exist are skipped.
When using a relative name, it is relative to the
current recipe. Thus the recipe specified with
<code class="computeroutput">:child dir/main.aap</code> uses a different cache
directory.
When this variable is set, currently cached files are
flushed. Otherwise this only happens when exiting.
Thus this command can be used to flush the cache:
<pre class="programlisting">
CACHEPATH = $CACHEPATH
</pre>
</td></tr><tr><td valign="top"><a name="var-cacheupdate"></a> $CACHEUPDATE </td><td valign="top"> user </td><td valign="top"> Timeout after which cached files may be downloaded again. For the
possible values see the <a href="user-fetch.html#cache-update">explanation in the user
manual</a>. </td></tr><tr><td valign="top"><a name="var-cc"></a> $CC </td><td valign="top"> conf </td><td valign="top"> Command to execute the C compiler (default: "cc"). </td></tr><tr><td valign="top"><a name="var-cflags"></a> $CFLAGS </td><td valign="top"> user </td><td valign="top"> Arguments always used for $CC. NOTE: it's not $CCFLAGS! This is
inconsistent, used for historic reasons.</td></tr><tr><td valign="top"><a name="var-childdir"></a> $CHILDDIR </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> In a child recipe: The directory of the child recipe relative to the
parent recipe. When using: :child subdir/main.aap $CHILDDIR will be "subdir"
in the child recipe. </td></tr><tr><td valign="top"><a name="var-cleandirs"></a> $CLEANDIRS </td><td valign="top"> auto </td><td valign="top"> Names of directories that the "clean" target should remove. </td></tr><tr><td valign="top"><a name="var-cleanfiles"></a> $CLEANFILES </td><td valign="top"> auto </td><td valign="top"> Names of files that the "clean" target should remove.
The <code class="computeroutput">:program</code> command adds files to this. </td></tr><tr><td valign="top"><a name="var-cleanmoredirs"></a> $CLEANMOREDIRS </td><td valign="top"> user </td><td valign="top"> Names of directories that the "cleanmore" target should remove.
</td></tr><tr><td valign="top"><a name="var-cleanmorefiles"></a> $CLEANMOREFILES </td><td valign="top"> user </td><td valign="top"> Names of files that the "cleanmore" target should remove. </td></tr><tr><td valign="top"><a name="var-compile-action"></a> $COMPILE_ACTION </td><td valign="top"> conf </td><td valign="top"> Obsolete. See <a href="ref-variables.html#var-c-compile-action">$C_COMPILE_ACTION</a> and <a href="ref-variables.html#var-cxx-compile-action">$CXX_COMPILE_ACTION</a>.
</td></tr><tr><td valign="top"><a name="var-confdir"></a> $CONFDIR </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Sub-directory to install configuration files into. Default value:
"etc/".</td></tr><tr><td valign="top"><a name="var-confmode"></a> $CONFMODE </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Mode to use for installed configuration files. Default value: "0644"
(read/write for the user, readable for the group and others).</td></tr><tr><td valign="top"><a name="var-cppflags"></a> $CPPFLAGS </td><td valign="top"> user </td><td valign="top"> Arguments for $CC when compiling sources (not when linking objects).
These are raw arguments, not always portable. Use $INCLUDE and $DEFINE when
possible. </td></tr><tr><td valign="top"><a name="var-cvs"></a> $CVS </td><td valign="top"> conf </td><td valign="top"> Cvs program to use. No arguments are allowed. May
include spaces. When not set "cvs" is used. </td></tr><tr><td valign="top"><a name="var-cvscmd"></a> $CVSCMD </td><td valign="top"> user </td><td valign="top"> Cvs command to use. This overrules $CVS and may include
arguments. E.g. "cvs -z 9". Spaces in the program name must be escaped as
expected for the shell. When not set $CVS is used. </td></tr><tr><td valign="top"><a name="var-cxx"></a> $CXX </td><td valign="top"> conf </td><td valign="top"> Command for compiling C++ files </td></tr><tr><td valign="top"><a name="var-cxxflags"></a> $CXXFLAGS </td><td valign="top"> user </td><td valign="top"> Arguments always used for $CXX. </td></tr><tr><td valign="top"><a name="var-shlink"></a> $CXXSHLINK </td><td valign="top"> conf </td><td valign="top"> Name of linker used to combine object files from C++
sources into a shared (dynamic)
library. Default value: "$CXX" for Unix, not used for MS-Windows. </td></tr><tr><td valign="top"><a name="var-shlinkflags"></a> $CXXSHLINKFLAGS </td><td valign="top"> user </td><td valign="top"> Arguments for $CXXSHLINK. Default value: "-shared" for
Unix, not used for MS-Windows. </td></tr><tr><td valign="top"><a name="var-datadir"></a> $DATADIR </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Sub-directory to install data files into. Default value:
"share/".</td></tr><tr><td valign="top"><a name="var-datamode"></a> $DATAMODE </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Mode to use for installed data files.
Default value: "0644"
(read/write for the user, readable for the group and others).</td></tr><tr><td valign="top"><a name="var-datestr"></a> $DATESTR </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top">Date as a string in the form "2002 Month 11". This does not change
while <span class="application">Aap</span> is running.
Also see <a href="ref-variables.html#var-timestr">$TIMESTR</a> and
<a href="ref-variables.html#var-gmtime">$GMTIME</a>.
</td></tr><tr><td valign="top"><a name="var-debug"></a> $DEBUG </td><td valign="top"> user </td><td valign="top"> The kind of debugging to be done. "yes" means debugging is enabled.
The variable is not set by default.
For an example see
<a href="tutor-variant.html#build-variant">the tutorial</a>.</td></tr><tr><td valign="top"><a name="var-defaultcheck"></a> $DEFAULTCHECK </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Check to use when none is speficied. Defaults to "md5", can be set to
"time" or "newer". "time" means that a file is outdated when its timestamp is
different from when it was last used. "newer" means a target is outdated when
one of the source files has a more recent timestamp.
Also see the <a href="ref-attributes.html#check-attribute">check</a> attribute.
</td></tr><tr><td valign="top"><a name="var-defer-action-name"></a> $DEFER_ACTION_NAME </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Only available in the commands of an action: the name the
action to which the work should be deferred.
</td></tr><tr><td valign="top"><a name="var-define"></a> $DEFINE </td><td valign="top"> user </td><td valign="top"> Preprocessor symbols. Used in the same place as
<a href="ref-variables.html#var-cppflags">$CPPFLAGS</a>.
Form: "-DNAME" or "-DNAME=value". The tools will convert this to the argument
the compiler actually uses. </td></tr><tr><td valign="top"><a name="var-destdir"></a> $DESTDIR </td><td valign="top"> user </td><td valign="top"> Directory used to install in a different root directory.
Useful for a "fake" install.
Also see <a href="ref-variables.html#var-prefix">$PREFIX</a>.
</td></tr><tr><td valign="top"><a name="var-distdirs"></a> $DISTDIRS </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Names of directories that should be distributed as a whole. If there
is one file in this directory that should not be distributed use $DISTFILES.
</td></tr><tr><td valign="top"><a name="var-distfiles"></a> $DISTFILES </td><td valign="top"> auto </td><td valign="top"> Names of files that are used as a source in the recipe and should be
distributed. The <code class="computeroutput">:program</code> command adds files to this.
</td></tr><tr><td valign="top"><a name="var-dllcflags"></a> $DLLCFLAGS </td><td valign="top"> user </td><td valign="top"> Extra arguments to compile a C program into a dynamic (shared) object
file.
The default is currently "-fPIC", but since that only works with gcc it
will soon be changed. </td></tr><tr><td valign="top"><a name="var-dllcxxflags"></a> $DLLCXXFLAGS </td><td valign="top"> user </td><td valign="top"> Extra arguments to compile a C++ program into a dynamic (shared)
object file.
The default is currently "-fPIC", but since that only works with gcc it
will soon be changed. </td></tr><tr><td valign="top"><a name="var-dlldir"></a> $DLLDIR </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Sub-directory to install shared (dynamic) library files into.
Default value: "lib/". </td></tr><tr><td valign="top"><a name="var-dllmode"></a> $DLLMODE </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Mode to use for installed shared (dynamic) library files.
Default value: "0755"
(readable and executable for everybody, writable for the user).</td></tr><tr><td valign="top"><a name="var-dllobjsuf"></a> $DLLOBJSUF </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Suffix for an object file to be included in a dynamic (shared)
library. Default: ".o" for Unix, ".obj" for MS-Windows. </td></tr><tr><td valign="top"><a name="var-dllpre"></a> $DLLPRE </td><td valign="top"> conf </td><td valign="top"> Prefix for a dynamic (shared) library. Default: "lib" for Unix, empty
for others.</td></tr><tr><td valign="top"><a name="var-dllsuf"></a> $DLLSUF </td><td valign="top"> conf </td><td valign="top"> Suffix for a dynamic (shared) library. Default: ".dll" for
MS-Windows, ".so" for Unix. </td></tr><tr><td valign="top"><a name="var-editor"></a> $EDITOR </td><td valign="top"> conf </td><td valign="top"> Editor to be used for the "edit" action. The default value comes from
the "VISUAL" or "EDITOR" environment variable. When these are not defined
it falls back to "vi" On Unix and "notepad" otherwise.
</td></tr><tr><td valign="top"><a name="var-execdir"></a> $EXECDIR </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Sub-directory to install programs files into.
Default value is "bin/".</td></tr><tr><td valign="top"><a name="var-execmode"></a> $EXECMODE </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Mode to use for installed programs.
Default value: "0755"
(readable and executable for everybody, writable for the user).</td></tr><tr><td valign="top"><a name="var-exesuf"></a> $EXESUF </td><td valign="top"> conf </td><td valign="top"> Suffix for an executable file. Default value: ".exe" for MS-Windows,
empty for others.</td></tr><tr><td valign="top"><a name="var-gmtime"></a> $GMTIME </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Time in seconds since 1970 Jan 1.
This always uses GMT, it ignores time zones and daylight saving. But it
depends on the system time to be set correctly! The value does not change
while <span class="application">Aap</span> is running, it is the time when <span class="application">Aap</span> was started.
Also see <a href="ref-variables.html#var-timestr">$TIMESTR</a> and
<a href="ref-variables.html#var-datestr">$DATESTR</a>.
</td></tr><tr><td valign="top"><a name="var-groupcount"></a> $GROUPCOUNT </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Number of files handled at a time for uploading,
downloading and version control commands. The default value is 20. Set it
to a smaller number when using big files. Set it to a large number when you
need to enter a password every time.
</td></tr><tr><td valign="top"><a name="var-hasgcc"></a> $HASGCC </td><td valign="top"> conf </td><td valign="top"> Indicates whether gcc can be used to scan C sources for
dependencies. It is initialized empty. When dependency scanning is to be
done a configure check is run to see if $CC can be used for dependency
checking. $HASGCC is then set to "yes" or "no". You can set $HASGCC to
empty to force running the check again, set it to "no" to avoid using $CC
for dependency checking or set it to "yes" to skip the configure check and
use $CC for dependency checking.
</td></tr><tr><td valign="top"><a name="var-hasgccxx"></a> $HASGCCXX </td><td valign="top"> conf </td><td valign="top"> Indicates whether gcc can be used to scan C++ sources for
dependencies. Just like
<a href="ref-variables.html#var-hasgcc">$HASGCC</a> does this for C.
</td></tr><tr><td valign="top"><a name="var-include"></a> $INCLUDE </td><td valign="top"> user </td><td valign="top"> Directories to find include files. Used in the same place as
<a href="ref-variables.html#var-cppflags">$CPPFLAGS</a>.
Form: "-Ipath". The tools will convert this to the argument the
compiler actually uses. </td></tr><tr><td valign="top"><a name="var-includedir"></a> $INCLUDEDIR </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Sub-directory to install include files into. Default value:
"include/".</td></tr><tr><td valign="top"><a name="var-includemode"></a> $INCLUDEMODE </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Mode to use for installed include files.
Default value: "0644"
(read/write for the user, readable for the group and others).</td></tr><tr><td valign="top"><a name="var-infodir"></a> $INFODIR </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Sub-directory to install info files into. Default value: "info/".</td></tr><tr><td valign="top"><a name="var-infomode"></a> $INFOMODE </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Mode to use for installed info files.
Default value: "0644"
(read/write for the user, readable for the group and others).</td></tr><tr><td valign="top"><a name="var-ld"></a> $LD </td><td valign="top"> conf </td><td valign="top"> Command to execute the linker. The default is empty, in which case
$CC is used. But for C++ object files (cxx_build action) the default is $CXX.
</td></tr><tr><td valign="top"><a name="var-ldflags"></a> $LDFLAGS </td><td valign="top"> user </td><td valign="top"> Arguments for linking, before the object files. The default is
empty.</td></tr><tr><td valign="top"><a name="var-lex"></a> $LEX </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Program to turn a lex file into C.
The default is empty.
When the "lex" action is invoked <span class="application">Aap</span> will search for "flex" and "lex" and
set $LEX to the found program.
</td></tr><tr><td valign="top"><a name="var-lexflags"></a> $LEXFLAGS </td><td valign="top"> user </td><td valign="top"> Flags for $LEX. There is no default value.</td></tr><tr><td valign="top"><a name="var-lexpp"></a> $LEXPP </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Program to turn a lex++ file into C++.
The default is empty.
When the "lexpp" action is invoked <span class="application">Aap</span> will search for "flex++", "lex++",
"flex" and "lex" and set $LEX to the found program.
</td></tr><tr><td valign="top"><a name="var-lexppflags"></a> $LEXPPFLAGS </td><td valign="top"> user </td><td valign="top"> Flags for $LEXPP. There is no default value.</td></tr><tr><td valign="top"><a name="var-libdir"></a> $LIBDIR </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Sub-directory to install static library files into. Default value:
"lib/".</td></tr><tr><td valign="top"><a name="var-libmode"></a> $LIBMODE </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Mode to use for installed static library files.
Default value: "0644"
(read/write for the user, readable for the group and others).</td></tr><tr><td valign="top"><a name="var-libobjsuf"></a> $LIBOBJSUF </td><td valign="top"> conf </td><td valign="top"> Suffix for an object file to be included in a static library. Default
value: ".o" for Unix, ".obj" for MS-Windows. </td></tr><tr><td valign="top"><a name="var-libpre"></a> $LIBPRE </td><td valign="top"> conf </td><td valign="top"> Prefix for static library. The default is empty on MS-Windows, "lib"
on Unix. </td></tr><tr><td valign="top"><a name="var-libs"></a> $LIBS </td><td valign="top"> user </td><td valign="top"> Arguments for linking, after the object files. Convention: Always use
"-lname", the tools will translate it into the flags that the linker actually
uses. Also see <a href="ref-variables.html#var-ltlibs">$LTLIBS</a></td></tr><tr><td valign="top"><a name="var-libsuf"></a> $LIBSUF </td><td valign="top"> conf </td><td valign="top"> Suffix for a static library. Default value: ".lib" for MS-Windows,
".a" for Unix.
</td></tr><tr><td valign="top"><a name="var-libtool"></a> $LIBTOOL </td><td valign="top"> conf </td><td valign="top"> Actual name of the "libtool" program, used to build libtool libraries
and for building programs that use libtool libraries. Default value:
"libtool --silent".
</td></tr><tr><td valign="top"><a name="var-lnksuf"></a> $LNKSUF </td><td valign="top"> conf </td><td valign="top"> Suffix for a (symbolic) link. Default is empty. </td></tr><tr><td valign="top"><a name="var-logentry"></a> $LOGENTRY </td><td valign="top"> user </td><td valign="top"> Default message for the version control change log. Used when a file
is committed (also when it was deleted and the delete is committed).</td></tr><tr><td valign="top"><a name="var-ltobjsuf"></a> $LTOBJSUF </td><td valign="top"> conf </td><td valign="top"> Suffix for an object file to be included in a libtool library.
Default value: ".lo". </td></tr><tr><td valign="top"><a name="var-ltlibpre"></a> $LTLIBPRE </td><td valign="top"> conf </td><td valign="top"> Prefix for libtool library. The default is "lib". </td></tr><tr><td valign="top"><a name="var-ltlibs"></a> $LTLIBS </td><td valign="top"> user </td><td valign="top"> Arguments for linking, after the object files but before
<a href="ref-variables.html#var-ltlibs">$LIBS</a>.
When <a href="ref-variables.html#var-ltlibs">$LTLIBS</a> is set "libtool" will be used
for building, see <a href="ref-variables.html#var-libtool">$LIBTOOL</a> (when the
platform supports it).
Convention: Always use "-lname", the tools will translate it into the flags
that the linker actually uses.</td></tr><tr><td valign="top"><a name="var-ltlibsuf"></a> $LTLIBSUF </td><td valign="top"> conf </td><td valign="top"> Suffix for a libtool library. Default value: ".la". </td></tr><tr><td valign="top"><a name="var-mandir"></a> $MANDIR </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Sub-directory to install man pages into. Default value: "man/".
Note that <span class="application">Aap</span> will append "man1", "man2", etc. when installing manual pages.
</td></tr><tr><td valign="top"><a name="var-manmode"></a> $MANMODE </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Mode to use for installed man pages.
Default value: "0644"
(read/write for the user, readable for the group and others).</td></tr><tr><td valign="top"><a name="var-message"></a> $MESSAGE </td><td valign="top"> user </td><td valign="top">
<p>
Comma separated list of message types which are printed. Possible
values:
</p><div class="literallayout"><p> note note message<br>
warning warning message<br>
error error message<br>
system executed system command<br>
result result of :sys command<br>
info informational message<br>
extra extra informational message<br>
changedir changing directories<br>
depend message about dependencies<br>
all all messages<br>
</p></div><p>
Default value: "error,warning,system,info".
When the <a href="ref-arguments.html#option-silent">-s</a> or <a href="ref-arguments.html#option-silent">--silent</a> option is used: "error".
When the <a href="ref-arguments.html#option-verbose">-v</a> or <a href="ref-arguments.html#option-verbose">--verbose</a> option is used: all possible
values.
</p>
<p>
Instead of removing "print" from $MESSAGE it is possible to use the
<a href="ref-commands.html#cmd-log">:log</a> command to write text to the log file.
</p>
</td></tr><tr><td valign="top"><a name="var-objsuf"></a> $OBJSUF </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Suffix for an object file. Default value: ".o" for Unix, ".obj" for
MS-Windows.
</td></tr><tr><td valign="top"><a name="var-optimize"></a> $OPTIMIZE </td><td valign="top"> user </td><td valign="top"> A number from zero to nine. Zero means no optimization, nine means
maximum optimization. The default is two.
For an example see
<a href="tutor-variant.html#build-variant">the tutorial</a>.</td></tr><tr><td valign="top"><a name="var-osname"></a> $OSNAME </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top">
The name of the operating system and its version (on systems that support it).
For instance, FreeBSD 4.9 gives $OSNAME the value
<code class="literal">FreeBSD4_9_STABLE</code>.
Systems that do not support name and version yield
what Python's <code class="literal">os.name</code> yields -
usually the same as $OSTYPE except for MS-Windows and MS-DOS.
This name is usually incorporated in <a href="ref-variables.html#var-bdir">$BDIR</a>
as well, as <code class="literal">build-<em class="replaceable"><code>OSNAME</code></em></code>.
</td></tr><tr><td valign="top"><a name="var-ostype"></a> $OSTYPE </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top">
Type of operating system used:
<div class="literallayout"><p> posix Unix-like (Linux, BSD)<br>
mswin MS-Windows (98, XP)<br>
msdos MS-DOS (not MS-Windows)<br>
os2 OS/2<br>
mac Macintosh (OS X gives "posix")<br>
java Java OS<br>
riscos Risc OS<br>
ce MS-Windows CE<br>
</p></div>
</td></tr><tr><td valign="top"><a name="var-painter"></a> $PAINTER </td><td valign="top"> conf </td><td valign="top"> Graphical editor to be used for the "edit" action. The default value
comes from the "PAINTER" environment variable.
</td></tr><tr><td valign="top"><a name="var-prefix"></a> $PREFIX </td><td valign="top"> user </td><td valign="top"> Directory normally used for the top directory to install
to. When empty it defaults to "/usr/local". Use a single slash to install
in the root directory.
Also see <a href="ref-variables.html#var-destdir">$DESTDIR</a>.
</td></tr><tr><td valign="top"><a name="var-ranlib"></a> $RANLIB </td><td valign="top"> conf </td><td valign="top"> Program to run on created static library. Default is not set. When
the "ranlib" action is invoked it will search for the "ranlib" program and set
the $RANLIB variable.</td></tr><tr><td valign="top"><a name="var-ranlibflags"></a> $RANLIBFLAGS </td><td valign="top"> user </td><td valign="top"> Arguments for $RANLIB. The default is not set. </td></tr><tr><td valign="top"><a name="var-rcp"></a> $RCP </td><td valign="top"> conf </td><td valign="top"> Remote copy program to use for rcp://. The default is not set, which
means "rcp -p" is used. May also include arguments. </td></tr><tr><td valign="top"><a name="var-recipeversion"></a> $RECIPEVERSION </td><td valign="top"> user </td><td valign="top"> Version of A-A-P the recipe was written for, set by the user. Uses
the format "1.0", "1.3". Currently not used, but in a later version of <span class="application">Aap</span>
it can be use for backward compatible behavior.</td></tr><tr><td valign="top"><a name="var-rsync"></a> $RSYNC </td><td valign="top"> user </td><td valign="top"> Remote sync program to use for rsync://. The default is not set,
which means "rsync -p --rsh=ssh --copy-links" is
used (preserve file attributes, use secure shell connection, copy what
symbolic link points to). </td></tr><tr><td valign="top"><a name="var-sbindir"></a> $SBINDIR </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Sub-directory to install "sbin" files into. Default value:
"sbin/".</td></tr><tr><td valign="top"><a name="var-scp"></a> $SCP </td><td valign="top"> user </td><td valign="top"> Secure copy program to use for scp://. The default is not set, which
means "scp -C -p" is used. May also include arguments, e.g.: "scp -i
c:/private/keyfile". </td></tr><tr><td valign="top"><a name="var-shlink"></a> $SHLINK </td><td valign="top"> conf </td><td valign="top"> Name of linker used to combine object files into a shared (dynamic)
library. Default value: "ld" for Unix, "link" for MS-Windows. </td></tr><tr><td valign="top"><a name="var-shlinkflags"></a> $SHLINKFLAGS </td><td valign="top"> user </td><td valign="top"> Arguments for $SHLINK. Default value: "-shared" for Unix, "/nologo
/dll" for MS-Windows. </td></tr><tr><td valign="top"><a name="var-source"></a> $SOURCE </td><td valign="top"> user </td><td valign="top"> List of source files. OBSOLETE </td></tr><tr><td valign="top"><a name="var-strip"></a> $STRIP </td><td valign="top"> conf </td><td valign="top"> Program to run on installed program. Default is empty. When the
"strip" action is involved <span class="application">Aap</span> will search for the "strip" command and set
$STRIP to the found program.</td></tr><tr><td valign="top"><a name="var-stripflags"></a> $STRIPFLAGS </td><td valign="top"> user </td><td valign="top"> Arguments for $STRIP. The default is not set. </td></tr><tr><td valign="top"><a name="var-tar"></a> $TAR </td><td valign="top"> conf </td><td valign="top"> Tar program to use. Default value is "tar". </td></tr><tr><td valign="top"><a name="var-target"></a> $TARGET </td><td valign="top"> user </td><td valign="top"> List of target files, usually the name of the resulting program.
OBSOLETE </td></tr><tr><td valign="top"><a name="var-targetarg"></a> $TARGETARG </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Target(s) specified on the command line. </td></tr><tr><td valign="top"><a name="var-timestr"></a> $TIMESTR </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Time as a string in the form "23:11:09". This always uses GMT, it
ignores time zones and daylight saving. But it depends on the system time to
be set correctly! The value does not change while <span class="application">Aap</span> is running, it is the
time when <span class="application">Aap</span> was started.
Also see <a href="ref-variables.html#var-gmtime">$GMTIME</a> and
<a href="ref-variables.html#var-datestr">$DATESTR</a>.
</td></tr><tr><td valign="top"><a name="var-topdir"></a> $TOPDIR </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> In a child recipe: The directory of the child recipe relative to the
toplevel recipe. When using: ":child subdir/main.aap" in the toplevel recipe,
$TOPDIR will be "subdir" in the child recipe. In the toplevel recipe $TOPDIR
is empty.</td></tr><tr><td valign="top"><a name="var-unzip"></a> $UNZIP </td><td valign="top"> conf </td><td valign="top"> Unzip program to use for ".zip" archives. Default value
is "unzip". </td></tr><tr><td valign="top"><a name="var-versionstr"></a> $VERSIONSTR </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Version of A-A-P being used as a string, e.g., "0.100".
Also see <a href="ref-variables.html#var-aapversion">$AAPVERSION</a>.
</td></tr><tr><td valign="top"><a name="var-yacc"></a> $YACC </td><td valign="top"> conf </td><td valign="top"> Program to turn a yacc file into C.
The default value is empty. When
the "yacc" action is invoked <span class="application">Aap</span> will search for "yacc" and "bison" and set
$YACC to the found program.
</td></tr><tr><td valign="top"><a name="var-yaccflags"></a> $YACCFLAGS </td><td valign="top"> user </td><td valign="top"> Flags for $YACC. The default value is not set.</td></tr><tr><td valign="top"><a name="var-yaccpp"></a> $YACCPP </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Program to turn a yacc++ file into C++.
The default value is empty. When
the "yaccpp" action is invoked <span class="application">Aap</span> will search for "bison" and "yacc" and
set $YACC to the found program.
</td></tr><tr><td valign="top"><a name="var-yaccppflags"></a> $YACCPPFLAGS </td><td valign="top"> user </td><td valign="top"> Flags for $YACCPP. The default value is not set.</td></tr><tr><td valign="top"><a name="var-bar-old"></a> $bar </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> A single |. OBSOLETE, use $(|). </td></tr><tr><td valign="top"><a name="var-br-old"></a> $br </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> A line break. OBSOLETE, use $BR </td></tr><tr><td valign="top"><a name="var-empty-old"></a> $empty </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> Empty. Can be used to get leading white space with
<code class="computeroutput">:print</code>.
OBSOLETE, use $( ) </td></tr><tr><td valign="top"><a name="var-gt-old"></a> $gt </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> A single >. OBSOLETE, use $(>). </td></tr><tr><td valign="top"><a name="var-lt-old"></a> $lt </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> A single <. OBSOLETE, use $(<). </td></tr><tr><td valign="top"><a name="var-pipe-old"></a> $pipe </td><td valign="top"> <span class="application">Aap</span> </td><td valign="top"> A single |. OBSOLETE, use $(|). </td></tr></tbody></table></div></div><br class="table-break"></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ref-varscope.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ref-assign.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 34. Variables and Scopes </td><td width="20%" align="center"><a accesskey="h" href="index.html">
Contents</a></td><td width="40%" align="right" valign="top"> Chapter 36. Assignments</td></tr></table></div></body></html>
