Source

SCons / src / engine / SCons / Tool / applelink.xml

<!--
__COPYRIGHT__

This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->
<tool name="applelink">
<summary>
Sets construction variables for the Apple linker
(similar to the GNU linker).
</summary>
<sets>
FRAMEWORKPATHPREFIX
_FRAMEWORKPATH
_FRAMEWORKS
LINKCOM
SHLINKFLAGS
SHLINKCOM
LDMODULEPREFIX
LDMODULESUFFIX
LDMODULEFLAGS
LDMODULECOM
</sets>
<uses>
FRAMEWORKSFLAGS
</uses>
</tool>

<cvar name="FRAMEWORKSFLAGS">">
<summary>
On Mac OS X with gcc,
general user-supplied frameworks options to be added at
the end of a command
line building a loadable module.
(This has been largely superseded by
the &cv-link-FRAMEWORKPATH;, &cv-link-FRAMEWORKPATHPREFIX;,
&cv-link-FRAMEWORKPREFIX; and &cv-link-FRAMEWORKS; variables
described above.)
</summary>
</cvar>

<cvar name="FRAMEWORKS">
<summary>
On Mac OS X with gcc, a list of the framework names to be linked into a
program or shared library or bundle.
The default value is the empty list.
For example:

<example>
 env.AppendUnique(FRAMEWORKS=Split('System Cocoa SystemConfiguration'))
</example>

</summary>
</cvar>

<cvar name="FRAMEWORKPREFIX">
<summary>
On Mac OS X with gcc,
the prefix to be used for linking in frameworks
(see &cv-link-FRAMEWORKS;).
The default value is
<option>-framework</option>.
</summary>
</cvar>

<cvar name="_FRAMEWORKS">
<summary>
On Mac OS X with gcc,
an automatically-generated construction variable
containing the linker command-line options
for linking with FRAMEWORKS.
</summary>
</cvar>

<cvar name="FRAMEWORKPATH">
<summary>
On Mac OS X with gcc,
a list containing the paths to search for frameworks.
Used by the compiler to find framework-style includes like
#include &lt;Fmwk/Header.h&gt;.
Used by the linker to find user-specified frameworks when linking (see
&cv-link-FRAMEWORKS;).
For example:

<example>
 env.AppendUnique(FRAMEWORKPATH='#myframeworkdir')
</example>

will add

<example>
  ... -Fmyframeworkdir
</example>

to the compiler and linker command lines.
</summary>
</cvar>

<cvar name="FRAMEWORKPATHPREFIX">
<summary>
On Mac OS X with gcc, the prefix to be used for the FRAMEWORKPATH entries.
(see &cv-link-FRAMEWORKPATH;).
The default value is
<option>-F</option>.
</summary>
</cvar>

<cvar name="_FRAMEWORKPATH">
<summary>
On Mac OS X with gcc, an automatically-generated construction variable
containing the linker command-line options corresponding to
&cv-link-FRAMEWORKPATH;.
</summary>
</cvar>