* objdump.c (endian): New static variable.
[deliverable/binutils-gdb.git] / binutils / binutils.texi
CommitLineData
765a273f 1\input texinfo @c -*- Texinfo -*-
c72af735 2@setfilename binutils.info
9bae56c5 3@include config.texi
c72af735 4
9abcc3b8
RP
5@ifinfo
6@format
7START-INFO-DIR-ENTRY
20f774c1
RP
8* Binutils: (binutils). The GNU binary utilities "ar", "objcopy",
9 "objdump", "nm", "nlmconv", "size",
10 "strings", "strip", and "ranlib".
9abcc3b8
RP
11END-INFO-DIR-ENTRY
12@end format
13@end ifinfo
c72af735 14
8b2c2275 15@ifinfo
f5818d79 16Copyright @copyright{} 1991, 92, 93, 94, 95, 1996 Free Software Foundation, Inc.
8b2c2275
RP
17
18Permission is granted to make and distribute verbatim copies of
19this manual provided the copyright notice and this permission notice
20are preserved on all copies.
21
22@ignore
23Permission is granted to process this file through TeX and print the
24results, provided the printed document carries a copying permission
25notice identical to this one except for the removal of this paragraph
26(this paragraph not being relevant to the printed manual).
27
28@end ignore
29
30Permission is granted to copy and distribute modified versions of this
31manual under the conditions for verbatim copying, provided also that
32the entire resulting derived work is distributed under the terms of a
33permission notice identical to this one.
34
35Permission is granted to copy and distribute translations of this manual
36into another language, under the above conditions for modified versions.
37@end ifinfo
38
c72af735
RP
39@synindex ky cp
40@c
df14d957 41@c This file documents the GNU binary utilities "ar", "ld", "objcopy",
ba7c8e29 42@c "objdump", "nm", "size", "strings", "strip", and "ranlib".
c72af735 43@c
f5818d79 44@c Copyright (C) 1991, 92, 93, 94, 95, 1996 Free Software Foundation, Inc.
c72af735
RP
45@c
46@c This text may be freely distributed under the terms of the GNU
47@c General Public License.
48@c
27e94bd5 49
c72af735 50@setchapternewpage odd
b94ff924 51@settitle @sc{gnu} Binary Utilities
4928b97b
RP
52@titlepage
53@finalout
b94ff924 54@title The @sc{gnu} Binary Utilities
9bae56c5 55@subtitle Version @value{VERSION}
c72af735 56@sp 1
e32341a7 57@subtitle May 1993
c72af735 58@author Roland H. Pesch
4961ce5b 59@author Jeffrey M. Osier
c72af735
RP
60@author Cygnus Support
61@page
62
63@tex
650a49f0 64{\parskip=0pt \hfill Cygnus Support\par \hfill
c72af735
RP
65\TeX{}info \texinfoversion\par }
66@end tex
67
68@vskip 0pt plus 1filll
f5818d79 69Copyright @copyright{} 1991, 92, 93, 94, 95, 1996 Free Software Foundation, Inc.
c72af735
RP
70
71Permission is granted to make and distribute verbatim copies of
72this manual provided the copyright notice and this permission notice
73are preserved on all copies.
74
75Permission is granted to copy and distribute modified versions of this
76manual under the conditions for verbatim copying, provided also that
77the entire resulting derived work is distributed under the terms of a
78permission notice identical to this one.
79
80Permission is granted to copy and distribute translations of this manual
81into another language, under the above conditions for modified versions.
82@end titlepage
83
eae04238 84@node Top
8981cac5 85@top Introduction
c72af735
RP
86
87@cindex version
b94ff924 88This brief manual contains preliminary documentation for the @sc{gnu} binary
9bae56c5 89utilities (collectively version @value{VERSION}):
8b2c2275
RP
90
91@iftex
c72af735
RP
92@table @code
93@item ar
94Create, modify, and extract from archives
95
96@item nm
97List symbols from object files
98
eed5eeab
DM
99@item objcopy
100Copy and translate object files
101
c72af735
RP
102@item objdump
103Display information from object files
104
105@item ranlib
106Generate index to archive contents
107
108@item size
eae04238 109List file section sizes and total size
c72af735 110
ba7c8e29
DM
111@item strings
112List printable strings from files
113
c72af735
RP
114@item strip
115Discard symbols
eae04238
DM
116
117@item c++filt
118Demangle encoded C++ symbols
119
120@item nlmconv
121Convert object code into a Netware Loadable Module
c72af735 122@end table
8b2c2275 123@end iftex
c72af735
RP
124
125@menu
8b2c2275 126* ar:: Create, modify, and extract from archives
8b2c2275 127* nm:: List symbols from object files
eed5eeab 128* objcopy:: Copy and translate object files
8b2c2275
RP
129* objdump:: Display information from object files
130* ranlib:: Generate index to archive contents
131* size:: List section sizes and total size
ba7c8e29 132* strings:: List printable strings from files
8b2c2275 133* strip:: Discard symbols
b6216af2 134* c++filt:: Filter to demangle encoded C++ symbols
94e9ad77 135* nlmconv:: Converts object code into an NLM
eae04238 136* Selecting The Target System:: How these utilities determine the target.
8b2c2275 137* Index::
c72af735
RP
138@end menu
139
eae04238 140@node ar
c72af735
RP
141@chapter ar
142
143@kindex ar
144@cindex archives
145@cindex collections of files
146@smallexample
650a49f0 147ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}]
4d9b5d5a 148ar -M [ <mri-script ]
c72af735
RP
149@end smallexample
150
b94ff924 151The @sc{gnu} @code{ar} program creates, modifies, and extracts from
c72af735
RP
152archives. An @dfn{archive} is a single file holding a collection of
153other files in a structure that makes it possible to retrieve
154the original individual files (called @dfn{members} of the archive).
155
156The original files' contents, mode (permissions), timestamp, owner, and
ec40bbb8 157group are preserved in the archive, and can be restored on
c72af735
RP
158extraction.
159
160@cindex name length
b94ff924 161@sc{gnu} @code{ar} can maintain archives whose members have names of any
c72af735 162length; however, depending on how @code{ar} is configured on your
ec40bbb8
DM
163system, a limit on member-name length may be imposed for compatibility
164with archive formats maintained with other tools. If it exists, the
c72af735
RP
165limit is often 15 characters (typical of formats related to a.out) or 16
166characters (typical of formats related to coff).
167
168@cindex libraries
169@code{ar} is considered a binary utility because archives of this sort
170are most often used as @dfn{libraries} holding commonly needed
171subroutines.
172
173@cindex symbol index
e31e9a8d 174@code{ar} creates an index to the symbols defined in relocatable
c72af735
RP
175object modules in the archive when you specify the modifier @samp{s}.
176Once created, this index is updated in the archive whenever @code{ar}
177makes a change to its contents (save for the @samp{q} update operation).
178An archive with such an index speeds up linking to the library, and
179allows routines in the library to call each other without regard to
180their placement in the archive.
181
918c2f61 182You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
c72af735
RP
183table. If an archive lacks the table, another form of @code{ar} called
184@code{ranlib} can be used to add just the table.
185
765a273f
RP
186@cindex compatibility, @code{ar}
187@cindex @code{ar} compatibility
b94ff924 188@sc{gnu} @code{ar} is designed to be compatible with two different
765a273f
RP
189facilities. You can control its activity using command-line options,
190like the different varieties of @code{ar} on Unix systems; or, if you
191specify the single command-line option @samp{-M}, you can control it
192with a script supplied via standard input, like the MRI ``librarian''
193program.
194
195@menu
eae04238
DM
196* ar cmdline:: Controlling @code{ar} on the command line
197* ar scripts:: Controlling @code{ar} with a script
765a273f
RP
198@end menu
199
200@page
eae04238 201@node ar cmdline
765a273f
RP
202@section Controlling @code{ar} on the command line
203
204@smallexample
650a49f0 205ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}]
765a273f
RP
206@end smallexample
207
208@cindex Unix compatibility, @code{ar}
209When you use @code{ar} in the Unix style, @code{ar} insists on at least two
210arguments to execute: one keyletter specifying the @emph{operation}
211(optionally accompanied by other keyletters specifying
212@emph{modifiers}), and the archive name to act on.
c72af735 213
650a49f0 214Most operations can also accept further @var{member} arguments,
c72af735
RP
215specifying particular files to operate on.
216
b94ff924 217@sc{gnu} @code{ar} allows you to mix the operation code @var{p} and modifier
c72af735
RP
218flags @var{mod} in any order, within the first command-line argument.
219
220If you wish, you may begin the first command-line argument with a
221dash.
222
223@cindex operations on archive
224The @var{p} keyletter specifies what operation to execute; it may be
225any of the following, but you must specify only one of them:
226
227@table @code
228@item d
229@cindex deleting from archive
230@emph{Delete} modules from the archive. Specify the names of modules to
650a49f0 231be deleted as @var{member}@dots{}; the archive is untouched if you
c72af735
RP
232specify no files to delete.
233
e31e9a8d 234If you specify the @samp{v} modifier, @code{ar} lists each module
c72af735
RP
235as it is deleted.
236
237@item m
238@cindex moving in archive
239Use this operation to @emph{move} members in an archive.
240
241The ordering of members in an archive can make a difference in how
242programs are linked using the library, if a symbol is defined in more
243than one member.
244
245If no modifiers are used with @code{m}, any members you name in the
650a49f0 246@var{member} arguments are moved to the @emph{end} of the archive;
c72af735
RP
247you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
248specified place instead.
249
250@item p
251@cindex printing from archive
252@emph{Print} the specified members of the archive, to the standard
253output file. If the @samp{v} modifier is specified, show the member
254name before copying its contents to standard output.
255
650a49f0 256If you specify no @var{member} arguments, all the files in the archive are
ec40bbb8 257printed.
c72af735
RP
258
259@item q
260@cindex quick append to archive
650a49f0 261@emph{Quick append}; add the files @var{member}@dots{} to the end of
ec40bbb8 262@var{archive}, without checking for replacement.
c72af735
RP
263
264The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
265operation; new members are always placed at the end of the archive.
266
267The modifier @samp{v} makes @code{ar} list each file as it is appended.
268
269Since the point of this operation is speed, the archive's symbol table
270index is not updated, even if it already existed; you can use @samp{ar s} or
271@code{ranlib} explicitly to update the symbol table index.
272
273@item r
274@cindex replacement in archive
650a49f0 275Insert the files @var{member}@dots{} into @var{archive} (with
ec40bbb8
DM
276@emph{replacement}). This operation differs from @samp{q} in that any
277previously existing members are deleted if their names match those being
278added.
c72af735 279
650a49f0 280If one of the files named in @var{member}@dots{} does not exist, @code{ar}
c72af735
RP
281displays an error message, and leaves undisturbed any existing members
282of the archive matching that name.
283
284By default, new members are added at the end of the file; but you may
285use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
286placement relative to some existing member.
287
288The modifier @samp{v} used with this operation elicits a line of
289output for each file inserted, along with one of the letters @samp{a} or
290@samp{r} to indicate whether the file was appended (no old member
291deleted) or replaced.
292
293@item t
294@cindex contents of archive
295Display a @emph{table} listing the contents of @var{archive}, or those
650a49f0 296of the files listed in @var{member}@dots{} that are present in the
c72af735
RP
297archive. Normally only the member name is shown; if you also want to
298see the modes (permissions), timestamp, owner, group, and size, you can
299request that by also specifying the @samp{v} modifier.
300
650a49f0 301If you do not specify a @var{member}, all files in the archive
c72af735
RP
302are listed.
303
304@cindex repeated names in archive
305@cindex name duplication in archive
306If there is more than one file with the same name (say, @samp{fie}) in
e31e9a8d 307an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
c72af735
RP
308first instance; to see them all, you must ask for a complete
309listing---in our example, @samp{ar t b.a}.
310@c WRS only; per Gumby, this is implementation-dependent, and in a more
311@c recent case in fact works the other way.
312
313@item x
314@cindex extract from archive
650a49f0 315@emph{Extract} members (named @var{member}) from the archive. You can
c72af735
RP
316use the @samp{v} modifier with this operation, to request that
317@code{ar} list each name as it extracts it.
318
650a49f0 319If you do not specify a @var{member}, all files in the archive
c72af735
RP
320are extracted.
321
322@end table
323
324A number of modifiers (@var{mod}) may immediately follow the @var{p}
325keyletter, to specify variations on an operation's behavior:
326
327@table @code
328@item a
329@cindex relative placement in archive
330Add new files @emph{after} an existing member of the
ec40bbb8 331archive. If you use the modifier @samp{a}, the name of an existing archive
650a49f0 332member must be present as the @var{relpos} argument, before the
c72af735
RP
333@var{archive} specification.
334
335@item b
336Add new files @emph{before} an existing member of the
ec40bbb8 337archive. If you use the modifier @samp{b}, the name of an existing archive
650a49f0 338member must be present as the @var{relpos} argument, before the
c72af735
RP
339@var{archive} specification. (same as @samp{i}).
340
341@item c
342@cindex creating archives
343@emph{Create} the archive. The specified @var{archive} is always
650a49f0 344created if it did not exist, when you request an update. But a warning is
c72af735
RP
345issued unless you specify in advance that you expect to create it, by
346using this modifier.
347
52af6a44 348@item f
b94ff924 349Truncate names in the archive. @sc{gnu} @code{ar} will normally permit file
52af6a44
ILT
350names of any length. This will cause it to create archives which are
351not compatible with the native @code{ar} program on some systems. If
352this is a concern, the @samp{f} modifier may be used to truncate file
353names when putting them in the archive.
354
c72af735
RP
355@item i
356Insert new files @emph{before} an existing member of the
ec40bbb8 357archive. If you use the modifier @samp{i}, the name of an existing archive
650a49f0 358member must be present as the @var{relpos} argument, before the
c72af735
RP
359@var{archive} specification. (same as @samp{b}).
360
361@item l
362This modifier is accepted but not used.
363@c whaffor ar l modifier??? presumably compat; with
b94ff924 364@c what???---doc@@cygnus.com, 25jan91
c72af735
RP
365
366@item o
367@cindex dates in archive
368Preserve the @emph{original} dates of members when extracting them. If
369you do not specify this modifier, files extracted from the archive
e31e9a8d 370are stamped with the time of extraction.
c72af735
RP
371
372@item s
373@cindex writing archive index
374Write an object-file index into the archive, or update an existing one,
375even if no other change is made to the archive. You may use this modifier
376flag either with any operation, or alone. Running @samp{ar s} on an
377archive is equivalent to running @samp{ranlib} on it.
378
379@item u
380@cindex updating an archive
b703c078 381Normally, @samp{ar r}@dots{} inserts all files
c72af735
RP
382listed into the archive. If you would like to insert @emph{only} those
383of the files you list that are newer than existing members of the same
384names, use this modifier. The @samp{u} modifier is allowed only for the
385operation @samp{r} (replace). In particular, the combination @samp{qu} is
386not allowed, since checking the timestamps would lose any speed
387advantage from the operation @samp{q}.
388
389@item v
390This modifier requests the @emph{verbose} version of an operation. Many
391operations display additional information, such as filenames processed,
392when the modifier @samp{v} is appended.
4d9b5d5a
DM
393
394@item V
395This modifier shows the version number of @code{ar}.
765a273f
RP
396@end table
397
eae04238 398@node ar scripts
765a273f
RP
399@section Controlling @code{ar} with a script
400
401@smallexample
402ar -M [ <@var{script} ]
403@end smallexample
404
405@cindex MRI compatibility, @code{ar}
406@cindex scripts, @code{ar}
407If you use the single command-line option @samp{-M} with @code{ar}, you
408can control its operation with a rudimentary command language. This
e31e9a8d 409form of @code{ar} operates interactively if standard input is coming
765a273f
RP
410directly from a terminal. During interactive use, @code{ar} prompts for
411input (the prompt is @samp{AR >}), and continues executing even after
412errors. If you redirect standard input to a script file, no prompts are
e31e9a8d 413issued, and @code{ar} abandons execution (with a nonzero exit code)
765a273f
RP
414on any error.
415
416The @code{ar} command language is @emph{not} designed to be equivalent
417to the command-line options; in fact, it provides somewhat less control
418over archives. The only purpose of the command language is to ease the
b94ff924 419transition to @sc{gnu} @code{ar} for developers who already have scripts
765a273f
RP
420written for the MRI ``librarian'' program.
421
422The syntax for the @code{ar} command language is straightforward:
423@itemize @bullet
424@item
425commands are recognized in upper or lower case; for example, @code{LIST}
426is the same as @code{list}. In the following descriptions, commands are
427shown in upper case for clarity.
428
429@item
430a single command may appear on each line; it is the first word on the
431line.
432
433@item
434empty lines are allowed, and have no effect.
435
436@item
437comments are allowed; text after either of the characters @samp{*}
438or @samp{;} is ignored.
439
440@item
441Whenever you use a list of names as part of the argument to an @code{ar}
442command, you can separate the individual names with either commas or
443blanks. Commas are shown in the explanations below, for clarity.
444
445@item
446@samp{+} is used as a line continuation character; if @samp{+} appears
447at the end of a line, the text on the following line is considered part
448of the current command.
449@end itemize
450
451Here are the commands you can use in @code{ar} scripts, or when using
452@code{ar} interactively. Three of them have special significance:
453
454@code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
455a temporary file required for most of the other commands.
456
457@code{SAVE} commits the changes so far specified by the script. Prior
458to @code{SAVE}, commands affect only the temporary copy of the current
459archive.
460
461@table @code
462@item ADDLIB @var{archive}
463@itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
464Add all the contents of @var{archive} (or, if specified, each named
465@var{module} from @var{archive}) to the current archive.
466
467Requires prior use of @code{OPEN} or @code{CREATE}.
468
650a49f0 469@item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
765a273f
RP
470@c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
471@c else like "ar q..."
650a49f0 472Add each named @var{member} as a module in the current archive.
765a273f
RP
473
474Requires prior use of @code{OPEN} or @code{CREATE}.
475
476@item CLEAR
477Discard the contents of the current archive, cancelling the effect of
478any operations since the last @code{SAVE}. May be executed (with no
479effect) even if no current archive is specified.
480
481@item CREATE @var{archive}
482Creates an archive, and makes it the current archive (required for many
483other commands). The new archive is created with a temporary name; it
484is not actually saved as @var{archive} until you use @code{SAVE}.
485You can overwrite existing archives; similarly, the contents of any
486existing file named @var{archive} will not be destroyed until @code{SAVE}.
487
488@item DELETE @var{module}, @var{module}, @dots{} @var{module}
489Delete each listed @var{module} from the current archive; equivalent to
490@samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
491
492Requires prior use of @code{OPEN} or @code{CREATE}.
493
494@item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
495@itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
496List each named @var{module} present in @var{archive}. The separate
497command @code{VERBOSE} specifies the form of the output: when verbose
498output is off, output is like that of @samp{ar -t @var{archive}
b703c078
DM
499@var{module}@dots{}}. When verbose output is on, the listing is like
500@samp{ar -tv @var{archive} @var{module}@dots{}}.
765a273f
RP
501
502Output normally goes to the standard output stream; however, if you
503specify @var{outputfile} as a final argument, @code{ar} directs the
504output to that file.
505
506@item END
507Exit from @code{ar}, with a @code{0} exit code to indicate successful
508completion. This command does not save the output file; if you have
509changed the current archive since the last @code{SAVE} command, those
510changes are lost.
511
512@item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
513Extract each named @var{module} from the current archive, writing them
514into the current directory as separate files. Equivalent to @samp{ar -x
b703c078 515@var{archive} @var{module}@dots{}}.
765a273f
RP
516
517Requires prior use of @code{OPEN} or @code{CREATE}.
518
519@ignore
520@c FIXME Tokens but no commands???
521@item FULLDIR
522
523@item HELP
524@end ignore
525
526@item LIST
527Display full contents of the current archive, in ``verbose'' style
528regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
b94ff924 529tv @var{archive}}). (This single command is a @sc{gnu} @code{ld}
765a273f
RP
530enhancement, rather than present for MRI compatibility.)
531
532Requires prior use of @code{OPEN} or @code{CREATE}.
533
534@item OPEN @var{archive}
535Opens an existing archive for use as the current archive (required for
536many other commands). Any changes as the result of subsequent commands
537will not actually affect @var{archive} until you next use @code{SAVE}.
538
539@item REPLACE @var{module}, @var{module}, @dots{} @var{module}
540In the current archive, replace each existing @var{module} (named in
541the @code{REPLACE} arguments) from files in the current working directory.
542To execute this command without errors, both the file, and the module in
543the current archive, must exist.
544
545Requires prior use of @code{OPEN} or @code{CREATE}.
546
547@item VERBOSE
548Toggle an internal flag governing the output from @code{DIRECTORY}.
549When the flag is on, @code{DIRECTORY} output matches output from
b703c078 550@samp{ar -tv }@dots{}.
765a273f
RP
551
552@item SAVE
553Commit your changes to the current archive, and actually save it as a
554file with the name specified in the last @code{CREATE} or @code{OPEN}
555command.
556
557Requires prior use of @code{OPEN} or @code{CREATE}.
c72af735
RP
558
559@end table
560
8b2c2275
RP
561@iftex
562@node ld
c72af735
RP
563@chapter ld
564@cindex linker
565@kindex ld
b94ff924
VM
566The @sc{gnu} linker @code{ld} is now described in a separate manual.
567@xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
8b2c2275 568@end iftex
c72af735 569
eae04238 570@node nm
c72af735
RP
571@chapter nm
572@cindex symbols
573@kindex nm
574
575@smallexample
d6a4c375 576nm [ -a | --debug-syms ] [ -g | --extern-only ]
de3b08ac 577 [ -B ] [ -C | --demangle ] [ -D | --dynamic ]
1896790e 578 [ -s | --print-armap ] [ -A | -o | --print-file-name ]
6cfbdb50 579 [ -n | -v | --numeric-sort ] [ -p | --no-sort ]
1896790e 580 [ -r | --reverse-sort ] [ --size-sort ] [ -u | --undefined-only ]
6cfbdb50
DM
581 [ -t @var{radix} | --radix=@var{radix} ] [ -P | --portability ]
582 [ --target=@var{bfdname} ] [ -f @var{format} | --format=@var{format} ]
77dd4469 583 [ --defined-only ] [-l | --line-numbers ]
9eb39bca 584 [ --no-demangle ] [ -V | --version ] [ --help ] [ @var{objfile}@dots{} ]
c72af735
RP
585@end smallexample
586
b94ff924 587@sc{gnu} @code{nm} lists the symbols from object files @var{objfile}@dots{}.
6cfbdb50
DM
588If no object files are listed as arguments, @code{nm} assumes
589@file{a.out}.
590
591For each symbol, @code{nm} shows:
592
593@itemize @bullet
594@item
595The symbol value, in the radix selected by options (see below), or
596hexadecimal by default.
597
598@item
599The symbol type. At least the following types are used; others are, as
600well, depending on the object file format. If lowercase, the symbol is
601local; if uppercase, the symbol is global (external).
602
603@c Some more detail on exactly what these symbol types are used for
604@c would be nice.
605@table @code
606@item A
85d4b870
ILT
607The symbol's value is absolute, and will not be changed by further
608linking.
6cfbdb50
DM
609
610@item B
85d4b870 611The symbol is in the uninitialized data section (known as BSS).
6cfbdb50
DM
612
613@item C
85d4b870
ILT
614The symbol is common. Common symbols are uninitialized data. When
615linking, multiple common symbols may appear with the same name. If the
616symbol is defined anywhere, the common symbols are treated as undefined
617references. For more details on common symbols, see the discussion of
618--warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
6cfbdb50
DM
619
620@item D
85d4b870
ILT
621The symbol is in the initialized data section.
622
623@item G
392e2505 624The symbol is in an initialized data section for small objects. Some
85d4b870
ILT
625object file formats permit more efficient access to small data objects,
626such as a global int variable as opposed to a large global array.
6cfbdb50
DM
627
628@item I
85d4b870
ILT
629The symbol is an indirect reference to another symbol. This is a GNU
630extension to the a.out object file format which is rarely used.
631
632@item N
633The symbol is a debugging symbol.
634
635@item R
636The symbol is in a read only data section.
637
638@item S
392e2505 639The symbol is in an uninitialized data section for small objects.
6cfbdb50
DM
640
641@item T
85d4b870 642The symbol is in the text (code) section.
6cfbdb50
DM
643
644@item U
85d4b870
ILT
645The symbol is undefined.
646
647@item W
648The symbol is weak. When a weak defined symbol is linked with a normal
649defined symbol, the normal defined symbol is used with no error. When a
650weak undefined symbol is linked and the symbol is not defined, the value
651of the weak symbol becomes zero with no error.
652
653@item -
654The symbol is a stabs symbol in an a.out object file. In this case, the
655next values printed are the stabs other field, the stabs desc field, and
656the stab type. Stabs symbols are used to hold debugging information;
657for more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
658``stabs'' debug format}.
659
660@item ?
661The symbol type is unknown, or object file format specific.
6cfbdb50
DM
662@end table
663
664@item
665The symbol name.
666@end itemize
c72af735
RP
667
668The long and short forms of options, shown here as alternatives, are
669equivalent.
670
671@table @code
6cfbdb50
DM
672@item -A
673@itemx -o
674@itemx --print-file-name
675@cindex input file name
676@cindex file name
677@cindex source file name
678Precede each symbol by the name of the input file (or archive element)
679in which it was found, rather than identifying the input file once only,
680before all of its symbols.
c72af735
RP
681
682@item -a
918c2f61 683@itemx --debug-syms
c72af735 684@cindex debugging symbols
6cfbdb50
DM
685Display all symbols, even debugger-only symbols; normally these are not
686listed.
687
68dd5295
DM
688@item -B
689@cindex @code{nm} format
690@cindex @code{nm} compatibility
d6a4c375
DM
691The same as @samp{--format=bsd} (for compatibility with the MIPS @code{nm}).
692
693@item -C
694@itemx --demangle
695@cindex demangling C++ symbols
696Decode (@dfn{demangle}) low-level symbol names into user-level names.
697Besides removing any initial underscore prepended by the system, this
698makes C++ function names readable. @xref{c++filt}, for more information
699on demangling.
68dd5295 700
9eb39bca
ILT
701@item --no-demangle
702Do not demangle low-level symbol names. This is the default.
703
de3b08ac
ILT
704@item -D
705@itemx --dynamic
706@cindex dynamic symbols
707Display the dynamic symbols rather than the normal symbols. This is
708only meaningful for dynamic objects, such as certain types of shared
709libraries.
710
6cfbdb50
DM
711@item -f @var{format}
712@itemx --format=@var{format}
68dd5295
DM
713@cindex @code{nm} format
714@cindex @code{nm} compatibility
6cfbdb50
DM
715Use the output format @var{format}, which can be @code{bsd},
716@code{sysv}, or @code{posix}. The default is @code{bsd}.
b26ac613 717Only the first character of @var{format} is significant; it can be
6cfbdb50 718either upper or lower case.
c72af735
RP
719
720@item -g
918c2f61 721@itemx --extern-only
c72af735
RP
722@cindex external symbols
723Display only external symbols.
724
77dd4469
ILT
725@item -l
726@itemx --line-numbers
727@cindex symbol line numbers
728For each symbol, use debugging information to try to find a filename and
729line number. For a defined symbol, look for the line number of the
730address of the symbol. For an undefined symbol, look for the line
731number of a relocation entry which refers to the symbol. If line number
732information can be found, print it after the other symbol information.
733
b26ac613
DM
734@item -n
735@itemx -v
736@itemx --numeric-sort
737Sort symbols numerically by their addresses, rather than alphabetically
738by their names.
739
c72af735 740@item -p
918c2f61 741@itemx --no-sort
c72af735 742@cindex sorting symbols
650a49f0 743Do not bother to sort the symbols in any order; print them in the order
6cfbdb50
DM
744encountered.
745
746@item -P
747@itemx --portability
748Use the POSIX.2 standard output format instead of the default format.
749Equivalent to @samp{-f posix}.
c72af735 750
c72af735 751@item -s
918c2f61 752@itemx --print-armap
c72af735
RP
753@cindex symbol index, listing
754When listing symbols from archive members, include the index: a mapping
ec40bbb8
DM
755(stored in the archive by @code{ar} or @code{ranlib}) of which modules
756contain definitions for which names.
c72af735 757
c72af735 758@item -r
918c2f61 759@itemx --reverse-sort
ec40bbb8 760Reverse the order of the sort (whether numeric or alphabetic); let the
c72af735
RP
761last come first.
762
1896790e
ILT
763@item --size-sort
764Sort symbols by size. The size is computed as the difference between
765the value of the symbol and the value of the symbol with the next higher
766value. The size of the symbol is printed, rather than the value.
767
6cfbdb50
DM
768@item -t @var{radix}
769@itemx --radix=@var{radix}
770Use @var{radix} as the radix for printing the symbol values. It must be
771@samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
772
ec40bbb8 773@item --target=@var{bfdname}
c72af735
RP
774@cindex object code format
775Specify an object code format other than your system's default format.
eae04238 776@xref{Target Selection}, for more information.
c72af735
RP
777
778@item -u
918c2f61 779@itemx --undefined-only
c72af735
RP
780@cindex external symbols
781@cindex undefined symbols
782Display only undefined symbols (those external to each object file).
783
dcd6706b
JL
784@item --defined-only
785@cindex external symbols
786@cindex undefined symbols
787Display only defined symbols for each object file.
788
6cfbdb50
DM
789@item -V
790@itemx --version
b26ac613
DM
791Show the version number of @code{nm} and exit.
792
793@item --help
794Show a summary of the options to @code{nm} and exit.
c72af735
RP
795@end table
796
eae04238 797@node objcopy
eed5eeab
DM
798@chapter objcopy
799
800@smallexample
eae04238
DM
801objcopy [ -F @var{bfdname} | --target=@var{bfdname} ]
802 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
803 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
eed5eeab 804 [ -S | --strip-all ] [ -g | --strip-debug ]
dff604a7 805 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
29c0d15c 806 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
eed5eeab 807 [ -x | --discard-all ] [ -X | --discard-locals ]
f7b839f7
DM
808 [ -b @var{byte} | --byte=@var{byte} ]
809 [ -i @var{interleave} | --interleave=@var{interleave} ]
0aca460e 810 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
f5818d79 811 [ --debugging ]
33e0a06d
ILT
812 [ --gap-fill=@var{val} ] [ --pad-to=@var{address} ]
813 [ --set-start=@var{val} ] [ --adjust-start=@var{incr} ]
814 [ --adjust-vma=@var{incr} ]
6c7ed084
ILT
815 [ --adjust-section-vma=@var{section}@{=,+,-@}@var{val} ]
816 [ --adjust-warnings ] [ --no-adjust-warnings ]
5ab41086 817 [ --set-section-flags=@var{section}=@var{flags} ]
d0130cc8 818 [ --add-section=@var{sectionname}=@var{filename} ]
5da470b2 819 [ --remove-leading-char ]
f7b839f7 820 [ -v | --verbose ] [ -V | --version ] [ --help ]
eed5eeab
DM
821 @var{infile} [@var{outfile}]
822@end smallexample
823
8981cac5
JO
824The @sc{gnu} @code{objcopy} utility copies the contents of an object
825file to another. @code{objcopy} uses the @sc{gnu} @sc{bfd} Library to
826read and write the object files. It can write the destination object
827file in a format different from that of the source object file. The
828exact behavior of @code{objcopy} is controlled by command-line options.
eed5eeab
DM
829
830@code{objcopy} creates temporary files to do its translations and
8981cac5
JO
831deletes them afterward. @code{objcopy} uses @sc{bfd} to do all its
832translation work; it has access to all the formats described in @sc{bfd}
833and thus is able to recognize most formats without being told
834explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
eed5eeab 835
67f67ed9
ILT
836@code{objcopy} can be used to generate S-records by using an output
837target of @samp{srec} (e.g., use @samp{-O srec}).
838
839@code{objcopy} can be used to generate a raw binary file by using an
840output target of @samp{binary} (e.g., use @samp{-O binary}). When
841@code{objcopy} generates a raw binary file, it will essentially produce
842a memory dump of the contents of the input object file. All symbols and
a6afc090 843relocation information will be discarded. The memory dump will start at
11de29d0 844the load address of the lowest section copied into the output file.
67f67ed9
ILT
845
846When generating an S-record or a raw binary file, it may be helpful to
847use @samp{-S} to remove sections containing debugging information. In
848some cases @samp{-R} will be useful to remove sections which contain
849information which is not needed by the binary file.
850
eed5eeab
DM
851@table @code
852@item @var{infile}
853@itemx @var{outfile}
8981cac5 854The source and output files, respectively.
eed5eeab
DM
855If you do not specify @var{outfile}, @code{objcopy} creates a
856temporary file and destructively renames the result with
8981cac5 857the name of @var{infile}.
eed5eeab 858
eae04238
DM
859@item -I @var{bfdname}
860@itemx --input-target=@var{bfdname}
861Consider the source file's object format to be @var{bfdname}, rather than
862attempting to deduce it. @xref{Target Selection}, for more information.
eed5eeab 863
eae04238
DM
864@item -O @var{bfdname}
865@itemx --output-target=@var{bfdname}
866Write the output file using the object format @var{bfdname}.
867@xref{Target Selection}, for more information.
eed5eeab 868
eae04238
DM
869@item -F @var{bfdname}
870@itemx --target=@var{bfdname}
871Use @var{bfdname} as the object format for both the input and the output
872file; i.e., simply transfer data from source to destination with no
873translation. @xref{Target Selection}, for more information.
eed5eeab 874
0aca460e
ILT
875@item -R @var{sectionname}
876@itemx --remove-section=@var{sectionname}
877Remove any section named @var{sectionname} from the output file. This
878option may be given more than once. Note that using this option
879inappropriately may make the output file unusable.
880
eed5eeab
DM
881@item -S
882@itemx --strip-all
883Do not copy relocation and symbol information from the source file.
884
885@item -g
886@itemx --strip-debug
887Do not copy debugging symbols from the source file.
888
9135e5f8
ILT
889@item --strip-unneeded
890Strip all symbols that are not needed for relocation processing.
891
dff604a7
ILT
892@item -K @var{symbolname}
893@itemx --keep-symbol=@var{symbolname}
894Copy only symbol @var{symbolname} from the source file. This option may
895be given more than once.
896
29c0d15c
ILT
897@item -N @var{symbolname}
898@itemx --strip-symbol=@var{symbolname}
dff604a7
ILT
899Do not copy symbol @var{symbolname} from the source file. This option
900may be given more than once, and may be combined with strip options
901other than @code{-K}.
29c0d15c 902
eed5eeab
DM
903@item -x
904@itemx --discard-all
905Do not copy non-global symbols from the source file.
906@c FIXME any reason to prefer "non-global" to "local" here?
907
908@item -X
909@itemx --discard-locals
910Do not copy compiler-generated local symbols.
911(These usually start with @samp{L} or @samp{.}.)
912
db2e6adb
DM
913@item -b @var{byte}
914@itemx --byte=@var{byte}
915Keep only every @var{byte}th byte of the input file (header data is not
f7b839f7
DM
916affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
917where @var{interleave} is given by the @samp{-i} or @samp{--interleave}
918option, or the default of 4. This option is useful for creating files
8981cac5 919to program @sc{rom}. It is typically used with an @code{srec} output
f7b839f7
DM
920target.
921
922@item -i @var{interleave}
923@itemx --interleave=@var{interleave}
8981cac5
JO
924Only copy one out of every @var{interleave} bytes. Select which byte to
925copy with the @var{-b} or @samp{--byte} option. The default is 4.
926@code{objcopy} ignores this option if you do not specify either @samp{-b} or
927@samp{--byte}.
db2e6adb 928
f5818d79
ILT
929@item --debugging
930Convert debugging information, if possible. This is not the default
931because only certain debugging formats are supported, and the
932conversion process can be time consuming.
933
596d99ba
ILT
934@item --gap-fill @var{val}
935Fill gaps between sections with @var{val}. This is done by increasing
936the size of the section with the lower address, and filling in the extra
937space created with @var{val}.
938
33e0a06d
ILT
939@item --pad-to @var{address}
940Pad the output file up to the virtual address @var{address}. This is
941done by increasing the size of the last section. The extra space is
942filled in with the value specified by @samp{--gap-fill} (default zero).
943
6c7ed084
ILT
944@item --set-start @var{val}
945Set the address of the new file to @var{val}. Not all object file
a6afc090 946formats support setting the start address.
6c7ed084
ILT
947
948@item --adjust-start @var{incr}
949Adjust the start address by adding @var{incr}. Not all object file
950formats support setting the start address.
951
952@item --adjust-vma @var{incr}
953Adjust the address of all sections, as well as the start address, by
954adding @var{incr}. Some object file formats do not permit section
955addresses to be changed arbitrarily. Note that this does not relocate
956the sections; if the program expects sections to be loaded at a certain
957address, and this option is used to change the sections such that they
958are loaded at a different address, the program may fail.
959
960@item --adjust-section-vma @var{section}@{=,+,-@}@var{val}
961Set or adjust the address of the named @var{section}. If @samp{=} is
962used, the section address is set to @var{val}. Otherwise, @var{val} is
963added to or subtracted from the section address. See the comments under
964@samp{--adjust-vma}, above. If @var{section} does not exist in the
965input file, a warning will be issued, unless @samp{--no-adjust-warnings}
966is used.
967
968@item --adjust-warnings
969If @samp{--adjust-section-vma} is used, and the named section does not
970exist, issue a warning. This is the default.
971
972@item --no-adjust-warnings
973Do not issue a warning if @samp{--adjust-section-vma} is used, even if
974the named section does not exist.
975
5ab41086
ILT
976@item --set-section-flags @var{section}=@var{flags}
977Set the flags for the named section. The @var{flags} argument is a
978comma separated string of flag names. The recognized names are
979@samp{alloc}, @samp{load}, @samp{readonly}, @samp{code}, @samp{data},
980and @samp{rom}. Not all flags are meaningful for all object file
981formats.
982
d0130cc8
ILT
983@item --add-section @var{sectionname}=@var{filename}
984Add a new section named @var{sectionname} while copying the file. The
985contents of the new section are taken from the file @var{filename}. The
986size of the section will be the size of the file. This option only
987works on file formats which can support sections with arbitrary names.
988
5da470b2
ILT
989@item --remove-leading-char
990If the first character of a global symbol is a special symbol leading
991character used by the object file format, remove the character. The
992most common symbol leading character is underscore. This option will
993remove a leading underscore from all global symbols. This can be useful
994if you want to link together objects of different file formats with
995different conventions for symbol names.
996
eed5eeab
DM
997@item -V
998@itemx --version
999Show the version number of @code{objcopy}.
1000
1001@item -v
1002@itemx --verbose
1003Verbose output: list all object files modified. In the case of
1004archives, @samp{objcopy -V} lists all members of the archive.
1005
1006@item --help
1007Show a summary of the options to @code{objcopy}.
1008@end table
1009
eae04238 1010@node objdump
c72af735
RP
1011@chapter objdump
1012
1013@cindex object file information
1014@kindex objdump
1015
1016@smallexample
10f2a7f6 1017objdump [ -a | --archive-headers ]
e1c14599 1018 [ -b @var{bfdname} | --target=@var{bfdname} ] [ --debugging ]
d5464baa 1019 [ -d | --disassemble ] [ -D | --disassemble-all ]
67c8c901 1020 [ -EB | -EL | --endian=@{big | little @} ]
d5464baa 1021 [ -f | --file-headers ]
eae04238 1022 [ -h | --section-headers | --headers ] [ -i | --info ]
10f2a7f6 1023 [ -j @var{section} | --section=@var{section} ]
a8e27cc6 1024 [ -l | --line-numbers ] [ -S | --source ]
7e5e9619
JO
1025 [ -m @var{machine} | --architecture=@var{machine} ]
1026 [ -r | --reloc ] [ -R | --dynamic-reloc ]
1027 [ -s | --full-contents ] [ --stabs ]
de3b08ac 1028 [ -t | --syms ] [ -T | --dynamic-syms ] [ -x | --all-headers ]
aa21a2a9 1029 [ -w | --wide ] [ --start-address=@var{address} ]
458bbd1f
DE
1030 [ --stop-address=@var{address} ] [ --show-raw-insn ]
1031 [ --version ] [ --help ]
aa21a2a9 1032 @var{objfile}@dots{}
c72af735
RP
1033@end smallexample
1034
1035@code{objdump} displays information about one or more object files.
1036The options control what particular information to display. This
1037information is mostly useful to programmers who are working on the
1038compilation tools, as opposed to programmers who just want their
1039program to compile and work.
1040
b26ac613
DM
1041@var{objfile}@dots{} are the object files to be examined. When you
1042specify archives, @code{objdump} shows information on each of the member
1043object files.
1044
c72af735 1045The long and short forms of options, shown here as alternatives, are
ed78872a 1046equivalent. At least one option besides @samp{-l} must be given.
c72af735
RP
1047
1048@table @code
c72af735 1049@item -a
eae04238 1050@itemx --archive-header
c72af735 1051@cindex archive headers
ec40bbb8 1052If any of the @var{objfile} files are archives, display the archive
c72af735
RP
1053header information (in a format similar to @samp{ls -l}). Besides the
1054information you could list with @samp{ar tv}, @samp{objdump -a} shows
1055the object file format of each archive member.
1056
c72af735 1057@item -b @var{bfdname}
eae04238 1058@itemx --target=@var{bfdname}
c72af735 1059@cindex object code format
ec40bbb8
DM
1060Specify that the object-code format for the object files is
1061@var{bfdname}. This option may not be necessary; @var{objdump} can
1062automatically recognize many formats.
1063
1064For example,
c72af735
RP
1065@example
1066objdump -b oasys -m vax -h fu.o
1067@end example
1068@noindent
ec40bbb8
DM
1069displays summary information from the section headers (@samp{-h}) of
1070@file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object
c72af735
RP
1071file in the format produced by Oasys compilers. You can list the
1072formats available with the @samp{-i} option.
eae04238 1073@xref{Target Selection}, for more information.
c72af735 1074
e1c14599
ILT
1075@item --debugging
1076Display debugging information. This attempts to parse debugging
1077information stored in the file and print it out using a C like syntax.
1078Only certain types of debugging information have been implemented.
1079
c72af735 1080@item -d
eae04238 1081@itemx --disassemble
c72af735
RP
1082@cindex disassembling object code
1083@cindex machine instructions
d5464baa
ILT
1084Display the assembler mnemonics for the machine instructions from
1085@var{objfile}. This option only disassembles those sections which are
1086expected to contain instructions.
1087
1088@item -D
1089@itemx --disassemble-all
1090Like @samp{-d}, but disassemble the contents of all sections, not just
1091those expected to contain instructions.
c72af735 1092
67c8c901
ILT
1093@item -EB
1094@itemx -EL
1095@itemx --endian=@{big|little@}
1096@cindex endianness
1097@cindex disassembly endianness
1098Specify the endianness of the object files. This only affects
1099disassembly. This can be useful when disassembling a file format which
1100does not describe endianness information, such as S-records.
1101
c72af735 1102@item -f
eae04238 1103@itemx --file-header
c72af735 1104@cindex object file header
eae04238 1105Display summary information from the overall header of
ec40bbb8 1106each of the @var{objfile} files.
c72af735
RP
1107
1108@item -h
eae04238 1109@itemx --section-header
c5f0c938 1110@itemx --header
c72af735 1111@cindex section headers
eae04238 1112Display summary information from the section headers of the
c72af735
RP
1113object file.
1114
db2e6adb
DM
1115File segments may be relocated to nonstandard addresses, for example by
1116using the @samp{-Ttext}, @samp{-Tdata}, or @samp{-Tbss} options to
1117@code{ld}. However, some object file formats, such as a.out, do not
1118store the starting address of the file segments. In those situations,
1119although @code{ld} relocates the sections correctly, using @samp{objdump
1120-h} to list the file section headers cannot show the correct addresses.
1121Instead, it shows the usual addresses, which are implicit for the
1122target.
1123
b26ac613
DM
1124@item --help
1125Print a summary of the options to @code{objdump} and exit.
1126
c72af735 1127@item -i
eae04238 1128@itemx --info
c72af735
RP
1129@cindex architectures available
1130@cindex object formats available
1131Display a list showing all architectures and object formats available
ec40bbb8 1132for specification with @samp{-b} or @samp{-m}.
c72af735 1133
c72af735 1134@item -j @var{name}
eae04238 1135@itemx --section=@var{name}
c72af735 1136@cindex section information
ec40bbb8 1137Display information only for section @var{name}.
c72af735 1138
c72af735 1139@item -l
eae04238 1140@itemx --line-numbers
c72af735 1141@cindex source filenames for object files
11548211
ILT
1142Label the display (using debugging information) with the filename and
1143source line numbers corresponding to the object code or relocs shown.
1144Only useful with @samp{-d}, @samp{-D}, or @samp{-r}.
c72af735 1145
c72af735 1146@item -m @var{machine}
eae04238 1147@itemx --architecture=@var{machine}
c72af735 1148@cindex architecture
67c8c901
ILT
1149@cindex disassembly architecture
1150Specify the architecture to use when disassembling object files. This
1151can be useful when disasembling object files which do not describe
1152architecture information, such as S-records. You can list the available
1153architectures with the @samp{-i} option.
c72af735
RP
1154
1155@item -r
c5f0c938 1156@itemx --reloc
c72af735 1157@cindex relocation entries, in object file
d5464baa
ILT
1158Print the relocation entries of the file. If used with @samp{-d} or
1159@samp{-D}, the relocations are printed interspersed with the
1160disassembly.
c72af735 1161
de3b08ac
ILT
1162@item -R
1163@itemx --dynamic-reloc
1164@cindex dynamic relocation entries, in object file
1165Print the dynamic relocation entries of the file. This is only
1166meaningful for dynamic objects, such as certain types of shared
1167libraries.
1168
c72af735 1169@item -s
eae04238 1170@itemx --full-contents
c72af735
RP
1171@cindex sections, full contents
1172@cindex object file sections
1173Display the full contents of any sections requested.
1174
a8e27cc6
ILT
1175@item -S
1176@itemx --source
1177@cindex source disassembly
1178@cindex disassembly, with source
1179Display source code intermixed with disassembly, if possible. Implies
1180@samp{-d}.
1181
458bbd1f
DE
1182@item --show-raw-insn
1183When disassembling instructions, print the instruction in hex as well as
1184in symbolic form. Not all targets handle this correctly yet.
1185
c5f0c938
JG
1186@item --stabs
1187@cindex stab
1188@cindex .stab
1189@cindex debug symbols
1190@cindex ELF object file format
c3c93fda
JG
1191Display the full contents of any sections requested. Display the
1192contents of the .stab and .stab.index and .stab.excl sections from an
1193ELF file. This is only useful on systems (such as Solaris 2.0) in which
1194@code{.stab} debugging symbol-table entries are carried in an ELF
1195section. In most other file formats, debugging symbol-table entries are
c5f0c938 1196interleaved with linkage symbols, and are visible in the @samp{--syms}
85d4b870
ILT
1197output. For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1198Overview,stabs.info, The ``stabs'' debug format}.
c5f0c938 1199
aa21a2a9
ILT
1200@item --start-address=@var{address}
1201@cindex start-address
1202Start displaying data at the specified address. This affects the output
1203of the @code{-d}, @code{-r} and @code{-s} options.
1204
1205@item --stop-address=@var{address}
1206@cindex stop-address
1207Stop displaying data at the specified address. This affects the output
1208of the @code{-d}, @code{-r} and @code{-s} options.
1209
c72af735 1210@item -t
c5f0c938 1211@itemx --syms
c72af735 1212@cindex symbol table entries, printing
eae04238 1213Print the symbol table entries of the file.
c72af735
RP
1214This is similar to the information provided by the @samp{nm} program.
1215
de3b08ac
ILT
1216@item -T
1217@itemx --dynamic-syms
1218@cindex dynamic symbol table entries, printing
1219Print the dynamic symbol table entries of the file. This is only
1220meaningful for dynamic objects, such as certain types of shared
1221libraries. This is similar to the information provided by the @samp{nm}
1222program when given the @samp{-D} (@samp{--dynamic}) option.
1223
b26ac613
DM
1224@item --version
1225Print the version number of @code{objdump} and exit.
1226
c72af735 1227@item -x
eae04238 1228@itemx --all-header
c72af735
RP
1229@cindex all header information, object file
1230@cindex header information, all
1231Display all available header information, including the symbol table and
1232relocation entries. Using @samp{-x} is equivalent to specifying all of
1233@samp{-a -f -h -r -t}.
4b6d0f78
MM
1234
1235@item -w
1236@item --wide
1237@cindex wide output, printing
1238Format some lines for output devices that have more than 80 columns.
c72af735
RP
1239@end table
1240
eae04238 1241@node ranlib
c72af735
RP
1242@chapter ranlib
1243
1244@kindex ranlib
1245@cindex archive contents
1246@cindex symbol index
1247
1248@smallexample
4d9b5d5a 1249ranlib [-vV] @var{archive}
c72af735
RP
1250@end smallexample
1251
ec40bbb8 1252@code{ranlib} generates an index to the contents of an archive and
c72af735
RP
1253stores it in the archive. The index lists each symbol defined by a
1254member of an archive that is a relocatable object file.
1255
918c2f61 1256You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
c72af735 1257
ec40bbb8 1258An archive with such an index speeds up linking to the library and
c72af735
RP
1259allows routines in the library to call each other without regard to
1260their placement in the archive.
1261
b94ff924 1262The @sc{gnu} @code{ranlib} program is another form of @sc{gnu} @code{ar}; running
c72af735
RP
1263@code{ranlib} is completely equivalent to executing @samp{ar -s}.
1264@xref{ar}.
1265
4d9b5d5a
DM
1266@table @code
1267@item -v
1268@itemx -V
1269Show the version number of @code{ranlib}.
c3f471a4 1270@end table
4d9b5d5a 1271
eae04238 1272@node size
c72af735
RP
1273@chapter size
1274
1275@kindex size
1276@cindex section sizes
1277
1278@smallexample
4d9b5d5a
DM
1279size [ -A | -B | --format=@var{compatibility} ]
1280 [ --help ] [ -d | -o | -x | --radix=@var{number} ]
1281 [ --target=@var{bfdname} ] [ -V | --version ]
1282 @var{objfile}@dots{}
c72af735
RP
1283@end smallexample
1284
b94ff924 1285The @sc{gnu} @code{size} utility lists the section sizes---and the total
ec40bbb8
DM
1286size---for each of the object or archive files @var{objfile} in its
1287argument list. By default, one line of output is generated for each
1288object file or each module in an archive.
c72af735 1289
b26ac613
DM
1290@var{objfile}@dots{} are the object files to be examined.
1291
c72af735 1292The command line options have the following meanings:
c72af735 1293
b26ac613 1294@table @code
c72af735
RP
1295@item -A
1296@itemx -B
ec40bbb8 1297@itemx --format=@var{compatibility}
68dd5295 1298@cindex @code{size} display format
b94ff924 1299Using one of these options, you can choose whether the output from @sc{gnu}
c72af735 1300@code{size} resembles output from System V @code{size} (using @samp{-A},
ec40bbb8
DM
1301or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or
1302@samp{--format=berkeley}). The default is the one-line format similar to
c72af735 1303Berkeley's.
918c2f61
PB
1304@c Bonus for doc-source readers: you can also say --format=strange (or
1305@c anything else that starts with 's') for sysv, and --format=boring (or
c72af735
RP
1306@c anything else that starts with 'b') for Berkeley.
1307
1308Here is an example of the Berkeley (default) format of output from
1309@code{size}:
1310@smallexample
eae04238 1311size --format=Berkeley ranlib size
c72af735
RP
1312text data bss dec hex filename
1313294880 81920 11592 388392 5ed28 ranlib
1314294880 81920 11888 388688 5ee50 size
1315@end smallexample
1316
1317@noindent
1318This is the same data, but displayed closer to System V conventions:
1319
1320@smallexample
eae04238 1321size --format=SysV ranlib size
c72af735
RP
1322ranlib :
1323section size addr
1324.text 294880 8192
1325.data 81920 303104
1326.bss 11592 385024
1327Total 388392
1328
1329
1330size :
1331section size addr
1332.text 294880 8192
1333.data 81920 303104
1334.bss 11888 385024
1335Total 388688
1336@end smallexample
1337
918c2f61 1338@item --help
c72af735
RP
1339Show a summary of acceptable arguments and options.
1340
1341@item -d
1342@itemx -o
1343@itemx -x
ec40bbb8 1344@itemx --radix=@var{number}
68dd5295 1345@cindex @code{size} number format
c72af735
RP
1346@cindex radix for section sizes
1347Using one of these options, you can control whether the size of each
ec40bbb8
DM
1348section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal
1349(@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or
1350@samp{--radix=16}). In @samp{--radix=@var{number}}, only the three
c72af735
RP
1351values (8, 10, 16) are supported. The total size is always given in two
1352radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
1353octal and hexadecimal if you're using @samp{-o}.
1354
ec40bbb8 1355@item --target=@var{bfdname}
c72af735 1356@cindex object code format
ec40bbb8
DM
1357Specify that the object-code format for @var{objfile} is
1358@var{bfdname}. This option may not be necessary; @code{size} can
eae04238
DM
1359automatically recognize many formats.
1360@xref{Target Selection}, for more information.
c72af735
RP
1361
1362@item -V
918c2f61 1363@itemx --version
4d9b5d5a 1364Display the version number of @code{size}.
c72af735
RP
1365@end table
1366
eae04238 1367@node strings
ba7c8e29
DM
1368@chapter strings
1369@kindex strings
1370@cindex listings strings
1371@cindex printing strings
1372@cindex strings, printing
1373
1374@smallexample
b26ac613 1375strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-]
650a49f0 1376 [--all] [--print-file-name] [--bytes=@var{min-len}]
eae04238
DM
1377 [--radix=@var{radix}] [--target=@var{bfdname}]
1378 [--help] [--version] @var{file}@dots{}
ba7c8e29
DM
1379@end smallexample
1380
b94ff924 1381For each @var{file} given, @sc{gnu} @code{strings} prints the printable
ba7c8e29 1382character sequences that are at least 4 characters long (or the number
67ace729 1383given with the options below) and are followed by an unprintable
ba7c8e29 1384character. By default, it only prints the strings from the initialized
5f057047
ILT
1385and loaded sections of object files; for other types of files, it prints
1386the strings from the whole file.
ba7c8e29
DM
1387
1388@code{strings} is mainly useful for determining the contents of non-text
1389files.
1390
1391@table @code
1392@item -a
1393@itemx --all
1394@itemx -
5f057047
ILT
1395Do not scan only the initialized and loaded sections of object files;
1396scan the whole files.
ba7c8e29
DM
1397
1398@item -f
1399@itemx --print-file-name
1400Print the name of the file before each string.
1401
b26ac613 1402@item --help
ba7c8e29
DM
1403Print a summary of the program usage on the standard output and exit.
1404
ba7c8e29 1405@itemx -@var{min-len}
b26ac613 1406@item -n @var{min-len}
ba7c8e29
DM
1407@itemx --bytes=@var{min-len}
1408Print sequences of characters that are at least @var{min-len} characters
1409long, instead of the default 4.
1410
1411@item -o
b26ac613
DM
1412Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o}
1413act like @samp{-t d} instead. Since we can not be compatible with both
1414ways, we simply chose one.
ba7c8e29
DM
1415
1416@item -t @var{radix}
1417@itemx --radix=@var{radix}
1418Print the offset within the file before each string. The single
1419character argument specifies the radix of the offset---@samp{o} for
1420octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1421
eae04238
DM
1422@item --target=@var{bfdname}
1423@cindex object code format
1424Specify an object code format other than your system's default format.
1425@xref{Target Selection}, for more information.
1426
ba7c8e29
DM
1427@item -v
1428@itemx --version
1429Print the program version number on the standard output and exit.
1430@end table
1431
eae04238 1432@node strip
c72af735
RP
1433@chapter strip
1434
1435@kindex strip
1436@cindex removing symbols
1437@cindex discarding symbols
1815e42c 1438@cindex symbols, discarding
c72af735
RP
1439
1440@smallexample
eae04238
DM
1441strip [ -F @var{bfdname} | --target=@var{bfdname} | --target=@var{bfdname} ]
1442 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1443 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
b703c078 1444 [ -s | --strip-all ] [ -S | -g | --strip-debug ]
dff604a7 1445 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
29c0d15c 1446 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
b703c078 1447 [ -x | --discard-all ] [ -X | --discard-locals ]
0aca460e 1448 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
b26ac613 1449 [ -v | --verbose ] [ -V | --version ] [ --help ]
b703c078 1450 @var{objfile}@dots{}
c72af735
RP
1451@end smallexample
1452
b94ff924 1453@sc{gnu} @code{strip} discards all symbols from object files
ec40bbb8 1454@var{objfile}. The list of object files may include archives.
b26ac613 1455At least one object file must be given.
c72af735 1456
ec40bbb8 1457@code{strip} modifies the files named in its argument,
c72af735 1458rather than writing modified copies under different names.
c72af735 1459
c72af735 1460@table @code
eae04238
DM
1461@item -F @var{bfdname}
1462@itemx --target=@var{bfdname}
b26ac613 1463Treat the original @var{objfile} as a file with the object
eae04238
DM
1464code format @var{bfdname}, and rewrite it in the same format.
1465@xref{Target Selection}, for more information.
b26ac613
DM
1466
1467@item --help
1468Show a summary of the options to @code{strip} and exit.
1469
eae04238
DM
1470@item -I @var{bfdname}
1471@itemx --input-target=@var{bfdname}
ec40bbb8 1472Treat the original @var{objfile} as a file with the object
eae04238
DM
1473code format @var{bfdname}.
1474@xref{Target Selection}, for more information.
918c2f61 1475
eae04238
DM
1476@item -O @var{bfdname}
1477@itemx --output-target=@var{bfdname}
1478Replace @var{objfile} with a file in the output format @var{bfdname}.
1479@xref{Target Selection}, for more information.
918c2f61 1480
0aca460e
ILT
1481@item -R @var{sectionname}
1482@itemx --remove-section=@var{sectionname}
1483Remove any section named @var{sectionname} from the output file. This
1484option may be given more than once. Note that using this option
1485inappropriately may make the output file unusable.
1486
b703c078
DM
1487@item -s
1488@itemx --strip-all
1489Remove all symbols.
1490
918c2f61
PB
1491@item -g
1492@itemx -S
1493@itemx --strip-debug
1494Remove debugging symbols only.
1495
9135e5f8
ILT
1496@item --strip-unneeded
1497Remove all symbols that are not needed for relocation processing.
1498
dff604a7
ILT
1499@item -K @var{symbolname}
1500@itemx --keep-symbol=@var{symbolname}
1501Keep only symbol @var{symbolname} from the source file. This option may
1502be given more than once.
1503
29c0d15c
ILT
1504@item -N @var{symbolname}
1505@itemx --strip-symbol=@var{symbolname}
dff604a7
ILT
1506Remove symbol @var{symbolname} from the source file. This option may be
1507given more than once, and may be combined with strip options other than
1508@code{-K}.
29c0d15c 1509
918c2f61
PB
1510@item -x
1511@itemx --discard-all
1512Remove non-global symbols.
1513
1514@item -X
1515@itemx --discard-locals
1516Remove compiler-generated local symbols.
ec40bbb8 1517(These usually start with @samp{L} or @samp{.}.)
918c2f61
PB
1518
1519@item -V
1520@itemx --version
ec40bbb8 1521Show the version number for @code{strip}.
918c2f61 1522
1815e42c 1523@item -v
918c2f61
PB
1524@itemx --verbose
1525Verbose output: list all object files modified. In the case of
1269d441 1526archives, @samp{strip -v} lists all members of the archive.
c72af735
RP
1527@end table
1528
eae04238 1529@node c++filt
b6216af2
PB
1530@chapter c++filt
1531
1532@kindex c++filt
1533@cindex demangling C++ symbols
1534
b26ac613
DM
1535@smallexample
1536c++filt [ -_ | --strip-underscores ]
6f88f031 1537 [ -n | --no-strip-underscores ]
b26ac613 1538 [ -s @var{format} | --format=@var{format} ]
d6a4c375 1539 [ --help ] [ --version ] [ @var{symbol}@dots{} ]
b26ac613
DM
1540@end smallexample
1541
6c69b6bd
JO
1542The C++ language provides function overloading, which means that you can
1543write many functions with the same name (providing each takes parameters
1544of different types). All C++ function names are encoded into a
b26ac613 1545low-level assembly label (this process is known as
6c69b6bd
JO
1546@dfn{mangling}). The @code{c++filt} program does the inverse mapping: it
1547decodes (@dfn{demangles}) low-level names into user-level names so that
1548the linker can keep these overloaded functions from clashing.
1549
1550Every alphanumeric word (consisting of letters, digits, underscores,
1551dollars, or periods) seen in the input is a potential label. If the
1552label decodes into a C++ name, the C++ name replaces the low-level
1553name in the output.
b6216af2 1554
d6a4c375 1555You can use @code{c++filt} to decipher individual symbols:
6c69b6bd
JO
1556
1557@example
1558c++filt @var{symbol}
1559@end example
1560
d6a4c375
DM
1561If no @var{symbol} arguments are given, @code{c++filt} reads symbol
1562names from the standard input and writes the demangled names to the
1563standard output. All results are printed on the standard output.
b6216af2 1564
b26ac613
DM
1565@table @code
1566@item -_
94e9ad77 1567@itemx --strip-underscores
b26ac613
DM
1568On some systems, both the C and C++ compilers put an underscore in front
1569of every name. For example, the C name @code{foo} gets the low-level
6f88f031
ILT
1570name @code{_foo}. This option removes the initial underscore. Whether
1571@code{c++filt} removes the underscore by default is target dependent.
1572
1573@item -n
1574@itemx --no-strip-underscores
1575Do not remove the initial underscore.
b26ac613
DM
1576
1577@item -s @var{format}
1578@itemx --format=@var{format}
b94ff924 1579@sc{gnu} @code{nm} can decode three different methods of mangling, used by
b26ac613
DM
1580different C++ compilers. The argument to this option selects which
1581method it uses:
1582
1583@table @code
1584@item gnu
b94ff924 1585the one used by the @sc{gnu} compiler (the default method)
b26ac613
DM
1586@item lucid
1587the one used by the Lucid compiler
1588@item arm
1589the one specified by the C++ Annotated Reference Manual
1590@end table
1591
1592@item --help
1593Print a summary of the options to @code{c++filt} and exit.
1594
1595@item --version
1596Print the version number of @code{c++filt} and exit.
1597@end table
b6216af2 1598
5eac46ae
JO
1599@quotation
1600@emph{Warning:} @code{c++filt} is a new utility, and the details of its
1601user interface are subject to change in future releases. In particular,
1602a command-line option may be required in the the future to decode a name
1603passed as an argument on the command line; in other words,
1604
1605@example
b26ac613 1606c++filt @var{symbol}
5eac46ae
JO
1607@end example
1608
1609@noindent
1610may in a future release become
1611
1612@example
b26ac613 1613c++filt @var{option} @var{symbol}
5eac46ae
JO
1614@end example
1615@end quotation
1616
eae04238 1617@node nlmconv
94e9ad77
JO
1618@chapter nlmconv
1619
1620@code{nlmconv} converts a relocatable object file into a NetWare
8981cac5
JO
1621Loadable Module.
1622
1623@ignore
1624@code{nlmconv} currently works with @samp{i386} object
4961ce5b
JO
1625files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
1626object files in @sc{elf}, or @code{a.out} format@footnote{
1627@code{nlmconv} should work with any @samp{i386} or @sc{sparc} object
1628format in the Binary File Descriptor library. It has only been tested
1629with the above formats.}.
8981cac5 1630@end ignore
4961ce5b
JO
1631
1632@quotation
1633@emph{Warning:} @code{nlmconv} is not always built as part of the binary
1634utilities, since it is only useful for NLM targets.
1635@end quotation
94e9ad77
JO
1636
1637@smallexample
eae04238
DM
1638nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1639 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
94e9ad77 1640 [ -T @var{headerfile} | --header-file=@var{headerfile} ]
20465f8b 1641 [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ]
94e9ad77
JO
1642 [ -h | --help ] [ -V | --version ]
1643 @var{infile} @var{outfile}
1644@end smallexample
1645
1646@code{nlmconv} converts the relocatable @samp{i386} object file
1647@var{infile} into the NetWare Loadable Module @var{outfile}, optionally
1648reading @var{headerfile} for NLM header information. For instructions
5b0ba16d
JO
1649on writing the NLM command file language used in header files, see the
1650@samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
1651Development and Tools Overview}, which is part of the NLM Software
1652Developer's Kit (``NLM SDK''), available from Novell, Inc.
1653@code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
eae04238 1654@var{infile}; see @ref{BFD,,BFD,ld.info,Using LD}, for
5b0ba16d 1655more information.
94e9ad77 1656
20465f8b
JO
1657@code{nlmconv} can perform a link step. In other words, you can list
1658more than one object file for input if you list them in the definitions
1659file (rather than simply specifying one input file on the command line).
1660In this case, @code{nlmconv} calls the linker for you.
1661
94e9ad77 1662@table @code
eae04238
DM
1663@item -I @var{bfdname}
1664@itemx --input-target=@var{bfdname}
94e9ad77 1665Object format of the input file. @code{nlmconv} can usually determine
eae04238
DM
1666the format of a given file (so no default is necessary).
1667@xref{Target Selection}, for more information.
94e9ad77 1668
eae04238
DM
1669@item -O @var{bfdname}
1670@itemx --output-target=@var{bfdname}
94e9ad77
JO
1671Object format of the output file. @code{nlmconv} infers the output
1672format based on the input format, e.g. for a @samp{i386} input file the
eae04238
DM
1673output format is @samp{nlm32-i386}.
1674@xref{Target Selection}, for more information.
94e9ad77
JO
1675
1676@item -T @var{headerfile}
1677@itemx --header-file=@var{headerfile}
1678Reads @var{headerfile} for NLM header information. For instructions on
5b0ba16d
JO
1679writing the NLM command file language used in header files, see@ see the
1680@samp{linkers} section, of the @cite{NLM Development and Tools
1681Overview}, which is part of the NLM Software Developer's Kit, available
1682from Novell, Inc.
94e9ad77 1683
20465f8b
JO
1684@item -d
1685@itemx --debug
1686Displays (on standard error) the linker command line used by @code{nlmconv}.
1687
1688@item -l @var{linker}
1689@itemx --linker=@var{linker}
1690Use @var{linker} for any linking. @var{linker} can be an abosolute or a
1691relative pathname.
1692
94e9ad77
JO
1693@item -h
1694@itemx --help
1695Prints a usage summary.
1696
1697@item -V
1698@itemx --version
1699Prints the version number for @code{nlmconv}.
1700@end table
1701
eae04238
DM
1702@node Selecting The Target System
1703@chapter Selecting the target system
1704
8981cac5
JO
1705You can specify three aspects of the target system to the @sc{gnu}
1706binary file utilities, each in several ways:
eae04238
DM
1707
1708@itemize @bullet
1709@item
8981cac5 1710the target
eae04238
DM
1711
1712@item
8981cac5 1713the architecture
eae04238
DM
1714
1715@item
8981cac5 1716the linker emulation (which applies to the linker only)
eae04238
DM
1717@end itemize
1718
1719In the following summaries, the lists of ways to specify values are in
8981cac5
JO
1720order of decreasing precedence. The ways listed first override those
1721listed later.
eae04238 1722
8981cac5
JO
1723The commands to list valid values only list the values for which the
1724programs you are running were configured. If they were configured with
8490169d 1725@samp{--enable-targets=all}, the commands list most of the available
eae04238 1726values, but a few are left out; not all targets can be configured in at
8981cac5
JO
1727once because some of them can only be configured @dfn{native} (on hosts
1728with the same type as the target system).
eae04238
DM
1729
1730@menu
1731* Target Selection::
1732* Architecture Selection::
1733* Linker Emulation Selection::
1734@end menu
1735
1736@node Target Selection
8981cac5 1737@section Target Selection
eae04238
DM
1738
1739A @dfn{target} is an object file format. A given target may be
1740supported for multiple architectures (@pxref{Architecture Selection}).
8981cac5
JO
1741A target selection may also have variations for different operating
1742systems or architectures.
eae04238 1743
8981cac5
JO
1744The command to list valid target values is @samp{objdump -i}
1745(the first column of output contains the relevant information).
eae04238 1746
10f2a7f6
JO
1747Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
1748@samp{a.out-sunos-big}.
eae04238 1749
8981cac5 1750@subheading @code{objdump} Target
eae04238
DM
1751
1752Ways to specify:
1753
1754@enumerate
1755@item
8981cac5 1756command line option: @samp{-b} or @samp{--target}
eae04238
DM
1757
1758@item
1759environment variable @code{GNUTARGET}
1760
1761@item
1762deduced from the input file
1763@end enumerate
1764
8981cac5 1765@subheading @code{objcopy} and @code{strip} Input Target
eae04238
DM
1766
1767Ways to specify:
1768
1769@enumerate
1770@item
8981cac5 1771command line options: @samp{-I} or @samp{--input-target}, or @samp{-F} or @samp{--target}
eae04238
DM
1772
1773@item
1774environment variable @code{GNUTARGET}
1775
1776@item
1777deduced from the input file
1778@end enumerate
1779
8981cac5 1780@subheading @code{objcopy} and @code{strip} Output Target
eae04238
DM
1781
1782Ways to specify:
1783
1784@enumerate
1785@item
8981cac5 1786command line options: @samp{-O} or @samp{--output-target}, or @samp{-F} or @samp{--target}
eae04238
DM
1787
1788@item
8981cac5 1789the input target (see ``@code{objcopy} and @code{strip} Input Target'' above)
eae04238
DM
1790
1791@item
1792environment variable @code{GNUTARGET}
1793
1794@item
1795deduced from the input file
1796@end enumerate
1797
8981cac5 1798@subheading @code{nm}, @code{size}, and @code{strings} Target
eae04238
DM
1799
1800Ways to specify:
1801
1802@enumerate
1803@item
8981cac5 1804command line option: @samp{--target}
eae04238
DM
1805
1806@item
1807environment variable @code{GNUTARGET}
1808
1809@item
1810deduced from the input file
1811@end enumerate
1812
8981cac5 1813@subheading Linker Input Target
eae04238
DM
1814
1815Ways to specify:
1816
1817@enumerate
1818@item
8981cac5 1819command line option: @samp{-b} or @samp{--format}
eae04238
DM
1820(@pxref{Options,,Options,ld.info,Using LD})
1821
1822@item
1823script command @code{TARGET}
1824(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1825
1826@item
1827environment variable @code{GNUTARGET}
1828(@pxref{Environment,,Environment,ld.info,Using LD})
1829
1830@item
1831the default target of the selected linker emulation
1832(@pxref{Linker Emulation Selection})
1833@end enumerate
1834
8981cac5 1835@subheading Linker Output Target
eae04238
DM
1836
1837Ways to specify:
1838
1839@enumerate
1840@item
8981cac5 1841command line option: @samp{-oformat}
eae04238
DM
1842(@pxref{Options,,Options,ld.info,Using LD})
1843
1844@item
1845script command @code{OUTPUT_FORMAT}
1846(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1847
1848@item
8981cac5 1849the linker input target (see ``Linker Input Target'' above)
eae04238
DM
1850@end enumerate
1851
1852@node Architecture Selection
1853@section Architecture selection
1854
8981cac5
JO
1855An @dfn{architecture} is a type of @sc{cpu} on which an object file is
1856to run. Its name may contain a colon, separating the name of the
1857processor family from the name of the particular @sc{cpu}.
eae04238 1858
8981cac5
JO
1859The command to list valid architecture values is @samp{objdump -i} (the
1860second column contains the relevant information).
eae04238
DM
1861
1862Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
1863
8981cac5 1864@subheading @code{objdump} Architecture
eae04238
DM
1865
1866Ways to specify:
1867
1868@enumerate
1869@item
8981cac5 1870command line option: @samp{-m} or @samp{--architecture}
eae04238
DM
1871
1872@item
1873deduced from the input file
1874@end enumerate
1875
8981cac5 1876@subheading @code{objcopy}, @code{nm}, @code{size}, @code{strings} Architecture
eae04238
DM
1877
1878Ways to specify:
1879
1880@enumerate
1881@item
1882deduced from the input file
1883@end enumerate
1884
8981cac5 1885@subheading Linker Input Architecture
eae04238
DM
1886
1887Ways to specify:
1888
1889@enumerate
1890@item
1891deduced from the input file
1892@end enumerate
1893
8981cac5 1894@subheading Linker Output Architecture
eae04238
DM
1895
1896Ways to specify:
1897
1898@enumerate
1899@item
1900script command @code{OUTPUT_ARCH}
1901(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1902
1903@item
1904the default architecture from the linker output target
8981cac5 1905(@pxref{Target Selection})
eae04238
DM
1906@end enumerate
1907
1908@node Linker Emulation Selection
1909@section Linker emulation selection
1910
1911A linker @dfn{emulation} is a ``personality'' of the linker, which gives
1912the linker default values for the other aspects of the target system.
1913In particular, it consists of
1914
1915@itemize @bullet
1916@item
8981cac5 1917the linker script
eae04238
DM
1918
1919@item
8981cac5 1920the target
eae04238
DM
1921
1922@item
1923several ``hook'' functions that are run at certain stages of the linking
8981cac5 1924process to do special things that some targets require
eae04238
DM
1925@end itemize
1926
8981cac5 1927The command to list valid linker emulation values is @samp{ld -V}.
eae04238
DM
1928
1929Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
1930
1931Ways to specify:
1932
1933@enumerate
1934@item
8981cac5 1935command line option: @samp{-m}
eae04238
DM
1936(@pxref{Options,,Options,ld.info,Using LD})
1937
1938@item
1939environment variable @code{LDEMULATION}
1940
1941@item
1942compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
1943which comes from @code{EMUL} in @file{config/@var{target}.mt}
1944@end enumerate
1945
1946@node Index
c72af735
RP
1947@unnumbered Index
1948
1949@printindex cp
1950
1951@contents
1952@bye
This page took 0.244142 seconds and 4 git commands to generate.