* parse.c (target_map_name_to_register): Check target specific
[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 8* Binutils: (binutils). The GNU binary utilities "ar", "objcopy",
76466873 9 "objdump", "nm", "nlmconv", "size", "readelf"
061ed861 10 "strings", "strip", "ranlib" and "dlltool".
9abcc3b8
RP
11END-INFO-DIR-ENTRY
12@end format
13@end ifinfo
c72af735 14
8b2c2275 15@ifinfo
eaa147a6 16Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 1998 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",
76466873 42@c "objdump", "nm", "size", "strings", "strip", "readelf" and "ranlib".
c72af735 43@c
eaa147a6 44@c Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 1998 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
eaa147a6 69Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 1998 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
76466873
NC
108@item readelf
109Display the contents of ELF format files.
110
c72af735 111@item size
eae04238 112List file section sizes and total size
c72af735 113
ba7c8e29
DM
114@item strings
115List printable strings from files
116
c72af735
RP
117@item strip
118Discard symbols
eae04238
DM
119
120@item c++filt
121Demangle encoded C++ symbols
122
fb38844d
ILT
123@item addr2line
124Convert addresses into file names and line numbers
125
eae04238
DM
126@item nlmconv
127Convert object code into a Netware Loadable Module
217947b2
ILT
128
129@item windres
130Manipulate Windows resources
061ed861
NC
131
132@item dlltool
133Create the files needed to build and use Dynamic Link Libraries
c72af735 134@end table
8b2c2275 135@end iftex
c72af735
RP
136
137@menu
8b2c2275 138* ar:: Create, modify, and extract from archives
8b2c2275 139* nm:: List symbols from object files
eed5eeab 140* objcopy:: Copy and translate object files
8b2c2275
RP
141* objdump:: Display information from object files
142* ranlib:: Generate index to archive contents
76466873 143* readelf:: Display the contents of ELF format files.
8b2c2275 144* size:: List section sizes and total size
ba7c8e29 145* strings:: List printable strings from files
8b2c2275 146* strip:: Discard symbols
b6216af2 147* c++filt:: Filter to demangle encoded C++ symbols
fb38844d 148* addr2line:: Convert addresses to file and line
94e9ad77 149* nlmconv:: Converts object code into an NLM
217947b2 150* windres:: Manipulate Windows resources
061ed861 151* dlltool:: Create files needed to build and use DLLs
eae04238 152* Selecting The Target System:: How these utilities determine the target.
cbcfa129
ILT
153* Reporting Bugs:: Reporting Bugs
154* Index:: Index
c72af735
RP
155@end menu
156
eae04238 157@node ar
c72af735
RP
158@chapter ar
159
160@kindex ar
161@cindex archives
162@cindex collections of files
163@smallexample
650a49f0 164ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}]
4d9b5d5a 165ar -M [ <mri-script ]
c72af735
RP
166@end smallexample
167
b94ff924 168The @sc{gnu} @code{ar} program creates, modifies, and extracts from
c72af735
RP
169archives. An @dfn{archive} is a single file holding a collection of
170other files in a structure that makes it possible to retrieve
171the original individual files (called @dfn{members} of the archive).
172
173The original files' contents, mode (permissions), timestamp, owner, and
ec40bbb8 174group are preserved in the archive, and can be restored on
c72af735
RP
175extraction.
176
177@cindex name length
b94ff924 178@sc{gnu} @code{ar} can maintain archives whose members have names of any
c72af735 179length; however, depending on how @code{ar} is configured on your
ec40bbb8
DM
180system, a limit on member-name length may be imposed for compatibility
181with archive formats maintained with other tools. If it exists, the
c72af735
RP
182limit is often 15 characters (typical of formats related to a.out) or 16
183characters (typical of formats related to coff).
184
185@cindex libraries
186@code{ar} is considered a binary utility because archives of this sort
187are most often used as @dfn{libraries} holding commonly needed
188subroutines.
189
190@cindex symbol index
e31e9a8d 191@code{ar} creates an index to the symbols defined in relocatable
c72af735
RP
192object modules in the archive when you specify the modifier @samp{s}.
193Once created, this index is updated in the archive whenever @code{ar}
194makes a change to its contents (save for the @samp{q} update operation).
195An archive with such an index speeds up linking to the library, and
196allows routines in the library to call each other without regard to
197their placement in the archive.
198
918c2f61 199You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
c72af735
RP
200table. If an archive lacks the table, another form of @code{ar} called
201@code{ranlib} can be used to add just the table.
202
765a273f
RP
203@cindex compatibility, @code{ar}
204@cindex @code{ar} compatibility
b94ff924 205@sc{gnu} @code{ar} is designed to be compatible with two different
765a273f
RP
206facilities. You can control its activity using command-line options,
207like the different varieties of @code{ar} on Unix systems; or, if you
208specify the single command-line option @samp{-M}, you can control it
209with a script supplied via standard input, like the MRI ``librarian''
210program.
211
212@menu
eae04238
DM
213* ar cmdline:: Controlling @code{ar} on the command line
214* ar scripts:: Controlling @code{ar} with a script
765a273f
RP
215@end menu
216
217@page
eae04238 218@node ar cmdline
765a273f
RP
219@section Controlling @code{ar} on the command line
220
221@smallexample
650a49f0 222ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}]
765a273f
RP
223@end smallexample
224
225@cindex Unix compatibility, @code{ar}
226When you use @code{ar} in the Unix style, @code{ar} insists on at least two
227arguments to execute: one keyletter specifying the @emph{operation}
228(optionally accompanied by other keyletters specifying
229@emph{modifiers}), and the archive name to act on.
c72af735 230
650a49f0 231Most operations can also accept further @var{member} arguments,
c72af735
RP
232specifying particular files to operate on.
233
b94ff924 234@sc{gnu} @code{ar} allows you to mix the operation code @var{p} and modifier
c72af735
RP
235flags @var{mod} in any order, within the first command-line argument.
236
237If you wish, you may begin the first command-line argument with a
238dash.
239
240@cindex operations on archive
241The @var{p} keyletter specifies what operation to execute; it may be
242any of the following, but you must specify only one of them:
243
244@table @code
245@item d
246@cindex deleting from archive
247@emph{Delete} modules from the archive. Specify the names of modules to
650a49f0 248be deleted as @var{member}@dots{}; the archive is untouched if you
c72af735
RP
249specify no files to delete.
250
e31e9a8d 251If you specify the @samp{v} modifier, @code{ar} lists each module
c72af735
RP
252as it is deleted.
253
254@item m
255@cindex moving in archive
256Use this operation to @emph{move} members in an archive.
257
258The ordering of members in an archive can make a difference in how
259programs are linked using the library, if a symbol is defined in more
260than one member.
261
262If no modifiers are used with @code{m}, any members you name in the
650a49f0 263@var{member} arguments are moved to the @emph{end} of the archive;
c72af735
RP
264you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
265specified place instead.
266
267@item p
268@cindex printing from archive
269@emph{Print} the specified members of the archive, to the standard
270output file. If the @samp{v} modifier is specified, show the member
271name before copying its contents to standard output.
272
650a49f0 273If you specify no @var{member} arguments, all the files in the archive are
ec40bbb8 274printed.
c72af735
RP
275
276@item q
277@cindex quick append to archive
7a2db4e5 278@emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
ec40bbb8 279@var{archive}, without checking for replacement.
c72af735
RP
280
281The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
282operation; new members are always placed at the end of the archive.
283
284The modifier @samp{v} makes @code{ar} list each file as it is appended.
285
286Since the point of this operation is speed, the archive's symbol table
287index is not updated, even if it already existed; you can use @samp{ar s} or
288@code{ranlib} explicitly to update the symbol table index.
289
27e0fef5
ILT
290However, too many different systems assume quick append rebuilds the
291index, so GNU ar implements @code{q} as a synonym for @code{r}.
7a2db4e5 292
c72af735
RP
293@item r
294@cindex replacement in archive
650a49f0 295Insert the files @var{member}@dots{} into @var{archive} (with
ec40bbb8
DM
296@emph{replacement}). This operation differs from @samp{q} in that any
297previously existing members are deleted if their names match those being
298added.
c72af735 299
650a49f0 300If one of the files named in @var{member}@dots{} does not exist, @code{ar}
c72af735
RP
301displays an error message, and leaves undisturbed any existing members
302of the archive matching that name.
303
304By default, new members are added at the end of the file; but you may
305use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
306placement relative to some existing member.
307
308The modifier @samp{v} used with this operation elicits a line of
309output for each file inserted, along with one of the letters @samp{a} or
310@samp{r} to indicate whether the file was appended (no old member
311deleted) or replaced.
312
313@item t
314@cindex contents of archive
315Display a @emph{table} listing the contents of @var{archive}, or those
650a49f0 316of the files listed in @var{member}@dots{} that are present in the
c72af735
RP
317archive. Normally only the member name is shown; if you also want to
318see the modes (permissions), timestamp, owner, group, and size, you can
319request that by also specifying the @samp{v} modifier.
320
650a49f0 321If you do not specify a @var{member}, all files in the archive
c72af735
RP
322are listed.
323
324@cindex repeated names in archive
325@cindex name duplication in archive
326If there is more than one file with the same name (say, @samp{fie}) in
e31e9a8d 327an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
c72af735
RP
328first instance; to see them all, you must ask for a complete
329listing---in our example, @samp{ar t b.a}.
330@c WRS only; per Gumby, this is implementation-dependent, and in a more
331@c recent case in fact works the other way.
332
333@item x
334@cindex extract from archive
650a49f0 335@emph{Extract} members (named @var{member}) from the archive. You can
c72af735
RP
336use the @samp{v} modifier with this operation, to request that
337@code{ar} list each name as it extracts it.
338
650a49f0 339If you do not specify a @var{member}, all files in the archive
c72af735
RP
340are extracted.
341
342@end table
343
344A number of modifiers (@var{mod}) may immediately follow the @var{p}
345keyletter, to specify variations on an operation's behavior:
346
347@table @code
348@item a
349@cindex relative placement in archive
350Add new files @emph{after} an existing member of the
ec40bbb8 351archive. If you use the modifier @samp{a}, the name of an existing archive
650a49f0 352member must be present as the @var{relpos} argument, before the
c72af735
RP
353@var{archive} specification.
354
355@item b
356Add new files @emph{before} an existing member of the
ec40bbb8 357archive. If you use the modifier @samp{b}, 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{i}).
360
361@item c
362@cindex creating archives
363@emph{Create} the archive. The specified @var{archive} is always
650a49f0 364created if it did not exist, when you request an update. But a warning is
c72af735
RP
365issued unless you specify in advance that you expect to create it, by
366using this modifier.
367
52af6a44 368@item f
b94ff924 369Truncate names in the archive. @sc{gnu} @code{ar} will normally permit file
52af6a44
ILT
370names of any length. This will cause it to create archives which are
371not compatible with the native @code{ar} program on some systems. If
372this is a concern, the @samp{f} modifier may be used to truncate file
373names when putting them in the archive.
374
c72af735
RP
375@item i
376Insert new files @emph{before} an existing member of the
ec40bbb8 377archive. If you use the modifier @samp{i}, the name of an existing archive
650a49f0 378member must be present as the @var{relpos} argument, before the
c72af735
RP
379@var{archive} specification. (same as @samp{b}).
380
381@item l
382This modifier is accepted but not used.
383@c whaffor ar l modifier??? presumably compat; with
b94ff924 384@c what???---doc@@cygnus.com, 25jan91
c72af735
RP
385
386@item o
387@cindex dates in archive
388Preserve the @emph{original} dates of members when extracting them. If
389you do not specify this modifier, files extracted from the archive
e31e9a8d 390are stamped with the time of extraction.
c72af735
RP
391
392@item s
393@cindex writing archive index
394Write an object-file index into the archive, or update an existing one,
395even if no other change is made to the archive. You may use this modifier
396flag either with any operation, or alone. Running @samp{ar s} on an
397archive is equivalent to running @samp{ranlib} on it.
398
27e0fef5
ILT
399@item S
400@cindex not writing archive index
401Do not generate an archive symbol table. This can speed up building a
402large library in several steps. The resulting archive can not be used
403with the linker. In order to build a symbol table, you must omit the
404@samp{S} modifier on the last execution of @samp{ar}, or you must run
405@samp{ranlib} on the archive.
406
c72af735
RP
407@item u
408@cindex updating an archive
b703c078 409Normally, @samp{ar r}@dots{} inserts all files
c72af735
RP
410listed into the archive. If you would like to insert @emph{only} those
411of the files you list that are newer than existing members of the same
412names, use this modifier. The @samp{u} modifier is allowed only for the
413operation @samp{r} (replace). In particular, the combination @samp{qu} is
414not allowed, since checking the timestamps would lose any speed
415advantage from the operation @samp{q}.
416
417@item v
418This modifier requests the @emph{verbose} version of an operation. Many
419operations display additional information, such as filenames processed,
420when the modifier @samp{v} is appended.
4d9b5d5a
DM
421
422@item V
423This modifier shows the version number of @code{ar}.
765a273f
RP
424@end table
425
eae04238 426@node ar scripts
765a273f
RP
427@section Controlling @code{ar} with a script
428
429@smallexample
430ar -M [ <@var{script} ]
431@end smallexample
432
433@cindex MRI compatibility, @code{ar}
434@cindex scripts, @code{ar}
435If you use the single command-line option @samp{-M} with @code{ar}, you
436can control its operation with a rudimentary command language. This
e31e9a8d 437form of @code{ar} operates interactively if standard input is coming
765a273f
RP
438directly from a terminal. During interactive use, @code{ar} prompts for
439input (the prompt is @samp{AR >}), and continues executing even after
440errors. If you redirect standard input to a script file, no prompts are
e31e9a8d 441issued, and @code{ar} abandons execution (with a nonzero exit code)
765a273f
RP
442on any error.
443
444The @code{ar} command language is @emph{not} designed to be equivalent
445to the command-line options; in fact, it provides somewhat less control
446over archives. The only purpose of the command language is to ease the
b94ff924 447transition to @sc{gnu} @code{ar} for developers who already have scripts
765a273f
RP
448written for the MRI ``librarian'' program.
449
450The syntax for the @code{ar} command language is straightforward:
451@itemize @bullet
452@item
453commands are recognized in upper or lower case; for example, @code{LIST}
454is the same as @code{list}. In the following descriptions, commands are
455shown in upper case for clarity.
456
457@item
458a single command may appear on each line; it is the first word on the
459line.
460
461@item
462empty lines are allowed, and have no effect.
463
464@item
465comments are allowed; text after either of the characters @samp{*}
466or @samp{;} is ignored.
467
468@item
469Whenever you use a list of names as part of the argument to an @code{ar}
470command, you can separate the individual names with either commas or
471blanks. Commas are shown in the explanations below, for clarity.
472
473@item
474@samp{+} is used as a line continuation character; if @samp{+} appears
475at the end of a line, the text on the following line is considered part
476of the current command.
477@end itemize
478
479Here are the commands you can use in @code{ar} scripts, or when using
480@code{ar} interactively. Three of them have special significance:
481
482@code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
483a temporary file required for most of the other commands.
484
485@code{SAVE} commits the changes so far specified by the script. Prior
486to @code{SAVE}, commands affect only the temporary copy of the current
487archive.
488
489@table @code
490@item ADDLIB @var{archive}
491@itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
492Add all the contents of @var{archive} (or, if specified, each named
493@var{module} from @var{archive}) to the current archive.
494
495Requires prior use of @code{OPEN} or @code{CREATE}.
496
650a49f0 497@item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
765a273f
RP
498@c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
499@c else like "ar q..."
650a49f0 500Add each named @var{member} as a module in the current archive.
765a273f
RP
501
502Requires prior use of @code{OPEN} or @code{CREATE}.
503
504@item CLEAR
061ed861 505Discard the contents of the current archive, canceling the effect of
765a273f
RP
506any operations since the last @code{SAVE}. May be executed (with no
507effect) even if no current archive is specified.
508
509@item CREATE @var{archive}
510Creates an archive, and makes it the current archive (required for many
511other commands). The new archive is created with a temporary name; it
512is not actually saved as @var{archive} until you use @code{SAVE}.
513You can overwrite existing archives; similarly, the contents of any
514existing file named @var{archive} will not be destroyed until @code{SAVE}.
515
516@item DELETE @var{module}, @var{module}, @dots{} @var{module}
517Delete each listed @var{module} from the current archive; equivalent to
518@samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
519
520Requires prior use of @code{OPEN} or @code{CREATE}.
521
522@item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
523@itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
524List each named @var{module} present in @var{archive}. The separate
525command @code{VERBOSE} specifies the form of the output: when verbose
526output is off, output is like that of @samp{ar -t @var{archive}
b703c078
DM
527@var{module}@dots{}}. When verbose output is on, the listing is like
528@samp{ar -tv @var{archive} @var{module}@dots{}}.
765a273f
RP
529
530Output normally goes to the standard output stream; however, if you
531specify @var{outputfile} as a final argument, @code{ar} directs the
532output to that file.
533
534@item END
535Exit from @code{ar}, with a @code{0} exit code to indicate successful
536completion. This command does not save the output file; if you have
537changed the current archive since the last @code{SAVE} command, those
538changes are lost.
539
540@item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
541Extract each named @var{module} from the current archive, writing them
542into the current directory as separate files. Equivalent to @samp{ar -x
b703c078 543@var{archive} @var{module}@dots{}}.
765a273f
RP
544
545Requires prior use of @code{OPEN} or @code{CREATE}.
546
547@ignore
548@c FIXME Tokens but no commands???
549@item FULLDIR
550
551@item HELP
552@end ignore
553
554@item LIST
555Display full contents of the current archive, in ``verbose'' style
556regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
b94ff924 557tv @var{archive}}). (This single command is a @sc{gnu} @code{ld}
765a273f
RP
558enhancement, rather than present for MRI compatibility.)
559
560Requires prior use of @code{OPEN} or @code{CREATE}.
561
562@item OPEN @var{archive}
563Opens an existing archive for use as the current archive (required for
564many other commands). Any changes as the result of subsequent commands
565will not actually affect @var{archive} until you next use @code{SAVE}.
566
567@item REPLACE @var{module}, @var{module}, @dots{} @var{module}
568In the current archive, replace each existing @var{module} (named in
569the @code{REPLACE} arguments) from files in the current working directory.
570To execute this command without errors, both the file, and the module in
571the current archive, must exist.
572
573Requires prior use of @code{OPEN} or @code{CREATE}.
574
575@item VERBOSE
576Toggle an internal flag governing the output from @code{DIRECTORY}.
577When the flag is on, @code{DIRECTORY} output matches output from
b703c078 578@samp{ar -tv }@dots{}.
765a273f
RP
579
580@item SAVE
581Commit your changes to the current archive, and actually save it as a
582file with the name specified in the last @code{CREATE} or @code{OPEN}
583command.
584
585Requires prior use of @code{OPEN} or @code{CREATE}.
c72af735
RP
586
587@end table
588
8b2c2275
RP
589@iftex
590@node ld
c72af735
RP
591@chapter ld
592@cindex linker
593@kindex ld
b94ff924
VM
594The @sc{gnu} linker @code{ld} is now described in a separate manual.
595@xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
8b2c2275 596@end iftex
c72af735 597
eae04238 598@node nm
c72af735
RP
599@chapter nm
600@cindex symbols
601@kindex nm
602
603@smallexample
d6a4c375 604nm [ -a | --debug-syms ] [ -g | --extern-only ]
de3b08ac 605 [ -B ] [ -C | --demangle ] [ -D | --dynamic ]
1896790e 606 [ -s | --print-armap ] [ -A | -o | --print-file-name ]
6cfbdb50 607 [ -n | -v | --numeric-sort ] [ -p | --no-sort ]
1896790e 608 [ -r | --reverse-sort ] [ --size-sort ] [ -u | --undefined-only ]
6cfbdb50
DM
609 [ -t @var{radix} | --radix=@var{radix} ] [ -P | --portability ]
610 [ --target=@var{bfdname} ] [ -f @var{format} | --format=@var{format} ]
77dd4469 611 [ --defined-only ] [-l | --line-numbers ]
9eb39bca 612 [ --no-demangle ] [ -V | --version ] [ --help ] [ @var{objfile}@dots{} ]
c72af735
RP
613@end smallexample
614
b94ff924 615@sc{gnu} @code{nm} lists the symbols from object files @var{objfile}@dots{}.
6cfbdb50
DM
616If no object files are listed as arguments, @code{nm} assumes
617@file{a.out}.
618
619For each symbol, @code{nm} shows:
620
621@itemize @bullet
622@item
623The symbol value, in the radix selected by options (see below), or
624hexadecimal by default.
625
626@item
627The symbol type. At least the following types are used; others are, as
628well, depending on the object file format. If lowercase, the symbol is
629local; if uppercase, the symbol is global (external).
630
631@c Some more detail on exactly what these symbol types are used for
632@c would be nice.
633@table @code
634@item A
85d4b870
ILT
635The symbol's value is absolute, and will not be changed by further
636linking.
6cfbdb50
DM
637
638@item B
85d4b870 639The symbol is in the uninitialized data section (known as BSS).
6cfbdb50
DM
640
641@item C
85d4b870
ILT
642The symbol is common. Common symbols are uninitialized data. When
643linking, multiple common symbols may appear with the same name. If the
644symbol is defined anywhere, the common symbols are treated as undefined
645references. For more details on common symbols, see the discussion of
646--warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
6cfbdb50
DM
647
648@item D
85d4b870
ILT
649The symbol is in the initialized data section.
650
651@item G
392e2505 652The symbol is in an initialized data section for small objects. Some
85d4b870
ILT
653object file formats permit more efficient access to small data objects,
654such as a global int variable as opposed to a large global array.
6cfbdb50
DM
655
656@item I
85d4b870
ILT
657The symbol is an indirect reference to another symbol. This is a GNU
658extension to the a.out object file format which is rarely used.
659
660@item N
661The symbol is a debugging symbol.
662
663@item R
664The symbol is in a read only data section.
665
666@item S
392e2505 667The symbol is in an uninitialized data section for small objects.
6cfbdb50
DM
668
669@item T
85d4b870 670The symbol is in the text (code) section.
6cfbdb50
DM
671
672@item U
85d4b870
ILT
673The symbol is undefined.
674
675@item W
676The symbol is weak. When a weak defined symbol is linked with a normal
677defined symbol, the normal defined symbol is used with no error. When a
678weak undefined symbol is linked and the symbol is not defined, the value
679of the weak symbol becomes zero with no error.
680
681@item -
682The symbol is a stabs symbol in an a.out object file. In this case, the
683next values printed are the stabs other field, the stabs desc field, and
684the stab type. Stabs symbols are used to hold debugging information;
685for more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
686``stabs'' debug format}.
687
688@item ?
689The symbol type is unknown, or object file format specific.
6cfbdb50
DM
690@end table
691
692@item
693The symbol name.
694@end itemize
c72af735
RP
695
696The long and short forms of options, shown here as alternatives, are
697equivalent.
698
699@table @code
6cfbdb50
DM
700@item -A
701@itemx -o
702@itemx --print-file-name
703@cindex input file name
704@cindex file name
705@cindex source file name
706Precede each symbol by the name of the input file (or archive element)
707in which it was found, rather than identifying the input file once only,
708before all of its symbols.
c72af735
RP
709
710@item -a
918c2f61 711@itemx --debug-syms
c72af735 712@cindex debugging symbols
6cfbdb50
DM
713Display all symbols, even debugger-only symbols; normally these are not
714listed.
715
68dd5295
DM
716@item -B
717@cindex @code{nm} format
718@cindex @code{nm} compatibility
d6a4c375
DM
719The same as @samp{--format=bsd} (for compatibility with the MIPS @code{nm}).
720
721@item -C
722@itemx --demangle
9793039f 723@cindex demangling in nm
d6a4c375
DM
724Decode (@dfn{demangle}) low-level symbol names into user-level names.
725Besides removing any initial underscore prepended by the system, this
726makes C++ function names readable. @xref{c++filt}, for more information
727on demangling.
68dd5295 728
9eb39bca
ILT
729@item --no-demangle
730Do not demangle low-level symbol names. This is the default.
731
de3b08ac
ILT
732@item -D
733@itemx --dynamic
734@cindex dynamic symbols
735Display the dynamic symbols rather than the normal symbols. This is
736only meaningful for dynamic objects, such as certain types of shared
737libraries.
738
6cfbdb50
DM
739@item -f @var{format}
740@itemx --format=@var{format}
68dd5295
DM
741@cindex @code{nm} format
742@cindex @code{nm} compatibility
6cfbdb50
DM
743Use the output format @var{format}, which can be @code{bsd},
744@code{sysv}, or @code{posix}. The default is @code{bsd}.
b26ac613 745Only the first character of @var{format} is significant; it can be
6cfbdb50 746either upper or lower case.
c72af735
RP
747
748@item -g
918c2f61 749@itemx --extern-only
c72af735
RP
750@cindex external symbols
751Display only external symbols.
752
77dd4469
ILT
753@item -l
754@itemx --line-numbers
755@cindex symbol line numbers
756For each symbol, use debugging information to try to find a filename and
757line number. For a defined symbol, look for the line number of the
758address of the symbol. For an undefined symbol, look for the line
759number of a relocation entry which refers to the symbol. If line number
760information can be found, print it after the other symbol information.
761
b26ac613
DM
762@item -n
763@itemx -v
764@itemx --numeric-sort
765Sort symbols numerically by their addresses, rather than alphabetically
766by their names.
767
c72af735 768@item -p
918c2f61 769@itemx --no-sort
c72af735 770@cindex sorting symbols
650a49f0 771Do not bother to sort the symbols in any order; print them in the order
6cfbdb50
DM
772encountered.
773
774@item -P
775@itemx --portability
776Use the POSIX.2 standard output format instead of the default format.
777Equivalent to @samp{-f posix}.
c72af735 778
c72af735 779@item -s
918c2f61 780@itemx --print-armap
c72af735
RP
781@cindex symbol index, listing
782When listing symbols from archive members, include the index: a mapping
ec40bbb8
DM
783(stored in the archive by @code{ar} or @code{ranlib}) of which modules
784contain definitions for which names.
c72af735 785
c72af735 786@item -r
918c2f61 787@itemx --reverse-sort
ec40bbb8 788Reverse the order of the sort (whether numeric or alphabetic); let the
c72af735
RP
789last come first.
790
1896790e
ILT
791@item --size-sort
792Sort symbols by size. The size is computed as the difference between
793the value of the symbol and the value of the symbol with the next higher
794value. The size of the symbol is printed, rather than the value.
795
6cfbdb50
DM
796@item -t @var{radix}
797@itemx --radix=@var{radix}
798Use @var{radix} as the radix for printing the symbol values. It must be
799@samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
800
ec40bbb8 801@item --target=@var{bfdname}
c72af735
RP
802@cindex object code format
803Specify an object code format other than your system's default format.
eae04238 804@xref{Target Selection}, for more information.
c72af735
RP
805
806@item -u
918c2f61 807@itemx --undefined-only
c72af735
RP
808@cindex external symbols
809@cindex undefined symbols
810Display only undefined symbols (those external to each object file).
811
dcd6706b
JL
812@item --defined-only
813@cindex external symbols
814@cindex undefined symbols
815Display only defined symbols for each object file.
816
6cfbdb50
DM
817@item -V
818@itemx --version
b26ac613
DM
819Show the version number of @code{nm} and exit.
820
821@item --help
822Show a summary of the options to @code{nm} and exit.
c72af735
RP
823@end table
824
eae04238 825@node objcopy
eed5eeab
DM
826@chapter objcopy
827
828@smallexample
eae04238
DM
829objcopy [ -F @var{bfdname} | --target=@var{bfdname} ]
830 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
831 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
eed5eeab 832 [ -S | --strip-all ] [ -g | --strip-debug ]
dff604a7 833 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
29c0d15c 834 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
246b7c9b 835 [ -L @var{symbolname} | --localize-symbol=@var{symbolname} ]
8d2e72a1 836 [ -W @var{symbolname} | --weaken-symbol=@var{symbolname} ]
eed5eeab 837 [ -x | --discard-all ] [ -X | --discard-locals ]
f7b839f7
DM
838 [ -b @var{byte} | --byte=@var{byte} ]
839 [ -i @var{interleave} | --interleave=@var{interleave} ]
0aca460e 840 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
2483354d 841 [ -p | --preserve-dates ] [ --debugging ]
33e0a06d
ILT
842 [ --gap-fill=@var{val} ] [ --pad-to=@var{address} ]
843 [ --set-start=@var{val} ] [ --adjust-start=@var{incr} ]
537b2e5e
NC
844 [ --change-addresses=@var{incr} ]
845 [ --change-section-address=@var{section}@{=,+,-@}@var{val} ]
846 [ --change-section-lma=@var{section}@{=,+,-@}@var{val} ]
847 [ --change-section-vma=@var{section}@{=,+,-@}@var{val} ]
848 [ --change-warnings ] [ --no-change-warnings ]
5ab41086 849 [ --set-section-flags=@var{section}=@var{flags} ]
d0130cc8 850 [ --add-section=@var{sectionname}=@var{filename} ]
decf2865 851 [ --change-leading-char ] [ --remove-leading-char ]
9a442fe8 852 [ --weaken ]
f7b839f7 853 [ -v | --verbose ] [ -V | --version ] [ --help ]
eed5eeab
DM
854 @var{infile} [@var{outfile}]
855@end smallexample
856
8981cac5
JO
857The @sc{gnu} @code{objcopy} utility copies the contents of an object
858file to another. @code{objcopy} uses the @sc{gnu} @sc{bfd} Library to
859read and write the object files. It can write the destination object
860file in a format different from that of the source object file. The
861exact behavior of @code{objcopy} is controlled by command-line options.
eed5eeab
DM
862
863@code{objcopy} creates temporary files to do its translations and
8981cac5
JO
864deletes them afterward. @code{objcopy} uses @sc{bfd} to do all its
865translation work; it has access to all the formats described in @sc{bfd}
866and thus is able to recognize most formats without being told
867explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
eed5eeab 868
67f67ed9
ILT
869@code{objcopy} can be used to generate S-records by using an output
870target of @samp{srec} (e.g., use @samp{-O srec}).
871
872@code{objcopy} can be used to generate a raw binary file by using an
873output target of @samp{binary} (e.g., use @samp{-O binary}). When
874@code{objcopy} generates a raw binary file, it will essentially produce
875a memory dump of the contents of the input object file. All symbols and
a6afc090 876relocation information will be discarded. The memory dump will start at
11de29d0 877the load address of the lowest section copied into the output file.
67f67ed9
ILT
878
879When generating an S-record or a raw binary file, it may be helpful to
880use @samp{-S} to remove sections containing debugging information. In
881some cases @samp{-R} will be useful to remove sections which contain
882information which is not needed by the binary file.
883
eed5eeab
DM
884@table @code
885@item @var{infile}
886@itemx @var{outfile}
8981cac5 887The source and output files, respectively.
eed5eeab
DM
888If you do not specify @var{outfile}, @code{objcopy} creates a
889temporary file and destructively renames the result with
8981cac5 890the name of @var{infile}.
eed5eeab 891
eae04238
DM
892@item -I @var{bfdname}
893@itemx --input-target=@var{bfdname}
894Consider the source file's object format to be @var{bfdname}, rather than
895attempting to deduce it. @xref{Target Selection}, for more information.
eed5eeab 896
eae04238
DM
897@item -O @var{bfdname}
898@itemx --output-target=@var{bfdname}
899Write the output file using the object format @var{bfdname}.
900@xref{Target Selection}, for more information.
eed5eeab 901
eae04238
DM
902@item -F @var{bfdname}
903@itemx --target=@var{bfdname}
904Use @var{bfdname} as the object format for both the input and the output
905file; i.e., simply transfer data from source to destination with no
906translation. @xref{Target Selection}, for more information.
eed5eeab 907
0aca460e
ILT
908@item -R @var{sectionname}
909@itemx --remove-section=@var{sectionname}
910Remove any section named @var{sectionname} from the output file. This
911option may be given more than once. Note that using this option
912inappropriately may make the output file unusable.
913
eed5eeab
DM
914@item -S
915@itemx --strip-all
916Do not copy relocation and symbol information from the source file.
917
918@item -g
919@itemx --strip-debug
920Do not copy debugging symbols from the source file.
921
9135e5f8
ILT
922@item --strip-unneeded
923Strip all symbols that are not needed for relocation processing.
924
dff604a7
ILT
925@item -K @var{symbolname}
926@itemx --keep-symbol=@var{symbolname}
927Copy only symbol @var{symbolname} from the source file. This option may
928be given more than once.
929
29c0d15c
ILT
930@item -N @var{symbolname}
931@itemx --strip-symbol=@var{symbolname}
dff604a7 932Do not copy symbol @var{symbolname} from the source file. This option
8d2e72a1
RH
933may be given more than once.
934
246b7c9b
RH
935@item -L @var{symbolname}
936@itemx --localize-symbol=@var{symbolname}
8d2e72a1
RH
937Make symbol @var{symbolname} local to the file, so that it is not
938visible externally. This option may be given more than once.
939
940@item -W @var{symbolname}
941@itemx --weaken-symbol=@var{symbolname}
942Make symbol @var{symbolname} weak. This option may be given more than once.
29c0d15c 943
eed5eeab
DM
944@item -x
945@itemx --discard-all
946Do not copy non-global symbols from the source file.
947@c FIXME any reason to prefer "non-global" to "local" here?
948
949@item -X
950@itemx --discard-locals
951Do not copy compiler-generated local symbols.
952(These usually start with @samp{L} or @samp{.}.)
953
db2e6adb
DM
954@item -b @var{byte}
955@itemx --byte=@var{byte}
956Keep only every @var{byte}th byte of the input file (header data is not
f7b839f7
DM
957affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
958where @var{interleave} is given by the @samp{-i} or @samp{--interleave}
959option, or the default of 4. This option is useful for creating files
8981cac5 960to program @sc{rom}. It is typically used with an @code{srec} output
f7b839f7
DM
961target.
962
963@item -i @var{interleave}
964@itemx --interleave=@var{interleave}
8981cac5
JO
965Only copy one out of every @var{interleave} bytes. Select which byte to
966copy with the @var{-b} or @samp{--byte} option. The default is 4.
967@code{objcopy} ignores this option if you do not specify either @samp{-b} or
968@samp{--byte}.
db2e6adb 969
2483354d
ILT
970@item -p
971@itemx --preserve-dates
972Set the access and modification dates of the output file to be the same
973as those of the input file.
974
f5818d79
ILT
975@item --debugging
976Convert debugging information, if possible. This is not the default
977because only certain debugging formats are supported, and the
978conversion process can be time consuming.
979
596d99ba 980@item --gap-fill @var{val}
a3a4bb5d
RH
981Fill gaps between sections with @var{val}. This operation applies to
982the @emph{load address} (LMA) of the sections. It is done by increasing
596d99ba
ILT
983the size of the section with the lower address, and filling in the extra
984space created with @var{val}.
985
33e0a06d 986@item --pad-to @var{address}
a3a4bb5d 987Pad the output file up to the load address @var{address}. This is
33e0a06d
ILT
988done by increasing the size of the last section. The extra space is
989filled in with the value specified by @samp{--gap-fill} (default zero).
990
6c7ed084
ILT
991@item --set-start @var{val}
992Set the address of the new file to @var{val}. Not all object file
a6afc090 993formats support setting the start address.
6c7ed084 994
537b2e5e
NC
995@item --change-start @var{incr}
996@itemx --adjust-start @var{incr}
997@cindex changing start address
998Change the start address by adding @var{incr}. Not all object file
6c7ed084
ILT
999formats support setting the start address.
1000
537b2e5e
NC
1001@item --change-addresses @var{incr}
1002@itemx --adjust-vma @var{incr}
1003@cindex changing object addresses
1004Change the VMA and LMA addresses of all sections, as well as the start
1005address, by adding @var{incr}. Some object file formats do not permit
1006section addresses to be changed arbitrarily. Note that this does not
1007relocate the sections; if the program expects sections to be loaded at a
1008certain address, and this option is used to change the sections such
1009that they are loaded at a different address, the program may fail.
1010
1011@item --change-section-address @var{section}@{=,+,-@}@var{val}
1012@itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1013@cindex changing section address
1014Set or change both the VMA address and the LMA address of the named
1015@var{section}. If @samp{=} is used, the section address is set to
1016@var{val}. Otherwise, @var{val} is added to or subtracted from the
1017section address. See the comments under @samp{--change-addresses},
1018above. If @var{section} does not exist in the input file, a warning will
1019be issued, unless @samp{--no-change-warnings} is used.
1020
1021@item --change-section-lma @var{section}@{=,+,-@}@var{val}
1022@cindex changing section LMA
1023Set or change the LMA address of the named @var{section}. The LMA
1024address is the address where the section will be loaded into memory at
1025program load time. Normally this is the same as the VMA address, which
1026is the address of the section at program run time, but on some systems,
1027especially those where a program is held in ROM, the two can be
1028different. If @samp{=} is used, the section address is set to
1029@var{val}. Otherwise, @var{val} is added to or subtracted from the
1030section address. See the comments under @samp{--change-addresses},
1031above. If @var{section} does not exist in the input file, a warning
1032will be issued, unless @samp{--no-change-warnings} is used.
1033
1034@item --change-section-vma @var{section}@{=,+,-@}@var{val}
1035@cindex changing section VMA
1036Set or change the VMA address of the named @var{section}. The VMA
1037address is the address where the section will be located once the
1038program has started executing. Normally this is the same as the LMA
1039address, which is the address where the section will be loaded into
1040memory, but on some systems, especially those where a program is held in
1041ROM, the two can be different. If @samp{=} is used, the section address
1042is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1043from the section address. See the comments under
1044@samp{--change-addresses}, above. If @var{section} does not exist in
1045the input file, a warning will be issued, unless
1046@samp{--no-change-warnings} is used.
1047
1048@item --change-warnings
1049@itemx --adjust-warnings
1050If @samp{--change-section-address} or @samp{--change-section-lma} or
1051@samp{--change-section-vma} is used, and the named section does not
1052exist, issue a warning. This is the default.
1053
1054@item --no-change-warnings
1055@itemx --no-adjust-warnings
1056Do not issue a warning if @samp{--change-section-address} or
1057@samp{--adjust-section-lma} or @samp{--adjust-section-vma} is used, even
1058if the named section does not exist.
6c7ed084 1059
5ab41086
ILT
1060@item --set-section-flags @var{section}=@var{flags}
1061Set the flags for the named section. The @var{flags} argument is a
1062comma separated string of flag names. The recognized names are
ee1f0bd1
ILT
1063@samp{alloc}, @samp{contents}, @samp{load}, @samp{readonly},
1064@samp{code}, @samp{data}, and @samp{rom}. You can set the
1065@samp{contents} flag for a section which does not have contents, but it
1066is not meaningful to clear the @samp{contents} flag of a section which
1067does have contents--just remove the section instead. Not all flags are
1068meaningful for all object file formats.
5ab41086 1069
d0130cc8
ILT
1070@item --add-section @var{sectionname}=@var{filename}
1071Add a new section named @var{sectionname} while copying the file. The
1072contents of the new section are taken from the file @var{filename}. The
1073size of the section will be the size of the file. This option only
1074works on file formats which can support sections with arbitrary names.
1075
decf2865
ILT
1076@item --change-leading-char
1077Some object file formats use special characters at the start of
1078symbols. The most common such character is underscore, which compilers
1079often add before every symbol. This option tells @code{objcopy} to
1080change the leading character of every symbol when it converts between
1081object file formats. If the object file formats use the same leading
1082character, this option has no effect. Otherwise, it will add a
1083character, or remove a character, or change a character, as
1084appropriate.
1085
5da470b2
ILT
1086@item --remove-leading-char
1087If the first character of a global symbol is a special symbol leading
1088character used by the object file format, remove the character. The
1089most common symbol leading character is underscore. This option will
1090remove a leading underscore from all global symbols. This can be useful
1091if you want to link together objects of different file formats with
decf2865
ILT
1092different conventions for symbol names. This is different from
1093@code{--change-leading-char} because it always changes the symbol name
1094when appropriate, regardless of the object file format of the output
1095file.
5da470b2 1096
9a442fe8
ILT
1097@item --weaken
1098Change all global symbols in the file to be weak. This can be useful
1099when building an object which will be linked against other objects using
1100the @code{-R} option to the linker. This option is only effective when
1101using an object file format which supports weak symbols.
1102
eed5eeab
DM
1103@item -V
1104@itemx --version
1105Show the version number of @code{objcopy}.
1106
1107@item -v
1108@itemx --verbose
1109Verbose output: list all object files modified. In the case of
1110archives, @samp{objcopy -V} lists all members of the archive.
1111
1112@item --help
1113Show a summary of the options to @code{objcopy}.
1114@end table
1115
eae04238 1116@node objdump
c72af735
RP
1117@chapter objdump
1118
1119@cindex object file information
1120@kindex objdump
1121
1122@smallexample
10f2a7f6 1123objdump [ -a | --archive-headers ]
e1c14599 1124 [ -b @var{bfdname} | --target=@var{bfdname} ] [ --debugging ]
9793039f
ILT
1125 [ -C | --demangle ] [ -d | --disassemble ]
1126 [ -D | --disassemble-all ] [ --disassemble-zeroes ]
67c8c901 1127 [ -EB | -EL | --endian=@{big | little @} ]
d5464baa 1128 [ -f | --file-headers ]
eae04238 1129 [ -h | --section-headers | --headers ] [ -i | --info ]
10f2a7f6 1130 [ -j @var{section} | --section=@var{section} ]
a8e27cc6 1131 [ -l | --line-numbers ] [ -S | --source ]
7e5e9619 1132 [ -m @var{machine} | --architecture=@var{machine} ]
14482680 1133 [ -p | --private-headers ]
7e5e9619
JO
1134 [ -r | --reloc ] [ -R | --dynamic-reloc ]
1135 [ -s | --full-contents ] [ --stabs ]
de3b08ac 1136 [ -t | --syms ] [ -T | --dynamic-syms ] [ -x | --all-headers ]
aa21a2a9 1137 [ -w | --wide ] [ --start-address=@var{address} ]
4cb99ff2 1138 [ --stop-address=@var{address} ]
5c59269f 1139 [ --prefix-addresses] [ --[no-]show-raw-insn ]
ab3a59cf 1140 [ --adjust-vma=@var{offset} ]
458bbd1f 1141 [ --version ] [ --help ]
aa21a2a9 1142 @var{objfile}@dots{}
c72af735
RP
1143@end smallexample
1144
1145@code{objdump} displays information about one or more object files.
1146The options control what particular information to display. This
1147information is mostly useful to programmers who are working on the
1148compilation tools, as opposed to programmers who just want their
1149program to compile and work.
1150
b26ac613
DM
1151@var{objfile}@dots{} are the object files to be examined. When you
1152specify archives, @code{objdump} shows information on each of the member
1153object files.
1154
c72af735 1155The long and short forms of options, shown here as alternatives, are
ed78872a 1156equivalent. At least one option besides @samp{-l} must be given.
c72af735
RP
1157
1158@table @code
c72af735 1159@item -a
eae04238 1160@itemx --archive-header
c72af735 1161@cindex archive headers
ec40bbb8 1162If any of the @var{objfile} files are archives, display the archive
c72af735
RP
1163header information (in a format similar to @samp{ls -l}). Besides the
1164information you could list with @samp{ar tv}, @samp{objdump -a} shows
1165the object file format of each archive member.
1166
ab3a59cf
ILT
1167@item --adjust-vma=@var{offset}
1168@cindex section addresses in objdump
1169@cindex VMA in objdump
1170When dumping information, first add @var{offset} to all the section
1171addresses. This is useful if the section addresses do not correspond to
1172the symbol table, which can happen when putting sections at particular
1173addresses when using a format which can not represent section addresses,
1174such as a.out.
1175
c72af735 1176@item -b @var{bfdname}
eae04238 1177@itemx --target=@var{bfdname}
c72af735 1178@cindex object code format
ec40bbb8
DM
1179Specify that the object-code format for the object files is
1180@var{bfdname}. This option may not be necessary; @var{objdump} can
1181automatically recognize many formats.
1182
1183For example,
c72af735
RP
1184@example
1185objdump -b oasys -m vax -h fu.o
1186@end example
1187@noindent
ec40bbb8
DM
1188displays summary information from the section headers (@samp{-h}) of
1189@file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object
c72af735
RP
1190file in the format produced by Oasys compilers. You can list the
1191formats available with the @samp{-i} option.
eae04238 1192@xref{Target Selection}, for more information.
c72af735 1193
9793039f
ILT
1194@item -C
1195@itemx --demangle
1196@cindex demangling in objdump
1197Decode (@dfn{demangle}) low-level symbol names into user-level names.
1198Besides removing any initial underscore prepended by the system, this
1199makes C++ function names readable. @xref{c++filt}, for more information
1200on demangling.
1201
e1c14599
ILT
1202@item --debugging
1203Display debugging information. This attempts to parse debugging
1204information stored in the file and print it out using a C like syntax.
1205Only certain types of debugging information have been implemented.
1206
c72af735 1207@item -d
eae04238 1208@itemx --disassemble
c72af735
RP
1209@cindex disassembling object code
1210@cindex machine instructions
d5464baa
ILT
1211Display the assembler mnemonics for the machine instructions from
1212@var{objfile}. This option only disassembles those sections which are
1213expected to contain instructions.
1214
1215@item -D
1216@itemx --disassemble-all
1217Like @samp{-d}, but disassemble the contents of all sections, not just
1218those expected to contain instructions.
c72af735 1219
51b8c416
ILT
1220@item --prefix-addresses
1221When disassembling, print the complete address on each line. This is
1222the older disassembly format.
1223
1224@item --disassemble-zeroes
1225Normally the disassembly output will skip blocks of zeroes. This
1226option directs the disassembler to disassemble those blocks, just like
1227any other data.
1228
67c8c901
ILT
1229@item -EB
1230@itemx -EL
1231@itemx --endian=@{big|little@}
1232@cindex endianness
1233@cindex disassembly endianness
1234Specify the endianness of the object files. This only affects
1235disassembly. This can be useful when disassembling a file format which
1236does not describe endianness information, such as S-records.
1237
c72af735 1238@item -f
eae04238 1239@itemx --file-header
c72af735 1240@cindex object file header
eae04238 1241Display summary information from the overall header of
ec40bbb8 1242each of the @var{objfile} files.
c72af735
RP
1243
1244@item -h
eae04238 1245@itemx --section-header
c5f0c938 1246@itemx --header
c72af735 1247@cindex section headers
eae04238 1248Display summary information from the section headers of the
c72af735
RP
1249object file.
1250
db2e6adb
DM
1251File segments may be relocated to nonstandard addresses, for example by
1252using the @samp{-Ttext}, @samp{-Tdata}, or @samp{-Tbss} options to
1253@code{ld}. However, some object file formats, such as a.out, do not
1254store the starting address of the file segments. In those situations,
1255although @code{ld} relocates the sections correctly, using @samp{objdump
1256-h} to list the file section headers cannot show the correct addresses.
1257Instead, it shows the usual addresses, which are implicit for the
1258target.
1259
b26ac613
DM
1260@item --help
1261Print a summary of the options to @code{objdump} and exit.
1262
c72af735 1263@item -i
eae04238 1264@itemx --info
c72af735
RP
1265@cindex architectures available
1266@cindex object formats available
1267Display a list showing all architectures and object formats available
ec40bbb8 1268for specification with @samp{-b} or @samp{-m}.
c72af735 1269
c72af735 1270@item -j @var{name}
eae04238 1271@itemx --section=@var{name}
c72af735 1272@cindex section information
ec40bbb8 1273Display information only for section @var{name}.
c72af735 1274
c72af735 1275@item -l
eae04238 1276@itemx --line-numbers
c72af735 1277@cindex source filenames for object files
11548211
ILT
1278Label the display (using debugging information) with the filename and
1279source line numbers corresponding to the object code or relocs shown.
1280Only useful with @samp{-d}, @samp{-D}, or @samp{-r}.
c72af735 1281
c72af735 1282@item -m @var{machine}
eae04238 1283@itemx --architecture=@var{machine}
c72af735 1284@cindex architecture
67c8c901
ILT
1285@cindex disassembly architecture
1286Specify the architecture to use when disassembling object files. This
061ed861 1287can be useful when disassembling object files which do not describe
67c8c901
ILT
1288architecture information, such as S-records. You can list the available
1289architectures with the @samp{-i} option.
c72af735 1290
14482680
ILT
1291@item -p
1292@itemx --private-headers
1293Print information that is specific to the object file format. The exact
1294information printed depends upon the object file format. For some
1295object file formats, no additional information is printed.
1296
c72af735 1297@item -r
c5f0c938 1298@itemx --reloc
c72af735 1299@cindex relocation entries, in object file
d5464baa
ILT
1300Print the relocation entries of the file. If used with @samp{-d} or
1301@samp{-D}, the relocations are printed interspersed with the
1302disassembly.
c72af735 1303
de3b08ac
ILT
1304@item -R
1305@itemx --dynamic-reloc
1306@cindex dynamic relocation entries, in object file
1307Print the dynamic relocation entries of the file. This is only
1308meaningful for dynamic objects, such as certain types of shared
1309libraries.
1310
c72af735 1311@item -s
eae04238 1312@itemx --full-contents
c72af735
RP
1313@cindex sections, full contents
1314@cindex object file sections
1315Display the full contents of any sections requested.
1316
a8e27cc6
ILT
1317@item -S
1318@itemx --source
1319@cindex source disassembly
1320@cindex disassembly, with source
1321Display source code intermixed with disassembly, if possible. Implies
1322@samp{-d}.
1323
458bbd1f
DE
1324@item --show-raw-insn
1325When disassembling instructions, print the instruction in hex as well as
4cb99ff2
ILT
1326in symbolic form. This is the default except when
1327@code{--prefix-addresses} is used.
458bbd1f 1328
5c59269f
ILT
1329@item --no-show-raw-insn
1330When disassembling instructions, do not print the instruction bytes.
1331This is the default when @code{--prefix-addresses} is used.
1332
c5f0c938
JG
1333@item --stabs
1334@cindex stab
1335@cindex .stab
1336@cindex debug symbols
1337@cindex ELF object file format
c3c93fda
JG
1338Display the full contents of any sections requested. Display the
1339contents of the .stab and .stab.index and .stab.excl sections from an
1340ELF file. This is only useful on systems (such as Solaris 2.0) in which
1341@code{.stab} debugging symbol-table entries are carried in an ELF
1342section. In most other file formats, debugging symbol-table entries are
c5f0c938 1343interleaved with linkage symbols, and are visible in the @samp{--syms}
85d4b870
ILT
1344output. For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1345Overview,stabs.info, The ``stabs'' debug format}.
c5f0c938 1346
aa21a2a9
ILT
1347@item --start-address=@var{address}
1348@cindex start-address
1349Start displaying data at the specified address. This affects the output
1350of the @code{-d}, @code{-r} and @code{-s} options.
1351
1352@item --stop-address=@var{address}
1353@cindex stop-address
1354Stop displaying data at the specified address. This affects the output
1355of the @code{-d}, @code{-r} and @code{-s} options.
1356
c72af735 1357@item -t
c5f0c938 1358@itemx --syms
c72af735 1359@cindex symbol table entries, printing
eae04238 1360Print the symbol table entries of the file.
c72af735
RP
1361This is similar to the information provided by the @samp{nm} program.
1362
de3b08ac
ILT
1363@item -T
1364@itemx --dynamic-syms
1365@cindex dynamic symbol table entries, printing
1366Print the dynamic symbol table entries of the file. This is only
1367meaningful for dynamic objects, such as certain types of shared
1368libraries. This is similar to the information provided by the @samp{nm}
1369program when given the @samp{-D} (@samp{--dynamic}) option.
1370
b26ac613
DM
1371@item --version
1372Print the version number of @code{objdump} and exit.
1373
c72af735 1374@item -x
eae04238 1375@itemx --all-header
c72af735
RP
1376@cindex all header information, object file
1377@cindex header information, all
1378Display all available header information, including the symbol table and
1379relocation entries. Using @samp{-x} is equivalent to specifying all of
1380@samp{-a -f -h -r -t}.
4b6d0f78
MM
1381
1382@item -w
ac0835f2 1383@itemx --wide
4b6d0f78
MM
1384@cindex wide output, printing
1385Format some lines for output devices that have more than 80 columns.
c72af735
RP
1386@end table
1387
eae04238 1388@node ranlib
c72af735
RP
1389@chapter ranlib
1390
1391@kindex ranlib
1392@cindex archive contents
1393@cindex symbol index
1394
1395@smallexample
4d9b5d5a 1396ranlib [-vV] @var{archive}
c72af735
RP
1397@end smallexample
1398
ec40bbb8 1399@code{ranlib} generates an index to the contents of an archive and
c72af735
RP
1400stores it in the archive. The index lists each symbol defined by a
1401member of an archive that is a relocatable object file.
1402
918c2f61 1403You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
c72af735 1404
ec40bbb8 1405An archive with such an index speeds up linking to the library and
c72af735
RP
1406allows routines in the library to call each other without regard to
1407their placement in the archive.
1408
b94ff924 1409The @sc{gnu} @code{ranlib} program is another form of @sc{gnu} @code{ar}; running
c72af735
RP
1410@code{ranlib} is completely equivalent to executing @samp{ar -s}.
1411@xref{ar}.
1412
4d9b5d5a
DM
1413@table @code
1414@item -v
1415@itemx -V
1416Show the version number of @code{ranlib}.
c3f471a4 1417@end table
4d9b5d5a 1418
eae04238 1419@node size
c72af735
RP
1420@chapter size
1421
1422@kindex size
1423@cindex section sizes
1424
1425@smallexample
4d9b5d5a
DM
1426size [ -A | -B | --format=@var{compatibility} ]
1427 [ --help ] [ -d | -o | -x | --radix=@var{number} ]
1428 [ --target=@var{bfdname} ] [ -V | --version ]
f2843a17 1429 [ @var{objfile}@dots{} ]
c72af735
RP
1430@end smallexample
1431
b94ff924 1432The @sc{gnu} @code{size} utility lists the section sizes---and the total
ec40bbb8
DM
1433size---for each of the object or archive files @var{objfile} in its
1434argument list. By default, one line of output is generated for each
1435object file or each module in an archive.
c72af735 1436
b26ac613 1437@var{objfile}@dots{} are the object files to be examined.
f2843a17 1438If none are specified, the file @code{a.out} will be used.
b26ac613 1439
c72af735 1440The command line options have the following meanings:
c72af735 1441
b26ac613 1442@table @code
c72af735
RP
1443@item -A
1444@itemx -B
ec40bbb8 1445@itemx --format=@var{compatibility}
68dd5295 1446@cindex @code{size} display format
b94ff924 1447Using one of these options, you can choose whether the output from @sc{gnu}
c72af735 1448@code{size} resembles output from System V @code{size} (using @samp{-A},
ec40bbb8
DM
1449or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or
1450@samp{--format=berkeley}). The default is the one-line format similar to
c72af735 1451Berkeley's.
918c2f61
PB
1452@c Bonus for doc-source readers: you can also say --format=strange (or
1453@c anything else that starts with 's') for sysv, and --format=boring (or
c72af735
RP
1454@c anything else that starts with 'b') for Berkeley.
1455
1456Here is an example of the Berkeley (default) format of output from
1457@code{size}:
1458@smallexample
eae04238 1459size --format=Berkeley ranlib size
c72af735
RP
1460text data bss dec hex filename
1461294880 81920 11592 388392 5ed28 ranlib
1462294880 81920 11888 388688 5ee50 size
1463@end smallexample
1464
1465@noindent
1466This is the same data, but displayed closer to System V conventions:
1467
1468@smallexample
eae04238 1469size --format=SysV ranlib size
c72af735
RP
1470ranlib :
1471section size addr
1472.text 294880 8192
1473.data 81920 303104
1474.bss 11592 385024
1475Total 388392
1476
1477
1478size :
1479section size addr
1480.text 294880 8192
1481.data 81920 303104
1482.bss 11888 385024
1483Total 388688
1484@end smallexample
1485
918c2f61 1486@item --help
c72af735
RP
1487Show a summary of acceptable arguments and options.
1488
1489@item -d
1490@itemx -o
1491@itemx -x
ec40bbb8 1492@itemx --radix=@var{number}
68dd5295 1493@cindex @code{size} number format
c72af735
RP
1494@cindex radix for section sizes
1495Using one of these options, you can control whether the size of each
ec40bbb8
DM
1496section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal
1497(@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or
1498@samp{--radix=16}). In @samp{--radix=@var{number}}, only the three
c72af735
RP
1499values (8, 10, 16) are supported. The total size is always given in two
1500radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
1501octal and hexadecimal if you're using @samp{-o}.
1502
ec40bbb8 1503@item --target=@var{bfdname}
c72af735 1504@cindex object code format
ec40bbb8
DM
1505Specify that the object-code format for @var{objfile} is
1506@var{bfdname}. This option may not be necessary; @code{size} can
eae04238
DM
1507automatically recognize many formats.
1508@xref{Target Selection}, for more information.
c72af735
RP
1509
1510@item -V
918c2f61 1511@itemx --version
4d9b5d5a 1512Display the version number of @code{size}.
c72af735
RP
1513@end table
1514
eae04238 1515@node strings
ba7c8e29
DM
1516@chapter strings
1517@kindex strings
1518@cindex listings strings
1519@cindex printing strings
1520@cindex strings, printing
1521
1522@smallexample
b26ac613 1523strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-]
650a49f0 1524 [--all] [--print-file-name] [--bytes=@var{min-len}]
eae04238
DM
1525 [--radix=@var{radix}] [--target=@var{bfdname}]
1526 [--help] [--version] @var{file}@dots{}
ba7c8e29
DM
1527@end smallexample
1528
b94ff924 1529For each @var{file} given, @sc{gnu} @code{strings} prints the printable
ba7c8e29 1530character sequences that are at least 4 characters long (or the number
67ace729 1531given with the options below) and are followed by an unprintable
ba7c8e29 1532character. By default, it only prints the strings from the initialized
5f057047
ILT
1533and loaded sections of object files; for other types of files, it prints
1534the strings from the whole file.
ba7c8e29
DM
1535
1536@code{strings} is mainly useful for determining the contents of non-text
1537files.
1538
1539@table @code
1540@item -a
1541@itemx --all
1542@itemx -
5f057047
ILT
1543Do not scan only the initialized and loaded sections of object files;
1544scan the whole files.
ba7c8e29
DM
1545
1546@item -f
1547@itemx --print-file-name
1548Print the name of the file before each string.
1549
b26ac613 1550@item --help
ba7c8e29
DM
1551Print a summary of the program usage on the standard output and exit.
1552
ac0835f2
ILT
1553@item -@var{min-len}
1554@itemx -n @var{min-len}
ba7c8e29
DM
1555@itemx --bytes=@var{min-len}
1556Print sequences of characters that are at least @var{min-len} characters
1557long, instead of the default 4.
1558
1559@item -o
b26ac613
DM
1560Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o}
1561act like @samp{-t d} instead. Since we can not be compatible with both
1562ways, we simply chose one.
ba7c8e29
DM
1563
1564@item -t @var{radix}
1565@itemx --radix=@var{radix}
1566Print the offset within the file before each string. The single
1567character argument specifies the radix of the offset---@samp{o} for
1568octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1569
eae04238
DM
1570@item --target=@var{bfdname}
1571@cindex object code format
1572Specify an object code format other than your system's default format.
1573@xref{Target Selection}, for more information.
1574
ba7c8e29
DM
1575@item -v
1576@itemx --version
1577Print the program version number on the standard output and exit.
1578@end table
1579
eae04238 1580@node strip
c72af735
RP
1581@chapter strip
1582
1583@kindex strip
1584@cindex removing symbols
1585@cindex discarding symbols
1815e42c 1586@cindex symbols, discarding
c72af735
RP
1587
1588@smallexample
18ef0a3d 1589strip [ -F @var{bfdname} | --target=@var{bfdname} ]
eae04238
DM
1590 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1591 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
b703c078 1592 [ -s | --strip-all ] [ -S | -g | --strip-debug ]
dff604a7 1593 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
29c0d15c 1594 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
b703c078 1595 [ -x | --discard-all ] [ -X | --discard-locals ]
0aca460e 1596 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
2483354d 1597 [ -o @var{file} ] [ -p | --preserve-dates ]
b26ac613 1598 [ -v | --verbose ] [ -V | --version ] [ --help ]
b703c078 1599 @var{objfile}@dots{}
c72af735
RP
1600@end smallexample
1601
b94ff924 1602@sc{gnu} @code{strip} discards all symbols from object files
ec40bbb8 1603@var{objfile}. The list of object files may include archives.
b26ac613 1604At least one object file must be given.
c72af735 1605
ec40bbb8 1606@code{strip} modifies the files named in its argument,
c72af735 1607rather than writing modified copies under different names.
c72af735 1608
c72af735 1609@table @code
eae04238
DM
1610@item -F @var{bfdname}
1611@itemx --target=@var{bfdname}
b26ac613 1612Treat the original @var{objfile} as a file with the object
eae04238
DM
1613code format @var{bfdname}, and rewrite it in the same format.
1614@xref{Target Selection}, for more information.
b26ac613
DM
1615
1616@item --help
1617Show a summary of the options to @code{strip} and exit.
1618
eae04238
DM
1619@item -I @var{bfdname}
1620@itemx --input-target=@var{bfdname}
ec40bbb8 1621Treat the original @var{objfile} as a file with the object
eae04238
DM
1622code format @var{bfdname}.
1623@xref{Target Selection}, for more information.
918c2f61 1624
eae04238
DM
1625@item -O @var{bfdname}
1626@itemx --output-target=@var{bfdname}
1627Replace @var{objfile} with a file in the output format @var{bfdname}.
1628@xref{Target Selection}, for more information.
918c2f61 1629
0aca460e
ILT
1630@item -R @var{sectionname}
1631@itemx --remove-section=@var{sectionname}
1632Remove any section named @var{sectionname} from the output file. This
1633option may be given more than once. Note that using this option
1634inappropriately may make the output file unusable.
1635
b703c078
DM
1636@item -s
1637@itemx --strip-all
1638Remove all symbols.
1639
918c2f61
PB
1640@item -g
1641@itemx -S
1642@itemx --strip-debug
1643Remove debugging symbols only.
1644
9135e5f8
ILT
1645@item --strip-unneeded
1646Remove all symbols that are not needed for relocation processing.
1647
dff604a7
ILT
1648@item -K @var{symbolname}
1649@itemx --keep-symbol=@var{symbolname}
1650Keep only symbol @var{symbolname} from the source file. This option may
1651be given more than once.
1652
29c0d15c
ILT
1653@item -N @var{symbolname}
1654@itemx --strip-symbol=@var{symbolname}
dff604a7
ILT
1655Remove symbol @var{symbolname} from the source file. This option may be
1656given more than once, and may be combined with strip options other than
1657@code{-K}.
29c0d15c 1658
16c3e32a
ILT
1659@item -o @var{file}
1660Put the stripped output in @var{file}, rather than replacing the
1661existing file. When this argument is used, only one @var{objfile}
1662argument may be specified.
1663
2483354d
ILT
1664@item -p
1665@itemx --preserve-dates
1666Preserve the access and modification dates of the file.
1667
918c2f61
PB
1668@item -x
1669@itemx --discard-all
1670Remove non-global symbols.
1671
1672@item -X
1673@itemx --discard-locals
1674Remove compiler-generated local symbols.
ec40bbb8 1675(These usually start with @samp{L} or @samp{.}.)
918c2f61
PB
1676
1677@item -V
1678@itemx --version
ec40bbb8 1679Show the version number for @code{strip}.
918c2f61 1680
1815e42c 1681@item -v
918c2f61
PB
1682@itemx --verbose
1683Verbose output: list all object files modified. In the case of
1269d441 1684archives, @samp{strip -v} lists all members of the archive.
c72af735
RP
1685@end table
1686
eae04238 1687@node c++filt
b6216af2
PB
1688@chapter c++filt
1689
1690@kindex c++filt
1691@cindex demangling C++ symbols
1692
b26ac613
DM
1693@smallexample
1694c++filt [ -_ | --strip-underscores ]
6f88f031 1695 [ -n | --no-strip-underscores ]
b26ac613 1696 [ -s @var{format} | --format=@var{format} ]
d6a4c375 1697 [ --help ] [ --version ] [ @var{symbol}@dots{} ]
b26ac613
DM
1698@end smallexample
1699
6c69b6bd
JO
1700The C++ language provides function overloading, which means that you can
1701write many functions with the same name (providing each takes parameters
1702of different types). All C++ function names are encoded into a
b26ac613 1703low-level assembly label (this process is known as
6c69b6bd
JO
1704@dfn{mangling}). The @code{c++filt} program does the inverse mapping: it
1705decodes (@dfn{demangles}) low-level names into user-level names so that
1706the linker can keep these overloaded functions from clashing.
1707
1708Every alphanumeric word (consisting of letters, digits, underscores,
1709dollars, or periods) seen in the input is a potential label. If the
1710label decodes into a C++ name, the C++ name replaces the low-level
1711name in the output.
b6216af2 1712
d6a4c375 1713You can use @code{c++filt} to decipher individual symbols:
6c69b6bd
JO
1714
1715@example
1716c++filt @var{symbol}
1717@end example
1718
d6a4c375
DM
1719If no @var{symbol} arguments are given, @code{c++filt} reads symbol
1720names from the standard input and writes the demangled names to the
1721standard output. All results are printed on the standard output.
b6216af2 1722
b26ac613
DM
1723@table @code
1724@item -_
94e9ad77 1725@itemx --strip-underscores
b26ac613
DM
1726On some systems, both the C and C++ compilers put an underscore in front
1727of every name. For example, the C name @code{foo} gets the low-level
6f88f031
ILT
1728name @code{_foo}. This option removes the initial underscore. Whether
1729@code{c++filt} removes the underscore by default is target dependent.
1730
1731@item -n
1732@itemx --no-strip-underscores
1733Do not remove the initial underscore.
b26ac613
DM
1734
1735@item -s @var{format}
1736@itemx --format=@var{format}
b94ff924 1737@sc{gnu} @code{nm} can decode three different methods of mangling, used by
b26ac613
DM
1738different C++ compilers. The argument to this option selects which
1739method it uses:
1740
1741@table @code
1742@item gnu
b94ff924 1743the one used by the @sc{gnu} compiler (the default method)
b26ac613
DM
1744@item lucid
1745the one used by the Lucid compiler
1746@item arm
1747the one specified by the C++ Annotated Reference Manual
1748@end table
1749
1750@item --help
1751Print a summary of the options to @code{c++filt} and exit.
1752
1753@item --version
1754Print the version number of @code{c++filt} and exit.
1755@end table
b6216af2 1756
5eac46ae
JO
1757@quotation
1758@emph{Warning:} @code{c++filt} is a new utility, and the details of its
1759user interface are subject to change in future releases. In particular,
1760a command-line option may be required in the the future to decode a name
1761passed as an argument on the command line; in other words,
1762
1763@example
b26ac613 1764c++filt @var{symbol}
5eac46ae
JO
1765@end example
1766
1767@noindent
1768may in a future release become
1769
1770@example
b26ac613 1771c++filt @var{option} @var{symbol}
5eac46ae
JO
1772@end example
1773@end quotation
1774
fb38844d
ILT
1775@node addr2line
1776@chapter addr2line
1777
1778@kindex addr2line
1779@cindex address to file name and line number
1780
1781@smallexample
1782addr2line [ -b @var{bfdname} | --target=@var{bfdname} ]
1783 [ -C | --demangle ]
1784 [ -e @var{filename} | --exe=@var{filename} ]
1785 [ -f | --functions ] [ -s | --basename ]
1786 [ -H | --help ] [ -V | --version ]
1787 [ addr addr ... ]
1788@end smallexample
1789
1790@code{addr2line} translates program addresses into file names and line
1791numbers. Given an address and an executable, it uses the debugging
1792information in the executable to figure out which file name and line
1793number are associated with a given address.
1794
1795The executable to use is specified with the @code{-e} option. The
1796default is @file{a.out}.
1797
1798@code{addr2line} has two modes of operation.
1799
1800In the first, hexadecimal addresses are specified on the command line,
1801and @code{addr2line} displays the file name and line number for each
1802address.
1803
1804In the second, @code{addr2line} reads hexadecimal addresses from
1805standard input, and prints the file name and line number for each
1806address on standard output. In this mode, @code{addr2line} may be used
1807in a pipe to convert dynamically chosen addresses.
1808
1809The format of the output is @samp{FILENAME:LINENO}. The file name and
1810line number for each address is printed on a separate line. If the
1811@code{-f} option is used, then each @samp{FILENAME:LINENO} line is
1812preceded by a @samp{FUNCTIONNAME} line which is the name of the function
1813containing the address.
1814
1815If the file name or function name can not be determined,
1816@code{addr2line} will print two question marks in their place. If the
1817line number can not be determined, @code{addr2line} will print 0.
1818
1819The long and short forms of options, shown here as alternatives, are
1820equivalent.
1821
1822@table @code
1823@item -b @var{bfdname}
1824@itemx --target=@var{bfdname}
1825@cindex object code format
1826Specify that the object-code format for the object files is
1827@var{bfdname}.
1828
1829@item -C
1830@itemx --demangle
1831@cindex demangling in objdump
1832Decode (@dfn{demangle}) low-level symbol names into user-level names.
1833Besides removing any initial underscore prepended by the system, this
1834makes C++ function names readable. @xref{c++filt}, for more information
1835on demangling.
1836
1837@item -e @var{filename}
1838@itemx --exe=@var{filename}
1839Specify the name of the executable for which addresses should be
1840translated. The default file is @file{a.out}.
1841
1842@item -f
1843@itemx --functions
1844Display function names as well as file and line number information.
1845
1846@item -s
1847@itemx --basenames
1848Display only the base of each file name.
1849@end table
1850
eae04238 1851@node nlmconv
94e9ad77
JO
1852@chapter nlmconv
1853
1854@code{nlmconv} converts a relocatable object file into a NetWare
8981cac5
JO
1855Loadable Module.
1856
1857@ignore
1858@code{nlmconv} currently works with @samp{i386} object
4961ce5b
JO
1859files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
1860object files in @sc{elf}, or @code{a.out} format@footnote{
1861@code{nlmconv} should work with any @samp{i386} or @sc{sparc} object
1862format in the Binary File Descriptor library. It has only been tested
1863with the above formats.}.
8981cac5 1864@end ignore
4961ce5b
JO
1865
1866@quotation
1867@emph{Warning:} @code{nlmconv} is not always built as part of the binary
1868utilities, since it is only useful for NLM targets.
1869@end quotation
94e9ad77
JO
1870
1871@smallexample
eae04238
DM
1872nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1873 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
94e9ad77 1874 [ -T @var{headerfile} | --header-file=@var{headerfile} ]
20465f8b 1875 [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ]
94e9ad77
JO
1876 [ -h | --help ] [ -V | --version ]
1877 @var{infile} @var{outfile}
1878@end smallexample
1879
1880@code{nlmconv} converts the relocatable @samp{i386} object file
1881@var{infile} into the NetWare Loadable Module @var{outfile}, optionally
1882reading @var{headerfile} for NLM header information. For instructions
5b0ba16d
JO
1883on writing the NLM command file language used in header files, see the
1884@samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
1885Development and Tools Overview}, which is part of the NLM Software
1886Developer's Kit (``NLM SDK''), available from Novell, Inc.
1887@code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
eae04238 1888@var{infile}; see @ref{BFD,,BFD,ld.info,Using LD}, for
5b0ba16d 1889more information.
94e9ad77 1890
20465f8b
JO
1891@code{nlmconv} can perform a link step. In other words, you can list
1892more than one object file for input if you list them in the definitions
1893file (rather than simply specifying one input file on the command line).
1894In this case, @code{nlmconv} calls the linker for you.
1895
94e9ad77 1896@table @code
eae04238
DM
1897@item -I @var{bfdname}
1898@itemx --input-target=@var{bfdname}
94e9ad77 1899Object format of the input file. @code{nlmconv} can usually determine
eae04238
DM
1900the format of a given file (so no default is necessary).
1901@xref{Target Selection}, for more information.
94e9ad77 1902
eae04238
DM
1903@item -O @var{bfdname}
1904@itemx --output-target=@var{bfdname}
94e9ad77
JO
1905Object format of the output file. @code{nlmconv} infers the output
1906format based on the input format, e.g. for a @samp{i386} input file the
eae04238
DM
1907output format is @samp{nlm32-i386}.
1908@xref{Target Selection}, for more information.
94e9ad77
JO
1909
1910@item -T @var{headerfile}
1911@itemx --header-file=@var{headerfile}
1912Reads @var{headerfile} for NLM header information. For instructions on
5b0ba16d
JO
1913writing the NLM command file language used in header files, see@ see the
1914@samp{linkers} section, of the @cite{NLM Development and Tools
1915Overview}, which is part of the NLM Software Developer's Kit, available
1916from Novell, Inc.
94e9ad77 1917
20465f8b
JO
1918@item -d
1919@itemx --debug
1920Displays (on standard error) the linker command line used by @code{nlmconv}.
1921
1922@item -l @var{linker}
1923@itemx --linker=@var{linker}
061ed861 1924Use @var{linker} for any linking. @var{linker} can be an absolute or a
20465f8b
JO
1925relative pathname.
1926
94e9ad77
JO
1927@item -h
1928@itemx --help
1929Prints a usage summary.
1930
1931@item -V
1932@itemx --version
1933Prints the version number for @code{nlmconv}.
1934@end table
1935
217947b2
ILT
1936@node windres
1937@chapter windres
1938
1939@code{windres} may be used to manipulate Windows resources.
1940
1941@quotation
1942@emph{Warning:} @code{windres} is not always built as part of the binary
1943utilities, since it is only useful for Windows targets.
1944@end quotation
1945
1946@smallexample
1947windres [options] [input-file] [output-file]
1948@end smallexample
1949
1950@code{windres} reads resources from an input file and copies them into
1951an output file. Either file may be in one of three formats:
1952
1953@table @code
1954@item rc
1955A text format read by the Resource Compiler.
1956
1957@item res
1958A binary format generated by the Resource Compiler.
1959
1960@item coff
1961A COFF object or executable.
1962@end table
1963
1964The exact description of these different formats is available in
1965documentation from Microsoft.
1966
1967When @code{windres} converts from the @code{rc} format to the @code{res}
1968format, it is acting like the Windows Resource Compiler. When
1969@code{windres} converts from the @code{res} format to the @code{coff}
1970format, it is acting like the Windows @code{CVTRES} program.
1971
1972When @code{windres} generates an @code{rc} file, the output is similar
1973but not identical to the format expected for the input. When an input
1974@code{rc} file refers to an external filename, an output @code{rc} file
1975will instead include the file contents.
1976
1977If the input or output format is not specified, @code{windres} will
1978guess based on the file name, or, for the input file, the file contents.
1979A file with an extension of @file{.rc} will be treated as an @code{rc}
1980file, a file with an extension of @file{.res} will be treated as a
1981@code{res} file, and a file with an extension of @file{.o} or
1982@file{.exe} will be treated as a @code{coff} file.
1983
1984If no output file is specified, @code{windres} will print the resources
1985in @code{rc} format to standard output.
1986
1987The normal use is for you to write an @code{rc} file, use @code{windres}
1988to convert it to a COFF object file, and then link the COFF file into
1989your application. This will make the resources described in the
1990@code{rc} file available to Windows.
1991
1992@table @code
1993@item -i @var{filename}
1994@itemx --input @var{filename}
1995The name of the input file. If this option is not used, then
1996@code{windres} will use the first non-option argument as the input file
1997name. If there are no non-option arguments, then @code{windres} will
1998read from standard input. @code{windres} can not read a COFF file from
1999standard input.
2000
2001@item -o @var{filename}
2002@itemx --output @var{filename}
2003The name of the output file. If this option is not used, then
2004@code{windres} will use the first non-option argument, after any used
2005for the input file name, as the output file name. If there is no
2006non-option argument, then @code{windres} will write to standard output.
2007@code{windres} can not write a COFF file to standard output.
2008
2009@item -I @var{format}
2010@itemx --input-format @var{format}
2011The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
2012@samp{coff}. If no input format is specified, @code{windres} will
2013guess, as described above.
2014
2015@item -O @var{format}
2016@itemx --output-format @var{format}
2017The output format to generate. @var{format} may be @samp{res},
2018@samp{rc}, or @samp{coff}. If no output format is specified,
2019@code{windres} will guess, as described above.
2020
2021@item -F @var{target}
2022@itemx --target @var{target}
2023Specify the BFD format to use for a COFF file as input or output. This
2024is a BFD target name; you can use the @code{--help} option to see a list
2025of supported targets. Normally @code{windres} will use the default
2026format, which is the first one listed by the @code{--help} option.
2027@ref{Target Selection}.
2028
2029@item --preprocessor @var{program}
2030When @code{windres} reads an @code{rc} file, it runs it through the C
2031preprocessor first. This option may be used to specify the preprocessor
2032to use, including any leading arguments. The default preprocessor
2033argument is @code{gcc -E -xc-header -DRC_INVOKED}.
2034
2035@item --include-dir @var{directory}
2036Specify an include directory to use when reading an @code{rc} file.
2037@code{windres} will pass this to the preprocessor as an @code{-I}
2038option. @code{windres} will also search this directory when looking for
2039files named in the @code{rc} file.
2040
2041@item --define @var{sym[=val]}
2042Specify a @code{-D} option to pass to the preprocessor when reading an
2043@code{rc} file.
2044
2045@item --language @var{val}
2046Specify the default language to use when reading an @code{rc} file.
2047@var{val} should be a hexadecimal language code. The low eight bits are
2048the language, and the high eight bits are the sublanguage.
2049
2050@item --help
2051Prints a usage summary.
2052
2053@item --version
2054Prints the version number for @code{windres}.
2055
2056@item --yydebug
2057If @code{windres} is compiled with @code{YYDEBUG} defined as @code{1},
2058this will turn on parser debugging.
2059@end table
2060
061ed861
NC
2061
2062@node dlltool
2063@chapter Create files needed to build and use DLLs
2064@cindex DLL
2065@kindex dlltool
2066
2067@code{dlltool} may be used to create the files needed to build and use
2068dynamic link libraries (DLLs).
2069
2070@quotation
2071@emph{Warning:} @code{dlltool} is not always built as part of the binary
2072utilities, since it is only useful for those targets which support DLLs.
2073@end quotation
2074
2075@smallexample
2076dlltool [-d|--input-def <def-file-name>]
2077 [-b|--base-file <base-file-name>]
2078 [-e|--output-exp <exports-file-name>]
2079 [-z|--output-def <def-file-name>]
2080 [-l|--output-lib <library-file-name>]
2081 [-S|--as <path-to-assembler>] [-f|--as-flags <options>]
2082 [-D|--dllname <name>] [-m|--machine <machine>]
2083 [-a|--add-indirect] [-U|--add-underscore] [-k|--kill-at]
2084 [-x|--no-idata4] [-c|--no-idata5] [-i|--interwork]
2085 [-n|--nodelete] [-v|--verbose] [-h|--help] [-V|--version]
2086 [object-file @dots{}]
2087@end smallexample
2088
2089@code{dlltool} reads its inputs, which can come from the @samp{-d} and
2090@samp{-b} options as well as object files specified on the command
2091line. It then processes these inputs and if the @samp{-e} option has
2092been specified it creates a exports file. If the @samp{-l} option
2093has been specified it creates a library file and if the @samp{-z} option
2094has been specified it creates a def file. Any or all of the -e, -l
2095and -z options can be present in one invocation of dlltool.
2096
2097When creating a DLL, along with the source for the DLL, it is necessary
2098to have three other files. @code{dlltool} can help with the creation of
2099these files.
2100
2101The first file is a @samp{.def} file which specifies which functions are
2102exported from the DLL, which functions the DLL imports, and so on. This
2103is a text file and can be created by hand, or @code{dlltool} can be used
2104to create it using the @samp{-z} option. In this case @code{dlltool}
2105will scan the object files specified on its command line looking for
2106those functions which have been specially marked as being exported and
2107put entries for them in the .def file it creates.
2108
2109In order to mark a function as being exported from a DLL, it needs to
2110have an @samp{-export:<name_of_function>} entry in the @samp{.drective}
2111section of the object file. This can be done in C by using the
2112asm() operator:
2113
2114@smallexample
2115 asm (".section .drective");
2116 asm (".ascii \"-export:my_func\"");
2117
2118 int my_func (void) @{ @dots{} @}
2119@end smallexample
2120
2121The second file needed for DLL creation is an exports file. This file
2122is linked with the object files that make up the body of the DLL and it
2123handles the interface between the DLL and the outside world. This is a
2124binary file and it can be created by giving the @samp{-e} option to
2125@code{dlltool} when it is creating or reading in a .def file.
2126
2127The third file needed for DLL creation is the library file that programs
2128will link with in order to access the functions in the DLL. This file
2129can be created by giving the @samp{-l} option to dlltool when it
2130is creating or reading in a .def file.
2131
2132@code{dlltool} builds the library file by hand, but it builds the
2133exports file by creating temporary files containing assembler statements
2134and then assembling these. The @samp{-S} command line option can be
2135used to specify the path to the assembler that dlltool will use,
2136and the @samp{-f} option can be used to pass specific flags to that
2137assembler. The @samp{-n} can be used to prevent dlltool from deleting
2138these temporary assembler files when it is done, and if @samp{-n} is
2139specified twice then this will prevent dlltool from deleting the
2140temporary object files it used to build the library.
2141
2142Here is an example of creating a DLL from a source file @samp{dll.c} and
2143also creating a program (from an object file called @samp{program.o})
2144that uses that DLL:
2145
2146@smallexample
2147 gcc -c dll.c
2148 dlltool -e exports.o -l dll.lib dll.o
2149 gcc dll.o exports.o -o dll.dll
2150 gcc program.o dll.lib -o program
2151@end smallexample
2152
2153The command line options have the following meanings:
2154
2155@table @code
2156
2157@item -d FILENAME
2158@itemx --input-def FILENAME
2159@cindex input .def file
2160Specifies the name of a .def file to be read in and processed.
2161
2162@item -b FILENAME
2163@itemx --base-file FILENAME
2164@cindex base files
2165Specifies the name of a base file to be read in and processed. The
2166contents of this file will be added to the relocation section in the
2167exports file generated by dlltool.
2168
2169@item -e FILENAME
2170@itemx --output-exp FILENAME
2171Specifies the name of the export file to be created by dlltool.
2172
2173@item -z FILENAME
2174@itemx --output-def FILENAME
2175Specifies the name of the .def file to be created by dlltool.
2176
2177@item -l FILENAME
2178@itemx --output-lib FILENAME
2179Specifies the name of the library file to be created by dlltool.
2180
2181@item -S PATH
2182@itemx --as PATH
2183Specifies the path, including the filename, of the assembler to be used
2184to create the exports file.
2185
2186@item -f SWITCHES
2187@itemx --as-flags SWITCHES
2188Specifies any specific command line switches to be passed to the
2189assembler when building the exports file. This option will work even if
2190the @samp{-S} option is not used. This option only takes one argument,
2191and if it occurs more than once on the command line, then later
2192occurrences will override earlier occurrences. So if it is necessary to
2193pass multiple switches to the assembler they should be enclosed in
2194double quotes.
2195
2196@item -D NAME
2197@itemx --dll-name NAME
2198Specifies the name to be stored in the .def file as the name of the DLL
2199when the @samp{-e} option is used. If this option is not present, then
2200the filename given to the @samp{-e} option will be used as the name of
2201the DLL.
2202
2203@item -m MACHINE
2204@itemx -machine MACHINE
2205Specifies the type of machine for which the library file should be
2206built. @code{dlltool} has a built in default type, depending upon how
2207it was created, but this option can be used to override that. This is
2208normally only useful when creating DLLs for an ARM processor, when the
2209contents of the DLL are actually encode using THUMB instructions.
2210
2211@item -a
2212@itemx --add-indirect
2213Specifies that when @code{dlltool} is creating the exports file it
2214should add a section which allows the exported functions to be
2215referenced without using the import library. Whatever the hell that
2216means!
2217
2218@item -U
2219@itemx --add-underscore
2220Specifies that when @code{dlltool} is creating the exports file it
2221should prepend an underscore to the names of the exported functions.
2222
2223@item -k
2224@itemx --kill-at
2225Specifies that when @code{dlltool} is creating the exports file it
2226should not append the string @samp{@@ <number>}. These numbers are
2227called ordinal numbers and they represent another way of accessing the
2228function in a DLL, other than by name.
2229
2230@item -x
2231@itemx --no-idata4
2232Specifies that when @code{dlltool} is creating the exports and library
2233files it should omit the .idata4 section. This is for compatibility
2234with certain operating systems.
2235
2236@item -c
2237@itemx --no-idata5
2238Specifies that when @code{dlltool} is creating the exports and library
2239files it should omit the .idata5 section. This is for compatibility
2240with certain operating systems.
2241
2242@item -i
2243@itemx --interwork
2244Specifies that @code{dlltool} should mark the objects in the library
2245file and exports file that it produces as supporting interworking
2246between ARM and THUMB code.
2247
2248@item -n
2249@itemx --nodelete
2250Makes @code{dlltool} preserve the temporary assembler files it used to
2251create the exports file. If this option is repeated then dlltool will
2252also preserve the temporary object files it uses to create the library
2253file.
2254
2255@item -v
2256@itemx --verbose
2257Make dlltool describe what it is doing.
2258
2259@item -h
2260@itemx --help
2261Displays a list of command line options and then exits.
2262
2263@item -V
2264@itemx --version
2265Displays dlltool's version number and then exits.
2266
2267@end table
2268
76466873
NC
2269@node readelf
2270@chapter readelf
2271
2272@cindex ELF file information
2273@kindex readelf
2274
2275@smallexample
2276readelf [ -a | --all ]
2277 [ -h | --file-header]
2278 [ -l | --program-headers | --segments]
2279 [ -S | --sections]
2280 [ -s | --symbols]
2281 [ -r | --relocs]
2282 [ -d | --dynamic]
2283 [ -V | --version-info]
2284 [ -D | --use-dynamic]
2285 [ -x <number> | --hex-dump=<number>]
2286 [ -v | --version]
2287 [ -H | --help]
2288 @var{elffile}@dots{}
2289@end smallexample
2290
2291@code{readelf} displays information about one or more ELF format object
2292files. The options control what particular information to display.
2293
2294@var{elffile}@dots{} are the object files to be examined. At the
2295moment, @code{readelf} does not support examining archives, nor does it
2296support examing 64 bit ELF files.
2297
2298The long and short forms of options, shown here as alternatives, are
2299equivalent. At least one option besides @samp{-v} or @samp{-H} must be
2300given.
2301
2302@table @code
2303@item -a
2304@itemx --all
2305Equivalent to specifiying @samp{--file-header},
2306@samp{--program-headers}, @samp{--sections}, @samp{--symbols},
2307@samp{--relocs}, @samp{--dynamic} and @samp{--version-info}.
2308
2309@item -h
2310@itemx --file-header
2311@cindex ELF file header information
2312Displays the information contained in the ELF header at the start of the
2313file.
2314
2315@item -l
2316@itemx --program-headers
2317@itemx --segments
2318@cindex ELF program header information
2319@cindex ELF segment information
2320Displays the information contained in the file's segment headers, if it
2321has any.
2322
2323@item -S
2324@itemx --sections
2325@cindex ELF section information
2326Displays the information contained in the file's section headers, if it
2327has any.
2328
2329@item -s
2330@itemx --symbols
2331@cindex ELF symbol table information
2332Displays the entries in symbol table section of the file, if it has one.
2333
2334@item -r
2335@itemx --relocs
2336@cindex ELF reloc information
2337Displays the contents of the file's relocation section, if it ha one.
2338
2339@item -d
2340@itemx --dynamic
2341@cindex ELF dynamic section information
2342Displays the contents of the file's dynamic section, if it has one.
2343
2344@item -V
2345@itemx --version-info
2346@cindex ELF version sections informations
2347Displays the contents of the version sections in the file, it they
2348exist.
2349
2350@item -D
2351@itemx --use-dynamic
2352When displaying symbols, this option makes @code{readelf} use the
2353symblol table in the file's dynamic section, rather than the one in the
2354symbols section.
2355
2356@item -x <number>
2357@itemx --hex-dump=<number>
2358Displays the contents of the indicated section as a hexadecimal dump.
2359
2360@item -v
2361@itemx --version
2362Display the version number of readelf.
2363
2364@item -H
2365@itemx --help
2366Display the command line options understood by @code{readelf}.
2367
2368@end table
061ed861
NC
2369
2370
eae04238
DM
2371@node Selecting The Target System
2372@chapter Selecting the target system
2373
8981cac5
JO
2374You can specify three aspects of the target system to the @sc{gnu}
2375binary file utilities, each in several ways:
eae04238
DM
2376
2377@itemize @bullet
2378@item
8981cac5 2379the target
eae04238
DM
2380
2381@item
8981cac5 2382the architecture
eae04238
DM
2383
2384@item
8981cac5 2385the linker emulation (which applies to the linker only)
eae04238
DM
2386@end itemize
2387
2388In the following summaries, the lists of ways to specify values are in
8981cac5
JO
2389order of decreasing precedence. The ways listed first override those
2390listed later.
eae04238 2391
8981cac5
JO
2392The commands to list valid values only list the values for which the
2393programs you are running were configured. If they were configured with
8490169d 2394@samp{--enable-targets=all}, the commands list most of the available
eae04238 2395values, but a few are left out; not all targets can be configured in at
8981cac5
JO
2396once because some of them can only be configured @dfn{native} (on hosts
2397with the same type as the target system).
eae04238
DM
2398
2399@menu
2400* Target Selection::
2401* Architecture Selection::
2402* Linker Emulation Selection::
2403@end menu
2404
2405@node Target Selection
8981cac5 2406@section Target Selection
eae04238
DM
2407
2408A @dfn{target} is an object file format. A given target may be
2409supported for multiple architectures (@pxref{Architecture Selection}).
8981cac5
JO
2410A target selection may also have variations for different operating
2411systems or architectures.
eae04238 2412
8981cac5
JO
2413The command to list valid target values is @samp{objdump -i}
2414(the first column of output contains the relevant information).
eae04238 2415
10f2a7f6
JO
2416Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
2417@samp{a.out-sunos-big}.
eae04238 2418
55311d1c
ILT
2419You can also specify a target using a configuration triplet. This is
2420the same sort of name that is passed to configure to specify a target.
2421When you use a configuration triplet as an argument, it must be fully
2422canonicalized. You can see the canonical version of a triplet by
2423running the shell script @file{config.sub} which is included with the
2424sources.
2425
2426Some sample configuration triplets are: @samp{m68k-hp-bsd},
2427@samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
2428
8981cac5 2429@subheading @code{objdump} Target
eae04238
DM
2430
2431Ways to specify:
2432
2433@enumerate
2434@item
8981cac5 2435command line option: @samp{-b} or @samp{--target}
eae04238
DM
2436
2437@item
2438environment variable @code{GNUTARGET}
2439
2440@item
2441deduced from the input file
2442@end enumerate
2443
8981cac5 2444@subheading @code{objcopy} and @code{strip} Input Target
eae04238
DM
2445
2446Ways to specify:
2447
2448@enumerate
2449@item
8981cac5 2450command line options: @samp{-I} or @samp{--input-target}, or @samp{-F} or @samp{--target}
eae04238
DM
2451
2452@item
2453environment variable @code{GNUTARGET}
2454
2455@item
2456deduced from the input file
2457@end enumerate
2458
8981cac5 2459@subheading @code{objcopy} and @code{strip} Output Target
eae04238
DM
2460
2461Ways to specify:
2462
2463@enumerate
2464@item
8981cac5 2465command line options: @samp{-O} or @samp{--output-target}, or @samp{-F} or @samp{--target}
eae04238
DM
2466
2467@item
8981cac5 2468the input target (see ``@code{objcopy} and @code{strip} Input Target'' above)
eae04238
DM
2469
2470@item
2471environment variable @code{GNUTARGET}
2472
2473@item
2474deduced from the input file
2475@end enumerate
2476
8981cac5 2477@subheading @code{nm}, @code{size}, and @code{strings} Target
eae04238
DM
2478
2479Ways to specify:
2480
2481@enumerate
2482@item
8981cac5 2483command line option: @samp{--target}
eae04238
DM
2484
2485@item
2486environment variable @code{GNUTARGET}
2487
2488@item
2489deduced from the input file
2490@end enumerate
2491
8981cac5 2492@subheading Linker Input Target
eae04238
DM
2493
2494Ways to specify:
2495
2496@enumerate
2497@item
8981cac5 2498command line option: @samp{-b} or @samp{--format}
eae04238
DM
2499(@pxref{Options,,Options,ld.info,Using LD})
2500
2501@item
2502script command @code{TARGET}
2503(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
2504
2505@item
2506environment variable @code{GNUTARGET}
2507(@pxref{Environment,,Environment,ld.info,Using LD})
2508
2509@item
2510the default target of the selected linker emulation
2511(@pxref{Linker Emulation Selection})
2512@end enumerate
2513
8981cac5 2514@subheading Linker Output Target
eae04238
DM
2515
2516Ways to specify:
2517
2518@enumerate
2519@item
8981cac5 2520command line option: @samp{-oformat}
eae04238
DM
2521(@pxref{Options,,Options,ld.info,Using LD})
2522
2523@item
2524script command @code{OUTPUT_FORMAT}
2525(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
2526
2527@item
8981cac5 2528the linker input target (see ``Linker Input Target'' above)
eae04238
DM
2529@end enumerate
2530
2531@node Architecture Selection
2532@section Architecture selection
2533
8981cac5
JO
2534An @dfn{architecture} is a type of @sc{cpu} on which an object file is
2535to run. Its name may contain a colon, separating the name of the
2536processor family from the name of the particular @sc{cpu}.
eae04238 2537
8981cac5
JO
2538The command to list valid architecture values is @samp{objdump -i} (the
2539second column contains the relevant information).
eae04238
DM
2540
2541Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
2542
8981cac5 2543@subheading @code{objdump} Architecture
eae04238
DM
2544
2545Ways to specify:
2546
2547@enumerate
2548@item
8981cac5 2549command line option: @samp{-m} or @samp{--architecture}
eae04238
DM
2550
2551@item
2552deduced from the input file
2553@end enumerate
2554
8981cac5 2555@subheading @code{objcopy}, @code{nm}, @code{size}, @code{strings} Architecture
eae04238
DM
2556
2557Ways to specify:
2558
2559@enumerate
2560@item
2561deduced from the input file
2562@end enumerate
2563
8981cac5 2564@subheading Linker Input Architecture
eae04238
DM
2565
2566Ways to specify:
2567
2568@enumerate
2569@item
2570deduced from the input file
2571@end enumerate
2572
8981cac5 2573@subheading Linker Output Architecture
eae04238
DM
2574
2575Ways to specify:
2576
2577@enumerate
2578@item
2579script command @code{OUTPUT_ARCH}
2580(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
2581
2582@item
2583the default architecture from the linker output target
8981cac5 2584(@pxref{Target Selection})
eae04238
DM
2585@end enumerate
2586
2587@node Linker Emulation Selection
2588@section Linker emulation selection
2589
2590A linker @dfn{emulation} is a ``personality'' of the linker, which gives
2591the linker default values for the other aspects of the target system.
2592In particular, it consists of
2593
2594@itemize @bullet
2595@item
8981cac5 2596the linker script
eae04238
DM
2597
2598@item
8981cac5 2599the target
eae04238
DM
2600
2601@item
2602several ``hook'' functions that are run at certain stages of the linking
8981cac5 2603process to do special things that some targets require
eae04238
DM
2604@end itemize
2605
8981cac5 2606The command to list valid linker emulation values is @samp{ld -V}.
eae04238
DM
2607
2608Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
2609
2610Ways to specify:
2611
2612@enumerate
2613@item
8981cac5 2614command line option: @samp{-m}
eae04238
DM
2615(@pxref{Options,,Options,ld.info,Using LD})
2616
2617@item
2618environment variable @code{LDEMULATION}
2619
2620@item
2621compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
2622which comes from @code{EMUL} in @file{config/@var{target}.mt}
2623@end enumerate
2624
cbcfa129
ILT
2625@node Reporting Bugs
2626@chapter Reporting Bugs
2627@cindex bugs
2628@cindex reporting bugs
2629
2630Your bug reports play an essential role in making the binary utilities
2631reliable.
2632
2633Reporting a bug may help you by bringing a solution to your problem, or
2634it may not. But in any case the principal function of a bug report is
2635to help the entire community by making the next version of the binary
2636utilities work better. Bug reports are your contribution to their
2637maintenance.
2638
2639In order for a bug report to serve its purpose, you must include the
2640information that enables us to fix the bug.
2641
2642@menu
2643* Bug Criteria:: Have you found a bug?
2644* Bug Reporting:: How to report bugs
2645@end menu
2646
2647@node Bug Criteria
2648@section Have you found a bug?
2649@cindex bug criteria
2650
2651If you are not sure whether you have found a bug, here are some guidelines:
2652
2653@itemize @bullet
2654@cindex fatal signal
2655@cindex crash
2656@item
2657If a binary utility gets a fatal signal, for any input whatever, that is
2658a bug. Reliable utilities never crash.
2659
2660@cindex error on valid input
2661@item
2662If a binary utility produces an error message for valid input, that is a
2663bug.
2664
2665@item
2666If you are an experienced user of binary utilities, your suggestions for
2667improvement are welcome in any case.
2668@end itemize
2669
2670@node Bug Reporting
2671@section How to report bugs
2672@cindex bug reports
2673@cindex bugs, reporting
2674
2675A number of companies and individuals offer support for @sc{gnu}
2676products. If you obtained the binary utilities from a support
2677organization, we recommend you contact that organization first.
2678
2679You can find contact information for many support companies and
2680individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
2681distribution.
2682
2683In any event, we also recommend that you send bug reports for the binary
eaa147a6 2684utilities to @samp{bug-gnu-utils@@gnu.org}.
cbcfa129
ILT
2685
2686The fundamental principle of reporting bugs usefully is this:
2687@strong{report all the facts}. If you are not sure whether to state a
2688fact or leave it out, state it!
2689
2690Often people omit facts because they think they know what causes the
2691problem and assume that some details do not matter. Thus, you might
2692assume that the name of a file you use in an example does not matter.
2693Well, probably it does not, but one cannot be sure. Perhaps the bug is
2694a stray memory reference which happens to fetch from the location where
2695that pathname is stored in memory; perhaps, if the pathname were
2696different, the contents of that location would fool the utility into
2697doing the right thing despite the bug. Play it safe and give a
2698specific, complete example. That is the easiest thing for you to do,
2699and the most helpful.
2700
2701Keep in mind that the purpose of a bug report is to enable us to fix the bug if
2702it is new to us. Therefore, always write your bug reports on the assumption
2703that the bug has not been reported previously.
2704
2705Sometimes people give a few sketchy facts and ask, ``Does this ring a
2706bell?'' Those bug reports are useless, and we urge everyone to
2707@emph{refuse to respond to them} except to chide the sender to report
2708bugs properly.
2709
2710To enable us to fix the bug, you should include all these things:
2711
2712@itemize @bullet
2713@item
2714The version of the utility. Each utility announces it if you start it
2715with the @samp{--version} argument.
2716
2717Without this, we will not know whether there is any point in looking for
2718the bug in the current version of the binary utilities.
2719
2720@item
2721Any patches you may have applied to the source, including any patches
2722made to the @code{BFD} library.
2723
2724@item
2725The type of machine you are using, and the operating system name and
2726version number.
2727
2728@item
2729What compiler (and its version) was used to compile the utilities---e.g.
2730``@code{gcc-2.7}''.
2731
2732@item
2733The command arguments you gave the utility to observe the bug. To
2734guarantee you will not omit something important, list them all. A copy
2735of the Makefile (or the output from make) is sufficient.
2736
2737If we were to try to guess the arguments, we would probably guess wrong
2738and then we might not encounter the bug.
2739
2740@item
2741A complete input file, or set of input files, that will reproduce the
2742bug. If the utility is reading an object file or files, then it is
2743generally most helpful to send the actual object files, uuencoded if
2744necessary to get them through the mail system. Making them available
2745for anonymous FTP is not as good, but may be the only reasonable choice
2746for large object files.
2747
2748If the source files were produced exclusively using @sc{gnu} programs
2749(e.g., @code{gcc}, @code{gas}, and/or the @sc{gnu} @code{ld}), then it
2750may be OK to send the source files rather than the object files. In
2751this case, be sure to say exactly what version of @code{gcc}, or
2752whatever, was used to produce the object files. Also say how
2753@code{gcc}, or whatever, was configured.
2754
2755@item
2756A description of what behavior you observe that you believe is
2757incorrect. For example, ``It gets a fatal signal.''
2758
2759Of course, if the bug is that the utility gets a fatal signal, then we
2760will certainly notice it. But if the bug is incorrect output, we might
2761not notice unless it is glaringly wrong. You might as well not give us
2762a chance to make a mistake.
2763
2764Even if the problem you experience is a fatal signal, you should still
2765say so explicitly. Suppose something strange is going on, such as, your
2766copy of the utility is out of synch, or you have encountered a bug in
2767the C library on your system. (This has happened!) Your copy might
2768crash and ours would not. If you told us to expect a crash, then when
2769ours fails to crash, we would know that the bug was not happening for
2770us. If you had not told us to expect a crash, then we would not be able
2771to draw any conclusion from our observations.
2772
2773@item
2774If you wish to suggest changes to the source, send us context diffs, as
2775generated by @code{diff} with the @samp{-u}, @samp{-c}, or @samp{-p}
2776option. Always send diffs from the old file to the new file. If you
2777even discuss something in the @code{ld} source, refer to it by context,
2778not by line number.
2779
2780The line numbers in our development sources will not match those in your
2781sources. Your line numbers would convey no useful information to us.
2782@end itemize
2783
2784Here are some things that are not necessary:
2785
2786@itemize @bullet
2787@item
2788A description of the envelope of the bug.
2789
2790Often people who encounter a bug spend a lot of time investigating
2791which changes to the input file will make the bug go away and which
2792changes will not affect it.
2793
2794This is often time consuming and not very useful, because the way we
2795will find the bug is by running a single example under the debugger
2796with breakpoints, not by pure deduction from a series of examples.
2797We recommend that you save your time for something else.
2798
2799Of course, if you can find a simpler example to report @emph{instead}
2800of the original one, that is a convenience for us. Errors in the
2801output will be easier to spot, running under the debugger will take
2802less time, and so on.
2803
2804However, simplification is not vital; if you do not want to do this,
2805report the bug anyway and send us the entire test case you used.
2806
2807@item
2808A patch for the bug.
2809
2810A patch for the bug does help us if it is a good one. But do not omit
2811the necessary information, such as the test case, on the assumption that
2812a patch is all we need. We might see problems with your patch and decide
2813to fix the problem another way, or we might not understand it at all.
2814
2815Sometimes with programs as complicated as the binary utilities it is
2816very hard to construct an example that will make the program follow a
2817certain path through the code. If you do not send us the example, we
2818will not be able to construct one, so we will not be able to verify that
2819the bug is fixed.
2820
2821And if we cannot understand what bug you are trying to fix, or why your
2822patch should be an improvement, we will not install it. A test case will
2823help us to understand.
2824
2825@item
2826A guess about what the bug is or what it depends on.
2827
2828Such guesses are usually wrong. Even we cannot guess right about such
2829things without first using the debugger to find the facts.
2830@end itemize
2831
eae04238 2832@node Index
c72af735
RP
2833@unnumbered Index
2834
2835@printindex cp
2836
2837@contents
2838@bye
This page took 0.349988 seconds and 4 git commands to generate.