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