summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/link.xml
blob: b9a6a11e4930393c5402f0e8e6240c45fb5eaabc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<!--
Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 The SCons Foundation

This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->
<tool name="link">
<summary>
Sets construction variables for generic POSIX linkers.
</summary>
<sets>
SHLINK
SHLINKFLAGS
SHLINKCOM
LINK
LINKFLAGS
LINKCOM
LIBDIRPREFIX
LIBDIRSUFFIX
LIBLINKPREFIX
LIBLINKSUFFIX
SHLIBSUFFIX
LDMODULE
LDMODULEPREFIX
LDMODULESUFFIX
LDMODULEFLAGS
LDMODULECOM
</sets>
<uses>
SHLINKCOMSTR
LINKCOMSTR
LDMODULECOMSTR
</uses>
</tool>

<cvar name="LDMODULE">
<summary>
The linker for building loadable modules.
By default, this is the same as &cv-link-SHLINK;.
</summary>
</cvar>

<cvar name="LDMODULECOM">
<summary>
The command line for building loadable modules.
On Mac OS X, this uses the &cv-link-LDMODULE;,
&cv-link-LDMODULEFLAGS; and
&cv-link-FRAMEWORKSFLAGS; variables.
On other systems, this is the same as &cv-link-SHLINK;.
</summary>
</cvar>

<cvar name="LDMODULECOMSTR">
<summary>
The string displayed when building loadable modules.
If this is not set, then &cv-link-LDMODULECOM; (the command line) is displayed.
</summary>
</cvar>

<cvar name="LDMODULEFLAGS">
<summary>
General user options passed to the linker for building loadable modules.
</summary>
</cvar>

<cvar name="LDMODULEPREFIX">
<summary>
The prefix used for loadable module file names.
On Mac OS X, this is null;
on other systems, this is
the same as &cv-link-SHLIBPREFIX;.
</summary>
</cvar>

<cvar name="LDMODULESUFFIX">
<summary>
The suffix used for loadable module file names.
On Mac OS X, this is null;
on other systems, this is
the same as $SHLIBSUFFIX.
</summary>
</cvar>

<cvar name="LINK">
<summary>
The linker.
</summary>
</cvar>

<cvar name="LINKCOM">
<summary>
The command line used to link object files into an executable.
</summary>
</cvar>

<cvar name="LINKCOMSTR">
<summary>
The string displayed when object files
are linked into an executable.
If this is not set, then &cv-link-LINKCOM; (the command line) is displayed.

<example>
env = Environment(LINKCOMSTR = "Linking $TARGET")
</example>
</summary>
</cvar>

<cvar name="LINKFLAGS">
<summary>
General user options passed to the linker.
Note that this variable should
<emphasis>not</emphasis>
contain
<option>-l</option>
(or similar) options for linking with the libraries listed in &cv-link-LIBS;,
nor
<option>-L</option>
(or similar) library search path options
that scons generates automatically from &cv-link-LIBPATH;.
See
&cv-link-_LIBFLAGS;
above,
for the variable that expands to library-link options,
and
&cv-link-_LIBDIRFLAGS;
above,
for the variable that expands to library search path options.
</summary>
</cvar>

<cvar name="SHLINK">
<summary>
The linker for programs that use shared libraries.
</summary>
</cvar>

<cvar name="SHLINKCOM">
<summary>
The command line used to link programs using shared libaries.
</summary>
</cvar>

<cvar name="SHLINKCOMSTR">
<summary>
The string displayed when programs using shared libraries are linked.
If this is not set, then &cv-link-SHLINKCOM; (the command line) is displayed.

<example>
env = Environment(SHLINKCOMSTR = "Linking shared $TARGET")
</example>
</summary>
</cvar>

<cvar name="SHLINKFLAGS">
<summary>
General user options passed to the linker for programs using shared libraries.
Note that this variable should
<emphasis>not</emphasis>
contain
<option>-l</option>
(or similar) options for linking with the libraries listed in &cv-link-LIBS;,
nor
<option>-L</option>
(or similar) include search path options
that scons generates automatically from &cv-link-LIBPATH;.
See
&cv-link-_LIBFLAGS;
above,
for the variable that expands to library-link options,
and
&cv-link-_LIBDIRFLAGS;
above,
for the variable that expands to library search path options.
</summary>
</cvar>