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