OpenCores
URL https://opencores.org/ocsvn/altor32/altor32/trunk

Subversion Repositories altor32

[/] [altor32/] [trunk/] [gcc-x64/] [or1knd-elf/] [share/] [man/] [man1/] [or1k-elf-ld.1] - Blame information for rev 35

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 35 ultra_embe
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
2
.\"
3
.\" Standard preamble:
4
.\" ========================================================================
5
.de Sp \" Vertical space (when we can't use .PP)
6
.if t .sp .5v
7
.if n .sp
8
..
9
.de Vb \" Begin verbatim text
10
.ft CW
11
.nf
12
.ne \\$1
13
..
14
.de Ve \" End verbatim text
15
.ft R
16
.fi
17
..
18
.\" Set up some character translations and predefined strings.  \*(-- will
19
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23
.\" nothing in troff, for use with C<>.
24
.tr \(*W-
25
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26
.ie n \{\
27
.    ds -- \(*W-
28
.    ds PI pi
29
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31
.    ds L" ""
32
.    ds R" ""
33
.    ds C` ""
34
.    ds C' ""
35
'br\}
36
.el\{\
37
.    ds -- \|\(em\|
38
.    ds PI \(*p
39
.    ds L" ``
40
.    ds R" ''
41
'br\}
42
.\"
43
.\" Escape single quotes in literal strings from groff's Unicode transform.
44
.ie \n(.g .ds Aq \(aq
45
.el       .ds Aq '
46
.\"
47
.\" If the F register is turned on, we'll generate index entries on stderr for
48
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49
.\" entries marked with X<> in POD.  Of course, you'll have to process the
50
.\" output yourself in some meaningful fashion.
51
.ie \nF \{\
52
.    de IX
53
.    tm Index:\\$1\t\\n%\t"\\$2"
54
..
55
.    nr % 0
56
.    rr F
57
.\}
58
.el \{\
59
.    de IX
60
..
61
.\}
62
.\"
63
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65
.    \" fudge factors for nroff and troff
66
.if n \{\
67
.    ds #H 0
68
.    ds #V .8m
69
.    ds #F .3m
70
.    ds #[ \f1
71
.    ds #] \fP
72
.\}
73
.if t \{\
74
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75
.    ds #V .6m
76
.    ds #F 0
77
.    ds #[ \&
78
.    ds #] \&
79
.\}
80
.    \" simple accents for nroff and troff
81
.if n \{\
82
.    ds ' \&
83
.    ds ` \&
84
.    ds ^ \&
85
.    ds , \&
86
.    ds ~ ~
87
.    ds /
88
.\}
89
.if t \{\
90
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96
.\}
97
.    \" troff and (daisy-wheel) nroff accents
98
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105
.ds ae a\h'-(\w'a'u*4/10)'e
106
.ds Ae A\h'-(\w'A'u*4/10)'E
107
.    \" corrections for vroff
108
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110
.    \" for low resolution devices (crt and lpr)
111
.if \n(.H>23 .if \n(.V>19 \
112
\{\
113
.    ds : e
114
.    ds 8 ss
115
.    ds o a
116
.    ds d- d\h'-1'\(ga
117
.    ds D- D\h'-1'\(hy
118
.    ds th \o'bp'
119
.    ds Th \o'LP'
120
.    ds ae ae
121
.    ds Ae AE
122
.\}
123
.rm #[ #] #H #V #F C
124
.\" ========================================================================
125
.\"
126
.IX Title "LD 1"
127
.TH LD 1 "2013-04-24" "binutils-2.23.51" "GNU Development Tools"
128
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129
.\" way too many mistakes in technical documents.
130
.if n .ad l
131
.nh
132
.SH "NAME"
133
ld \- The GNU linker
134
.SH "SYNOPSIS"
135
.IX Header "SYNOPSIS"
136
ld [\fBoptions\fR] \fIobjfile\fR ...
137
.SH "DESCRIPTION"
138
.IX Header "DESCRIPTION"
139
\&\fBld\fR combines a number of object and archive files, relocates
140
their data and ties up symbol references. Usually the last step in
141
compiling a program is to run \fBld\fR.
142
.PP
143
\&\fBld\fR accepts Linker Command Language files written in
144
a superset of \s-1AT&T\s0's Link Editor Command Language syntax,
145
to provide explicit and total control over the linking process.
146
.PP
147
This man page does not describe the command language; see the
148
\&\fBld\fR entry in \f(CW\*(C`info\*(C'\fR for full details on the command
149
language and on other aspects of the \s-1GNU\s0 linker.
150
.PP
151
This version of \fBld\fR uses the general purpose \s-1BFD\s0 libraries
152
to operate on object files. This allows \fBld\fR to read, combine, and
153
write object files in many different formats\-\-\-for example, \s-1COFF\s0 or
154
\&\f(CW\*(C`a.out\*(C'\fR.  Different formats may be linked together to produce any
155
available kind of object file.
156
.PP
157
Aside from its flexibility, the \s-1GNU\s0 linker is more helpful than other
158
linkers in providing diagnostic information.  Many linkers abandon
159
execution immediately upon encountering an error; whenever possible,
160
\&\fBld\fR continues executing, allowing you to identify other errors
161
(or, in some cases, to get an output file in spite of the error).
162
.PP
163
The \s-1GNU\s0 linker \fBld\fR is meant to cover a broad range of situations,
164
and to be as compatible as possible with other linkers.  As a result,
165
you have many choices to control its behavior.
166
.SH "OPTIONS"
167
.IX Header "OPTIONS"
168
The linker supports a plethora of command-line options, but in actual
169
practice few of them are used in any particular context.
170
For instance, a frequent use of \fBld\fR is to link standard Unix
171
object files on a standard, supported Unix system.  On such a system, to
172
link a file \f(CW\*(C`hello.o\*(C'\fR:
173
.PP
174
.Vb 1
175
\&        ld \-o  /lib/crt0.o hello.o \-lc
176
.Ve
177
.PP
178
This tells \fBld\fR to produce a file called \fIoutput\fR as the
179
result of linking the file \f(CW\*(C`/lib/crt0.o\*(C'\fR with \f(CW\*(C`hello.o\*(C'\fR and
180
the library \f(CW\*(C`libc.a\*(C'\fR, which will come from the standard search
181
directories.  (See the discussion of the \fB\-l\fR option below.)
182
.PP
183
Some of the command-line options to \fBld\fR may be specified at any
184
point in the command line.  However, options which refer to files, such
185
as \fB\-l\fR or \fB\-T\fR, cause the file to be read at the point at
186
which the option appears in the command line, relative to the object
187
files and other file options.  Repeating non-file options with a
188
different argument will either have no further effect, or override prior
189
occurrences (those further to the left on the command line) of that
190
option.  Options which may be meaningfully specified more than once are
191
noted in the descriptions below.
192
.PP
193
Non-option arguments are object files or archives which are to be linked
194
together.  They may follow, precede, or be mixed in with command-line
195
options, except that an object file argument may not be placed between
196
an option and its argument.
197
.PP
198
Usually the linker is invoked with at least one object file, but you can
199
specify other forms of binary input files using \fB\-l\fR, \fB\-R\fR,
200
and the script command language.  If \fIno\fR binary input files at all
201
are specified, the linker does not produce any output, and issues the
202
message \fBNo input files\fR.
203
.PP
204
If the linker cannot recognize the format of an object file, it will
205
assume that it is a linker script.  A script specified in this way
206
augments the main linker script used for the link (either the default
207
linker script or the one specified by using \fB\-T\fR).  This feature
208
permits the linker to link against a file which appears to be an object
209
or an archive, but actually merely defines some symbol values, or uses
210
\&\f(CW\*(C`INPUT\*(C'\fR or \f(CW\*(C`GROUP\*(C'\fR to load other objects.  Specifying a
211
script in this way merely augments the main linker script, with the
212
extra commands placed after the main script; use the \fB\-T\fR option
213
to replace the default linker script entirely, but note the effect of
214
the \f(CW\*(C`INSERT\*(C'\fR command.
215
.PP
216
For options whose names are a single letter,
217
option arguments must either follow the option letter without intervening
218
whitespace, or be given as separate arguments immediately following the
219
option that requires them.
220
.PP
221
For options whose names are multiple letters, either one dash or two can
222
precede the option name; for example, \fB\-trace\-symbol\fR and
223
\&\fB\-\-trace\-symbol\fR are equivalent.  Note\-\-\-there is one exception to
224
this rule.  Multiple letter options that start with a lower case 'o' can
225
only be preceded by two dashes.  This is to reduce confusion with the
226
\&\fB\-o\fR option.  So for example \fB\-omagic\fR sets the output file
227
name to \fBmagic\fR whereas \fB\-\-omagic\fR sets the \s-1NMAGIC\s0 flag on the
228
output.
229
.PP
230
Arguments to multiple-letter options must either be separated from the
231
option name by an equals sign, or be given as separate arguments
232
immediately following the option that requires them.  For example,
233
\&\fB\-\-trace\-symbol foo\fR and \fB\-\-trace\-symbol=foo\fR are equivalent.
234
Unique abbreviations of the names of multiple-letter options are
235
accepted.
236
.PP
237
Note\-\-\-if the linker is being invoked indirectly, via a compiler driver
238
(e.g. \fBgcc\fR) then all the linker command line options should be
239
prefixed by \fB\-Wl,\fR (or whatever is appropriate for the particular
240
compiler driver) like this:
241
.PP
242
.Vb 1
243
\&          gcc \-Wl,\-\-start\-group foo.o bar.o \-Wl,\-\-end\-group
244
.Ve
245
.PP
246
This is important, because otherwise the compiler driver program may
247
silently drop the linker options, resulting in a bad link.  Confusion
248
may also arise when passing options that require values through a
249
driver, as the use of a space between option and argument acts as
250
a separator, and causes the driver to pass only the option to the linker
251
and the argument to the compiler.  In this case, it is simplest to use
252
the joined forms of both single\- and multiple-letter options, such as:
253
.PP
254
.Vb 1
255
\&          gcc foo.o bar.o \-Wl,\-eENTRY \-Wl,\-Map=a.map
256
.Ve
257
.PP
258
Here is a table of the generic command line switches accepted by the \s-1GNU\s0
259
linker:
260
.IP "\fB@\fR\fIfile\fR" 4
261
.IX Item "@file"
262
Read command-line options from \fIfile\fR.  The options read are
263
inserted in place of the original @\fIfile\fR option.  If \fIfile\fR
264
does not exist, or cannot be read, then the option will be treated
265
literally, and not removed.
266
.Sp
267
Options in \fIfile\fR are separated by whitespace.  A whitespace
268
character may be included in an option by surrounding the entire
269
option in either single or double quotes.  Any character (including a
270
backslash) may be included by prefixing the character to be included
271
with a backslash.  The \fIfile\fR may itself contain additional
272
@\fIfile\fR options; any such options will be processed recursively.
273
.IP "\fB\-a\fR \fIkeyword\fR" 4
274
.IX Item "-a keyword"
275
This option is supported for \s-1HP/UX\s0 compatibility.  The \fIkeyword\fR
276
argument must be one of the strings \fBarchive\fR, \fBshared\fR, or
277
\&\fBdefault\fR.  \fB\-aarchive\fR is functionally equivalent to
278
\&\fB\-Bstatic\fR, and the other two keywords are functionally equivalent
279
to \fB\-Bdynamic\fR.  This option may be used any number of times.
280
.IP "\fB\-\-audit\fR \fI\s-1AUDITLIB\s0\fR" 4
281
.IX Item "--audit AUDITLIB"
282
Adds \fI\s-1AUDITLIB\s0\fR to the \f(CW\*(C`DT_AUDIT\*(C'\fR entry of the dynamic section.
283
\&\fI\s-1AUDITLIB\s0\fR is not checked for existence, nor will it use the \s-1DT_SONAME\s0
284
specified in the library.  If specified multiple times \f(CW\*(C`DT_AUDIT\*(C'\fR
285
will contain a colon separated list of audit interfaces to use. If the linker
286
finds an object with an audit entry while searching for shared libraries,
287
it will add a corresponding \f(CW\*(C`DT_DEPAUDIT\*(C'\fR entry in the output file.
288
This option is only meaningful on \s-1ELF\s0 platforms supporting the rtld-audit
289
interface.
290
.IP "\fB\-A\fR \fIarchitecture\fR" 4
291
.IX Item "-A architecture"
292
.PD 0
293
.IP "\fB\-\-architecture=\fR\fIarchitecture\fR" 4
294
.IX Item "--architecture=architecture"
295
.PD
296
In the current release of \fBld\fR, this option is useful only for the
297
Intel 960 family of architectures.  In that \fBld\fR configuration, the
298
\&\fIarchitecture\fR argument identifies the particular architecture in
299
the 960 family, enabling some safeguards and modifying the
300
archive-library search path.
301
.Sp
302
Future releases of \fBld\fR may support similar functionality for
303
other architecture families.
304
.IP "\fB\-b\fR \fIinput-format\fR" 4
305
.IX Item "-b input-format"
306
.PD 0
307
.IP "\fB\-\-format=\fR\fIinput-format\fR" 4
308
.IX Item "--format=input-format"
309
.PD
310
\&\fBld\fR may be configured to support more than one kind of object
311
file.  If your \fBld\fR is configured this way, you can use the
312
\&\fB\-b\fR option to specify the binary format for input object files
313
that follow this option on the command line.  Even when \fBld\fR is
314
configured to support alternative object formats, you don't usually need
315
to specify this, as \fBld\fR should be configured to expect as a
316
default input format the most usual format on each machine.
317
\&\fIinput-format\fR is a text string, the name of a particular format
318
supported by the \s-1BFD\s0 libraries.  (You can list the available binary
319
formats with \fBobjdump \-i\fR.)
320
.Sp
321
You may want to use this option if you are linking files with an unusual
322
binary format.  You can also use \fB\-b\fR to switch formats explicitly (when
323
linking object files of different formats), by including
324
\&\fB\-b\fR \fIinput-format\fR before each group of object files in a
325
particular format.
326
.Sp
327
The default format is taken from the environment variable
328
\&\f(CW\*(C`GNUTARGET\*(C'\fR.
329
.Sp
330
You can also define the input format from a script, using the command
331
\&\f(CW\*(C`TARGET\*(C'\fR;
332
.IP "\fB\-c\fR \fIMRI-commandfile\fR" 4
333
.IX Item "-c MRI-commandfile"
334
.PD 0
335
.IP "\fB\-\-mri\-script=\fR\fIMRI-commandfile\fR" 4
336
.IX Item "--mri-script=MRI-commandfile"
337
.PD
338
For compatibility with linkers produced by \s-1MRI\s0, \fBld\fR accepts script
339
files written in an alternate, restricted command language, described in
340
the \s-1MRI\s0 Compatible Script Files section of \s-1GNU\s0 ld documentation.
341
Introduce \s-1MRI\s0 script files with
342
the option \fB\-c\fR; use the \fB\-T\fR option to run linker
343
scripts written in the general-purpose \fBld\fR scripting language.
344
If \fIMRI-cmdfile\fR does not exist, \fBld\fR looks for it in the directories
345
specified by any \fB\-L\fR options.
346
.IP "\fB\-d\fR" 4
347
.IX Item "-d"
348
.PD 0
349
.IP "\fB\-dc\fR" 4
350
.IX Item "-dc"
351
.IP "\fB\-dp\fR" 4
352
.IX Item "-dp"
353
.PD
354
These three options are equivalent; multiple forms are supported for
355
compatibility with other linkers.  They assign space to common symbols
356
even if a relocatable output file is specified (with \fB\-r\fR).  The
357
script command \f(CW\*(C`FORCE_COMMON_ALLOCATION\*(C'\fR has the same effect.
358
.IP "\fB\-\-depaudit\fR \fI\s-1AUDITLIB\s0\fR" 4
359
.IX Item "--depaudit AUDITLIB"
360
.PD 0
361
.IP "\fB\-P\fR \fI\s-1AUDITLIB\s0\fR" 4
362
.IX Item "-P AUDITLIB"
363
.PD
364
Adds \fI\s-1AUDITLIB\s0\fR to the \f(CW\*(C`DT_DEPAUDIT\*(C'\fR entry of the dynamic section.
365
\&\fI\s-1AUDITLIB\s0\fR is not checked for existence, nor will it use the \s-1DT_SONAME\s0
366
specified in the library.  If specified multiple times \f(CW\*(C`DT_DEPAUDIT\*(C'\fR
367
will contain a colon separated list of audit interfaces to use.  This
368
option is only meaningful on \s-1ELF\s0 platforms supporting the rtld-audit interface.
369
The \-P option is provided for Solaris compatibility.
370
.IP "\fB\-e\fR \fIentry\fR" 4
371
.IX Item "-e entry"
372
.PD 0
373
.IP "\fB\-\-entry=\fR\fIentry\fR" 4
374
.IX Item "--entry=entry"
375
.PD
376
Use \fIentry\fR as the explicit symbol for beginning execution of your
377
program, rather than the default entry point.  If there is no symbol
378
named \fIentry\fR, the linker will try to parse \fIentry\fR as a number,
379
and use that as the entry address (the number will be interpreted in
380
base 10; you may use a leading \fB0x\fR for base 16, or a leading
381
\&\fB0\fR for base 8).
382
.IP "\fB\-\-exclude\-libs\fR \fIlib\fR\fB,\fR\fIlib\fR\fB,...\fR" 4
383
.IX Item "--exclude-libs lib,lib,..."
384
Specifies a list of archive libraries from which symbols should not be automatically
385
exported.  The library names may be delimited by commas or colons.  Specifying
386
\&\f(CW\*(C`\-\-exclude\-libs ALL\*(C'\fR excludes symbols in all archive libraries from
387
automatic export.  This option is available only for the i386 \s-1PE\s0 targeted
388
port of the linker and for \s-1ELF\s0 targeted ports.  For i386 \s-1PE\s0, symbols
389
explicitly listed in a .def file are still exported, regardless of this
390
option.  For \s-1ELF\s0 targeted ports, symbols affected by this option will
391
be treated as hidden.
392
.IP "\fB\-\-exclude\-modules\-for\-implib\fR \fImodule\fR\fB,\fR\fImodule\fR\fB,...\fR" 4
393
.IX Item "--exclude-modules-for-implib module,module,..."
394
Specifies a list of object files or archive members, from which symbols
395
should not be automatically exported, but which should be copied wholesale
396
into the import library being generated during the link.  The module names
397
may be delimited by commas or colons, and must match exactly the filenames
398
used by \fBld\fR to open the files; for archive members, this is simply
399
the member name, but for object files the name listed must include and
400
match precisely any path used to specify the input file on the linker's
401
command-line.  This option is available only for the i386 \s-1PE\s0 targeted port
402
of the linker.  Symbols explicitly listed in a .def file are still exported,
403
regardless of this option.
404
.IP "\fB\-E\fR" 4
405
.IX Item "-E"
406
.PD 0
407
.IP "\fB\-\-export\-dynamic\fR" 4
408
.IX Item "--export-dynamic"
409
.IP "\fB\-\-no\-export\-dynamic\fR" 4
410
.IX Item "--no-export-dynamic"
411
.PD
412
When creating a dynamically linked executable, using the \fB\-E\fR
413
option or the \fB\-\-export\-dynamic\fR option causes the linker to add
414
all symbols to the dynamic symbol table.  The dynamic symbol table is the
415
set of symbols which are visible from dynamic objects at run time.
416
.Sp
417
If you do not use either of these options (or use the
418
\&\fB\-\-no\-export\-dynamic\fR option to restore the default behavior), the
419
dynamic symbol table will normally contain only those symbols which are
420
referenced by some dynamic object mentioned in the link.
421
.Sp
422
If you use \f(CW\*(C`dlopen\*(C'\fR to load a dynamic object which needs to refer
423
back to the symbols defined by the program, rather than some other
424
dynamic object, then you will probably need to use this option when
425
linking the program itself.
426
.Sp
427
You can also use the dynamic list to control what symbols should
428
be added to the dynamic symbol table if the output format supports it.
429
See the description of \fB\-\-dynamic\-list\fR.
430
.Sp
431
Note that this option is specific to \s-1ELF\s0 targeted ports.  \s-1PE\s0 targets
432
support a similar function to export all symbols from a \s-1DLL\s0 or \s-1EXE\s0; see
433
the description of \fB\-\-export\-all\-symbols\fR below.
434
.IP "\fB\-EB\fR" 4
435
.IX Item "-EB"
436
Link big-endian objects.  This affects the default output format.
437
.IP "\fB\-EL\fR" 4
438
.IX Item "-EL"
439
Link little-endian objects.  This affects the default output format.
440
.IP "\fB\-f\fR \fIname\fR" 4
441
.IX Item "-f name"
442
.PD 0
443
.IP "\fB\-\-auxiliary=\fR\fIname\fR" 4
444
.IX Item "--auxiliary=name"
445
.PD
446
When creating an \s-1ELF\s0 shared object, set the internal \s-1DT_AUXILIARY\s0 field
447
to the specified name.  This tells the dynamic linker that the symbol
448
table of the shared object should be used as an auxiliary filter on the
449
symbol table of the shared object \fIname\fR.
450
.Sp
451
If you later link a program against this filter object, then, when you
452
run the program, the dynamic linker will see the \s-1DT_AUXILIARY\s0 field.  If
453
the dynamic linker resolves any symbols from the filter object, it will
454
first check whether there is a definition in the shared object
455
\&\fIname\fR.  If there is one, it will be used instead of the definition
456
in the filter object.  The shared object \fIname\fR need not exist.
457
Thus the shared object \fIname\fR may be used to provide an alternative
458
implementation of certain functions, perhaps for debugging or for
459
machine specific performance.
460
.Sp
461
This option may be specified more than once.  The \s-1DT_AUXILIARY\s0 entries
462
will be created in the order in which they appear on the command line.
463
.IP "\fB\-F\fR \fIname\fR" 4
464
.IX Item "-F name"
465
.PD 0
466
.IP "\fB\-\-filter=\fR\fIname\fR" 4
467
.IX Item "--filter=name"
468
.PD
469
When creating an \s-1ELF\s0 shared object, set the internal \s-1DT_FILTER\s0 field to
470
the specified name.  This tells the dynamic linker that the symbol table
471
of the shared object which is being created should be used as a filter
472
on the symbol table of the shared object \fIname\fR.
473
.Sp
474
If you later link a program against this filter object, then, when you
475
run the program, the dynamic linker will see the \s-1DT_FILTER\s0 field.  The
476
dynamic linker will resolve symbols according to the symbol table of the
477
filter object as usual, but it will actually link to the definitions
478
found in the shared object \fIname\fR.  Thus the filter object can be
479
used to select a subset of the symbols provided by the object
480
\&\fIname\fR.
481
.Sp
482
Some older linkers used the \fB\-F\fR option throughout a compilation
483
toolchain for specifying object-file format for both input and output
484
object files.
485
The \s-1GNU\s0 linker uses other mechanisms for this purpose: the
486
\&\fB\-b\fR, \fB\-\-format\fR, \fB\-\-oformat\fR options, the
487
\&\f(CW\*(C`TARGET\*(C'\fR command in linker scripts, and the \f(CW\*(C`GNUTARGET\*(C'\fR
488
environment variable.
489
The \s-1GNU\s0 linker will ignore the \fB\-F\fR option when not
490
creating an \s-1ELF\s0 shared object.
491
.IP "\fB\-fini=\fR\fIname\fR" 4
492
.IX Item "-fini=name"
493
When creating an \s-1ELF\s0 executable or shared object, call \s-1NAME\s0 when the
494
executable or shared object is unloaded, by setting \s-1DT_FINI\s0 to the
495
address of the function.  By default, the linker uses \f(CW\*(C`_fini\*(C'\fR as
496
the function to call.
497
.IP "\fB\-g\fR" 4
498
.IX Item "-g"
499
Ignored.  Provided for compatibility with other tools.
500
.IP "\fB\-G\fR \fIvalue\fR" 4
501
.IX Item "-G value"
502
.PD 0
503
.IP "\fB\-\-gpsize=\fR\fIvalue\fR" 4
504
.IX Item "--gpsize=value"
505
.PD
506
Set the maximum size of objects to be optimized using the \s-1GP\s0 register to
507
\&\fIsize\fR.  This is only meaningful for object file formats such as
508
\&\s-1MIPS\s0 \s-1ECOFF\s0 which supports putting large and small objects into different
509
sections.  This is ignored for other object file formats.
510
.IP "\fB\-h\fR \fIname\fR" 4
511
.IX Item "-h name"
512
.PD 0
513
.IP "\fB\-soname=\fR\fIname\fR" 4
514
.IX Item "-soname=name"
515
.PD
516
When creating an \s-1ELF\s0 shared object, set the internal \s-1DT_SONAME\s0 field to
517
the specified name.  When an executable is linked with a shared object
518
which has a \s-1DT_SONAME\s0 field, then when the executable is run the dynamic
519
linker will attempt to load the shared object specified by the \s-1DT_SONAME\s0
520
field rather than the using the file name given to the linker.
521
.IP "\fB\-i\fR" 4
522
.IX Item "-i"
523
Perform an incremental link (same as option \fB\-r\fR).
524
.IP "\fB\-init=\fR\fIname\fR" 4
525
.IX Item "-init=name"
526
When creating an \s-1ELF\s0 executable or shared object, call \s-1NAME\s0 when the
527
executable or shared object is loaded, by setting \s-1DT_INIT\s0 to the address
528
of the function.  By default, the linker uses \f(CW\*(C`_init\*(C'\fR as the
529
function to call.
530
.IP "\fB\-l\fR \fInamespec\fR" 4
531
.IX Item "-l namespec"
532
.PD 0
533
.IP "\fB\-\-library=\fR\fInamespec\fR" 4
534
.IX Item "--library=namespec"
535
.PD
536
Add the archive or object file specified by \fInamespec\fR to the
537
list of files to link.  This option may be used any number of times.
538
If \fInamespec\fR is of the form \fI:\fIfilename\fI\fR, \fBld\fR
539
will search the library path for a file called \fIfilename\fR, otherwise it
540
will search the library path for a file called \fIlib\fInamespec\fI.a\fR.
541
.Sp
542
On systems which support shared libraries, \fBld\fR may also search for
543
files other than \fIlib\fInamespec\fI.a\fR.  Specifically, on \s-1ELF\s0
544
and SunOS systems, \fBld\fR will search a directory for a library
545
called \fIlib\fInamespec\fI.so\fR before searching for one called
546
\&\fIlib\fInamespec\fI.a\fR.  (By convention, a \f(CW\*(C`.so\*(C'\fR extension
547
indicates a shared library.)  Note that this behavior does not apply
548
to \fI:\fIfilename\fI\fR, which always specifies a file called
549
\&\fIfilename\fR.
550
.Sp
551
The linker will search an archive only once, at the location where it is
552
specified on the command line.  If the archive defines a symbol which
553
was undefined in some object which appeared before the archive on the
554
command line, the linker will include the appropriate file(s) from the
555
archive.  However, an undefined symbol in an object appearing later on
556
the command line will not cause the linker to search the archive again.
557
.Sp
558
See the \fB\-(\fR option for a way to force the linker to search
559
archives multiple times.
560
.Sp
561
You may list the same archive multiple times on the command line.
562
.Sp
563
This type of archive searching is standard for Unix linkers.  However,
564
if you are using \fBld\fR on \s-1AIX\s0, note that it is different from the
565
behaviour of the \s-1AIX\s0 linker.
566
.IP "\fB\-L\fR \fIsearchdir\fR" 4
567
.IX Item "-L searchdir"
568
.PD 0
569
.IP "\fB\-\-library\-path=\fR\fIsearchdir\fR" 4
570
.IX Item "--library-path=searchdir"
571
.PD
572
Add path \fIsearchdir\fR to the list of paths that \fBld\fR will search
573
for archive libraries and \fBld\fR control scripts.  You may use this
574
option any number of times.  The directories are searched in the order
575
in which they are specified on the command line.  Directories specified
576
on the command line are searched before the default directories.  All
577
\&\fB\-L\fR options apply to all \fB\-l\fR options, regardless of the
578
order in which the options appear.  \fB\-L\fR options do not affect
579
how \fBld\fR searches for a linker script unless \fB\-T\fR
580
option is specified.
581
.Sp
582
If \fIsearchdir\fR begins with \f(CW\*(C`=\*(C'\fR, then the \f(CW\*(C`=\*(C'\fR will be replaced
583
by the \fIsysroot prefix\fR, a path specified when the linker is configured.
584
.Sp
585
The default set of paths searched (without being specified with
586
\&\fB\-L\fR) depends on which emulation mode \fBld\fR is using, and in
587
some cases also on how it was configured.
588
.Sp
589
The paths can also be specified in a link script with the
590
\&\f(CW\*(C`SEARCH_DIR\*(C'\fR command.  Directories specified this way are searched
591
at the point in which the linker script appears in the command line.
592
.IP "\fB\-m\fR \fIemulation\fR" 4
593
.IX Item "-m emulation"
594
Emulate the \fIemulation\fR linker.  You can list the available
595
emulations with the \fB\-\-verbose\fR or \fB\-V\fR options.
596
.Sp
597
If the \fB\-m\fR option is not used, the emulation is taken from the
598
\&\f(CW\*(C`LDEMULATION\*(C'\fR environment variable, if that is defined.
599
.Sp
600
Otherwise, the default emulation depends upon how the linker was
601
configured.
602
.IP "\fB\-M\fR" 4
603
.IX Item "-M"
604
.PD 0
605
.IP "\fB\-\-print\-map\fR" 4
606
.IX Item "--print-map"
607
.PD
608
Print a link map to the standard output.  A link map provides
609
information about the link, including the following:
610
.RS 4
611
.IP "\(bu" 4
612
Where object files are mapped into memory.
613
.IP "\(bu" 4
614
How common symbols are allocated.
615
.IP "\(bu" 4
616
All archive members included in the link, with a mention of the symbol
617
which caused the archive member to be brought in.
618
.IP "\(bu" 4
619
The values assigned to symbols.
620
.Sp
621
Note \- symbols whose values are computed by an expression which
622
involves a reference to a previous value of the same symbol may not
623
have correct result displayed in the link map.  This is because the
624
linker discards intermediate results and only retains the final value
625
of an expression.  Under such circumstances the linker will display
626
the final value enclosed by square brackets.  Thus for example a
627
linker script containing:
628
.Sp
629
.Vb 3
630
\&           foo = 1
631
\&           foo = foo * 4
632
\&           foo = foo + 8
633
.Ve
634
.Sp
635
will produce the following output in the link map if the \fB\-M\fR
636
option is used:
637
.Sp
638
.Vb 3
639
\&           0x00000001                foo = 0x1
640
\&           [0x0000000c]                foo = (foo * 0x4)
641
\&           [0x0000000c]                foo = (foo + 0x8)
642
.Ve
643
.Sp
644
See \fBExpressions\fR for more information about expressions in linker
645
scripts.
646
.RE
647
.RS 4
648
.RE
649
.IP "\fB\-n\fR" 4
650
.IX Item "-n"
651
.PD 0
652
.IP "\fB\-\-nmagic\fR" 4
653
.IX Item "--nmagic"
654
.PD
655
Turn off page alignment of sections, and disable linking against shared
656
libraries.  If the output format supports Unix style magic numbers,
657
mark the output as \f(CW\*(C`NMAGIC\*(C'\fR.
658
.IP "\fB\-N\fR" 4
659
.IX Item "-N"
660
.PD 0
661
.IP "\fB\-\-omagic\fR" 4
662
.IX Item "--omagic"
663
.PD
664
Set the text and data sections to be readable and writable.  Also, do
665
not page-align the data segment, and disable linking against shared
666
libraries.  If the output format supports Unix style magic numbers,
667
mark the output as \f(CW\*(C`OMAGIC\*(C'\fR. Note: Although a writable text section
668
is allowed for PE-COFF targets, it does not conform to the format
669
specification published by Microsoft.
670
.IP "\fB\-\-no\-omagic\fR" 4
671
.IX Item "--no-omagic"
672
This option negates most of the effects of the \fB\-N\fR option.  It
673
sets the text section to be read-only, and forces the data segment to
674
be page-aligned.  Note \- this option does not enable linking against
675
shared libraries.  Use \fB\-Bdynamic\fR for this.
676
.IP "\fB\-o\fR \fIoutput\fR" 4
677
.IX Item "-o output"
678
.PD 0
679
.IP "\fB\-\-output=\fR\fIoutput\fR" 4
680
.IX Item "--output=output"
681
.PD
682
Use \fIoutput\fR as the name for the program produced by \fBld\fR; if this
683
option is not specified, the name \fIa.out\fR is used by default.  The
684
script command \f(CW\*(C`OUTPUT\*(C'\fR can also specify the output file name.
685
.IP "\fB\-O\fR \fIlevel\fR" 4
686
.IX Item "-O level"
687
If \fIlevel\fR is a numeric values greater than zero \fBld\fR optimizes
688
the output.  This might take significantly longer and therefore probably
689
should only be enabled for the final binary.  At the moment this
690
option only affects \s-1ELF\s0 shared library generation.  Future releases of
691
the linker may make more use of this option.  Also currently there is
692
no difference in the linker's behaviour for different non-zero values
693
of this option.  Again this may change with future releases.
694
.IP "\fB\-q\fR" 4
695
.IX Item "-q"
696
.PD 0
697
.IP "\fB\-\-emit\-relocs\fR" 4
698
.IX Item "--emit-relocs"
699
.PD
700
Leave relocation sections and contents in fully linked executables.
701
Post link analysis and optimization tools may need this information in
702
order to perform correct modifications of executables.  This results
703
in larger executables.
704
.Sp
705
This option is currently only supported on \s-1ELF\s0 platforms.
706
.IP "\fB\-\-force\-dynamic\fR" 4
707
.IX Item "--force-dynamic"
708
Force the output file to have dynamic sections.  This option is specific
709
to VxWorks targets.
710
.IP "\fB\-r\fR" 4
711
.IX Item "-r"
712
.PD 0
713
.IP "\fB\-\-relocatable\fR" 4
714
.IX Item "--relocatable"
715
.PD
716
Generate relocatable output\-\-\-i.e., generate an output file that can in
717
turn serve as input to \fBld\fR.  This is often called \fIpartial
718
linking\fR.  As a side effect, in environments that support standard Unix
719
magic numbers, this option also sets the output file's magic number to
720
\&\f(CW\*(C`OMAGIC\*(C'\fR.
721
If this option is not specified, an absolute file is produced.  When
722
linking \*(C+ programs, this option \fIwill not\fR resolve references to
723
constructors; to do that, use \fB\-Ur\fR.
724
.Sp
725
When an input file does not have the same format as the output file,
726
partial linking is only supported if that input file does not contain any
727
relocations.  Different output formats can have further restrictions; for
728
example some \f(CW\*(C`a.out\*(C'\fR\-based formats do not support partial linking
729
with input files in other formats at all.
730
.Sp
731
This option does the same thing as \fB\-i\fR.
732
.IP "\fB\-R\fR \fIfilename\fR" 4
733
.IX Item "-R filename"
734
.PD 0
735
.IP "\fB\-\-just\-symbols=\fR\fIfilename\fR" 4
736
.IX Item "--just-symbols=filename"
737
.PD
738
Read symbol names and their addresses from \fIfilename\fR, but do not
739
relocate it or include it in the output.  This allows your output file
740
to refer symbolically to absolute locations of memory defined in other
741
programs.  You may use this option more than once.
742
.Sp
743
For compatibility with other \s-1ELF\s0 linkers, if the \fB\-R\fR option is
744
followed by a directory name, rather than a file name, it is treated as
745
the \fB\-rpath\fR option.
746
.IP "\fB\-s\fR" 4
747
.IX Item "-s"
748
.PD 0
749
.IP "\fB\-\-strip\-all\fR" 4
750
.IX Item "--strip-all"
751
.PD
752
Omit all symbol information from the output file.
753
.IP "\fB\-S\fR" 4
754
.IX Item "-S"
755
.PD 0
756
.IP "\fB\-\-strip\-debug\fR" 4
757
.IX Item "--strip-debug"
758
.PD
759
Omit debugger symbol information (but not all symbols) from the output file.
760
.IP "\fB\-t\fR" 4
761
.IX Item "-t"
762
.PD 0
763
.IP "\fB\-\-trace\fR" 4
764
.IX Item "--trace"
765
.PD
766
Print the names of the input files as \fBld\fR processes them.
767
.IP "\fB\-T\fR \fIscriptfile\fR" 4
768
.IX Item "-T scriptfile"
769
.PD 0
770
.IP "\fB\-\-script=\fR\fIscriptfile\fR" 4
771
.IX Item "--script=scriptfile"
772
.PD
773
Use \fIscriptfile\fR as the linker script.  This script replaces
774
\&\fBld\fR's default linker script (rather than adding to it), so
775
\&\fIcommandfile\fR must specify everything necessary to describe the
776
output file.    If \fIscriptfile\fR does not exist in
777
the current directory, \f(CW\*(C`ld\*(C'\fR looks for it in the directories
778
specified by any preceding \fB\-L\fR options.  Multiple \fB\-T\fR
779
options accumulate.
780
.IP "\fB\-dT\fR \fIscriptfile\fR" 4
781
.IX Item "-dT scriptfile"
782
.PD 0
783
.IP "\fB\-\-default\-script=\fR\fIscriptfile\fR" 4
784
.IX Item "--default-script=scriptfile"
785
.PD
786
Use \fIscriptfile\fR as the default linker script.
787
.Sp
788
This option is similar to the \fB\-\-script\fR option except that
789
processing of the script is delayed until after the rest of the
790
command line has been processed.  This allows options placed after the
791
\&\fB\-\-default\-script\fR option on the command line to affect the
792
behaviour of the linker script, which can be important when the linker
793
command line cannot be directly controlled by the user.  (eg because
794
the command line is being constructed by another tool, such as
795
\&\fBgcc\fR).
796
.IP "\fB\-u\fR \fIsymbol\fR" 4
797
.IX Item "-u symbol"
798
.PD 0
799
.IP "\fB\-\-undefined=\fR\fIsymbol\fR" 4
800
.IX Item "--undefined=symbol"
801
.PD
802
Force \fIsymbol\fR to be entered in the output file as an undefined
803
symbol.  Doing this may, for example, trigger linking of additional
804
modules from standard libraries.  \fB\-u\fR may be repeated with
805
different option arguments to enter additional undefined symbols.  This
806
option is equivalent to the \f(CW\*(C`EXTERN\*(C'\fR linker script command.
807
.IP "\fB\-Ur\fR" 4
808
.IX Item "-Ur"
809
For anything other than \*(C+ programs, this option is equivalent to
810
\&\fB\-r\fR: it generates relocatable output\-\-\-i.e., an output file that can in
811
turn serve as input to \fBld\fR.  When linking \*(C+ programs, \fB\-Ur\fR
812
\&\fIdoes\fR resolve references to constructors, unlike \fB\-r\fR.
813
It does not work to use \fB\-Ur\fR on files that were themselves linked
814
with \fB\-Ur\fR; once the constructor table has been built, it cannot
815
be added to.  Use \fB\-Ur\fR only for the last partial link, and
816
\&\fB\-r\fR for the others.
817
.IP "\fB\-\-unique[=\fR\fI\s-1SECTION\s0\fR\fB]\fR" 4
818
.IX Item "--unique[=SECTION]"
819
Creates a separate output section for every input section matching
820
\&\fI\s-1SECTION\s0\fR, or if the optional wildcard \fI\s-1SECTION\s0\fR argument is
821
missing, for every orphan input section.  An orphan section is one not
822
specifically mentioned in a linker script.  You may use this option
823
multiple times on the command line;  It prevents the normal merging of
824
input sections with the same name, overriding output section assignments
825
in a linker script.
826
.IP "\fB\-v\fR" 4
827
.IX Item "-v"
828
.PD 0
829
.IP "\fB\-\-version\fR" 4
830
.IX Item "--version"
831
.IP "\fB\-V\fR" 4
832
.IX Item "-V"
833
.PD
834
Display the version number for \fBld\fR.  The \fB\-V\fR option also
835
lists the supported emulations.
836
.IP "\fB\-x\fR" 4
837
.IX Item "-x"
838
.PD 0
839
.IP "\fB\-\-discard\-all\fR" 4
840
.IX Item "--discard-all"
841
.PD
842
Delete all local symbols.
843
.IP "\fB\-X\fR" 4
844
.IX Item "-X"
845
.PD 0
846
.IP "\fB\-\-discard\-locals\fR" 4
847
.IX Item "--discard-locals"
848
.PD
849
Delete all temporary local symbols.  (These symbols start with
850
system-specific local label prefixes, typically \fB.L\fR for \s-1ELF\s0 systems
851
or \fBL\fR for traditional a.out systems.)
852
.IP "\fB\-y\fR \fIsymbol\fR" 4
853
.IX Item "-y symbol"
854
.PD 0
855
.IP "\fB\-\-trace\-symbol=\fR\fIsymbol\fR" 4
856
.IX Item "--trace-symbol=symbol"
857
.PD
858
Print the name of each linked file in which \fIsymbol\fR appears.  This
859
option may be given any number of times.  On many systems it is necessary
860
to prepend an underscore.
861
.Sp
862
This option is useful when you have an undefined symbol in your link but
863
don't know where the reference is coming from.
864
.IP "\fB\-Y\fR \fIpath\fR" 4
865
.IX Item "-Y path"
866
Add \fIpath\fR to the default library search path.  This option exists
867
for Solaris compatibility.
868
.IP "\fB\-z\fR \fIkeyword\fR" 4
869
.IX Item "-z keyword"
870
The recognized keywords are:
871
.RS 4
872
.IP "\fBcombreloc\fR" 4
873
.IX Item "combreloc"
874
Combines multiple reloc sections and sorts them to make dynamic symbol
875
lookup caching possible.
876
.IP "\fBdefs\fR" 4
877
.IX Item "defs"
878
Disallows undefined symbols in object files.  Undefined symbols in
879
shared libraries are still allowed.
880
.IP "\fBexecstack\fR" 4
881
.IX Item "execstack"
882
Marks the object as requiring executable stack.
883
.IP "\fBglobal\fR" 4
884
.IX Item "global"
885
This option is only meaningful when building a shared object.  It makes
886
the symbols defined by this shared object available for symbol resolution
887
of subsequently loaded libraries.
888
.IP "\fBinitfirst\fR" 4
889
.IX Item "initfirst"
890
This option is only meaningful when building a shared object.
891
It marks the object so that its runtime initialization will occur
892
before the runtime initialization of any other objects brought into
893
the process at the same time.  Similarly the runtime finalization of
894
the object will occur after the runtime finalization of any other
895
objects.
896
.IP "\fBinterpose\fR" 4
897
.IX Item "interpose"
898
Marks the object that its symbol table interposes before all symbols
899
but the primary executable.
900
.IP "\fBlazy\fR" 4
901
.IX Item "lazy"
902
When generating an executable or shared library, mark it to tell the
903
dynamic linker to defer function call resolution to the point when
904
the function is called (lazy binding), rather than at load time.
905
Lazy binding is the default.
906
.IP "\fBloadfltr\fR" 4
907
.IX Item "loadfltr"
908
Marks  the object that its filters be processed immediately at
909
runtime.
910
.IP "\fBmuldefs\fR" 4
911
.IX Item "muldefs"
912
Allows multiple definitions.
913
.IP "\fBnocombreloc\fR" 4
914
.IX Item "nocombreloc"
915
Disables multiple reloc sections combining.
916
.IP "\fBnocopyreloc\fR" 4
917
.IX Item "nocopyreloc"
918
Disables production of copy relocs.
919
.IP "\fBnodefaultlib\fR" 4
920
.IX Item "nodefaultlib"
921
Marks the object that the search for dependencies of this object will
922
ignore any default library search paths.
923
.IP "\fBnodelete\fR" 4
924
.IX Item "nodelete"
925
Marks the object shouldn't be unloaded at runtime.
926
.IP "\fBnodlopen\fR" 4
927
.IX Item "nodlopen"
928
Marks the object not available to \f(CW\*(C`dlopen\*(C'\fR.
929
.IP "\fBnodump\fR" 4
930
.IX Item "nodump"
931
Marks the object can not be dumped by \f(CW\*(C`dldump\*(C'\fR.
932
.IP "\fBnoexecstack\fR" 4
933
.IX Item "noexecstack"
934
Marks the object as not requiring executable stack.
935
.IP "\fBnorelro\fR" 4
936
.IX Item "norelro"
937
Don't create an \s-1ELF\s0 \f(CW\*(C`PT_GNU_RELRO\*(C'\fR segment header in the object.
938
.IP "\fBnow\fR" 4
939
.IX Item "now"
940
When generating an executable or shared library, mark it to tell the
941
dynamic linker to resolve all symbols when the program is started, or
942
when the shared library is linked to using dlopen, instead of
943
deferring function call resolution to the point when the function is
944
first called.
945
.IP "\fBorigin\fR" 4
946
.IX Item "origin"
947
Marks the object may contain \f(CW$ORIGIN\fR.
948
.IP "\fBrelro\fR" 4
949
.IX Item "relro"
950
Create an \s-1ELF\s0 \f(CW\*(C`PT_GNU_RELRO\*(C'\fR segment header in the object.
951
.IP "\fBmax\-page\-size=\fR\fIvalue\fR" 4
952
.IX Item "max-page-size=value"
953
Set the emulation maximum page size to \fIvalue\fR.
954
.IP "\fBcommon\-page\-size=\fR\fIvalue\fR" 4
955
.IX Item "common-page-size=value"
956
Set the emulation common page size to \fIvalue\fR.
957
.IP "\fBstack\-size=\fR\fIvalue\fR" 4
958
.IX Item "stack-size=value"
959
Specify a stack size for in an \s-1ELF\s0 \f(CW\*(C`PT_GNU_STACK\*(C'\fR segment.
960
Specifying zero will override any default non-zero sized
961
\&\f(CW\*(C`PT_GNU_STACK\*(C'\fR segment creation.
962
.RE
963
.RS 4
964
.Sp
965
Other keywords are ignored for Solaris compatibility.
966
.RE
967
.IP "\fB\-(\fR \fIarchives\fR \fB\-)\fR" 4
968
.IX Item "-( archives -)"
969
.PD 0
970
.IP "\fB\-\-start\-group\fR \fIarchives\fR \fB\-\-end\-group\fR" 4
971
.IX Item "--start-group archives --end-group"
972
.PD
973
The \fIarchives\fR should be a list of archive files.  They may be
974
either explicit file names, or \fB\-l\fR options.
975
.Sp
976
The specified archives are searched repeatedly until no new undefined
977
references are created.  Normally, an archive is searched only once in
978
the order that it is specified on the command line.  If a symbol in that
979
archive is needed to resolve an undefined symbol referred to by an
980
object in an archive that appears later on the command line, the linker
981
would not be able to resolve that reference.  By grouping the archives,
982
they all be searched repeatedly until all possible references are
983
resolved.
984
.Sp
985
Using this option has a significant performance cost.  It is best to use
986
it only when there are unavoidable circular references between two or
987
more archives.
988
.IP "\fB\-\-accept\-unknown\-input\-arch\fR" 4
989
.IX Item "--accept-unknown-input-arch"
990
.PD 0
991
.IP "\fB\-\-no\-accept\-unknown\-input\-arch\fR" 4
992
.IX Item "--no-accept-unknown-input-arch"
993
.PD
994
Tells the linker to accept input files whose architecture cannot be
995
recognised.  The assumption is that the user knows what they are doing
996
and deliberately wants to link in these unknown input files.  This was
997
the default behaviour of the linker, before release 2.14.  The default
998
behaviour from release 2.14 onwards is to reject such input files, and
999
so the \fB\-\-accept\-unknown\-input\-arch\fR option has been added to
1000
restore the old behaviour.
1001
.IP "\fB\-\-as\-needed\fR" 4
1002
.IX Item "--as-needed"
1003
.PD 0
1004
.IP "\fB\-\-no\-as\-needed\fR" 4
1005
.IX Item "--no-as-needed"
1006
.PD
1007
This option affects \s-1ELF\s0 \s-1DT_NEEDED\s0 tags for dynamic libraries mentioned
1008
on the command line after the \fB\-\-as\-needed\fR option.  Normally
1009
the linker will add a \s-1DT_NEEDED\s0 tag for each dynamic library mentioned
1010
on the command line, regardless of whether the library is actually
1011
needed or not.  \fB\-\-as\-needed\fR causes a \s-1DT_NEEDED\s0 tag to only be
1012
emitted for a library that satisfies an undefined symbol reference
1013
from a regular object file or, if the library is not found in the
1014
\&\s-1DT_NEEDED\s0 lists of other libraries linked up to that point, an
1015
undefined symbol reference from another dynamic library.
1016
\&\fB\-\-no\-as\-needed\fR restores the default behaviour.
1017
.IP "\fB\-\-add\-needed\fR" 4
1018
.IX Item "--add-needed"
1019
.PD 0
1020
.IP "\fB\-\-no\-add\-needed\fR" 4
1021
.IX Item "--no-add-needed"
1022
.PD
1023
These two options have been deprecated because of the similarity of
1024
their names to the \fB\-\-as\-needed\fR and \fB\-\-no\-as\-needed\fR
1025
options.  They have been replaced by \fB\-\-copy\-dt\-needed\-entries\fR
1026
and \fB\-\-no\-copy\-dt\-needed\-entries\fR.
1027
.IP "\fB\-assert\fR \fIkeyword\fR" 4
1028
.IX Item "-assert keyword"
1029
This option is ignored for SunOS compatibility.
1030
.IP "\fB\-Bdynamic\fR" 4
1031
.IX Item "-Bdynamic"
1032
.PD 0
1033
.IP "\fB\-dy\fR" 4
1034
.IX Item "-dy"
1035
.IP "\fB\-call_shared\fR" 4
1036
.IX Item "-call_shared"
1037
.PD
1038
Link against dynamic libraries.  This is only meaningful on platforms
1039
for which shared libraries are supported.  This option is normally the
1040
default on such platforms.  The different variants of this option are
1041
for compatibility with various systems.  You may use this option
1042
multiple times on the command line: it affects library searching for
1043
\&\fB\-l\fR options which follow it.
1044
.IP "\fB\-Bgroup\fR" 4
1045
.IX Item "-Bgroup"
1046
Set the \f(CW\*(C`DF_1_GROUP\*(C'\fR flag in the \f(CW\*(C`DT_FLAGS_1\*(C'\fR entry in the dynamic
1047
section.  This causes the runtime linker to handle lookups in this
1048
object and its dependencies to be performed only inside the group.
1049
\&\fB\-\-unresolved\-symbols=report\-all\fR is implied.  This option is
1050
only meaningful on \s-1ELF\s0 platforms which support shared libraries.
1051
.IP "\fB\-Bstatic\fR" 4
1052
.IX Item "-Bstatic"
1053
.PD 0
1054
.IP "\fB\-dn\fR" 4
1055
.IX Item "-dn"
1056
.IP "\fB\-non_shared\fR" 4
1057
.IX Item "-non_shared"
1058
.IP "\fB\-static\fR" 4
1059
.IX Item "-static"
1060
.PD
1061
Do not link against shared libraries.  This is only meaningful on
1062
platforms for which shared libraries are supported.  The different
1063
variants of this option are for compatibility with various systems.  You
1064
may use this option multiple times on the command line: it affects
1065
library searching for \fB\-l\fR options which follow it.  This
1066
option also implies \fB\-\-unresolved\-symbols=report\-all\fR.  This
1067
option can be used with \fB\-shared\fR.  Doing so means that a
1068
shared library is being created but that all of the library's external
1069
references must be resolved by pulling in entries from static
1070
libraries.
1071
.IP "\fB\-Bsymbolic\fR" 4
1072
.IX Item "-Bsymbolic"
1073
When creating a shared library, bind references to global symbols to the
1074
definition within the shared library, if any.  Normally, it is possible
1075
for a program linked against a shared library to override the definition
1076
within the shared library.  This option is only meaningful on \s-1ELF\s0
1077
platforms which support shared libraries.
1078
.IP "\fB\-Bsymbolic\-functions\fR" 4
1079
.IX Item "-Bsymbolic-functions"
1080
When creating a shared library, bind references to global function
1081
symbols to the definition within the shared library, if any.
1082
This option is only meaningful on \s-1ELF\s0 platforms which support shared
1083
libraries.
1084
.IP "\fB\-\-dynamic\-list=\fR\fIdynamic-list-file\fR" 4
1085
.IX Item "--dynamic-list=dynamic-list-file"
1086
Specify the name of a dynamic list file to the linker.  This is
1087
typically used when creating shared libraries to specify a list of
1088
global symbols whose references shouldn't be bound to the definition
1089
within the shared library, or creating dynamically linked executables
1090
to specify a list of symbols which should be added to the symbol table
1091
in the executable.  This option is only meaningful on \s-1ELF\s0 platforms
1092
which support shared libraries.
1093
.Sp
1094
The format of the dynamic list is the same as the version node without
1095
scope and node name.  See \fB\s-1VERSION\s0\fR for more information.
1096
.IP "\fB\-\-dynamic\-list\-data\fR" 4
1097
.IX Item "--dynamic-list-data"
1098
Include all global data symbols to the dynamic list.
1099
.IP "\fB\-\-dynamic\-list\-cpp\-new\fR" 4
1100
.IX Item "--dynamic-list-cpp-new"
1101
Provide the builtin dynamic list for \*(C+ operator new and delete.  It
1102
is mainly useful for building shared libstdc++.
1103
.IP "\fB\-\-dynamic\-list\-cpp\-typeinfo\fR" 4
1104
.IX Item "--dynamic-list-cpp-typeinfo"
1105
Provide the builtin dynamic list for \*(C+ runtime type identification.
1106
.IP "\fB\-\-check\-sections\fR" 4
1107
.IX Item "--check-sections"
1108
.PD 0
1109
.IP "\fB\-\-no\-check\-sections\fR" 4
1110
.IX Item "--no-check-sections"
1111
.PD
1112
Asks the linker \fInot\fR to check section addresses after they have
1113
been assigned to see if there are any overlaps.  Normally the linker will
1114
perform this check, and if it finds any overlaps it will produce
1115
suitable error messages.  The linker does know about, and does make
1116
allowances for sections in overlays.  The default behaviour can be
1117
restored by using the command line switch \fB\-\-check\-sections\fR.
1118
Section overlap is not usually checked for relocatable links.  You can
1119
force checking in that case by using the \fB\-\-check\-sections\fR
1120
option.
1121
.IP "\fB\-\-copy\-dt\-needed\-entries\fR" 4
1122
.IX Item "--copy-dt-needed-entries"
1123
.PD 0
1124
.IP "\fB\-\-no\-copy\-dt\-needed\-entries\fR" 4
1125
.IX Item "--no-copy-dt-needed-entries"
1126
.PD
1127
This option affects the treatment of dynamic libraries referred to
1128
by \s-1DT_NEEDED\s0 tags \fIinside\fR \s-1ELF\s0 dynamic libraries mentioned on the
1129
command line.  Normally the linker won't add a \s-1DT_NEEDED\s0 tag to the
1130
output binary for each library mentioned in a \s-1DT_NEEDED\s0 tag in an
1131
input dynamic library.  With \fB\-\-copy\-dt\-needed\-entries\fR
1132
specified on the command line however any dynamic libraries that
1133
follow it will have their \s-1DT_NEEDED\s0 entries added.  The default
1134
behaviour can be restored with \fB\-\-no\-copy\-dt\-needed\-entries\fR.
1135
.Sp
1136
This option also has an effect on the resolution of symbols in dynamic
1137
libraries.  With \fB\-\-copy\-dt\-needed\-entries\fR dynamic libraries
1138
mentioned on the command line will be recursively searched, following
1139
their \s-1DT_NEEDED\s0 tags to other libraries, in order to resolve symbols
1140
required by the output binary.  With the default setting however
1141
the searching of dynamic libraries that follow it will stop with the
1142
dynamic library itself.  No \s-1DT_NEEDED\s0 links will be traversed to resolve
1143
symbols.
1144
.IP "\fB\-\-cref\fR" 4
1145
.IX Item "--cref"
1146
Output a cross reference table.  If a linker map file is being
1147
generated, the cross reference table is printed to the map file.
1148
Otherwise, it is printed on the standard output.
1149
.Sp
1150
The format of the table is intentionally simple, so that it may be
1151
easily processed by a script if necessary.  The symbols are printed out,
1152
sorted by name.  For each symbol, a list of file names is given.  If the
1153
symbol is defined, the first file listed is the location of the
1154
definition.  The remaining files contain references to the symbol.
1155
.IP "\fB\-\-no\-define\-common\fR" 4
1156
.IX Item "--no-define-common"
1157
This option inhibits the assignment of addresses to common symbols.
1158
The script command \f(CW\*(C`INHIBIT_COMMON_ALLOCATION\*(C'\fR has the same effect.
1159
.Sp
1160
The \fB\-\-no\-define\-common\fR option allows decoupling
1161
the decision to assign addresses to Common symbols from the choice
1162
of the output file type; otherwise a non-Relocatable output type
1163
forces assigning addresses to Common symbols.
1164
Using \fB\-\-no\-define\-common\fR allows Common symbols that are referenced
1165
from a shared library to be assigned addresses only in the main program.
1166
This eliminates the unused duplicate space in the shared library,
1167
and also prevents any possible confusion over resolving to the wrong
1168
duplicate when there are many dynamic modules with specialized search
1169
paths for runtime symbol resolution.
1170
.IP "\fB\-\-defsym=\fR\fIsymbol\fR\fB=\fR\fIexpression\fR" 4
1171
.IX Item "--defsym=symbol=expression"
1172
Create a global symbol in the output file, containing the absolute
1173
address given by \fIexpression\fR.  You may use this option as many
1174
times as necessary to define multiple symbols in the command line.  A
1175
limited form of arithmetic is supported for the \fIexpression\fR in this
1176
context: you may give a hexadecimal constant or the name of an existing
1177
symbol, or use \f(CW\*(C`+\*(C'\fR and \f(CW\*(C`\-\*(C'\fR to add or subtract hexadecimal
1178
constants or symbols.  If you need more elaborate expressions, consider
1179
using the linker command language from a script.  \fINote:\fR there should be no white
1180
space between \fIsymbol\fR, the equals sign ("\fB=\fR"), and
1181
\&\fIexpression\fR.
1182
.IP "\fB\-\-demangle[=\fR\fIstyle\fR\fB]\fR" 4
1183
.IX Item "--demangle[=style]"
1184
.PD 0
1185
.IP "\fB\-\-no\-demangle\fR" 4
1186
.IX Item "--no-demangle"
1187
.PD
1188
These options control whether to demangle symbol names in error messages
1189
and other output.  When the linker is told to demangle, it tries to
1190
present symbol names in a readable fashion: it strips leading
1191
underscores if they are used by the object file format, and converts \*(C+
1192
mangled symbol names into user readable names.  Different compilers have
1193
different mangling styles.  The optional demangling style argument can be used
1194
to choose an appropriate demangling style for your compiler.  The linker will
1195
demangle by default unless the environment variable \fB\s-1COLLECT_NO_DEMANGLE\s0\fR
1196
is set.  These options may be used to override the default.
1197
.IP "\fB\-I\fR\fIfile\fR" 4
1198
.IX Item "-Ifile"
1199
.PD 0
1200
.IP "\fB\-\-dynamic\-linker=\fR\fIfile\fR" 4
1201
.IX Item "--dynamic-linker=file"
1202
.PD
1203
Set the name of the dynamic linker.  This is only meaningful when
1204
generating dynamically linked \s-1ELF\s0 executables.  The default dynamic
1205
linker is normally correct; don't use this unless you know what you are
1206
doing.
1207
.IP "\fB\-\-fatal\-warnings\fR" 4
1208
.IX Item "--fatal-warnings"
1209
.PD 0
1210
.IP "\fB\-\-no\-fatal\-warnings\fR" 4
1211
.IX Item "--no-fatal-warnings"
1212
.PD
1213
Treat all warnings as errors.  The default behaviour can be restored
1214
with the option \fB\-\-no\-fatal\-warnings\fR.
1215
.IP "\fB\-\-force\-exe\-suffix\fR" 4
1216
.IX Item "--force-exe-suffix"
1217
Make sure that an output file has a .exe suffix.
1218
.Sp
1219
If a successfully built fully linked output file does not have a
1220
\&\f(CW\*(C`.exe\*(C'\fR or \f(CW\*(C`.dll\*(C'\fR suffix, this option forces the linker to copy
1221
the output file to one of the same name with a \f(CW\*(C`.exe\*(C'\fR suffix. This
1222
option is useful when using unmodified Unix makefiles on a Microsoft
1223
Windows host, since some versions of Windows won't run an image unless
1224
it ends in a \f(CW\*(C`.exe\*(C'\fR suffix.
1225
.IP "\fB\-\-gc\-sections\fR" 4
1226
.IX Item "--gc-sections"
1227
.PD 0
1228
.IP "\fB\-\-no\-gc\-sections\fR" 4
1229
.IX Item "--no-gc-sections"
1230
.PD
1231
Enable garbage collection of unused input sections.  It is ignored on
1232
targets that do not support this option.  The default behaviour (of not
1233
performing this garbage collection) can be restored by specifying
1234
\&\fB\-\-no\-gc\-sections\fR on the command line.
1235
.Sp
1236
\&\fB\-\-gc\-sections\fR decides which input sections are used by
1237
examining symbols and relocations.  The section containing the entry
1238
symbol and all sections containing symbols undefined on the
1239
command-line will be kept, as will sections containing symbols
1240
referenced by dynamic objects.  Note that when building shared
1241
libraries, the linker must assume that any visible symbol is
1242
referenced.  Once this initial set of sections has been determined,
1243
the linker recursively marks as used any section referenced by their
1244
relocations.  See \fB\-\-entry\fR and \fB\-\-undefined\fR.
1245
.Sp
1246
This option can be set when doing a partial link (enabled with option
1247
\&\fB\-r\fR).  In this case the root of symbols kept must be explicitly
1248
specified either by an \fB\-\-entry\fR or \fB\-\-undefined\fR option or by
1249
a \f(CW\*(C`ENTRY\*(C'\fR command in the linker script.
1250
.IP "\fB\-\-print\-gc\-sections\fR" 4
1251
.IX Item "--print-gc-sections"
1252
.PD 0
1253
.IP "\fB\-\-no\-print\-gc\-sections\fR" 4
1254
.IX Item "--no-print-gc-sections"
1255
.PD
1256
List all sections removed by garbage collection.  The listing is
1257
printed on stderr.  This option is only effective if garbage
1258
collection has been enabled via the \fB\-\-gc\-sections\fR) option.  The
1259
default behaviour (of not listing the sections that are removed) can
1260
be restored by specifying \fB\-\-no\-print\-gc\-sections\fR on the command
1261
line.
1262
.IP "\fB\-\-print\-output\-format\fR" 4
1263
.IX Item "--print-output-format"
1264
Print the name of the default output format (perhaps influenced by
1265
other command-line options).  This is the string that would appear
1266
in an \f(CW\*(C`OUTPUT_FORMAT\*(C'\fR linker script command.
1267
.IP "\fB\-\-help\fR" 4
1268
.IX Item "--help"
1269
Print a summary of the command-line options on the standard output and exit.
1270
.IP "\fB\-\-target\-help\fR" 4
1271
.IX Item "--target-help"
1272
Print a summary of all target specific options on the standard output and exit.
1273
.IP "\fB\-Map=\fR\fImapfile\fR" 4
1274
.IX Item "-Map=mapfile"
1275
Print a link map to the file \fImapfile\fR.  See the description of the
1276
\&\fB\-M\fR option, above.
1277
.IP "\fB\-\-no\-keep\-memory\fR" 4
1278
.IX Item "--no-keep-memory"
1279
\&\fBld\fR normally optimizes for speed over memory usage by caching the
1280
symbol tables of input files in memory.  This option tells \fBld\fR to
1281
instead optimize for memory usage, by rereading the symbol tables as
1282
necessary.  This may be required if \fBld\fR runs out of memory space
1283
while linking a large executable.
1284
.IP "\fB\-\-no\-undefined\fR" 4
1285
.IX Item "--no-undefined"
1286
.PD 0
1287
.IP "\fB\-z defs\fR" 4
1288
.IX Item "-z defs"
1289
.PD
1290
Report unresolved symbol references from regular object files.  This
1291
is done even if the linker is creating a non-symbolic shared library.
1292
The switch \fB\-\-[no\-]allow\-shlib\-undefined\fR controls the
1293
behaviour for reporting unresolved references found in shared
1294
libraries being linked in.
1295
.IP "\fB\-\-allow\-multiple\-definition\fR" 4
1296
.IX Item "--allow-multiple-definition"
1297
.PD 0
1298
.IP "\fB\-z muldefs\fR" 4
1299
.IX Item "-z muldefs"
1300
.PD
1301
Normally when a symbol is defined multiple times, the linker will
1302
report a fatal error. These options allow multiple definitions and the
1303
first definition will be used.
1304
.IP "\fB\-\-allow\-shlib\-undefined\fR" 4
1305
.IX Item "--allow-shlib-undefined"
1306
.PD 0
1307
.IP "\fB\-\-no\-allow\-shlib\-undefined\fR" 4
1308
.IX Item "--no-allow-shlib-undefined"
1309
.PD
1310
Allows or disallows undefined symbols in shared libraries.
1311
This switch is similar to \fB\-\-no\-undefined\fR except that it
1312
determines the behaviour when the undefined symbols are in a
1313
shared library rather than a regular object file.  It does not affect
1314
how undefined symbols in regular object files are handled.
1315
.Sp
1316
The default behaviour is to report errors for any undefined symbols
1317
referenced in shared libraries if the linker is being used to create
1318
an executable, but to allow them if the linker is being used to create
1319
a shared library.
1320
.Sp
1321
The reasons for allowing undefined symbol references in shared
1322
libraries specified at link time are that:
1323
.RS 4
1324
.IP "\(bu" 4
1325
A shared library specified at link time may not be the same as the one
1326
that is available at load time, so the symbol might actually be
1327
resolvable at load time.
1328
.IP "\(bu" 4
1329
There are some operating systems, eg BeOS and \s-1HPPA\s0, where undefined
1330
symbols in shared libraries are normal.
1331
.Sp
1332
The BeOS kernel for example patches shared libraries at load time to
1333
select whichever function is most appropriate for the current
1334
architecture.  This is used, for example, to dynamically select an
1335
appropriate memset function.
1336
.RE
1337
.RS 4
1338
.RE
1339
.IP "\fB\-\-no\-undefined\-version\fR" 4
1340
.IX Item "--no-undefined-version"
1341
Normally when a symbol has an undefined version, the linker will ignore
1342
it. This option disallows symbols with undefined version and a fatal error
1343
will be issued instead.
1344
.IP "\fB\-\-default\-symver\fR" 4
1345
.IX Item "--default-symver"
1346
Create and use a default symbol version (the soname) for unversioned
1347
exported symbols.
1348
.IP "\fB\-\-default\-imported\-symver\fR" 4
1349
.IX Item "--default-imported-symver"
1350
Create and use a default symbol version (the soname) for unversioned
1351
imported symbols.
1352
.IP "\fB\-\-no\-warn\-mismatch\fR" 4
1353
.IX Item "--no-warn-mismatch"
1354
Normally \fBld\fR will give an error if you try to link together input
1355
files that are mismatched for some reason, perhaps because they have
1356
been compiled for different processors or for different endiannesses.
1357
This option tells \fBld\fR that it should silently permit such possible
1358
errors.  This option should only be used with care, in cases when you
1359
have taken some special action that ensures that the linker errors are
1360
inappropriate.
1361
.IP "\fB\-\-no\-warn\-search\-mismatch\fR" 4
1362
.IX Item "--no-warn-search-mismatch"
1363
Normally \fBld\fR will give a warning if it finds an incompatible
1364
library during a library search.  This option silences the warning.
1365
.IP "\fB\-\-no\-whole\-archive\fR" 4
1366
.IX Item "--no-whole-archive"
1367
Turn off the effect of the \fB\-\-whole\-archive\fR option for subsequent
1368
archive files.
1369
.IP "\fB\-\-noinhibit\-exec\fR" 4
1370
.IX Item "--noinhibit-exec"
1371
Retain the executable output file whenever it is still usable.
1372
Normally, the linker will not produce an output file if it encounters
1373
errors during the link process; it exits without writing an output file
1374
when it issues any error whatsoever.
1375
.IP "\fB\-nostdlib\fR" 4
1376
.IX Item "-nostdlib"
1377
Only search library directories explicitly specified on the
1378
command line.  Library directories specified in linker scripts
1379
(including linker scripts specified on the command line) are ignored.
1380
.IP "\fB\-\-oformat=\fR\fIoutput-format\fR" 4
1381
.IX Item "--oformat=output-format"
1382
\&\fBld\fR may be configured to support more than one kind of object
1383
file.  If your \fBld\fR is configured this way, you can use the
1384
\&\fB\-\-oformat\fR option to specify the binary format for the output
1385
object file.  Even when \fBld\fR is configured to support alternative
1386
object formats, you don't usually need to specify this, as \fBld\fR
1387
should be configured to produce as a default output format the most
1388
usual format on each machine.  \fIoutput-format\fR is a text string, the
1389
name of a particular format supported by the \s-1BFD\s0 libraries.  (You can
1390
list the available binary formats with \fBobjdump \-i\fR.)  The script
1391
command \f(CW\*(C`OUTPUT_FORMAT\*(C'\fR can also specify the output format, but
1392
this option overrides it.
1393
.IP "\fB\-pie\fR" 4
1394
.IX Item "-pie"
1395
.PD 0
1396
.IP "\fB\-\-pic\-executable\fR" 4
1397
.IX Item "--pic-executable"
1398
.PD
1399
Create a position independent executable.  This is currently only supported on
1400
\&\s-1ELF\s0 platforms.  Position independent executables are similar to shared
1401
libraries in that they are relocated by the dynamic linker to the virtual
1402
address the \s-1OS\s0 chooses for them (which can vary between invocations).  Like
1403
normal dynamically linked executables they can be executed and symbols
1404
defined in the executable cannot be overridden by shared libraries.
1405
.IP "\fB\-qmagic\fR" 4
1406
.IX Item "-qmagic"
1407
This option is ignored for Linux compatibility.
1408
.IP "\fB\-Qy\fR" 4
1409
.IX Item "-Qy"
1410
This option is ignored for \s-1SVR4\s0 compatibility.
1411
.IP "\fB\-\-relax\fR" 4
1412
.IX Item "--relax"
1413
.PD 0
1414
.IP "\fB\-\-no\-relax\fR" 4
1415
.IX Item "--no-relax"
1416
.PD
1417
An option with machine dependent effects.
1418
This option is only supported on a few targets.
1419
.Sp
1420
On some platforms the \fB\-\-relax\fR option performs target specific,
1421
global optimizations that become possible when the linker resolves
1422
addressing in the program, such as relaxing address modes,
1423
synthesizing new instructions, selecting shorter version of current
1424
instructions, and combining constant values.
1425
.Sp
1426
On some platforms these link time global optimizations may make symbolic
1427
debugging of the resulting executable impossible.
1428
This is known to be the case for the Matsushita \s-1MN10200\s0 and \s-1MN10300\s0
1429
family of processors.
1430
.Sp
1431
On platforms where this is not supported, \fB\-\-relax\fR is accepted,
1432
but ignored.
1433
.Sp
1434
On platforms where \fB\-\-relax\fR is accepted the option
1435
\&\fB\-\-no\-relax\fR can be used to disable the feature.
1436
.IP "\fB\-\-retain\-symbols\-file=\fR\fIfilename\fR" 4
1437
.IX Item "--retain-symbols-file=filename"
1438
Retain \fIonly\fR the symbols listed in the file \fIfilename\fR,
1439
discarding all others.  \fIfilename\fR is simply a flat file, with one
1440
symbol name per line.  This option is especially useful in environments
1441
(such as VxWorks)
1442
where a large global symbol table is accumulated gradually, to conserve
1443
run-time memory.
1444
.Sp
1445
\&\fB\-\-retain\-symbols\-file\fR does \fInot\fR discard undefined symbols,
1446
or symbols needed for relocations.
1447
.Sp
1448
You may only specify \fB\-\-retain\-symbols\-file\fR once in the command
1449
line.  It overrides \fB\-s\fR and \fB\-S\fR.
1450
.IP "\fB\-rpath=\fR\fIdir\fR" 4
1451
.IX Item "-rpath=dir"
1452
Add a directory to the runtime library search path.  This is used when
1453
linking an \s-1ELF\s0 executable with shared objects.  All \fB\-rpath\fR
1454
arguments are concatenated and passed to the runtime linker, which uses
1455
them to locate shared objects at runtime.  The \fB\-rpath\fR option is
1456
also used when locating shared objects which are needed by shared
1457
objects explicitly included in the link; see the description of the
1458
\&\fB\-rpath\-link\fR option.  If \fB\-rpath\fR is not used when linking an
1459
\&\s-1ELF\s0 executable, the contents of the environment variable
1460
\&\f(CW\*(C`LD_RUN_PATH\*(C'\fR will be used if it is defined.
1461
.Sp
1462
The \fB\-rpath\fR option may also be used on SunOS.  By default, on
1463
SunOS, the linker will form a runtime search patch out of all the
1464
\&\fB\-L\fR options it is given.  If a \fB\-rpath\fR option is used, the
1465
runtime search path will be formed exclusively using the \fB\-rpath\fR
1466
options, ignoring the \fB\-L\fR options.  This can be useful when using
1467
gcc, which adds many \fB\-L\fR options which may be on \s-1NFS\s0 mounted
1468
file systems.
1469
.Sp
1470
For compatibility with other \s-1ELF\s0 linkers, if the \fB\-R\fR option is
1471
followed by a directory name, rather than a file name, it is treated as
1472
the \fB\-rpath\fR option.
1473
.IP "\fB\-rpath\-link=\fR\fIdir\fR" 4
1474
.IX Item "-rpath-link=dir"
1475
When using \s-1ELF\s0 or SunOS, one shared library may require another.  This
1476
happens when an \f(CW\*(C`ld \-shared\*(C'\fR link includes a shared library as one
1477
of the input files.
1478
.Sp
1479
When the linker encounters such a dependency when doing a non-shared,
1480
non-relocatable link, it will automatically try to locate the required
1481
shared library and include it in the link, if it is not included
1482
explicitly.  In such a case, the \fB\-rpath\-link\fR option
1483
specifies the first set of directories to search.  The
1484
\&\fB\-rpath\-link\fR option may specify a sequence of directory names
1485
either by specifying a list of names separated by colons, or by
1486
appearing multiple times.
1487
.Sp
1488
This option should be used with caution as it overrides the search path
1489
that may have been hard compiled into a shared library. In such a case it
1490
is possible to use unintentionally a different search path than the
1491
runtime linker would do.
1492
.Sp
1493
The linker uses the following search paths to locate required shared
1494
libraries:
1495
.RS 4
1496
.IP "1." 4
1497
Any directories specified by \fB\-rpath\-link\fR options.
1498
.IP "2." 4
1499
Any directories specified by \fB\-rpath\fR options.  The difference
1500
between \fB\-rpath\fR and \fB\-rpath\-link\fR is that directories
1501
specified by \fB\-rpath\fR options are included in the executable and
1502
used at runtime, whereas the \fB\-rpath\-link\fR option is only effective
1503
at link time. Searching \fB\-rpath\fR in this way is only supported
1504
by native linkers and cross linkers which have been configured with
1505
the \fB\-\-with\-sysroot\fR option.
1506
.IP "3." 4
1507
On an \s-1ELF\s0 system, for native linkers, if the \fB\-rpath\fR and
1508
\&\fB\-rpath\-link\fR options were not used, search the contents of the
1509
environment variable \f(CW\*(C`LD_RUN_PATH\*(C'\fR.
1510
.IP "4." 4
1511
On SunOS, if the \fB\-rpath\fR option was not used, search any
1512
directories specified using \fB\-L\fR options.
1513
.IP "5." 4
1514
For a native linker, the search the contents of the environment
1515
variable \f(CW\*(C`LD_LIBRARY_PATH\*(C'\fR.
1516
.IP "6." 4
1517
For a native \s-1ELF\s0 linker, the directories in \f(CW\*(C`DT_RUNPATH\*(C'\fR or
1518
\&\f(CW\*(C`DT_RPATH\*(C'\fR of a shared library are searched for shared
1519
libraries needed by it. The \f(CW\*(C`DT_RPATH\*(C'\fR entries are ignored if
1520
\&\f(CW\*(C`DT_RUNPATH\*(C'\fR entries exist.
1521
.IP "7." 4
1522
The default directories, normally \fI/lib\fR and \fI/usr/lib\fR.
1523
.IP "8." 4
1524
For a native linker on an \s-1ELF\s0 system, if the file \fI/etc/ld.so.conf\fR
1525
exists, the list of directories found in that file.
1526
.RE
1527
.RS 4
1528
.Sp
1529
If the required shared library is not found, the linker will issue a
1530
warning and continue with the link.
1531
.RE
1532
.IP "\fB\-shared\fR" 4
1533
.IX Item "-shared"
1534
.PD 0
1535
.IP "\fB\-Bshareable\fR" 4
1536
.IX Item "-Bshareable"
1537
.PD
1538
Create a shared library.  This is currently only supported on \s-1ELF\s0, \s-1XCOFF\s0
1539
and SunOS platforms.  On SunOS, the linker will automatically create a
1540
shared library if the \fB\-e\fR option is not used and there are
1541
undefined symbols in the link.
1542
.IP "\fB\-\-sort\-common\fR" 4
1543
.IX Item "--sort-common"
1544
.PD 0
1545
.IP "\fB\-\-sort\-common=ascending\fR" 4
1546
.IX Item "--sort-common=ascending"
1547
.IP "\fB\-\-sort\-common=descending\fR" 4
1548
.IX Item "--sort-common=descending"
1549
.PD
1550
This option tells \fBld\fR to sort the common symbols by alignment in
1551
ascending or descending order when it places them in the appropriate output
1552
sections.  The symbol alignments considered are sixteen-byte or larger,
1553
eight-byte, four-byte, two-byte, and one-byte. This is to prevent gaps
1554
between symbols due to alignment constraints.  If no sorting order is
1555
specified, then descending order is assumed.
1556
.IP "\fB\-\-sort\-section=name\fR" 4
1557
.IX Item "--sort-section=name"
1558
This option will apply \f(CW\*(C`SORT_BY_NAME\*(C'\fR to all wildcard section
1559
patterns in the linker script.
1560
.IP "\fB\-\-sort\-section=alignment\fR" 4
1561
.IX Item "--sort-section=alignment"
1562
This option will apply \f(CW\*(C`SORT_BY_ALIGNMENT\*(C'\fR to all wildcard section
1563
patterns in the linker script.
1564
.IP "\fB\-\-split\-by\-file[=\fR\fIsize\fR\fB]\fR" 4
1565
.IX Item "--split-by-file[=size]"
1566
Similar to \fB\-\-split\-by\-reloc\fR but creates a new output section for
1567
each input file when \fIsize\fR is reached.  \fIsize\fR defaults to a
1568
size of 1 if not given.
1569
.IP "\fB\-\-split\-by\-reloc[=\fR\fIcount\fR\fB]\fR" 4
1570
.IX Item "--split-by-reloc[=count]"
1571
Tries to creates extra sections in the output file so that no single
1572
output section in the file contains more than \fIcount\fR relocations.
1573
This is useful when generating huge relocatable files for downloading into
1574
certain real time kernels with the \s-1COFF\s0 object file format; since \s-1COFF\s0
1575
cannot represent more than 65535 relocations in a single section.  Note
1576
that this will fail to work with object file formats which do not
1577
support arbitrary sections.  The linker will not split up individual
1578
input sections for redistribution, so if a single input section contains
1579
more than \fIcount\fR relocations one output section will contain that
1580
many relocations.  \fIcount\fR defaults to a value of 32768.
1581
.IP "\fB\-\-stats\fR" 4
1582
.IX Item "--stats"
1583
Compute and display statistics about the operation of the linker, such
1584
as execution time and memory usage.
1585
.IP "\fB\-\-sysroot=\fR\fIdirectory\fR" 4
1586
.IX Item "--sysroot=directory"
1587
Use \fIdirectory\fR as the location of the sysroot, overriding the
1588
configure-time default.  This option is only supported by linkers
1589
that were configured using \fB\-\-with\-sysroot\fR.
1590
.IP "\fB\-\-traditional\-format\fR" 4
1591
.IX Item "--traditional-format"
1592
For some targets, the output of \fBld\fR is different in some ways from
1593
the output of some existing linker.  This switch requests \fBld\fR to
1594
use the traditional format instead.
1595
.Sp
1596
For example, on SunOS, \fBld\fR combines duplicate entries in the
1597
symbol string table.  This can reduce the size of an output file with
1598
full debugging information by over 30 percent.  Unfortunately, the SunOS
1599
\&\f(CW\*(C`dbx\*(C'\fR program can not read the resulting program (\f(CW\*(C`gdb\*(C'\fR has no
1600
trouble).  The \fB\-\-traditional\-format\fR switch tells \fBld\fR to not
1601
combine duplicate entries.
1602
.IP "\fB\-\-section\-start=\fR\fIsectionname\fR\fB=\fR\fIorg\fR" 4
1603
.IX Item "--section-start=sectionname=org"
1604
Locate a section in the output file at the absolute
1605
address given by \fIorg\fR.  You may use this option as many
1606
times as necessary to locate multiple sections in the command
1607
line.
1608
\&\fIorg\fR must be a single hexadecimal integer;
1609
for compatibility with other linkers, you may omit the leading
1610
\&\fB0x\fR usually associated with hexadecimal values.  \fINote:\fR there
1611
should be no white space between \fIsectionname\fR, the equals
1612
sign ("\fB=\fR"), and \fIorg\fR.
1613
.IP "\fB\-Tbss=\fR\fIorg\fR" 4
1614
.IX Item "-Tbss=org"
1615
.PD 0
1616
.IP "\fB\-Tdata=\fR\fIorg\fR" 4
1617
.IX Item "-Tdata=org"
1618
.IP "\fB\-Ttext=\fR\fIorg\fR" 4
1619
.IX Item "-Ttext=org"
1620
.PD
1621
Same as \fB\-\-section\-start\fR, with \f(CW\*(C`.bss\*(C'\fR, \f(CW\*(C`.data\*(C'\fR or
1622
\&\f(CW\*(C`.text\*(C'\fR as the \fIsectionname\fR.
1623
.IP "\fB\-Ttext\-segment=\fR\fIorg\fR" 4
1624
.IX Item "-Ttext-segment=org"
1625
When creating an \s-1ELF\s0 executable or shared object, it will set the address
1626
of the first byte of the text segment.
1627
.IP "\fB\-\-unresolved\-symbols=\fR\fImethod\fR" 4
1628
.IX Item "--unresolved-symbols=method"
1629
Determine how to handle unresolved symbols.  There are four possible
1630
values for \fBmethod\fR:
1631
.RS 4
1632
.IP "\fBignore-all\fR" 4
1633
.IX Item "ignore-all"
1634
Do not report any unresolved symbols.
1635
.IP "\fBreport-all\fR" 4
1636
.IX Item "report-all"
1637
Report all unresolved symbols.  This is the default.
1638
.IP "\fBignore-in-object-files\fR" 4
1639
.IX Item "ignore-in-object-files"
1640
Report unresolved symbols that are contained in shared libraries, but
1641
ignore them if they come from regular object files.
1642
.IP "\fBignore-in-shared-libs\fR" 4
1643
.IX Item "ignore-in-shared-libs"
1644
Report unresolved symbols that come from regular object files, but
1645
ignore them if they come from shared libraries.  This can be useful
1646
when creating a dynamic binary and it is known that all the shared
1647
libraries that it should be referencing are included on the linker's
1648
command line.
1649
.RE
1650
.RS 4
1651
.Sp
1652
The behaviour for shared libraries on their own can also be controlled
1653
by the \fB\-\-[no\-]allow\-shlib\-undefined\fR option.
1654
.Sp
1655
Normally the linker will generate an error message for each reported
1656
unresolved symbol but the option \fB\-\-warn\-unresolved\-symbols\fR
1657
can change this to a warning.
1658
.RE
1659
.IP "\fB\-\-dll\-verbose\fR" 4
1660
.IX Item "--dll-verbose"
1661
.PD 0
1662
.IP "\fB\-\-verbose[=\fR\fI\s-1NUMBER\s0\fR\fB]\fR" 4
1663
.IX Item "--verbose[=NUMBER]"
1664
.PD
1665
Display the version number for \fBld\fR and list the linker emulations
1666
supported.  Display which input files can and cannot be opened.  Display
1667
the linker script being used by the linker. If the optional \fI\s-1NUMBER\s0\fR
1668
argument > 1, plugin symbol status will also be displayed.
1669
.IP "\fB\-\-version\-script=\fR\fIversion-scriptfile\fR" 4
1670
.IX Item "--version-script=version-scriptfile"
1671
Specify the name of a version script to the linker.  This is typically
1672
used when creating shared libraries to specify additional information
1673
about the version hierarchy for the library being created.  This option
1674
is only fully supported on \s-1ELF\s0 platforms which support shared libraries;
1675
see \fB\s-1VERSION\s0\fR.  It is partially supported on \s-1PE\s0 platforms, which can
1676
use version scripts to filter symbol visibility in auto-export mode: any
1677
symbols marked \fBlocal\fR in the version script will not be exported.
1678
.IP "\fB\-\-warn\-common\fR" 4
1679
.IX Item "--warn-common"
1680
Warn when a common symbol is combined with another common symbol or with
1681
a symbol definition.  Unix linkers allow this somewhat sloppy practice,
1682
but linkers on some other operating systems do not.  This option allows
1683
you to find potential problems from combining global symbols.
1684
Unfortunately, some C libraries use this practice, so you may get some
1685
warnings about symbols in the libraries as well as in your programs.
1686
.Sp
1687
There are three kinds of global symbols, illustrated here by C examples:
1688
.RS 4
1689
.IP "\fBint i = 1;\fR" 4
1690
.IX Item "int i = 1;"
1691
A definition, which goes in the initialized data section of the output
1692
file.
1693
.IP "\fBextern int i;\fR" 4
1694
.IX Item "extern int i;"
1695
An undefined reference, which does not allocate space.
1696
There must be either a definition or a common symbol for the
1697
variable somewhere.
1698
.IP "\fBint i;\fR" 4
1699
.IX Item "int i;"
1700
A common symbol.  If there are only (one or more) common symbols for a
1701
variable, it goes in the uninitialized data area of the output file.
1702
The linker merges multiple common symbols for the same variable into a
1703
single symbol.  If they are of different sizes, it picks the largest
1704
size.  The linker turns a common symbol into a declaration, if there is
1705
a definition of the same variable.
1706
.RE
1707
.RS 4
1708
.Sp
1709
The \fB\-\-warn\-common\fR option can produce five kinds of warnings.
1710
Each warning consists of a pair of lines: the first describes the symbol
1711
just encountered, and the second describes the previous symbol
1712
encountered with the same name.  One or both of the two symbols will be
1713
a common symbol.
1714
.IP "1." 4
1715
Turning a common symbol into a reference, because there is already a
1716
definition for the symbol.
1717
.Sp
1718
.Vb 3
1719
\&        (
): warning: common of \`\*(Aq
1720
\&           overridden by definition
1721
\&        (
): warning: defined here
1722
.Ve
1723
.IP "2." 4
1724
Turning a common symbol into a reference, because a later definition for
1725
the symbol is encountered.  This is the same as the previous case,
1726
except that the symbols are encountered in a different order.
1727
.Sp
1728
.Vb 3
1729
\&        (
): warning: definition of \`\*(Aq
1730
\&           overriding common
1731
\&        (
): warning: common is here
1732
.Ve
1733
.IP "3." 4
1734
Merging a common symbol with a previous same-sized common symbol.
1735
.Sp
1736
.Vb 3
1737
\&        (
): warning: multiple common
1738
\&           of \`\*(Aq
1739
\&        (
): warning: previous common is here
1740
.Ve
1741
.IP "4." 4
1742
Merging a common symbol with a previous larger common symbol.
1743
.Sp
1744
.Vb 3
1745
\&        (
): warning: common of \`\*(Aq
1746
\&           overridden by larger common
1747
\&        (
): warning: larger common is here
1748
.Ve
1749
.IP "5." 4
1750
Merging a common symbol with a previous smaller common symbol.  This is
1751
the same as the previous case, except that the symbols are
1752
encountered in a different order.
1753
.Sp
1754
.Vb 3
1755
\&        (
): warning: common of \`\*(Aq
1756
\&           overriding smaller common
1757
\&        (
): warning: smaller common is here
1758
.Ve
1759
.RE
1760
.RS 4
1761
.RE
1762
.IP "\fB\-\-warn\-constructors\fR" 4
1763
.IX Item "--warn-constructors"
1764
Warn if any global constructors are used.  This is only useful for a few
1765
object file formats.  For formats like \s-1COFF\s0 or \s-1ELF\s0, the linker can not
1766
detect the use of global constructors.
1767
.IP "\fB\-\-warn\-multiple\-gp\fR" 4
1768
.IX Item "--warn-multiple-gp"
1769
Warn if multiple global pointer values are required in the output file.
1770
This is only meaningful for certain processors, such as the Alpha.
1771
Specifically, some processors put large-valued constants in a special
1772
section.  A special register (the global pointer) points into the middle
1773
of this section, so that constants can be loaded efficiently via a
1774
base-register relative addressing mode.  Since the offset in
1775
base-register relative mode is fixed and relatively small (e.g., 16
1776
bits), this limits the maximum size of the constant pool.  Thus, in
1777
large programs, it is often necessary to use multiple global pointer
1778
values in order to be able to address all possible constants.  This
1779
option causes a warning to be issued whenever this case occurs.
1780
.IP "\fB\-\-warn\-once\fR" 4
1781
.IX Item "--warn-once"
1782
Only warn once for each undefined symbol, rather than once per module
1783
which refers to it.
1784
.IP "\fB\-\-warn\-section\-align\fR" 4
1785
.IX Item "--warn-section-align"
1786
Warn if the address of an output section is changed because of
1787
alignment.  Typically, the alignment will be set by an input section.
1788
The address will only be changed if it not explicitly specified; that
1789
is, if the \f(CW\*(C`SECTIONS\*(C'\fR command does not specify a start address for
1790
the section.
1791
.IP "\fB\-\-warn\-shared\-textrel\fR" 4
1792
.IX Item "--warn-shared-textrel"
1793
Warn if the linker adds a \s-1DT_TEXTREL\s0 to a shared object.
1794
.IP "\fB\-\-warn\-alternate\-em\fR" 4
1795
.IX Item "--warn-alternate-em"
1796
Warn if an object has alternate \s-1ELF\s0 machine code.
1797
.IP "\fB\-\-warn\-unresolved\-symbols\fR" 4
1798
.IX Item "--warn-unresolved-symbols"
1799
If the linker is going to report an unresolved symbol (see the option
1800
\&\fB\-\-unresolved\-symbols\fR) it will normally generate an error.
1801
This option makes it generate a warning instead.
1802
.IP "\fB\-\-error\-unresolved\-symbols\fR" 4
1803
.IX Item "--error-unresolved-symbols"
1804
This restores the linker's default behaviour of generating errors when
1805
it is reporting unresolved symbols.
1806
.IP "\fB\-\-whole\-archive\fR" 4
1807
.IX Item "--whole-archive"
1808
For each archive mentioned on the command line after the
1809
\&\fB\-\-whole\-archive\fR option, include every object file in the archive
1810
in the link, rather than searching the archive for the required object
1811
files.  This is normally used to turn an archive file into a shared
1812
library, forcing every object to be included in the resulting shared
1813
library.  This option may be used more than once.
1814
.Sp
1815
Two notes when using this option from gcc: First, gcc doesn't know
1816
about this option, so you have to use \fB\-Wl,\-whole\-archive\fR.
1817
Second, don't forget to use \fB\-Wl,\-no\-whole\-archive\fR after your
1818
list of archives, because gcc will add its own list of archives to
1819
your link and you may not want this flag to affect those as well.
1820
.IP "\fB\-\-wrap=\fR\fIsymbol\fR" 4
1821
.IX Item "--wrap=symbol"
1822
Use a wrapper function for \fIsymbol\fR.  Any undefined reference to
1823
\&\fIsymbol\fR will be resolved to \f(CW\*(C`_\|_wrap_\f(CIsymbol\f(CW\*(C'\fR.  Any
1824
undefined reference to \f(CW\*(C`_\|_real_\f(CIsymbol\f(CW\*(C'\fR will be resolved to
1825
\&\fIsymbol\fR.
1826
.Sp
1827
This can be used to provide a wrapper for a system function.  The
1828
wrapper function should be called \f(CW\*(C`_\|_wrap_\f(CIsymbol\f(CW\*(C'\fR.  If it
1829
wishes to call the system function, it should call
1830
\&\f(CW\*(C`_\|_real_\f(CIsymbol\f(CW\*(C'\fR.
1831
.Sp
1832
Here is a trivial example:
1833
.Sp
1834
.Vb 6
1835
\&        void *
1836
\&        _\|_wrap_malloc (size_t c)
1837
\&        {
1838
\&          printf ("malloc called with %zu\en", c);
1839
\&          return _\|_real_malloc (c);
1840
\&        }
1841
.Ve
1842
.Sp
1843
If you link other code with this file using \fB\-\-wrap malloc\fR, then
1844
all calls to \f(CW\*(C`malloc\*(C'\fR will call the function \f(CW\*(C`_\|_wrap_malloc\*(C'\fR
1845
instead.  The call to \f(CW\*(C`_\|_real_malloc\*(C'\fR in \f(CW\*(C`_\|_wrap_malloc\*(C'\fR will
1846
call the real \f(CW\*(C`malloc\*(C'\fR function.
1847
.Sp
1848
You may wish to provide a \f(CW\*(C`_\|_real_malloc\*(C'\fR function as well, so that
1849
links without the \fB\-\-wrap\fR option will succeed.  If you do this,
1850
you should not put the definition of \f(CW\*(C`_\|_real_malloc\*(C'\fR in the same
1851
file as \f(CW\*(C`_\|_wrap_malloc\*(C'\fR; if you do, the assembler may resolve the
1852
call before the linker has a chance to wrap it to \f(CW\*(C`malloc\*(C'\fR.
1853
.IP "\fB\-\-eh\-frame\-hdr\fR" 4
1854
.IX Item "--eh-frame-hdr"
1855
Request creation of \f(CW\*(C`.eh_frame_hdr\*(C'\fR section and \s-1ELF\s0
1856
\&\f(CW\*(C`PT_GNU_EH_FRAME\*(C'\fR segment header.
1857
.IP "\fB\-\-no\-ld\-generated\-unwind\-info\fR" 4
1858
.IX Item "--no-ld-generated-unwind-info"
1859
Request creation of \f(CW\*(C`.eh_frame\*(C'\fR unwind info for linker
1860
generated code sections like \s-1PLT\s0.  This option is on by default
1861
if linker generated unwind info is supported.
1862
.IP "\fB\-\-enable\-new\-dtags\fR" 4
1863
.IX Item "--enable-new-dtags"
1864
.PD 0
1865
.IP "\fB\-\-disable\-new\-dtags\fR" 4
1866
.IX Item "--disable-new-dtags"
1867
.PD
1868
This linker can create the new dynamic tags in \s-1ELF\s0. But the older \s-1ELF\s0
1869
systems may not understand them. If you specify
1870
\&\fB\-\-enable\-new\-dtags\fR, the dynamic tags will be created as needed.
1871
If you specify \fB\-\-disable\-new\-dtags\fR, no new dynamic tags will be
1872
created. By default, the new dynamic tags are not created. Note that
1873
those options are only available for \s-1ELF\s0 systems.
1874
.IP "\fB\-\-hash\-size=\fR\fInumber\fR" 4
1875
.IX Item "--hash-size=number"
1876
Set the default size of the linker's hash tables to a prime number
1877
close to \fInumber\fR.  Increasing this value can reduce the length of
1878
time it takes the linker to perform its tasks, at the expense of
1879
increasing the linker's memory requirements.  Similarly reducing this
1880
value can reduce the memory requirements at the expense of speed.
1881
.IP "\fB\-\-hash\-style=\fR\fIstyle\fR" 4
1882
.IX Item "--hash-style=style"
1883
Set the type of linker's hash table(s).  \fIstyle\fR can be either
1884
\&\f(CW\*(C`sysv\*(C'\fR for classic \s-1ELF\s0 \f(CW\*(C`.hash\*(C'\fR section, \f(CW\*(C`gnu\*(C'\fR for
1885
new style \s-1GNU\s0 \f(CW\*(C`.gnu.hash\*(C'\fR section or \f(CW\*(C`both\*(C'\fR for both
1886
the classic \s-1ELF\s0 \f(CW\*(C`.hash\*(C'\fR and new style \s-1GNU\s0 \f(CW\*(C`.gnu.hash\*(C'\fR
1887
hash tables.  The default is \f(CW\*(C`sysv\*(C'\fR.
1888
.IP "\fB\-\-reduce\-memory\-overheads\fR" 4
1889
.IX Item "--reduce-memory-overheads"
1890
This option reduces memory requirements at ld runtime, at the expense of
1891
linking speed.  This was introduced to select the old O(n^2) algorithm
1892
for link map file generation, rather than the new O(n) algorithm which uses
1893
about 40% more memory for symbol storage.
1894
.Sp
1895
Another effect of the switch is to set the default hash table size to
1896
1021, which again saves memory at the cost of lengthening the linker's
1897
run time.  This is not done however if the \fB\-\-hash\-size\fR switch
1898
has been used.
1899
.Sp
1900
The \fB\-\-reduce\-memory\-overheads\fR switch may be also be used to
1901
enable other tradeoffs in future versions of the linker.
1902
.IP "\fB\-\-build\-id\fR" 4
1903
.IX Item "--build-id"
1904
.PD 0
1905
.IP "\fB\-\-build\-id=\fR\fIstyle\fR" 4
1906
.IX Item "--build-id=style"
1907
.PD
1908
Request creation of \f(CW\*(C`.note.gnu.build\-id\*(C'\fR \s-1ELF\s0 note section.
1909
The contents of the note are unique bits identifying this linked
1910
file.  \fIstyle\fR can be \f(CW\*(C`uuid\*(C'\fR to use 128 random bits,
1911
\&\f(CW\*(C`sha1\*(C'\fR to use a 160\-bit \s-1SHA1\s0 hash on the normative
1912
parts of the output contents, \f(CW\*(C`md5\*(C'\fR to use a 128\-bit
1913
\&\s-1MD5\s0 hash on the normative parts of the output contents, or
1914
\&\f(CW\*(C`0x\f(CIhexstring\f(CW\*(C'\fR to use a chosen bit string specified as
1915
an even number of hexadecimal digits (\f(CW\*(C`\-\*(C'\fR and \f(CW\*(C`:\*(C'\fR
1916
characters between digit pairs are ignored).  If \fIstyle\fR is
1917
omitted, \f(CW\*(C`sha1\*(C'\fR is used.
1918
.Sp
1919
The \f(CW\*(C`md5\*(C'\fR and \f(CW\*(C`sha1\*(C'\fR styles produces an identifier
1920
that is always the same in an identical output file, but will be
1921
unique among all nonidentical output files.  It is not intended
1922
to be compared as a checksum for the file's contents.  A linked
1923
file may be changed later by other tools, but the build \s-1ID\s0 bit
1924
string identifying the original linked file does not change.
1925
.Sp
1926
Passing \f(CW\*(C`none\*(C'\fR for \fIstyle\fR disables the setting from any
1927
\&\f(CW\*(C`\-\-build\-id\*(C'\fR options earlier on the command line.
1928
.PP
1929
The i386 \s-1PE\s0 linker supports the \fB\-shared\fR option, which causes
1930
the output to be a dynamically linked library (\s-1DLL\s0) instead of a
1931
normal executable.  You should name the output \f(CW\*(C`*.dll\*(C'\fR when you
1932
use this option.  In addition, the linker fully supports the standard
1933
\&\f(CW\*(C`*.def\*(C'\fR files, which may be specified on the linker command line
1934
like an object file (in fact, it should precede archives it exports
1935
symbols from, to ensure that they get linked in, just like a normal
1936
object file).
1937
.PP
1938
In addition to the options common to all targets, the i386 \s-1PE\s0 linker
1939
support additional command line options that are specific to the i386
1940
\&\s-1PE\s0 target.  Options that take values may be separated from their
1941
values by either a space or an equals sign.
1942
.IP "\fB\-\-add\-stdcall\-alias\fR" 4
1943
.IX Item "--add-stdcall-alias"
1944
If given, symbols with a stdcall suffix (@\fInn\fR) will be exported
1945
as-is and also with the suffix stripped.
1946
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
1947
.IP "\fB\-\-base\-file\fR \fIfile\fR" 4
1948
.IX Item "--base-file file"
1949
Use \fIfile\fR as the name of a file in which to save the base
1950
addresses of all the relocations needed for generating DLLs with
1951
\&\fIdlltool\fR.
1952
[This is an i386 \s-1PE\s0 specific option]
1953
.IP "\fB\-\-dll\fR" 4
1954
.IX Item "--dll"
1955
Create a \s-1DLL\s0 instead of a regular executable.  You may also use
1956
\&\fB\-shared\fR or specify a \f(CW\*(C`LIBRARY\*(C'\fR in a given \f(CW\*(C`.def\*(C'\fR
1957
file.
1958
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
1959
.IP "\fB\-\-enable\-long\-section\-names\fR" 4
1960
.IX Item "--enable-long-section-names"
1961
.PD 0
1962
.IP "\fB\-\-disable\-long\-section\-names\fR" 4
1963
.IX Item "--disable-long-section-names"
1964
.PD
1965
The \s-1PE\s0 variants of the Coff object format add an extension that permits
1966
the use of section names longer than eight characters, the normal limit
1967
for Coff.  By default, these names are only allowed in object files, as
1968
fully-linked executable images do not carry the Coff string table required
1969
to support the longer names.  As a \s-1GNU\s0 extension, it is possible to
1970
allow their use in executable images as well, or to (probably pointlessly!)
1971
disallow it in object files, by using these two options.  Executable images
1972
generated with these long section names are slightly non-standard, carrying
1973
as they do a string table, and may generate confusing output when examined
1974
with non-GNU PE-aware tools, such as file viewers and dumpers.  However,
1975
\&\s-1GDB\s0 relies on the use of \s-1PE\s0 long section names to find Dwarf\-2 debug
1976
information sections in an executable image at runtime, and so if neither
1977
option is specified on the command-line, \fBld\fR will enable long
1978
section names, overriding the default and technically correct behaviour,
1979
when it finds the presence of debug information while linking an executable
1980
image and not stripping symbols.
1981
[This option is valid for all \s-1PE\s0 targeted ports of the linker]
1982
.IP "\fB\-\-enable\-stdcall\-fixup\fR" 4
1983
.IX Item "--enable-stdcall-fixup"
1984
.PD 0
1985
.IP "\fB\-\-disable\-stdcall\-fixup\fR" 4
1986
.IX Item "--disable-stdcall-fixup"
1987
.PD
1988
If the link finds a symbol that it cannot resolve, it will attempt to
1989
do \*(L"fuzzy linking\*(R" by looking for another defined symbol that differs
1990
only in the format of the symbol name (cdecl vs stdcall) and will
1991
resolve that symbol by linking to the match.  For example, the
1992
undefined symbol \f(CW\*(C`_foo\*(C'\fR might be linked to the function
1993
\&\f(CW\*(C`_foo@12\*(C'\fR, or the undefined symbol \f(CW\*(C`_bar@16\*(C'\fR might be linked
1994
to the function \f(CW\*(C`_bar\*(C'\fR.  When the linker does this, it prints a
1995
warning, since it normally should have failed to link, but sometimes
1996
import libraries generated from third-party dlls may need this feature
1997
to be usable.  If you specify \fB\-\-enable\-stdcall\-fixup\fR, this
1998
feature is fully enabled and warnings are not printed.  If you specify
1999
\&\fB\-\-disable\-stdcall\-fixup\fR, this feature is disabled and such
2000
mismatches are considered to be errors.
2001
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2002
.IP "\fB\-\-leading\-underscore\fR" 4
2003
.IX Item "--leading-underscore"
2004
.PD 0
2005
.IP "\fB\-\-no\-leading\-underscore\fR" 4
2006
.IX Item "--no-leading-underscore"
2007
.PD
2008
For most targets default symbol-prefix is an underscore and is defined
2009
in target's description. By this option it is possible to
2010
disable/enable the default underscore symbol-prefix.
2011
.IP "\fB\-\-export\-all\-symbols\fR" 4
2012
.IX Item "--export-all-symbols"
2013
If given, all global symbols in the objects used to build a \s-1DLL\s0 will
2014
be exported by the \s-1DLL\s0.  Note that this is the default if there
2015
otherwise wouldn't be any exported symbols.  When symbols are
2016
explicitly exported via \s-1DEF\s0 files or implicitly exported via function
2017
attributes, the default is to not export anything else unless this
2018
option is given.  Note that the symbols \f(CW\*(C`DllMain@12\*(C'\fR,
2019
\&\f(CW\*(C`DllEntryPoint@0\*(C'\fR, \f(CW\*(C`DllMainCRTStartup@12\*(C'\fR, and
2020
\&\f(CW\*(C`impure_ptr\*(C'\fR will not be automatically
2021
exported.  Also, symbols imported from other DLLs will not be
2022
re-exported, nor will symbols specifying the \s-1DLL\s0's internal layout
2023
such as those beginning with \f(CW\*(C`_head_\*(C'\fR or ending with
2024
\&\f(CW\*(C`_iname\*(C'\fR.  In addition, no symbols from \f(CW\*(C`libgcc\*(C'\fR,
2025
\&\f(CW\*(C`libstd++\*(C'\fR, \f(CW\*(C`libmingw32\*(C'\fR, or \f(CW\*(C`crtX.o\*(C'\fR will be exported.
2026
Symbols whose names begin with \f(CW\*(C`_\|_rtti_\*(C'\fR or \f(CW\*(C`_\|_builtin_\*(C'\fR will
2027
not be exported, to help with \*(C+ DLLs.  Finally, there is an
2028
extensive list of cygwin-private symbols that are not exported
2029
(obviously, this applies on when building DLLs for cygwin targets).
2030
These cygwin-excludes are: \f(CW\*(C`_cygwin_dll_entry@12\*(C'\fR,
2031
\&\f(CW\*(C`_cygwin_crt0_common@8\*(C'\fR, \f(CW\*(C`_cygwin_noncygwin_dll_entry@12\*(C'\fR,
2032
\&\f(CW\*(C`_fmode\*(C'\fR, \f(CW\*(C`_impure_ptr\*(C'\fR, \f(CW\*(C`cygwin_attach_dll\*(C'\fR,
2033
\&\f(CW\*(C`cygwin_premain0\*(C'\fR, \f(CW\*(C`cygwin_premain1\*(C'\fR, \f(CW\*(C`cygwin_premain2\*(C'\fR,
2034
\&\f(CW\*(C`cygwin_premain3\*(C'\fR, and \f(CW\*(C`environ\*(C'\fR.
2035
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2036
.IP "\fB\-\-exclude\-symbols\fR \fIsymbol\fR\fB,\fR\fIsymbol\fR\fB,...\fR" 4
2037
.IX Item "--exclude-symbols symbol,symbol,..."
2038
Specifies a list of symbols which should not be automatically
2039
exported.  The symbol names may be delimited by commas or colons.
2040
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2041
.IP "\fB\-\-exclude\-all\-symbols\fR" 4
2042
.IX Item "--exclude-all-symbols"
2043
Specifies no symbols should be automatically exported.
2044
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2045
.IP "\fB\-\-file\-alignment\fR" 4
2046
.IX Item "--file-alignment"
2047
Specify the file alignment.  Sections in the file will always begin at
2048
file offsets which are multiples of this number.  This defaults to
2049
512.
2050
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2051
.IP "\fB\-\-heap\fR \fIreserve\fR" 4
2052
.IX Item "--heap reserve"
2053
.PD 0
2054
.IP "\fB\-\-heap\fR \fIreserve\fR\fB,\fR\fIcommit\fR" 4
2055
.IX Item "--heap reserve,commit"
2056
.PD
2057
Specify the number of bytes of memory to reserve (and optionally commit)
2058
to be used as heap for this program.  The default is 1Mb reserved, 4K
2059
committed.
2060
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2061
.IP "\fB\-\-image\-base\fR \fIvalue\fR" 4
2062
.IX Item "--image-base value"
2063
Use \fIvalue\fR as the base address of your program or dll.  This is
2064
the lowest memory location that will be used when your program or dll
2065
is loaded.  To reduce the need to relocate and improve performance of
2066
your dlls, each should have a unique base address and not overlap any
2067
other dlls.  The default is 0x400000 for executables, and 0x10000000
2068
for dlls.
2069
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2070
.IP "\fB\-\-kill\-at\fR" 4
2071
.IX Item "--kill-at"
2072
If given, the stdcall suffixes (@\fInn\fR) will be stripped from
2073
symbols before they are exported.
2074
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2075
.IP "\fB\-\-large\-address\-aware\fR" 4
2076
.IX Item "--large-address-aware"
2077
If given, the appropriate bit in the \*(L"Characteristics\*(R" field of the \s-1COFF\s0
2078
header is set to indicate that this executable supports virtual addresses
2079
greater than 2 gigabytes.  This should be used in conjunction with the /3GB
2080
or /USERVA=\fIvalue\fR megabytes switch in the \*(L"[operating systems]\*(R"
2081
section of the \s-1BOOT\s0.INI.  Otherwise, this bit has no effect.
2082
[This option is specific to \s-1PE\s0 targeted ports of the linker]
2083
.IP "\fB\-\-major\-image\-version\fR \fIvalue\fR" 4
2084
.IX Item "--major-image-version value"
2085
Sets the major number of the \*(L"image version\*(R".  Defaults to 1.
2086
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2087
.IP "\fB\-\-major\-os\-version\fR \fIvalue\fR" 4
2088
.IX Item "--major-os-version value"
2089
Sets the major number of the \*(L"os version\*(R".  Defaults to 4.
2090
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2091
.IP "\fB\-\-major\-subsystem\-version\fR \fIvalue\fR" 4
2092
.IX Item "--major-subsystem-version value"
2093
Sets the major number of the \*(L"subsystem version\*(R".  Defaults to 4.
2094
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2095
.IP "\fB\-\-minor\-image\-version\fR \fIvalue\fR" 4
2096
.IX Item "--minor-image-version value"
2097
Sets the minor number of the \*(L"image version\*(R".  Defaults to 0.
2098
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2099
.IP "\fB\-\-minor\-os\-version\fR \fIvalue\fR" 4
2100
.IX Item "--minor-os-version value"
2101
Sets the minor number of the \*(L"os version\*(R".  Defaults to 0.
2102
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2103
.IP "\fB\-\-minor\-subsystem\-version\fR \fIvalue\fR" 4
2104
.IX Item "--minor-subsystem-version value"
2105
Sets the minor number of the \*(L"subsystem version\*(R".  Defaults to 0.
2106
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2107
.IP "\fB\-\-output\-def\fR \fIfile\fR" 4
2108
.IX Item "--output-def file"
2109
The linker will create the file \fIfile\fR which will contain a \s-1DEF\s0
2110
file corresponding to the \s-1DLL\s0 the linker is generating.  This \s-1DEF\s0 file
2111
(which should be called \f(CW\*(C`*.def\*(C'\fR) may be used to create an import
2112
library with \f(CW\*(C`dlltool\*(C'\fR or may be used as a reference to
2113
automatically or implicitly exported symbols.
2114
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2115
.IP "\fB\-\-out\-implib\fR \fIfile\fR" 4
2116
.IX Item "--out-implib file"
2117
The linker will create the file \fIfile\fR which will contain an
2118
import lib corresponding to the \s-1DLL\s0 the linker is generating. This
2119
import lib (which should be called \f(CW\*(C`*.dll.a\*(C'\fR or \f(CW\*(C`*.a\*(C'\fR
2120
may be used to link clients against the generated \s-1DLL\s0; this behaviour
2121
makes it possible to skip a separate \f(CW\*(C`dlltool\*(C'\fR import library
2122
creation step.
2123
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2124
.IP "\fB\-\-enable\-auto\-image\-base\fR" 4
2125
.IX Item "--enable-auto-image-base"
2126
Automatically choose the image base for DLLs, unless one is specified
2127
using the \f(CW\*(C`\-\-image\-base\*(C'\fR argument.  By using a hash generated
2128
from the dllname to create unique image bases for each \s-1DLL\s0, in-memory
2129
collisions and relocations which can delay program execution are
2130
avoided.
2131
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2132
.IP "\fB\-\-disable\-auto\-image\-base\fR" 4
2133
.IX Item "--disable-auto-image-base"
2134
Do not automatically generate a unique image base.  If there is no
2135
user-specified image base (\f(CW\*(C`\-\-image\-base\*(C'\fR) then use the platform
2136
default.
2137
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2138
.IP "\fB\-\-dll\-search\-prefix\fR \fIstring\fR" 4
2139
.IX Item "--dll-search-prefix string"
2140
When linking dynamically to a dll without an import library,
2141
search for \f(CW\*(C`.dll\*(C'\fR in preference to
2142
\&\f(CW\*(C`lib.dll\*(C'\fR. This behaviour allows easy distinction
2143
between DLLs built for the various \*(L"subplatforms\*(R": native, cygwin,
2144
uwin, pw, etc.  For instance, cygwin DLLs typically use
2145
\&\f(CW\*(C`\-\-dll\-search\-prefix=cyg\*(C'\fR.
2146
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2147
.IP "\fB\-\-enable\-auto\-import\fR" 4
2148
.IX Item "--enable-auto-import"
2149
Do sophisticated linking of \f(CW\*(C`_symbol\*(C'\fR to \f(CW\*(C`_\|_imp_\|_symbol\*(C'\fR for
2150
\&\s-1DATA\s0 imports from DLLs, and create the necessary thunking symbols when
2151
building the import libraries with those \s-1DATA\s0 exports. Note: Use of the
2152
\&'auto\-import' extension will cause the text section of the image file
2153
to be made writable. This does not conform to the PE-COFF format
2154
specification published by Microsoft.
2155
.Sp
2156
Note \- use of the 'auto\-import' extension will also cause read only
2157
data which would normally be placed into the .rdata section to be
2158
placed into the .data section instead.  This is in order to work
2159
around a problem with consts that is described here:
2160
http://www.cygwin.com/ml/cygwin/2004\-09/msg01101.html
2161
.Sp
2162
Using 'auto\-import' generally will 'just work' \*(-- but sometimes you may
2163
see this message:
2164
.Sp
2165
"variable '' can't be auto-imported. Please read the
2166
documentation for ld's \f(CW\*(C`\-\-enable\-auto\-import\*(C'\fR for details."
2167
.Sp
2168
This message occurs when some (sub)expression accesses an address
2169
ultimately given by the sum of two constants (Win32 import tables only
2170
allow one).  Instances where this may occur include accesses to member
2171
fields of struct variables imported from a \s-1DLL\s0, as well as using a
2172
constant index into an array variable imported from a \s-1DLL\s0.  Any
2173
multiword variable (arrays, structs, long long, etc) may trigger
2174
this error condition.  However, regardless of the exact data type
2175
of the offending exported variable, ld will always detect it, issue
2176
the warning, and exit.
2177
.Sp
2178
There are several ways to address this difficulty, regardless of the
2179
data type of the exported variable:
2180
.Sp
2181
One way is to use \-\-enable\-runtime\-pseudo\-reloc switch. This leaves the task
2182
of adjusting references in your client code for runtime environment, so
2183
this method works only when runtime environment supports this feature.
2184
.Sp
2185
A second solution is to force one of the 'constants' to be a variable \*(--
2186
that is, unknown and un-optimizable at compile time.  For arrays,
2187
there are two possibilities: a) make the indexee (the array's address)
2188
a variable, or b) make the 'constant' index a variable.  Thus:
2189
.Sp
2190
.Vb 3
2191
\&        extern type extern_array[];
2192
\&        extern_array[1] \-\->
2193
\&           { volatile type *t=extern_array; t[1] }
2194
.Ve
2195
.Sp
2196
or
2197
.Sp
2198
.Vb 3
2199
\&        extern type extern_array[];
2200
\&        extern_array[1] \-\->
2201
\&           { volatile int t=1; extern_array[t] }
2202
.Ve
2203
.Sp
2204
For structs (and most other multiword data types) the only option
2205
is to make the struct itself (or the long long, or the ...) variable:
2206
.Sp
2207
.Vb 3
2208
\&        extern struct s extern_struct;
2209
\&        extern_struct.field \-\->
2210
\&           { volatile struct s *t=&extern_struct; t\->field }
2211
.Ve
2212
.Sp
2213
or
2214
.Sp
2215
.Vb 3
2216
\&        extern long long extern_ll;
2217
\&        extern_ll \-\->
2218
\&          { volatile long long * local_ll=&extern_ll; *local_ll }
2219
.Ve
2220
.Sp
2221
A third method of dealing with this difficulty is to abandon
2222
\&'auto\-import' for the offending symbol and mark it with
2223
\&\f(CW\*(C`_\|_declspec(dllimport)\*(C'\fR.  However, in practice that
2224
requires using compile-time #defines to indicate whether you are
2225
building a \s-1DLL\s0, building client code that will link to the \s-1DLL\s0, or
2226
merely building/linking to a static library.   In making the choice
2227
between the various methods of resolving the 'direct address with
2228
constant offset' problem, you should consider typical real-world usage:
2229
.Sp
2230
Original:
2231
.Sp
2232
.Vb 7
2233
\&        \-\-foo.h
2234
\&        extern int arr[];
2235
\&        \-\-foo.c
2236
\&        #include "foo.h"
2237
\&        void main(int argc, char **argv){
2238
\&          printf("%d\en",arr[1]);
2239
\&        }
2240
.Ve
2241
.Sp
2242
Solution 1:
2243
.Sp
2244
.Vb 9
2245
\&        \-\-foo.h
2246
\&        extern int arr[];
2247
\&        \-\-foo.c
2248
\&        #include "foo.h"
2249
\&        void main(int argc, char **argv){
2250
\&          /* This workaround is for win32 and cygwin; do not "optimize" */
2251
\&          volatile int *parr = arr;
2252
\&          printf("%d\en",parr[1]);
2253
\&        }
2254
.Ve
2255
.Sp
2256
Solution 2:
2257
.Sp
2258
.Vb 10
2259
\&        \-\-foo.h
2260
\&        /* Note: auto\-export is assumed (no _\|_declspec(dllexport)) */
2261
\&        #if (defined(_WIN32) || defined(_\|_CYGWIN_\|_)) && \e
2262
\&          !(defined(FOO_BUILD_DLL) || defined(FOO_STATIC))
2263
\&        #define FOO_IMPORT _\|_declspec(dllimport)
2264
\&        #else
2265
\&        #define FOO_IMPORT
2266
\&        #endif
2267
\&        extern FOO_IMPORT int arr[];
2268
\&        \-\-foo.c
2269
\&        #include "foo.h"
2270
\&        void main(int argc, char **argv){
2271
\&          printf("%d\en",arr[1]);
2272
\&        }
2273
.Ve
2274
.Sp
2275
A fourth way to avoid this problem is to re-code your
2276
library to use a functional interface rather than a data interface
2277
for the offending variables (e.g. \fIset_foo()\fR and \fIget_foo()\fR accessor
2278
functions).
2279
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2280
.IP "\fB\-\-disable\-auto\-import\fR" 4
2281
.IX Item "--disable-auto-import"
2282
Do not attempt to do sophisticated linking of \f(CW\*(C`_symbol\*(C'\fR to
2283
\&\f(CW\*(C`_\|_imp_\|_symbol\*(C'\fR for \s-1DATA\s0 imports from DLLs.
2284
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2285
.IP "\fB\-\-enable\-runtime\-pseudo\-reloc\fR" 4
2286
.IX Item "--enable-runtime-pseudo-reloc"
2287
If your code contains expressions described in \-\-enable\-auto\-import section,
2288
that is, \s-1DATA\s0 imports from \s-1DLL\s0 with non-zero offset, this switch will create
2289
a vector of 'runtime pseudo relocations' which can be used by runtime
2290
environment to adjust references to such data in your client code.
2291
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2292
.IP "\fB\-\-disable\-runtime\-pseudo\-reloc\fR" 4
2293
.IX Item "--disable-runtime-pseudo-reloc"
2294
Do not create pseudo relocations for non-zero offset \s-1DATA\s0 imports from
2295
DLLs.  This is the default.
2296
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2297
.IP "\fB\-\-enable\-extra\-pe\-debug\fR" 4
2298
.IX Item "--enable-extra-pe-debug"
2299
Show additional debug info related to auto-import symbol thunking.
2300
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2301
.IP "\fB\-\-section\-alignment\fR" 4
2302
.IX Item "--section-alignment"
2303
Sets the section alignment.  Sections in memory will always begin at
2304
addresses which are a multiple of this number.  Defaults to 0x1000.
2305
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2306
.IP "\fB\-\-stack\fR \fIreserve\fR" 4
2307
.IX Item "--stack reserve"
2308
.PD 0
2309
.IP "\fB\-\-stack\fR \fIreserve\fR\fB,\fR\fIcommit\fR" 4
2310
.IX Item "--stack reserve,commit"
2311
.PD
2312
Specify the number of bytes of memory to reserve (and optionally commit)
2313
to be used as stack for this program.  The default is 2Mb reserved, 4K
2314
committed.
2315
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2316
.IP "\fB\-\-subsystem\fR \fIwhich\fR" 4
2317
.IX Item "--subsystem which"
2318
.PD 0
2319
.IP "\fB\-\-subsystem\fR \fIwhich\fR\fB:\fR\fImajor\fR" 4
2320
.IX Item "--subsystem which:major"
2321
.IP "\fB\-\-subsystem\fR \fIwhich\fR\fB:\fR\fImajor\fR\fB.\fR\fIminor\fR" 4
2322
.IX Item "--subsystem which:major.minor"
2323
.PD
2324
Specifies the subsystem under which your program will execute.  The
2325
legal values for \fIwhich\fR are \f(CW\*(C`native\*(C'\fR, \f(CW\*(C`windows\*(C'\fR,
2326
\&\f(CW\*(C`console\*(C'\fR, \f(CW\*(C`posix\*(C'\fR, and \f(CW\*(C`xbox\*(C'\fR.  You may optionally set
2327
the subsystem version also.  Numeric values are also accepted for
2328
\&\fIwhich\fR.
2329
[This option is specific to the i386 \s-1PE\s0 targeted port of the linker]
2330
.Sp
2331
The following options set flags in the \f(CW\*(C`DllCharacteristics\*(C'\fR field
2332
of the \s-1PE\s0 file header:
2333
[These options are specific to \s-1PE\s0 targeted ports of the linker]
2334
.IP "\fB\-\-dynamicbase\fR" 4
2335
.IX Item "--dynamicbase"
2336
The image base address may be relocated using address space layout
2337
randomization (\s-1ASLR\s0).  This feature was introduced with \s-1MS\s0 Windows
2338
Vista for i386 \s-1PE\s0 targets.
2339
.IP "\fB\-\-forceinteg\fR" 4
2340
.IX Item "--forceinteg"
2341
Code integrity checks are enforced.
2342
.IP "\fB\-\-nxcompat\fR" 4
2343
.IX Item "--nxcompat"
2344
The image is compatible with the Data Execution Prevention.
2345
This feature was introduced with \s-1MS\s0 Windows \s-1XP\s0 \s-1SP2\s0 for i386 \s-1PE\s0 targets.
2346
.IP "\fB\-\-no\-isolation\fR" 4
2347
.IX Item "--no-isolation"
2348
Although the image understands isolation, do not isolate the image.
2349
.IP "\fB\-\-no\-seh\fR" 4
2350
.IX Item "--no-seh"
2351
The image does not use \s-1SEH\s0. No \s-1SE\s0 handler may be called from
2352
this image.
2353
.IP "\fB\-\-no\-bind\fR" 4
2354
.IX Item "--no-bind"
2355
Do not bind this image.
2356
.IP "\fB\-\-wdmdriver\fR" 4
2357
.IX Item "--wdmdriver"
2358
The driver uses the \s-1MS\s0 Windows Driver Model.
2359
.IP "\fB\-\-tsaware\fR" 4
2360
.IX Item "--tsaware"
2361
The image is Terminal Server aware.
2362
.PP
2363
The C6X uClinux target uses a binary format called \s-1DSBT\s0 to support shared
2364
libraries.  Each shared library in the system needs to have a unique index;
2365
all executables use an index of 0.
2366
.IP "\fB\-\-dsbt\-size\fR \fIsize\fR" 4
2367
.IX Item "--dsbt-size size"
2368
This option sets the number of entires in the \s-1DSBT\s0 of the current executable
2369
or shared library to \fIsize\fR.  The default is to create a table with 64
2370
entries.
2371
.IP "\fB\-\-dsbt\-index\fR \fIindex\fR" 4
2372
.IX Item "--dsbt-index index"
2373
This option sets the \s-1DSBT\s0 index of the current executable or shared library
2374
to \fIindex\fR.  The default is 0, which is appropriate for generating
2375
executables.  If a shared library is generated with a \s-1DSBT\s0 index of 0, the
2376
\&\f(CW\*(C`R_C6000_DSBT_INDEX\*(C'\fR relocs are copied into the output file.
2377
.Sp
2378
The \fB\-\-no\-merge\-exidx\-entries\fR switch disables the merging of adjacent
2379
exidx entries in frame unwind info.
2380
.PP
2381
The 68HC11 and 68HC12 linkers support specific options to control the
2382
memory bank switching mapping and trampoline code generation.
2383
.IP "\fB\-\-no\-trampoline\fR" 4
2384
.IX Item "--no-trampoline"
2385
This option disables the generation of trampoline. By default a trampoline
2386
is generated for each far function which is called using a \f(CW\*(C`jsr\*(C'\fR
2387
instruction (this happens when a pointer to a far function is taken).
2388
.IP "\fB\-\-bank\-window\fR \fIname\fR" 4
2389
.IX Item "--bank-window name"
2390
This option indicates to the linker the name of the memory region in
2391
the \fB\s-1MEMORY\s0\fR specification that describes the memory bank window.
2392
The definition of such region is then used by the linker to compute
2393
paging and addresses within the memory window.
2394
.PP
2395
The following options are supported to control handling of \s-1GOT\s0 generation
2396
when linking for 68K targets.
2397
.IP "\fB\-\-got=\fR\fItype\fR" 4
2398
.IX Item "--got=type"
2399
This option tells the linker which \s-1GOT\s0 generation scheme to use.
2400
\&\fItype\fR should be one of \fBsingle\fR, \fBnegative\fR,
2401
\&\fBmultigot\fR or \fBtarget\fR.  For more information refer to the
2402
Info entry for \fIld\fR.
2403
.SH "ENVIRONMENT"
2404
.IX Header "ENVIRONMENT"
2405
You can change the behaviour of \fBld\fR with the environment variables
2406
\&\f(CW\*(C`GNUTARGET\*(C'\fR,
2407
\&\f(CW\*(C`LDEMULATION\*(C'\fR and \f(CW\*(C`COLLECT_NO_DEMANGLE\*(C'\fR.
2408
.PP
2409
\&\f(CW\*(C`GNUTARGET\*(C'\fR determines the input-file object format if you don't
2410
use \fB\-b\fR (or its synonym \fB\-\-format\fR).  Its value should be one
2411
of the \s-1BFD\s0 names for an input format.  If there is no
2412
\&\f(CW\*(C`GNUTARGET\*(C'\fR in the environment, \fBld\fR uses the natural format
2413
of the target. If \f(CW\*(C`GNUTARGET\*(C'\fR is set to \f(CW\*(C`default\*(C'\fR then \s-1BFD\s0
2414
attempts to discover the input format by examining binary input files;
2415
this method often succeeds, but there are potential ambiguities, since
2416
there is no method of ensuring that the magic number used to specify
2417
object-file formats is unique.  However, the configuration procedure for
2418
\&\s-1BFD\s0 on each system places the conventional format for that system first
2419
in the search-list, so ambiguities are resolved in favor of convention.
2420
.PP
2421
\&\f(CW\*(C`LDEMULATION\*(C'\fR determines the default emulation if you don't use the
2422
\&\fB\-m\fR option.  The emulation can affect various aspects of linker
2423
behaviour, particularly the default linker script.  You can list the
2424
available emulations with the \fB\-\-verbose\fR or \fB\-V\fR options.  If
2425
the \fB\-m\fR option is not used, and the \f(CW\*(C`LDEMULATION\*(C'\fR environment
2426
variable is not defined, the default emulation depends upon how the
2427
linker was configured.
2428
.PP
2429
Normally, the linker will default to demangling symbols.  However, if
2430
\&\f(CW\*(C`COLLECT_NO_DEMANGLE\*(C'\fR is set in the environment, then it will
2431
default to not demangling symbols.  This environment variable is used in
2432
a similar fashion by the \f(CW\*(C`gcc\*(C'\fR linker wrapper program.  The default
2433
may be overridden by the \fB\-\-demangle\fR and \fB\-\-no\-demangle\fR
2434
options.
2435
.SH "SEE ALSO"
2436
.IX Header "SEE ALSO"
2437
\&\fIar\fR\|(1), \fInm\fR\|(1), \fIobjcopy\fR\|(1), \fIobjdump\fR\|(1), \fIreadelf\fR\|(1) and
2438
the Info entries for \fIbinutils\fR and
2439
\&\fIld\fR.
2440
.SH "COPYRIGHT"
2441
.IX Header "COPYRIGHT"
2442
Copyright (c) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
2443
1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2012 Free
2444
Software Foundation, Inc.
2445
.PP
2446
Permission is granted to copy, distribute and/or modify this document
2447
under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3
2448
or any later version published by the Free Software Foundation;
2449
with no Invariant Sections, with no Front-Cover Texts, and with no
2450
Back-Cover Texts.  A copy of the license is included in the
2451
section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.