Subversion Repositories openrisc_me

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14

.\"

.\" Standard preamble:

.\" ========================================================================

.de Sh \" Subsection heading

.br

.if t .Sp

.ne 5

.PP

\fB\\$1\fR

.PP

..

.de Sp \" Vertical space (when we can't use .PP)

.if t .sp .5v

.if n .sp

..

.de Vb \" Begin verbatim text

.ft CW

.nf

.ne \\$1

..

.de Ve \" End verbatim text

.ft R

.fi

..

.\" Set up some character translations and predefined strings.  \*(-- will

.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left

.\" double quote, and \*(R" will give a right double quote.  | will give a

.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to

.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'

.\" expand to `' in nroff, nothing in troff, for use with C<>.

.tr \(*W-|\(bv\*(Tr

.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'

.ie n \{\

.    ds -- \(*W-

.    ds PI pi

.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch

.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch

.    ds L" ""

.    ds R" ""

.    ds C` ""

.    ds C' ""

'br\}

.el\{\

.    ds -- \|\(em\|

.    ds PI \(*p

.    ds L" ``

.    ds R" ''

'br\}

.\"

.\" If the F register is turned on, we'll generate index entries on stderr for

.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index

.\" entries marked with X<> in POD.  Of course, you'll have to process the

.\" output yourself in some meaningful fashion.

.if \nF \{\

.    de IX

.    tm Index:\\$1\t\\n%\t"\\$2"

..

.    nr % 0

.    rr F

.\}

.\"

.\" For nroff, turn off justification.  Always turn off hyphenation; it makes

.\" way too many mistakes in technical documents.

.hy 0

.\"

.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).

.\" Fear.  Run.  Save yourself.  No user-serviceable parts.

.    \" fudge factors for nroff and troff

.if n \{\

.    ds #H 0

.    ds #V .8m

.    ds #F .3m

.    ds #[ \f1

.    ds #] \fP

.\}

.if t \{\

.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)

.    ds #V .6m

.    ds #F 0

.    ds #[ \&

.    ds #] \&

.\}

.    \" simple accents for nroff and troff

.if n \{\

.    ds ' \&

.    ds ` \&

.    ds ^ \&

.    ds , \&

.    ds ~ ~

.    ds /

.\}

.if t \{\

.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"

.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'

.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'

.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'

.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'

.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'

.\}

.    \" troff and (daisy-wheel) nroff accents

.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'

.ds 8 \h'\*(#H'\(*b\h'-\*(#H'

.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]

.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'

.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'

.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]

.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]

.ds ae a\h'-(\w'a'u*4/10)'e

.ds Ae A\h'-(\w'A'u*4/10)'E

.    \" corrections for vroff

.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'

.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'

.    \" for low resolution devices (crt and lpr)

.if \n(.H>23 .if \n(.V>19 \

\{\

.    ds : e

.    ds 8 ss

.    ds o a

.    ds d- d\h'-1'\(ga

.    ds D- D\h'-1'\(hy

.    ds th \o'bp'

.    ds Th \o'LP'

.    ds ae ae

.    ds Ae AE

.\}

.rm #[ #] #H #V #F C

.\" ========================================================================

.\"

.IX Title "LD 1"

.TH LD 1 "2008-05-06" "binutils-2.18.50" "GNU Development Tools"

.SH "NAME"

ld \- The GNU linker

.SH "SYNOPSIS"

.IX Header "SYNOPSIS"

ld [\fBoptions\fR] \fIobjfile\fR ...

.SH "DESCRIPTION"

.IX Header "DESCRIPTION"

\&\fBld\fR combines a number of object and archive files, relocates

their data and ties up symbol references. Usually the last step in

compiling a program is to run \fBld\fR.

.PP

\&\fBld\fR accepts Linker Command Language files written in

a superset of \s-1AT&T\s0's Link Editor Command Language syntax,

to provide explicit and total control over the linking process.

.PP

This man page does not describe the command language; see the

\&\fBld\fR entry in \f(CW\*(C`info\*(C'\fR for full details on the command

language and on other aspects of the \s-1GNU\s0 linker.

.PP

This version of \fBld\fR uses the general purpose \s-1BFD\s0 libraries

to operate on object files. This allows \fBld\fR to read, combine, and

write object files in many different formats\-\-\-for example, \s-1COFF\s0 or

\&\f(CW\*(C`a.out\*(C'\fR.  Different formats may be linked together to produce any

available kind of object file.

.PP

Aside from its flexibility, the \s-1GNU\s0 linker is more helpful than other

linkers in providing diagnostic information.  Many linkers abandon

execution immediately upon encountering an error; whenever possible,

\&\fBld\fR continues executing, allowing you to identify other errors

(or, in some cases, to get an output file in spite of the error).

.PP

The \s-1GNU\s0 linker \fBld\fR is meant to cover a broad range of situations,

and to be as compatible as possible with other linkers.  As a result,

you have many choices to control its behavior.

.SH "OPTIONS"

.IX Header "OPTIONS"

The linker supports a plethora of command-line options, but in actual

practice few of them are used in any particular context.

For instance, a frequent use of \fBld\fR is to link standard Unix

object files on a standard, supported Unix system.  On such a system, to

link a file \f(CW\*(C`hello.o\*(C'\fR:

.PP

.Vb 1

\&        ld -o 
 /lib/crt0.o hello.o -lc

.Ve

.PP

This tells \fBld\fR to produce a file called \fIoutput\fR as the

result of linking the file \f(CW\*(C`/lib/crt0.o\*(C'\fR with \f(CW\*(C`hello.o\*(C'\fR and

the library \f(CW\*(C`libc.a\*(C'\fR, which will come from the standard search

directories.  (See the discussion of the \fB\-l\fR option below.)

.PP

Some of the command-line options to \fBld\fR may be specified at any

point in the command line.  However, options which refer to files, such

as \fB\-l\fR or \fB\-T\fR, cause the file to be read at the point at

which the option appears in the command line, relative to the object

files and other file options.  Repeating non-file options with a

different argument will either have no further effect, or override prior

occurrences (those further to the left on the command line) of that

option.  Options which may be meaningfully specified more than once are

noted in the descriptions below.

.PP

Non-option arguments are object files or archives which are to be linked

together.  They may follow, precede, or be mixed in with command-line

options, except that an object file argument may not be placed between

an option and its argument.

.PP

Usually the linker is invoked with at least one object file, but you can

specify other forms of binary input files using \fB\-l\fR, \fB\-R\fR,

and the script command language.  If \fIno\fR binary input files at all

are specified, the linker does not produce any output, and issues the

message \fBNo input files\fR.

.PP

If the linker cannot recognize the format of an object file, it will

assume that it is a linker script.  A script specified in this way

augments the main linker script used for the link (either the default

linker script or the one specified by using \fB\-T\fR).  This feature

permits the linker to link against a file which appears to be an object

or an archive, but actually merely defines some symbol values, or uses

\&\f(CW\*(C`INPUT\*(C'\fR or \f(CW\*(C`GROUP\*(C'\fR to load other objects.  Specifying a

script in this way merely augments the main linker script, with the

extra commands placed after the main script; use the \fB\-T\fR option

to replace the default linker script entirely, but note the effect of

the \f(CW\*(C`INSERT\*(C'\fR command.

.PP

For options whose names are a single letter,

option arguments must either follow the option letter without intervening

whitespace, or be given as separate arguments immediately following the

option that requires them.

.PP

For options whose names are multiple letters, either one dash or two can

precede the option name; for example, \fB\-trace\-symbol\fR and

\&\fB\-\-trace\-symbol\fR are equivalent.  Note\-\-\-there is one exception to

this rule.  Multiple letter options that start with a lower case 'o' can

only be preceded by two dashes.  This is to reduce confusion with the

\&\fB\-o\fR option.  So for example \fB\-omagic\fR sets the output file

name to \fBmagic\fR whereas \fB\-\-omagic\fR sets the \s-1NMAGIC\s0 flag on the

output.

.PP

Arguments to multiple-letter options must either be separated from the

option name by an equals sign, or be given as separate arguments

immediately following the option that requires them.  For example,

\&\fB\-\-trace\-symbol foo\fR and \fB\-\-trace\-symbol=foo\fR are equivalent.

Unique abbreviations of the names of multiple-letter options are

accepted.

.PP

Note\-\-\-if the linker is being invoked indirectly, via a compiler driver

(e.g. \fBgcc\fR) then all the linker command line options should be

prefixed by \fB\-Wl,\fR (or whatever is appropriate for the particular

compiler driver) like this:

.PP

.Vb 1

\&          gcc -Wl,--startgroup foo.o bar.o -Wl,--endgroup

.Ve

.PP

This is important, because otherwise the compiler driver program may

silently drop the linker options, resulting in a bad link.

.PP

Here is a table of the generic command line switches accepted by the \s-1GNU\s0

linker:

.IP "\fB@\fR\fIfile\fR" 4

.IX Item "@file"

Read command-line options from \fIfile\fR.  The options read are

inserted in place of the original @\fIfile\fR option.  If \fIfile\fR

does not exist, or cannot be read, then the option will be treated

literally, and not removed.

.Sp

Options in \fIfile\fR are separated by whitespace.  A whitespace

character may be included in an option by surrounding the entire

option in either single or double quotes.  Any character (including a

backslash) may be included by prefixing the character to be included

with a backslash.  The \fIfile\fR may itself contain additional

@\fIfile\fR options; any such options will be processed recursively.

.IP "\fB\-a\fR\fIkeyword\fR" 4

.IX Item "-akeyword"

This option is supported for \s-1HP/UX\s0 compatibility.  The \fIkeyword\fR

argument must be one of the strings \fBarchive\fR, \fBshared\fR, or

\&\fBdefault\fR.  \fB\-aarchive\fR is functionally equivalent to

\&\fB\-Bstatic\fR, and the other two keywords are functionally equivalent

to \fB\-Bdynamic\fR.  This option may be used any number of times.

.IP "\fB\-A\fR\fIarchitecture\fR" 4

.IX Item "-Aarchitecture"

.PD 0

.IP "\fB\-\-architecture=\fR\fIarchitecture\fR" 4

.IX Item "--architecture=architecture"

.PD

In the current release of \fBld\fR, this option is useful only for the

Intel 960 family of architectures.  In that \fBld\fR configuration, the

\&\fIarchitecture\fR argument identifies the particular architecture in

the 960 family, enabling some safeguards and modifying the

archive-library search path.

.Sp

Future releases of \fBld\fR may support similar functionality for

other architecture families.

.IP "\fB\-b\fR \fIinput-format\fR" 4

.IX Item "-b input-format"

.PD 0

.IP "\fB\-\-format=\fR\fIinput-format\fR" 4

.IX Item "--format=input-format"

.PD

\&\fBld\fR may be configured to support more than one kind of object

file.  If your \fBld\fR is configured this way, you can use the

\&\fB\-b\fR option to specify the binary format for input object files

that follow this option on the command line.  Even when \fBld\fR is

configured to support alternative object formats, you don't usually need

to specify this, as \fBld\fR should be configured to expect as a

default input format the most usual format on each machine.

\&\fIinput-format\fR is a text string, the name of a particular format

supported by the \s-1BFD\s0 libraries.  (You can list the available binary

formats with \fBobjdump \-i\fR.)

.Sp

You may want to use this option if you are linking files with an unusual

binary format.  You can also use \fB\-b\fR to switch formats explicitly (when

linking object files of different formats), by including

\&\fB\-b\fR \fIinput-format\fR before each group of object files in a

particular format.

.Sp

The default format is taken from the environment variable

\&\f(CW\*(C`GNUTARGET\*(C'\fR.

.Sp

You can also define the input format from a script, using the command

\&\f(CW\*(C`TARGET\*(C'\fR;

.IP "\fB\-c\fR \fIMRI-commandfile\fR" 4

.IX Item "-c MRI-commandfile"

.PD 0

.IP "\fB\-\-mri\-script=\fR\fIMRI-commandfile\fR" 4

.IX Item "--mri-script=MRI-commandfile"

.PD

For compatibility with linkers produced by \s-1MRI\s0, \fBld\fR accepts script

files written in an alternate, restricted command language, described in

the \s-1MRI\s0 Compatible Script Files section of \s-1GNU\s0 ld documentation.

Introduce \s-1MRI\s0 script files with

the option \fB\-c\fR; use the \fB\-T\fR option to run linker

scripts written in the general-purpose \fBld\fR scripting language.

If \fIMRI-cmdfile\fR does not exist, \fBld\fR looks for it in the directories

specified by any \fB\-L\fR options.

.IP "\fB\-d\fR" 4

.IX Item "-d"

.PD 0

.IP "\fB\-dc\fR" 4

.IX Item "-dc"

.IP "\fB\-dp\fR" 4

.IX Item "-dp"

.PD

These three options are equivalent; multiple forms are supported for

compatibility with other linkers.  They assign space to common symbols

even if a relocatable output file is specified (with \fB\-r\fR).  The

script command \f(CW\*(C`FORCE_COMMON_ALLOCATION\*(C'\fR has the same effect.

.IP "\fB\-e\fR \fIentry\fR" 4

.IX Item "-e entry"

.PD 0

.IP "\fB\-\-entry=\fR\fIentry\fR" 4

.IX Item "--entry=entry"

.PD

Use \fIentry\fR as the explicit symbol for beginning execution of your

program, rather than the default entry point.  If there is no symbol

named \fIentry\fR, the linker will try to parse \fIentry\fR as a number,

and use that as the entry address (the number will be interpreted in

base 10; you may use a leading \fB0x\fR for base 16, or a leading

\&\fB0\fR for base 8).

.IP "\fB\-\-exclude\-libs\fR \fIlib\fR\fB,\fR\fIlib\fR\fB,...\fR" 4

.IX Item "--exclude-libs lib,lib,..."

Specifies a list of archive libraries from which symbols should not be automatically

exported. The library names may be delimited by commas or colons.  Specifying

\&\f(CW\*(C`\-\-exclude\-libs ALL\*(C'\fR excludes symbols in all archive libraries from

automatic export.  This option is available only for the i386 \s-1PE\s0 targeted

port of the linker and for \s-1ELF\s0 targeted ports.  For i386 \s-1PE\s0, symbols

explicitly listed in a .def file are still exported, regardless of this

option.  For \s-1ELF\s0 targeted ports, symbols affected by this option will

be treated as hidden.

.IP "\fB\-E\fR" 4

.IX Item "-E"

.PD 0

.IP "\fB\-\-export\-dynamic\fR" 4

.IX Item "--export-dynamic"

.PD

When creating a dynamically linked executable, add all symbols to the

dynamic symbol table.  The dynamic symbol table is the set of symbols

which are visible from dynamic objects at run time.

.Sp

If you do not use this option, the dynamic symbol table will normally

contain only those symbols which are referenced by some dynamic object

mentioned in the link.

.Sp

If you use \f(CW\*(C`dlopen\*(C'\fR to load a dynamic object which needs to refer

back to the symbols defined by the program, rather than some other

dynamic object, then you will probably need to use this option when

linking the program itself.

.Sp

You can also use the dynamic list to control what symbols should

be added to the dynamic symbol table if the output format supports it.

See the description of \fB\-\-dynamic\-list\fR.

.IP "\fB\-EB\fR" 4

.IX Item "-EB"

Link big-endian objects.  This affects the default output format.

.IP "\fB\-EL\fR" 4

.IX Item "-EL"

Link little-endian objects.  This affects the default output format.

.IP "\fB\-f\fR" 4

.IX Item "-f"

.PD 0

.IP "\fB\-\-auxiliary\fR \fIname\fR" 4

.IX Item "--auxiliary name"

.PD

When creating an \s-1ELF\s0 shared object, set the internal \s-1DT_AUXILIARY\s0 field

to the specified name.  This tells the dynamic linker that the symbol

table of the shared object should be used as an auxiliary filter on the

symbol table of the shared object \fIname\fR.

.Sp

If you later link a program against this filter object, then, when you

run the program, the dynamic linker will see the \s-1DT_AUXILIARY\s0 field.  If

the dynamic linker resolves any symbols from the filter object, it will

first check whether there is a definition in the shared object

\&\fIname\fR.  If there is one, it will be used instead of the definition

in the filter object.  The shared object \fIname\fR need not exist.

Thus the shared object \fIname\fR may be used to provide an alternative

implementation of certain functions, perhaps for debugging or for

machine specific performance.

.Sp

This option may be specified more than once.  The \s-1DT_AUXILIARY\s0 entries

will be created in the order in which they appear on the command line.

.IP "\fB\-F\fR \fIname\fR" 4

.IX Item "-F name"

.PD 0

.IP "\fB\-\-filter\fR \fIname\fR" 4

.IX Item "--filter name"

.PD

When creating an \s-1ELF\s0 shared object, set the internal \s-1DT_FILTER\s0 field to

the specified name.  This tells the dynamic linker that the symbol table

of the shared object which is being created should be used as a filter

on the symbol table of the shared object \fIname\fR.

.Sp

If you later link a program against this filter object, then, when you

run the program, the dynamic linker will see the \s-1DT_FILTER\s0 field.  The

dynamic linker will resolve symbols according to the symbol table of the

filter object as usual, but it will actually link to the definitions

found in the shared object \fIname\fR.  Thus the filter object can be

used to select a subset of the symbols provided by the object

\&\fIname\fR.

.Sp

Some older linkers used the \fB\-F\fR option throughout a compilation

toolchain for specifying object-file format for both input and output

object files.

The \s-1GNU\s0 linker uses other mechanisms for this purpose: the

\&\fB\-b\fR, \fB\-\-format\fR, \fB\-\-oformat\fR options, the

\&\f(CW\*(C`TARGET\*(C'\fR command in linker scripts, and the \f(CW\*(C`GNUTARGET\*(C'\fR

environment variable.

The \s-1GNU\s0 linker will ignore the \fB\-F\fR option when not

creating an \s-1ELF\s0 shared object.

.IP "\fB\-fini\fR \fIname\fR" 4

.IX Item "-fini name"

When creating an \s-1ELF\s0 executable or shared object, call \s-1NAME\s0 when the

executable or shared object is unloaded, by setting \s-1DT_FINI\s0 to the

address of the function.  By default, the linker uses \f(CW\*(C`_fini\*(C'\fR as

the function to call.

.IP "\fB\-g\fR" 4

.IX Item "-g"

Ignored.  Provided for compatibility with other tools.

.IP "\fB\-G\fR\fIvalue\fR" 4

.IX Item "-Gvalue"

.PD 0

.IP "\fB\-\-gpsize=\fR\fIvalue\fR" 4

.IX Item "--gpsize=value"

.PD

Set the maximum size of objects to be optimized using the \s-1GP\s0 register to

\&\fIsize\fR.  This is only meaningful for object file formats such as

\&\s-1MIPS\s0 \s-1ECOFF\s0 which supports putting large and small objects into different

sections.  This is ignored for other object file formats.

.IP "\fB\-h\fR\fIname\fR" 4

.IX Item "-hname"

.PD 0

.IP "\fB\-soname=\fR\fIname\fR" 4

.IX Item "-soname=name"

.PD

When creating an \s-1ELF\s0 shared object, set the internal \s-1DT_SONAME\s0 field to

the specified name.  When an executable is linked with a shared object

which has a \s-1DT_SONAME\s0 field, then when the executable is run the dynamic

linker will attempt to load the shared object specified by the \s-1DT_SONAME\s0

field rather than the using the file name given to the linker.

.IP "\fB\-i\fR" 4

.IX Item "-i"

Perform an incremental link (same as option \fB\-r\fR).

.IP "\fB\-init\fR \fIname\fR" 4

.IX Item "-init name"

When creating an \s-1ELF\s0 executable or shared object, call \s-1NAME\s0 when the

executable or shared object is loaded, by setting \s-1DT_INIT\s0 to the address

of the function.  By default, the linker uses \f(CW\*(C`_init\*(C'\fR as the

function to call.

.IP "\fB\-l\fR\fInamespec\fR" 4

.IX Item "-lnamespec"

.PD 0

.IP "\fB\-\-library=\fR\fInamespec\fR" 4

.IX Item "--library=namespec"

.PD

Add the archive or object file specified by \fInamespec\fR to the

list of files to link.  This option may be used any number of times.

If \fInamespec\fR is of the form \fI:\fIfilename\fI\fR, \fBld\fR

will search the library path for a file called \fIfilename\fR, otherise it

will search the library path for a file called \fIlib\fInamespec\fI.a\fR.

.Sp

On systems which support shared libraries, \fBld\fR may also search for

files other than \fIlib\fInamespec\fI.a\fR.  Specifically, on \s-1ELF\s0

and SunOS systems, \fBld\fR will search a directory for a library

called \fIlib\fInamespec\fI.so\fR before searching for one called

\&\fIlib\fInamespec\fI.a\fR.  (By convention, a \f(CW\*(C`.so\*(C'\fR extension

indicates a shared library.)  Note that this behavior does not apply

to \fI:\fIfilename\fI\fR, which always specifies a file called

\&\fIfilename\fR.

.Sp

The linker will search an archive only once, at the location where it is

specified on the command line.  If the archive defines a symbol which

was undefined in some object which appeared before the archive on the

command line, the linker will include the appropriate file(s) from the

archive.  However, an undefined symbol in an object appearing later on

the command line will not cause the linker to search the archive again.

.Sp

See the \fB\-(\fR option for a way to force the linker to search

archives multiple times.

.Sp

You may list the same archive multiple times on the command line.

.Sp

This type of archive searching is standard for Unix linkers.  However,

if you are using \fBld\fR on \s-1AIX\s0, note that it is different from the

behaviour of the \s-1AIX\s0 linker.

.IP "\fB\-L\fR\fIsearchdir\fR" 4

.IX Item "-Lsearchdir"

.PD 0

.IP "\fB\-\-library\-path=\fR\fIsearchdir\fR" 4

.IX Item "--library-path=searchdir"

.PD

Add path \fIsearchdir\fR to the list of paths that \fBld\fR will search

for archive libraries and \fBld\fR control scripts.  You may use this

option any number of times.  The directories are searched in the order

in which they are specified on the command line.  Directories specified

on the command line are searched before the default directories.  All

\&\fB\-L\fR options apply to all \fB\-l\fR options, regardless of the

order in which the options appear.

.Sp

If \fIsearchdir\fR begins with \f(CW\*(C`=\*(C'\fR, then the \f(CW\*(C`=\*(C'\fR will be replaced

by the \fIsysroot prefix\fR, a path specified when the linker is configured.

.Sp

The default set of paths searched (without being specified with

\&\fB\-L\fR) depends on which emulation mode \fBld\fR is using, and in

some cases also on how it was configured.

.Sp

The paths can also be specified in a link script with the

\&\f(CW\*(C`SEARCH_DIR\*(C'\fR command.  Directories specified this way are searched

at the point in which the linker script appears in the command line.

.IP "\fB\-m\fR\fIemulation\fR" 4

.IX Item "-memulation"

Emulate the \fIemulation\fR linker.  You can list the available

emulations with the \fB\-\-verbose\fR or \fB\-V\fR options.

.Sp

If the \fB\-m\fR option is not used, the emulation is taken from the

\&\f(CW\*(C`LDEMULATION\*(C'\fR environment variable, if that is defined.

.Sp

Otherwise, the default emulation depends upon how the linker was

configured.

.IP "\fB\-M\fR" 4

.IX Item "-M"

.PD 0

.IP "\fB\-\-print\-map\fR" 4

.IX Item "--print-map"

.PD

Print a link map to the standard output.  A link map provides

information about the link, including the following:

.RS 4

.IP "*" 4

Where object files are mapped into memory.

.IP "*" 4

How common symbols are allocated.

.IP "*" 4

All archive members included in the link, with a mention of the symbol

which caused the archive member to be brought in.

.IP "*" 4

The values assigned to symbols.

.Sp

Note \- symbols whose values are computed by an expression which

involves a reference to a previous value of the same symbol may not

have correct result displayed in the link map.  This is because the

linker discards intermediate results and only retains the final value

of an expression.  Under such circumstances the linker will display

the final value enclosed by square brackets.  Thus for example a

linker script containing:

.Sp

.Vb 3

\&           foo = 1

\&           foo = foo * 4

\&           foo = foo + 8

.Ve

.Sp

will produce the following output in the link map if the \fB\-M\fR

option is used:

.Sp

.Vb 3

\&           0x00000001                foo = 0x1

\&           [0x0000000c]                foo = (foo * 0x4)

\&           [0x0000000c]                foo = (foo + 0x8)

.Ve

.Sp

See \fBExpressions\fR for more information about expressions in linker

scripts.

.RE

.RS 4

.RE

.IP "\fB\-n\fR" 4

.IX Item "-n"

.PD 0

.IP "\fB\-\-nmagic\fR" 4

.IX Item "--nmagic"

.PD

Turn off page alignment of sections, and mark the output as

\&\f(CW\*(C`NMAGIC\*(C'\fR if possible.

.IP "\fB\-N\fR" 4

.IX Item "-N"

.PD 0

.IP "\fB\-\-omagic\fR" 4

.IX Item "--omagic"

.PD

Set the text and data sections to be readable and writable.  Also, do

not page-align the data segment, and disable linking against shared

libraries.  If the output format supports Unix style magic numbers,

mark the output as \f(CW\*(C`OMAGIC\*(C'\fR. Note: Although a writable text section

is allowed for PE-COFF targets, it does not conform to the format

specification published by Microsoft.

.IP "\fB\-\-no\-omagic\fR" 4

.IX Item "--no-omagic"

This option negates most of the effects of the \fB\-N\fR option.  It

sets the text section to be read\-only, and forces the data segment to

be page\-aligned.  Note \- this option does not enable linking against

shared libraries.  Use \fB\-Bdynamic\fR for this.

.IP "\fB\-o\fR \fIoutput\fR" 4

.IX Item "-o output"

.PD 0

.IP "\fB\-\-output=\fR\fIoutput\fR" 4

.IX Item "--output=output"

.PD

Use \fIoutput\fR as the name for the program produced by \fBld\fR; if this

option is not specified, the name \fIa.out\fR is used by default.  The

script command \f(CW\*(C`OUTPUT\*(C'\fR can also specify the output file name.

.IP "\fB\-O\fR \fIlevel\fR" 4

.IX Item "-O level"

If \fIlevel\fR is a numeric values greater than zero \fBld\fR optimizes

the output.  This might take significantly longer and therefore probably

should only be enabled for the final binary.  At the moment this

option only affects \s-1ELF\s0 shared library generation.  Future releases of

the linker may make more use of this option.  Also currently there is

no difference in the linker's behaviour for different non-zero values

of this option.  Again this may change with future releases.

.IP "\fB\-q\fR" 4

.IX Item "-q"

.PD 0

.IP "\fB\-\-emit\-relocs\fR" 4

.IX Item "--emit-relocs"

.PD

Leave relocation sections and contents in fully linked executables.

Post link analysis and optimization tools may need this information in

order to perform correct modifications of executables.  This results

in larger executables.

.Sp

This option is currently only supported on \s-1ELF\s0 platforms.

.IP "\fB\-\-force\-dynamic\fR" 4

.IX Item "--force-dynamic"

Force the output file to have dynamic sections.  This option is specific

to VxWorks targets.

.IP "\fB\-r\fR" 4

.IX Item "-r"

.PD 0

.IP "\fB\-\-relocatable\fR" 4

.IX Item "--relocatable"

.PD

Generate relocatable output\-\-\-i.e., generate an output file that can in

turn serve as input to \fBld\fR.  This is often called \fIpartial

linking\fR.  As a side effect, in environments that support standard Unix

magic numbers, this option also sets the output file's magic number to

\&\f(CW\*(C`OMAGIC\*(C'\fR.

If this option is not specified, an absolute file is produced.  When

linking \*(C+ programs, this option \fIwill not\fR resolve references to

constructors; to do that, use \fB\-Ur\fR.

.Sp

When an input file does not have the same format as the output file,

partial linking is only supported if that input file does not contain any

relocations.  Different output formats can have further restrictions; for

example some \f(CW\*(C`a.out\*(C'\fR\-based formats do not support partial linking

with input files in other formats at all.

.Sp

This option does the same thing as \fB\-i\fR.

.IP "\fB\-R\fR \fIfilename\fR" 4

.IX Item "-R filename"

.PD 0

.IP "\fB\-\-just\-symbols=\fR\fIfilename\fR" 4

.IX Item "--just-symbols=filename"

.PD

Read symbol names and their addresses from \fIfilename\fR, but do not

relocate it or include it in the output.  This allows your output file

to refer symbolically to absolute locations of memory defined in other

programs.  You may use this option more than once.

.Sp

For compatibility with other \s-1ELF\s0 linkers, if the \fB\-R\fR option is

followed by a directory name, rather than a file name, it is treated as

the \fB\-rpath\fR option.

.IP "\fB\-s\fR" 4

.IX Item "-s"

.PD 0

.IP "\fB\-\-strip\-all\fR" 4

.IX Item "--strip-all"

.PD

Omit all symbol information from the output file.

.IP "\fB\-S\fR" 4

.IX Item "-S"

.PD 0

.IP "\fB\-\-strip\-debug\fR" 4

.IX Item "--strip-debug"

.PD

Omit debugger symbol information (but not all symbols) from the output file.

.IP "\fB\-t\fR" 4

.IX Item "-t"

.PD 0

.IP "\fB\-\-trace\fR" 4

.IX Item "--trace"

.PD

Print the names of the input files as \fBld\fR processes them.

.IP "\fB\-T\fR \fIscriptfile\fR" 4

.IX Item "-T scriptfile"

.PD 0

.IP "\fB\-\-script=\fR\fIscriptfile\fR" 4

.IX Item "--script=scriptfile"

.PD

Use \fIscriptfile\fR as the linker script.  This script replaces

\&\fBld\fR's default linker script (rather than adding to it), so

\&\fIcommandfile\fR must specify everything necessary to describe the

output file.    If \fIscriptfile\fR does not exist in

the current directory, \f(CW\*(C`ld\*(C'\fR looks for it in the directories

specified by any preceding \fB\-L\fR options.  Multiple \fB\-T\fR

options accumulate.

.IP "\fB\-dT\fR \fIscriptfile\fR" 4

.IX Item "-dT scriptfile"

.PD 0

.IP "\fB\-\-default\-script=\fR\fIscriptfile\fR" 4

.IX Item "--default-script=scriptfile"

.PD

Use \fIscriptfile\fR as the default linker script.

.Sp

This option is similar to the \fB\-\-script\fR option except that

processing of the script is delayed until after the rest of the

command line has been processed.  This allows options placed after the

\&\fB\-\-default\-script\fR option on the command line to affect the

behaviour of the linker script, which can be important when the linker

command line cannot be directly controlled by the user.  (eg because

the command line is being constructed by another tool, such as

\&\fBgcc\fR).

.IP "\fB\-u\fR \fIsymbol\fR" 4

.IX Item "-u symbol"

.PD 0

.IP "\fB\-\-undefined=\fR\fIsymbol\fR" 4

.IX Item "--undefined=symbol"

.PD

Force \fIsymbol\fR to be entered in the output file as an undefined

symbol.  Doing this may, for example, trigger linking of additional

modules from standard libraries.  \fB\-u\fR may be repeated with

different option arguments to enter additional undefined symbols.  This

option is equivalent to the \f(CW\*(C`EXTERN\*(C'\fR linker script command.

.IP "\fB\-Ur\fR" 4

.IX Item "-Ur"

For anything other than \*(C+ programs, this option is equivalent to

\&\fB\-r\fR: it generates relocatable output\-\-\-i.e., an output file that can in

turn serve as input to \fBld\fR.  When linking \*(C+ programs, \fB\-Ur\fR

\&\fIdoes\fR resolve references to constructors, unlike \fB\-r\fR.

It does not work to use \fB\-Ur\fR on files that were themselves linked

with \fB\-Ur\fR; once the constructor table has been built, it cannot

be added to.  Use \fB\-Ur\fR only for the last partial link, and

\&\fB\-r\fR for the others.

.IP "\fB\-\-unique[=\fR\fI\s-1SECTION\s0\fR\fB]\fR" 4

.IX Item "--unique[=SECTION]"

Creates a separate output section for every input section matching

\&\fI\s-1SECTION\s0\fR, or if the optional wildcard \fI\s-1SECTION\s0\fR argument is

missing, for every orphan input section.  An orphan section is one not

specifically mentioned in a linker script.  You may use this option

multiple times on the command line;  It prevents the normal merging of

input sections with the same name, overriding output section assignments

in a linker script.

.IP "\fB\-v\fR" 4

.IX Item "-v"

.PD 0

.IP "\fB\-\-version\fR" 4

.IX Item "--version"

.IP "\fB\-V\fR" 4

.IX Item "-V"

.PD

Display the version number for \fBld\fR.  The \fB\-V\fR option also

lists the supported emulations.

.IP "\fB\-x\fR" 4

.IX Item "-x"

.PD 0

.IP "\fB\-\-discard\-all\fR" 4

.IX Item "--discard-all"

.PD

Delete all local symbols.

.IP "\fB\-X\fR" 4

.IX Item "-X"

.PD 0

.IP "\fB\-\-discard\-locals\fR" 4

.IX Item "--discard-locals"

.PD

Delete all temporary local symbols.  (These symbols start with

system-specific local label prefixes, typically \fB.L\fR for \s-1ELF\s0 systems

or \fBL\fR for traditional a.out systems.)

.IP "\fB\-y\fR \fIsymbol\fR" 4

.IX Item "-y symbol"

.PD 0

.IP "\fB\-\-trace\-symbol=\fR\fIsymbol\fR" 4

.IX Item "--trace-symbol=symbol"

.PD

Print the name of each linked file in which \fIsymbol\fR appears.  This

option may be given any number of times.  On many systems it is necessary

to prepend an underscore.

.Sp

This option is useful when you have an undefined symbol in your link but

don't know where the reference is coming from.

.IP "\fB\-Y\fR \fIpath\fR" 4

.IX Item "-Y path"

Add \fIpath\fR to the default library search path.  This option exists

for Solaris compatibility.

.IP "\fB\-z\fR \fIkeyword\fR" 4

.IX Item "-z keyword"

The recognized keywords are:

.RS 4

.IP "\fBcombreloc\fR" 4

.IX Item "combreloc"

Combines multiple reloc sections and sorts them to make dynamic symbol

lookup caching possible.

.IP "\fBdefs\fR" 4

.IX Item "defs"

Disallows undefined symbols in object files.  Undefined symbols in

shared libraries are still allowed.

.IP "\fBexecstack\fR" 4

.IX Item "execstack"

Marks the object as requiring executable stack.

.IP "\fBinitfirst\fR" 4

.IX Item "initfirst"

This option is only meaningful when building a shared object.

It marks the object so that its runtime initialization will occur

before the runtime initialization of any other objects brought into

the process at the same time.  Similarly the runtime finalization of

the object will occur after the runtime finalization of any other

objects.

.IP "\fBinterpose\fR" 4

.IX Item "interpose"

Marks the object that its symbol table interposes before all symbols

but the primary executable.

.IP "\fBlazy\fR" 4

.IX Item "lazy"

When generating an executable or shared library, mark it to tell the

dynamic linker to defer function call resolution to the point when

the function is called (lazy binding), rather than at load time.

Lazy binding is the default.

.IP "\fBloadfltr\fR" 4

.IX Item "loadfltr"

Marks  the object that its filters be processed immediately at

runtime.

.IP "\fBmuldefs\fR" 4

.IX Item "muldefs"

Allows multiple definitions.

.IP "\fBnocombreloc\fR" 4

.IX Item "nocombreloc"

Disables multiple reloc sections combining.

.IP "\fBnocopyreloc\fR" 4

.IX Item "nocopyreloc"

Disables production of copy relocs.

.IP "\fBnodefaultlib\fR" 4

.IX Item "nodefaultlib"

Marks the object that the search for dependencies of this object will

ignore any default library search paths.

.IP "\fBnodelete\fR" 4

.IX Item "nodelete"

Marks the object shouldn't be unloaded at runtime.

.IP "\fBnodlopen\fR" 4

.IX Item "nodlopen"

Marks the object not available to \f(CW\*(C`dlopen\*(C'\fR.

.IP "\fBnodump\fR" 4

.IX Item "nodump"

Marks the object can not be dumped by \f(CW\*(C`dldump\*(C'\fR.

.IP "\fBnoexecstack\fR" 4

.IX Item "noexecstack"

Marks the object as not requiring executable stack.

.IP "\fBnorelro\fR" 4

.IX Item "norelro"

Don't create an \s-1ELF\s0 \f(CW\*(C`PT_GNU_RELRO\*(C'\fR segment header in the object.

.IP "\fBnow\fR" 4

.IX Item "now"

When generating an executable or shared library, mark it to tell the

dynamic linker to resolve all symbols when the program is started, or

when the shared library is linked to using dlopen, instead of

deferring function call resolution to the point when the function is

first called.

.IP "\fBorigin\fR" 4

.IX Item "origin"

Marks the object may contain \f(CW$ORIGIN\fR.

.IP "\fBrelro\fR" 4

.IX Item "relro"

Create an \s-1ELF\s0 \f(CW\*(C`PT_GNU_RELRO\*(C'\fR segment header in the object.

.IP "\fBmax\-page\-size=\fR\fIvalue\fR" 4

.IX Item "max-page-size=value"

Set the emulation maximum page size to \fIvalue\fR.

.IP "\fBcommon\-page\-size=\fR\fIvalue\fR" 4

.IX Item "common-page-size=value"

Set the emulation common page size to \fIvalue\fR.

.RE

.RS 4

.Sp

Other keywords are ignored for Solaris compatibility.

.RE

.IP "\fB\-(\fR \fIarchives\fR \fB\-)\fR" 4

.IX Item "-( archives -)"

.PD 0

.IP "\fB\-\-start\-group\fR \fIarchives\fR \fB\-\-end\-group\fR" 4

.IX Item "--start-group archives --end-group"

.PD

The \fIarchives\fR should be a list of archive files.  They may be

either explicit file names, or \fB\-l\fR options.

.Sp

The specified archives are searched repeatedly until no new undefined

references are created.  Normally, an archive is searched only once in

the order that it is specified on the command line.  If a symbol in that

archive is needed to resolve an undefined symbol referred to by an

object in an archive that appears later on the command line, the linker

would not be able to resolve that reference.  By grouping the archives,

they all be searched repeatedly until all possible references are

resolved.

.Sp

Using this option has a significant performance cost.  It is best to use

it only when there are unavoidable circular references between two or

more archives.

.IP "\fB\-\-accept\-unknown\-input\-arch\fR" 4

.IX Item "--accept-unknown-input-arch"

.PD 0

.IP "\fB\-\-no\-accept\-unknown\-input\-arch\fR" 4

.IX Item "--no-accept-unknown-input-arch"

.PD

Tells the linker to accept input files whose architecture cannot be

recognised.  The assumption is that the user knows what they are doing

and deliberately wants to link in these unknown input files.  This was

the default behaviour of the linker, before release 2.14.  The default

behaviour from release 2.14 onwards is to reject such input files, and

so the \fB\-\-accept\-unknown\-input\-arch\fR option has been added to

restore the old behaviour.

.IP "\fB\-\-as\-needed\fR" 4

.IX Item "--as-needed"

.PD 0