You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

3088 lines
138KB

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