binutils/testsuite/
[deliverable/binutils-gdb.git] / binutils / doc / binutils.texi
CommitLineData
252b5132
RH
1\input texinfo @c -*- Texinfo -*-
2@setfilename binutils.info
aef6203b 3@c Copyright 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
8c2bc687 4
252b5132
RH
5@include config.texi
6
7@ifinfo
8@format
9START-INFO-DIR-ENTRY
ad0481cd
AS
10* Binutils: (binutils). The GNU binary utilities.
11* ar: (binutils)ar. Create, modify, and extract from archives
12* nm: (binutils)nm. List symbols from object files
13* objcopy: (binutils)objcopy. Copy and translate object files
14* objdump: (binutils)objdump. Display information from object files
15* ranlib: (binutils)ranlib. Generate index to archive contents
16* readelf: (binutils)readelf. Display the contents of ELF format files.
17* size: (binutils)size. List section sizes and total size
18* strings: (binutils)strings. List printable strings from files
19* strip: (binutils)strip. Discard symbols
20* c++filt: (binutils)c++filt. Filter to demangle encoded C++ symbols
21* cxxfilt: (binutils)c++filt. MS-DOS name for c++filt
22* addr2line: (binutils)addr2line. Convert addresses to file and line
23* nlmconv: (binutils)nlmconv. Converts object code into an NLM
24* windres: (binutils)windres. Manipulate Windows resources
25* dlltool: (binutils)dlltool. Create files needed to build and use DLLs
252b5132
RH
26END-INFO-DIR-ENTRY
27@end format
28@end ifinfo
29
30@ifinfo
0285c67d 31@c man begin COPYRIGHT
2423fbe6 32Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
7b4a0685 332000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
252b5132 34
0285c67d
NC
35Permission is granted to copy, distribute and/or modify this document
36under the terms of the GNU Free Documentation License, Version 1.1
37or any later version published by the Free Software Foundation;
38with no Invariant Sections, with no Front-Cover Texts, and with no
39Back-Cover Texts. A copy of the license is included in the
947ed062 40section entitled ``GNU Free Documentation License''.
252b5132 41
0285c67d 42@c man end
252b5132
RH
43@ignore
44Permission is granted to process this file through TeX and print the
45results, provided the printed document carries a copying permission
46notice identical to this one except for the removal of this paragraph
47(this paragraph not being relevant to the printed manual).
48
49@end ignore
252b5132
RH
50@end ifinfo
51
52@synindex ky cp
53@c
54@c This file documents the GNU binary utilities "ar", "ld", "objcopy",
55@c "objdump", "nm", "size", "strings", "strip", "readelf" and "ranlib".
56@c
2423fbe6 57@c Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
7b4a0685 58@c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
252b5132
RH
59@c
60@c This text may be freely distributed under the terms of the GNU
cf055d54 61@c Free Documentation License.
252b5132
RH
62@c
63
64@setchapternewpage odd
65@settitle @sc{gnu} Binary Utilities
66@titlepage
67@finalout
68@title The @sc{gnu} Binary Utilities
69@subtitle Version @value{VERSION}
70@sp 1
36607f99 71@subtitle @value{UPDATED}
252b5132
RH
72@author Roland H. Pesch
73@author Jeffrey M. Osier
74@author Cygnus Support
75@page
76
77@tex
78{\parskip=0pt \hfill Cygnus Support\par \hfill
79\TeX{}info \texinfoversion\par }
80@end tex
81
82@vskip 0pt plus 1filll
2423fbe6 83Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
7b4a0685 842000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
252b5132 85
cf055d54
NC
86 Permission is granted to copy, distribute and/or modify this document
87 under the terms of the GNU Free Documentation License, Version 1.1
88 or any later version published by the Free Software Foundation;
89 with no Invariant Sections, with no Front-Cover Texts, and with no
90 Back-Cover Texts. A copy of the license is included in the
947ed062 91 section entitled ``GNU Free Documentation License''.
252b5132 92
252b5132
RH
93@end titlepage
94
95@node Top
96@top Introduction
97
98@cindex version
947ed062 99This brief manual contains documentation for the @sc{gnu} binary
252b5132
RH
100utilities (collectively version @value{VERSION}):
101
102@iftex
103@table @code
104@item ar
105Create, modify, and extract from archives
106
107@item nm
108List symbols from object files
109
110@item objcopy
111Copy and translate object files
112
113@item objdump
114Display information from object files
115
116@item ranlib
117Generate index to archive contents
118
119@item readelf
120Display the contents of ELF format files.
121
122@item size
123List file section sizes and total size
124
125@item strings
126List printable strings from files
127
128@item strip
129Discard symbols
130
131@item c++filt
9d51cc66
ILT
132Demangle encoded C++ symbols (on MS-DOS, this program is named
133@code{cxxfilt})
252b5132
RH
134
135@item addr2line
136Convert addresses into file names and line numbers
137
138@item nlmconv
139Convert object code into a Netware Loadable Module
140
141@item windres
142Manipulate Windows resources
143
144@item dlltool
145Create the files needed to build and use Dynamic Link Libraries
146@end table
147@end iftex
148
cf055d54
NC
149This document is distributed under the terms of the GNU Free
150Documentation License. A copy of the license is included in the
151section entitled "GNU Free Documentation License".
152
252b5132
RH
153@menu
154* ar:: Create, modify, and extract from archives
155* nm:: List symbols from object files
156* objcopy:: Copy and translate object files
157* objdump:: Display information from object files
158* ranlib:: Generate index to archive contents
159* readelf:: Display the contents of ELF format files.
160* size:: List section sizes and total size
161* strings:: List printable strings from files
162* strip:: Discard symbols
163* c++filt:: Filter to demangle encoded C++ symbols
9d51cc66 164* cxxfilt: c++filt. MS-DOS name for c++filt
252b5132
RH
165* addr2line:: Convert addresses to file and line
166* nlmconv:: Converts object code into an NLM
167* windres:: Manipulate Windows resources
168* dlltool:: Create files needed to build and use DLLs
07012eee 169* Common Options:: Command-line options for all utilities
252b5132
RH
170* Selecting The Target System:: How these utilities determine the target.
171* Reporting Bugs:: Reporting Bugs
cf055d54 172* GNU Free Documentation License:: GNU Free Documentation License
252b5132
RH
173* Index:: Index
174@end menu
175
176@node ar
177@chapter ar
178
179@kindex ar
180@cindex archives
181@cindex collections of files
0285c67d
NC
182
183@c man title ar create, modify, and extract from archives
184
252b5132 185@smallexample
3de39064 186ar [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]
252b5132
RH
187ar -M [ <mri-script ]
188@end smallexample
189
0285c67d
NC
190@c man begin DESCRIPTION ar
191
c7c55b78 192The @sc{gnu} @command{ar} program creates, modifies, and extracts from
252b5132
RH
193archives. An @dfn{archive} is a single file holding a collection of
194other files in a structure that makes it possible to retrieve
195the original individual files (called @dfn{members} of the archive).
196
197The original files' contents, mode (permissions), timestamp, owner, and
198group are preserved in the archive, and can be restored on
199extraction.
200
201@cindex name length
c7c55b78
NC
202@sc{gnu} @command{ar} can maintain archives whose members have names of any
203length; however, depending on how @command{ar} is configured on your
252b5132
RH
204system, a limit on member-name length may be imposed for compatibility
205with archive formats maintained with other tools. If it exists, the
206limit is often 15 characters (typical of formats related to a.out) or 16
207characters (typical of formats related to coff).
208
209@cindex libraries
c7c55b78 210@command{ar} is considered a binary utility because archives of this sort
252b5132
RH
211are most often used as @dfn{libraries} holding commonly needed
212subroutines.
213
214@cindex symbol index
c7c55b78 215@command{ar} creates an index to the symbols defined in relocatable
252b5132 216object modules in the archive when you specify the modifier @samp{s}.
c7c55b78 217Once created, this index is updated in the archive whenever @command{ar}
252b5132
RH
218makes a change to its contents (save for the @samp{q} update operation).
219An archive with such an index speeds up linking to the library, and
220allows routines in the library to call each other without regard to
221their placement in the archive.
222
223You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
c7c55b78
NC
224table. If an archive lacks the table, another form of @command{ar} called
225@command{ranlib} can be used to add just the table.
252b5132 226
c7c55b78
NC
227@cindex compatibility, @command{ar}
228@cindex @command{ar} compatibility
229@sc{gnu} @command{ar} is designed to be compatible with two different
252b5132 230facilities. You can control its activity using command-line options,
c7c55b78
NC
231like the different varieties of @command{ar} on Unix systems; or, if you
232specify the single command-line option @option{-M}, you can control it
252b5132
RH
233with a script supplied via standard input, like the MRI ``librarian''
234program.
235
0285c67d
NC
236@c man end
237
252b5132 238@menu
c7c55b78
NC
239* ar cmdline:: Controlling @command{ar} on the command line
240* ar scripts:: Controlling @command{ar} with a script
252b5132
RH
241@end menu
242
243@page
244@node ar cmdline
947ed062 245@section Controlling @command{ar} on the Command Line
252b5132
RH
246
247@smallexample
0285c67d 248@c man begin SYNOPSIS ar
c7c55b78 249ar [@option{-X32_64}] [@option{-}]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]
0285c67d 250@c man end
252b5132
RH
251@end smallexample
252
c7c55b78
NC
253@cindex Unix compatibility, @command{ar}
254When you use @command{ar} in the Unix style, @command{ar} insists on at least two
252b5132
RH
255arguments to execute: one keyletter specifying the @emph{operation}
256(optionally accompanied by other keyletters specifying
257@emph{modifiers}), and the archive name to act on.
258
259Most operations can also accept further @var{member} arguments,
260specifying particular files to operate on.
261
0285c67d
NC
262@c man begin OPTIONS ar
263
c7c55b78 264@sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
252b5132
RH
265flags @var{mod} in any order, within the first command-line argument.
266
267If you wish, you may begin the first command-line argument with a
268dash.
269
270@cindex operations on archive
271The @var{p} keyletter specifies what operation to execute; it may be
272any of the following, but you must specify only one of them:
273
c7c55b78 274@table @samp
252b5132
RH
275@item d
276@cindex deleting from archive
277@emph{Delete} modules from the archive. Specify the names of modules to
278be deleted as @var{member}@dots{}; the archive is untouched if you
279specify no files to delete.
280
c7c55b78 281If you specify the @samp{v} modifier, @command{ar} lists each module
252b5132
RH
282as it is deleted.
283
284@item m
285@cindex moving in archive
286Use this operation to @emph{move} members in an archive.
287
288The ordering of members in an archive can make a difference in how
289programs are linked using the library, if a symbol is defined in more
290than one member.
291
292If no modifiers are used with @code{m}, any members you name in the
293@var{member} arguments are moved to the @emph{end} of the archive;
294you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
295specified place instead.
296
297@item p
298@cindex printing from archive
299@emph{Print} the specified members of the archive, to the standard
300output file. If the @samp{v} modifier is specified, show the member
301name before copying its contents to standard output.
302
303If you specify no @var{member} arguments, all the files in the archive are
304printed.
305
306@item q
307@cindex quick append to archive
308@emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
309@var{archive}, without checking for replacement.
310
311The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
312operation; new members are always placed at the end of the archive.
313
c7c55b78 314The modifier @samp{v} makes @command{ar} list each file as it is appended.
252b5132
RH
315
316Since the point of this operation is speed, the archive's symbol table
317index is not updated, even if it already existed; you can use @samp{ar s} or
c7c55b78 318@command{ranlib} explicitly to update the symbol table index.
252b5132
RH
319
320However, too many different systems assume quick append rebuilds the
947ed062 321index, so @sc{gnu} @command{ar} implements @samp{q} as a synonym for @samp{r}.
252b5132
RH
322
323@item r
324@cindex replacement in archive
325Insert the files @var{member}@dots{} into @var{archive} (with
326@emph{replacement}). This operation differs from @samp{q} in that any
327previously existing members are deleted if their names match those being
328added.
329
c7c55b78 330If one of the files named in @var{member}@dots{} does not exist, @command{ar}
252b5132
RH
331displays an error message, and leaves undisturbed any existing members
332of the archive matching that name.
333
334By default, new members are added at the end of the file; but you may
335use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
336placement relative to some existing member.
337
338The modifier @samp{v} used with this operation elicits a line of
339output for each file inserted, along with one of the letters @samp{a} or
340@samp{r} to indicate whether the file was appended (no old member
341deleted) or replaced.
342
343@item t
344@cindex contents of archive
345Display a @emph{table} listing the contents of @var{archive}, or those
346of the files listed in @var{member}@dots{} that are present in the
347archive. Normally only the member name is shown; if you also want to
348see the modes (permissions), timestamp, owner, group, and size, you can
349request that by also specifying the @samp{v} modifier.
350
351If you do not specify a @var{member}, all files in the archive
352are listed.
353
354@cindex repeated names in archive
355@cindex name duplication in archive
356If there is more than one file with the same name (say, @samp{fie}) in
357an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
358first instance; to see them all, you must ask for a complete
359listing---in our example, @samp{ar t b.a}.
360@c WRS only; per Gumby, this is implementation-dependent, and in a more
361@c recent case in fact works the other way.
362
363@item x
364@cindex extract from archive
365@emph{Extract} members (named @var{member}) from the archive. You can
366use the @samp{v} modifier with this operation, to request that
c7c55b78 367@command{ar} list each name as it extracts it.
252b5132
RH
368
369If you do not specify a @var{member}, all files in the archive
370are extracted.
371
372@end table
373
374A number of modifiers (@var{mod}) may immediately follow the @var{p}
375keyletter, to specify variations on an operation's behavior:
376
c7c55b78 377@table @samp
252b5132
RH
378@item a
379@cindex relative placement in archive
380Add new files @emph{after} an existing member of the
381archive. If you use the modifier @samp{a}, the name of an existing archive
382member must be present as the @var{relpos} argument, before the
383@var{archive} specification.
384
385@item b
386Add new files @emph{before} an existing member of the
387archive. If you use the modifier @samp{b}, the name of an existing archive
388member must be present as the @var{relpos} argument, before the
389@var{archive} specification. (same as @samp{i}).
390
391@item c
392@cindex creating archives
393@emph{Create} the archive. The specified @var{archive} is always
394created if it did not exist, when you request an update. But a warning is
395issued unless you specify in advance that you expect to create it, by
396using this modifier.
397
398@item f
c7c55b78 399Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
252b5132 400names of any length. This will cause it to create archives which are
c7c55b78 401not compatible with the native @command{ar} program on some systems. If
252b5132
RH
402this is a concern, the @samp{f} modifier may be used to truncate file
403names when putting them in the archive.
404
405@item i
406Insert new files @emph{before} an existing member of the
407archive. If you use the modifier @samp{i}, the name of an existing archive
408member must be present as the @var{relpos} argument, before the
409@var{archive} specification. (same as @samp{b}).
410
411@item l
412This modifier is accepted but not used.
413@c whaffor ar l modifier??? presumably compat; with
414@c what???---doc@@cygnus.com, 25jan91
415
3de39064
ILT
416@item N
417Uses the @var{count} parameter. This is used if there are multiple
418entries in the archive with the same name. Extract or delete instance
419@var{count} of the given name from the archive.
420
252b5132
RH
421@item o
422@cindex dates in archive
423Preserve the @emph{original} dates of members when extracting them. If
424you do not specify this modifier, files extracted from the archive
425are stamped with the time of extraction.
426
3de39064
ILT
427@item P
428Use the full path name when matching names in the archive. @sc{gnu}
c7c55b78 429@command{ar} can not create an archive with a full path name (such archives
3de39064 430are not POSIX complaint), but other archive creators can. This option
c7c55b78 431will cause @sc{gnu} @command{ar} to match file names using a complete path
3de39064
ILT
432name, which can be convenient when extracting a single file from an
433archive created by another tool.
434
252b5132
RH
435@item s
436@cindex writing archive index
437Write an object-file index into the archive, or update an existing one,
438even if no other change is made to the archive. You may use this modifier
439flag either with any operation, or alone. Running @samp{ar s} on an
440archive is equivalent to running @samp{ranlib} on it.
441
442@item S
443@cindex not writing archive index
444Do not generate an archive symbol table. This can speed up building a
445large library in several steps. The resulting archive can not be used
446with the linker. In order to build a symbol table, you must omit the
447@samp{S} modifier on the last execution of @samp{ar}, or you must run
448@samp{ranlib} on the archive.
449
450@item u
451@cindex updating an archive
452Normally, @samp{ar r}@dots{} inserts all files
453listed into the archive. If you would like to insert @emph{only} those
454of the files you list that are newer than existing members of the same
455names, use this modifier. The @samp{u} modifier is allowed only for the
456operation @samp{r} (replace). In particular, the combination @samp{qu} is
457not allowed, since checking the timestamps would lose any speed
458advantage from the operation @samp{q}.
459
460@item v
461This modifier requests the @emph{verbose} version of an operation. Many
462operations display additional information, such as filenames processed,
463when the modifier @samp{v} is appended.
464
465@item V
c7c55b78 466This modifier shows the version number of @command{ar}.
252b5132
RH
467@end table
468
c7c55b78 469@command{ar} ignores an initial option spelt @samp{-X32_64}, for
6e800839 470compatibility with AIX. The behaviour produced by this option is the
947ed062 471default for @sc{gnu} @command{ar}. @command{ar} does not support any of the other
c7c55b78
NC
472@samp{-X} options; in particular, it does not support @option{-X32}
473which is the default for AIX @command{ar}.
6e800839 474
0285c67d
NC
475@c man end
476
477@ignore
478@c man begin SEEALSO ar
479nm(1), ranlib(1), and the Info entries for @file{binutils}.
480@c man end
481@end ignore
482
252b5132 483@node ar scripts
947ed062 484@section Controlling @command{ar} with a Script
252b5132
RH
485
486@smallexample
487ar -M [ <@var{script} ]
488@end smallexample
489
c7c55b78
NC
490@cindex MRI compatibility, @command{ar}
491@cindex scripts, @command{ar}
492If you use the single command-line option @samp{-M} with @command{ar}, you
252b5132 493can control its operation with a rudimentary command language. This
c7c55b78
NC
494form of @command{ar} operates interactively if standard input is coming
495directly from a terminal. During interactive use, @command{ar} prompts for
252b5132
RH
496input (the prompt is @samp{AR >}), and continues executing even after
497errors. If you redirect standard input to a script file, no prompts are
c7c55b78 498issued, and @command{ar} abandons execution (with a nonzero exit code)
252b5132
RH
499on any error.
500
c7c55b78 501The @command{ar} command language is @emph{not} designed to be equivalent
252b5132
RH
502to the command-line options; in fact, it provides somewhat less control
503over archives. The only purpose of the command language is to ease the
c7c55b78 504transition to @sc{gnu} @command{ar} for developers who already have scripts
252b5132
RH
505written for the MRI ``librarian'' program.
506
c7c55b78 507The syntax for the @command{ar} command language is straightforward:
252b5132
RH
508@itemize @bullet
509@item
510commands are recognized in upper or lower case; for example, @code{LIST}
511is the same as @code{list}. In the following descriptions, commands are
512shown in upper case for clarity.
513
514@item
515a single command may appear on each line; it is the first word on the
516line.
517
518@item
519empty lines are allowed, and have no effect.
520
521@item
522comments are allowed; text after either of the characters @samp{*}
523or @samp{;} is ignored.
524
525@item
c7c55b78 526Whenever you use a list of names as part of the argument to an @command{ar}
252b5132
RH
527command, you can separate the individual names with either commas or
528blanks. Commas are shown in the explanations below, for clarity.
529
530@item
531@samp{+} is used as a line continuation character; if @samp{+} appears
532at the end of a line, the text on the following line is considered part
533of the current command.
534@end itemize
535
c7c55b78
NC
536Here are the commands you can use in @command{ar} scripts, or when using
537@command{ar} interactively. Three of them have special significance:
252b5132
RH
538
539@code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
540a temporary file required for most of the other commands.
541
542@code{SAVE} commits the changes so far specified by the script. Prior
543to @code{SAVE}, commands affect only the temporary copy of the current
544archive.
545
546@table @code
547@item ADDLIB @var{archive}
548@itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
549Add all the contents of @var{archive} (or, if specified, each named
550@var{module} from @var{archive}) to the current archive.
551
552Requires prior use of @code{OPEN} or @code{CREATE}.
553
554@item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
555@c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
556@c else like "ar q..."
557Add each named @var{member} as a module in the current archive.
558
559Requires prior use of @code{OPEN} or @code{CREATE}.
560
561@item CLEAR
562Discard the contents of the current archive, canceling the effect of
563any operations since the last @code{SAVE}. May be executed (with no
564effect) even if no current archive is specified.
565
566@item CREATE @var{archive}
567Creates an archive, and makes it the current archive (required for many
568other commands). The new archive is created with a temporary name; it
569is not actually saved as @var{archive} until you use @code{SAVE}.
570You can overwrite existing archives; similarly, the contents of any
571existing file named @var{archive} will not be destroyed until @code{SAVE}.
572
573@item DELETE @var{module}, @var{module}, @dots{} @var{module}
574Delete each listed @var{module} from the current archive; equivalent to
575@samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
576
577Requires prior use of @code{OPEN} or @code{CREATE}.
578
579@item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
580@itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
581List each named @var{module} present in @var{archive}. The separate
582command @code{VERBOSE} specifies the form of the output: when verbose
583output is off, output is like that of @samp{ar -t @var{archive}
584@var{module}@dots{}}. When verbose output is on, the listing is like
585@samp{ar -tv @var{archive} @var{module}@dots{}}.
586
587Output normally goes to the standard output stream; however, if you
c7c55b78 588specify @var{outputfile} as a final argument, @command{ar} directs the
252b5132
RH
589output to that file.
590
591@item END
c7c55b78 592Exit from @command{ar}, with a @code{0} exit code to indicate successful
252b5132
RH
593completion. This command does not save the output file; if you have
594changed the current archive since the last @code{SAVE} command, those
595changes are lost.
596
597@item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
598Extract each named @var{module} from the current archive, writing them
599into the current directory as separate files. Equivalent to @samp{ar -x
600@var{archive} @var{module}@dots{}}.
601
602Requires prior use of @code{OPEN} or @code{CREATE}.
603
604@ignore
605@c FIXME Tokens but no commands???
606@item FULLDIR
607
608@item HELP
609@end ignore
610
611@item LIST
612Display full contents of the current archive, in ``verbose'' style
613regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
c7c55b78 614tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
252b5132
RH
615enhancement, rather than present for MRI compatibility.)
616
617Requires prior use of @code{OPEN} or @code{CREATE}.
618
619@item OPEN @var{archive}
620Opens an existing archive for use as the current archive (required for
621many other commands). Any changes as the result of subsequent commands
622will not actually affect @var{archive} until you next use @code{SAVE}.
623
624@item REPLACE @var{module}, @var{module}, @dots{} @var{module}
625In the current archive, replace each existing @var{module} (named in
626the @code{REPLACE} arguments) from files in the current working directory.
627To execute this command without errors, both the file, and the module in
628the current archive, must exist.
629
630Requires prior use of @code{OPEN} or @code{CREATE}.
631
632@item VERBOSE
633Toggle an internal flag governing the output from @code{DIRECTORY}.
634When the flag is on, @code{DIRECTORY} output matches output from
635@samp{ar -tv }@dots{}.
636
637@item SAVE
638Commit your changes to the current archive, and actually save it as a
639file with the name specified in the last @code{CREATE} or @code{OPEN}
640command.
641
642Requires prior use of @code{OPEN} or @code{CREATE}.
643
644@end table
645
646@iftex
647@node ld
648@chapter ld
649@cindex linker
650@kindex ld
c7c55b78 651The @sc{gnu} linker @command{ld} is now described in a separate manual.
252b5132
RH
652@xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
653@end iftex
654
655@node nm
656@chapter nm
657@cindex symbols
658@kindex nm
659
0285c67d
NC
660@c man title nm list symbols from object files
661
252b5132 662@smallexample
0285c67d 663@c man begin SYNOPSIS nm
c7c55b78
NC
664nm [@option{-a}|@option{--debug-syms}] [@option{-g}|@option{--extern-only}]
665 [@option{-B}] [@option{-C}|@option{--demangle}[=@var{style}]] [@option{-D}|@option{--dynamic}]
72797995 666 [@option{-S}|@option{--print-size}] [@option{-s}|@option{--print-armap}]
3c9458e9 667 [@option{-A}|@option{-o}|@option{--print-file-name}][@option{--special-syms}]
c7c55b78
NC
668 [@option{-n}|@option{-v}|@option{--numeric-sort}] [@option{-p}|@option{--no-sort}]
669 [@option{-r}|@option{--reverse-sort}] [@option{--size-sort}] [@option{-u}|@option{--undefined-only}]
670 [@option{-t} @var{radix}|@option{--radix=}@var{radix}] [@option{-P}|@option{--portability}]
671 [@option{--target=}@var{bfdname}] [@option{-f}@var{format}|@option{--format=}@var{format}]
672 [@option{--defined-only}] [@option{-l}|@option{--line-numbers}] [@option{--no-demangle}]
673 [@option{-V}|@option{--version}] [@option{-X 32_64}] [@option{--help}] [@var{objfile}@dots{}]
0285c67d 674@c man end
252b5132
RH
675@end smallexample
676
0285c67d 677@c man begin DESCRIPTION nm
c7c55b78
NC
678@sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
679If no object files are listed as arguments, @command{nm} assumes the file
252b5132
RH
680@file{a.out}.
681
c7c55b78 682For each symbol, @command{nm} shows:
252b5132
RH
683
684@itemize @bullet
685@item
686The symbol value, in the radix selected by options (see below), or
687hexadecimal by default.
688
689@item
690The symbol type. At least the following types are used; others are, as
691well, depending on the object file format. If lowercase, the symbol is
692local; if uppercase, the symbol is global (external).
693
694@c Some more detail on exactly what these symbol types are used for
695@c would be nice.
696@table @code
697@item A
698The symbol's value is absolute, and will not be changed by further
699linking.
700
701@item B
702The symbol is in the uninitialized data section (known as BSS).
703
704@item C
705The symbol is common. Common symbols are uninitialized data. When
706linking, multiple common symbols may appear with the same name. If the
707symbol is defined anywhere, the common symbols are treated as undefined
0285c67d
NC
708references.
709@ifclear man
710For more details on common symbols, see the discussion of
252b5132 711--warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
0879a67a 712@end ifclear
252b5132
RH
713
714@item D
715The symbol is in the initialized data section.
716
717@item G
718The symbol is in an initialized data section for small objects. Some
719object file formats permit more efficient access to small data objects,
720such as a global int variable as opposed to a large global array.
721
722@item I
947ed062 723The symbol is an indirect reference to another symbol. This is a @sc{gnu}
252b5132
RH
724extension to the a.out object file format which is rarely used.
725
726@item N
727The symbol is a debugging symbol.
728
729@item R
730The symbol is in a read only data section.
731
732@item S
733The symbol is in an uninitialized data section for small objects.
734
735@item T
736The symbol is in the text (code) section.
737
738@item U
739The symbol is undefined.
740
fad6fcbb
NC
741@item V
742The symbol is a weak object. When a weak defined symbol is linked with
743a normal defined symbol, the normal defined symbol is used with no error.
744When a weak undefined symbol is linked and the symbol is not defined,
745the value of the weak symbol becomes zero with no error.
746
252b5132 747@item W
fad6fcbb
NC
748The symbol is a weak symbol that has not been specifically tagged as a
749weak object symbol. When a weak defined symbol is linked with a normal
750defined symbol, the normal defined symbol is used with no error.
751When a weak undefined symbol is linked and the symbol is not defined,
c87db184 752the value of the symbol is determined in a system-specific manner without
977cdf5a
NC
753error. On some systems, uppercase indicates that a default value has been
754specified.
755
252b5132
RH
756
757@item -
758The symbol is a stabs symbol in an a.out object file. In this case, the
759next values printed are the stabs other field, the stabs desc field, and
c7c55b78
NC
760the stab type. Stabs symbols are used to hold debugging information.
761@ifclear man
762For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
252b5132 763``stabs'' debug format}.
c7c55b78 764@end ifclear
252b5132
RH
765
766@item ?
767The symbol type is unknown, or object file format specific.
768@end table
769
770@item
771The symbol name.
772@end itemize
773
0285c67d
NC
774@c man end
775
776@c man begin OPTIONS nm
252b5132
RH
777The long and short forms of options, shown here as alternatives, are
778equivalent.
779
c7c55b78 780@table @env
252b5132
RH
781@item -A
782@itemx -o
783@itemx --print-file-name
784@cindex input file name
785@cindex file name
786@cindex source file name
f20a759a 787Precede each symbol by the name of the input file (or archive member)
252b5132
RH
788in which it was found, rather than identifying the input file once only,
789before all of its symbols.
790
791@item -a
792@itemx --debug-syms
793@cindex debugging symbols
794Display all symbols, even debugger-only symbols; normally these are not
795listed.
796
797@item -B
c7c55b78
NC
798@cindex @command{nm} format
799@cindex @command{nm} compatibility
800The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
252b5132
RH
801
802@item -C
28c309a2 803@itemx --demangle[=@var{style}]
252b5132
RH
804@cindex demangling in nm
805Decode (@dfn{demangle}) low-level symbol names into user-level names.
806Besides removing any initial underscore prepended by the system, this
28c309a2
NC
807makes C++ function names readable. Different compilers have different
808mangling styles. The optional demangling style argument can be used to
809choose an appropriate demangling style for your compiler. @xref{c++filt},
810for more information on demangling.
252b5132
RH
811
812@item --no-demangle
813Do not demangle low-level symbol names. This is the default.
814
815@item -D
816@itemx --dynamic
817@cindex dynamic symbols
818Display the dynamic symbols rather than the normal symbols. This is
819only meaningful for dynamic objects, such as certain types of shared
820libraries.
821
822@item -f @var{format}
823@itemx --format=@var{format}
c7c55b78
NC
824@cindex @command{nm} format
825@cindex @command{nm} compatibility
252b5132
RH
826Use the output format @var{format}, which can be @code{bsd},
827@code{sysv}, or @code{posix}. The default is @code{bsd}.
828Only the first character of @var{format} is significant; it can be
829either upper or lower case.
830
831@item -g
832@itemx --extern-only
833@cindex external symbols
834Display only external symbols.
835
836@item -l
837@itemx --line-numbers
838@cindex symbol line numbers
839For each symbol, use debugging information to try to find a filename and
840line number. For a defined symbol, look for the line number of the
841address of the symbol. For an undefined symbol, look for the line
842number of a relocation entry which refers to the symbol. If line number
843information can be found, print it after the other symbol information.
844
845@item -n
846@itemx -v
847@itemx --numeric-sort
848Sort symbols numerically by their addresses, rather than alphabetically
849by their names.
850
851@item -p
852@itemx --no-sort
853@cindex sorting symbols
854Do not bother to sort the symbols in any order; print them in the order
855encountered.
856
857@item -P
858@itemx --portability
859Use the POSIX.2 standard output format instead of the default format.
860Equivalent to @samp{-f posix}.
861
72797995
L
862@item -S
863@itemx --print-size
06a30c77 864Print size, not the value, of defined symbols for the @code{bsd} output format.
72797995 865
252b5132
RH
866@item -s
867@itemx --print-armap
868@cindex symbol index, listing
869When listing symbols from archive members, include the index: a mapping
c7c55b78 870(stored in the archive by @command{ar} or @command{ranlib}) of which modules
252b5132
RH
871contain definitions for which names.
872
873@item -r
874@itemx --reverse-sort
875Reverse the order of the sort (whether numeric or alphabetic); let the
876last come first.
877
878@item --size-sort
879Sort symbols by size. The size is computed as the difference between
880the value of the symbol and the value of the symbol with the next higher
06a30c77 881value. If the @code{bsd} output format is used the size of the symbol
76ed1927
NC
882is printed, rather than the value, and @samp{-S} must be used in order
883both size and value to be printed.
252b5132 884
3c9458e9
NC
885@item --special-syms
886Display symbols which have a target-specific special meaning. These
887symbols are usually used by the target for some special processing and
888are not normally helpful when included included in the normal symbol
889lists. For example for ARM targets this option would skip the mapping
890symbols used to mark transistions between ARM code, THUMB code and
891data.
892
252b5132
RH
893@item -t @var{radix}
894@itemx --radix=@var{radix}
895Use @var{radix} as the radix for printing the symbol values. It must be
896@samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
897
898@item --target=@var{bfdname}
899@cindex object code format
900Specify an object code format other than your system's default format.
901@xref{Target Selection}, for more information.
902
903@item -u
904@itemx --undefined-only
905@cindex external symbols
906@cindex undefined symbols
907Display only undefined symbols (those external to each object file).
908
909@item --defined-only
910@cindex external symbols
911@cindex undefined symbols
912Display only defined symbols for each object file.
913
914@item -V
915@itemx --version
c7c55b78 916Show the version number of @command{nm} and exit.
252b5132 917
6e800839
GK
918@item -X
919This option is ignored for compatibility with the AIX version of
c7c55b78
NC
920@command{nm}. It takes one parameter which must be the string
921@option{32_64}. The default mode of AIX @command{nm} corresponds
922to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
6e800839 923
252b5132 924@item --help
c7c55b78 925Show a summary of the options to @command{nm} and exit.
252b5132
RH
926@end table
927
0285c67d
NC
928@c man end
929
930@ignore
931@c man begin SEEALSO nm
932ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
933@c man end
934@end ignore
935
252b5132
RH
936@node objcopy
937@chapter objcopy
938
0285c67d
NC
939@c man title objcopy copy and translate object files
940
252b5132 941@smallexample
0285c67d 942@c man begin SYNOPSIS objcopy
c7c55b78
NC
943objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
944 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
945 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
946 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
2593f09a
NC
947 [@option{-S}|@option{--strip-all}]
948 [@option{-g}|@option{--strip-debug}]
c7c55b78
NC
949 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
950 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
bcf32829 951 [@option{--strip-unneeded-symbol=}@var{symbolname}]
c7c55b78
NC
952 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
953 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
7b4a0685 954 [@option{--globalize-symbol=}@var{symbolname}]
c7c55b78 955 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
5fe11841 956 [@option{-w}|@option{--wildcard}]
2593f09a
NC
957 [@option{-x}|@option{--discard-all}]
958 [@option{-X}|@option{--discard-locals}]
c7c55b78
NC
959 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
960 [@option{-i} @var{interleave}|@option{--interleave=}@var{interleave}]
961 [@option{-j} @var{sectionname}|@option{--only-section=}@var{sectionname}]
962 [@option{-R} @var{sectionname}|@option{--remove-section=}@var{sectionname}]
963 [@option{-p}|@option{--preserve-dates}]
964 [@option{--debugging}]
2593f09a
NC
965 [@option{--gap-fill=}@var{val}]
966 [@option{--pad-to=}@var{address}]
967 [@option{--set-start=}@var{val}]
968 [@option{--adjust-start=}@var{incr}]
c7c55b78
NC
969 [@option{--change-addresses=}@var{incr}]
970 [@option{--change-section-address} @var{section}@{=,+,-@}@var{val}]
971 [@option{--change-section-lma} @var{section}@{=,+,-@}@var{val}]
972 [@option{--change-section-vma} @var{section}@{=,+,-@}@var{val}]
973 [@option{--change-warnings}] [@option{--no-change-warnings}]
974 [@option{--set-section-flags} @var{section}=@var{flags}]
975 [@option{--add-section} @var{sectionname}=@var{filename}]
976 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
2593f09a
NC
977 [@option{--change-leading-char}] [@option{--remove-leading-char}]
978 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
979 [@option{--redefine-sym} @var{old}=@var{new}]
980 [@option{--redefine-syms=}@var{filename}]
c7c55b78
NC
981 [@option{--weaken}]
982 [@option{--keep-symbols=}@var{filename}]
983 [@option{--strip-symbols=}@var{filename}]
bcf32829 984 [@option{--strip-unneeded-symbols=}@var{filename}]
c7c55b78
NC
985 [@option{--keep-global-symbols=}@var{filename}]
986 [@option{--localize-symbols=}@var{filename}]
7b4a0685 987 [@option{--globalize-symbols=}@var{filename}]
c7c55b78 988 [@option{--weaken-symbols=}@var{filename}]
c51238bc
DA
989 [@option{--alt-machine-code=}@var{index}]
990 [@option{--prefix-symbols=}@var{string}]
991 [@option{--prefix-sections=}@var{string}]
992 [@option{--prefix-alloc-sections=}@var{string}]
ed1653a7
NC
993 [@option{--add-gnu-debuglink=}@var{path-to-file}]
994 [@option{--only-keep-debug}]
4087920c
MR
995 [@option{--writable-text}]
996 [@option{--readonly-text}]
997 [@option{--pure}]
998 [@option{--impure}]
c7c55b78
NC
999 [@option{-v}|@option{--verbose}]
1000 [@option{-V}|@option{--version}]
7c29036b 1001 [@option{--help}] [@option{--info}]
252b5132 1002 @var{infile} [@var{outfile}]
0285c67d 1003@c man end
252b5132
RH
1004@end smallexample
1005
0285c67d 1006@c man begin DESCRIPTION objcopy
c7c55b78
NC
1007The @sc{gnu} @command{objcopy} utility copies the contents of an object
1008file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
252b5132
RH
1009read and write the object files. It can write the destination object
1010file in a format different from that of the source object file. The
c7c55b78
NC
1011exact behavior of @command{objcopy} is controlled by command-line options.
1012Note that @command{objcopy} should be able to copy a fully linked file
ccd13d18
L
1013between any two formats. However, copying a relocatable object file
1014between any two formats may not work as expected.
252b5132 1015
c7c55b78
NC
1016@command{objcopy} creates temporary files to do its translations and
1017deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
252b5132
RH
1018translation work; it has access to all the formats described in @sc{bfd}
1019and thus is able to recognize most formats without being told
1020explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1021
c7c55b78 1022@command{objcopy} can be used to generate S-records by using an output
252b5132
RH
1023target of @samp{srec} (e.g., use @samp{-O srec}).
1024
c7c55b78
NC
1025@command{objcopy} can be used to generate a raw binary file by using an
1026output target of @samp{binary} (e.g., use @option{-O binary}). When
1027@command{objcopy} generates a raw binary file, it will essentially produce
252b5132
RH
1028a memory dump of the contents of the input object file. All symbols and
1029relocation information will be discarded. The memory dump will start at
1030the load address of the lowest section copied into the output file.
1031
1032When generating an S-record or a raw binary file, it may be helpful to
c7c55b78
NC
1033use @option{-S} to remove sections containing debugging information. In
1034some cases @option{-R} will be useful to remove sections which contain
f20a759a 1035information that is not needed by the binary file.
252b5132 1036
947ed062
NC
1037Note---@command{objcopy} is not able to change the endianness of its input
1038files. If the input format has an endianness (some formats do not),
c7c55b78 1039@command{objcopy} can only copy the inputs into file formats that have the
947ed062 1040same endianness or which have no endianness (e.g., @samp{srec}).
18356cf2 1041
0285c67d
NC
1042@c man end
1043
1044@c man begin OPTIONS objcopy
1045
c7c55b78 1046@table @env
252b5132
RH
1047@item @var{infile}
1048@itemx @var{outfile}
f20a759a 1049The input and output files, respectively.
c7c55b78 1050If you do not specify @var{outfile}, @command{objcopy} creates a
252b5132
RH
1051temporary file and destructively renames the result with
1052the name of @var{infile}.
1053
c7c55b78 1054@item -I @var{bfdname}
252b5132
RH
1055@itemx --input-target=@var{bfdname}
1056Consider the source file's object format to be @var{bfdname}, rather than
1057attempting to deduce it. @xref{Target Selection}, for more information.
1058
1059@item -O @var{bfdname}
1060@itemx --output-target=@var{bfdname}
1061Write the output file using the object format @var{bfdname}.
1062@xref{Target Selection}, for more information.
1063
1064@item -F @var{bfdname}
1065@itemx --target=@var{bfdname}
1066Use @var{bfdname} as the object format for both the input and the output
1067file; i.e., simply transfer data from source to destination with no
1068translation. @xref{Target Selection}, for more information.
1069
43a0748c
NC
1070@item -B @var{bfdarch}
1071@itemx --binary-architecture=@var{bfdarch}
1072Useful when transforming a raw binary input file into an object file.
1073In this case the output architecture can be set to @var{bfdarch}. This
1074option will be ignored if the input file has a known @var{bfdarch}. You
1075can access this binary data inside a program by referencing the special
1076symbols that are created by the conversion process. These symbols are
1077called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1078_binary_@var{objfile}_size. e.g. you can transform a picture file into
1079an object file and then access it in your code using these symbols.
1080
f91ea849
ILT
1081@item -j @var{sectionname}
1082@itemx --only-section=@var{sectionname}
1083Copy only the named section from the input file to the output file.
1084This option may be given more than once. Note that using this option
1085inappropriately may make the output file unusable.
1086
252b5132
RH
1087@item -R @var{sectionname}
1088@itemx --remove-section=@var{sectionname}
1089Remove any section named @var{sectionname} from the output file. This
1090option may be given more than once. Note that using this option
1091inappropriately may make the output file unusable.
1092
1093@item -S
1094@itemx --strip-all
1095Do not copy relocation and symbol information from the source file.
1096
1097@item -g
1098@itemx --strip-debug
2593f09a 1099Do not copy debugging symbols or sections from the source file.
252b5132
RH
1100
1101@item --strip-unneeded
1102Strip all symbols that are not needed for relocation processing.
1103
1104@item -K @var{symbolname}
1105@itemx --keep-symbol=@var{symbolname}
e7f918ad
NC
1106When stripping symbols, keep symbol @var{symbolname} even if it would
1107normally be stripped. This option may be given more than once.
252b5132
RH
1108
1109@item -N @var{symbolname}
1110@itemx --strip-symbol=@var{symbolname}
1111Do not copy symbol @var{symbolname} from the source file. This option
1112may be given more than once.
1113
bcf32829
JB
1114@item --strip-unneeded-symbol=@var{symbolname}
1115Do not copy symbol @var{symbolname} from the source file unless it is needed
1116by a relocation. This option may be given more than once.
1117
16b2b71c
NC
1118@item -G @var{symbolname}
1119@itemx --keep-global-symbol=@var{symbolname}
1120Keep only symbol @var{symbolname} global. Make all other symbols local
1121to the file, so that they are not visible externally. This option may
1122be given more than once.
1123
252b5132
RH
1124@item -L @var{symbolname}
1125@itemx --localize-symbol=@var{symbolname}
1126Make symbol @var{symbolname} local to the file, so that it is not
1127visible externally. This option may be given more than once.
1128
1129@item -W @var{symbolname}
1130@itemx --weaken-symbol=@var{symbolname}
1131Make symbol @var{symbolname} weak. This option may be given more than once.
1132
7b4a0685
NC
1133@item --globalize-symbol=@var{symbolname}
1134Give symbol @var{symbolname} global scoping so that it is visible
1135outside of the file in which it is defined. This option may be given
1136more than once.
1137
5fe11841
NC
1138@item -w
1139@itemx --wildcard
1140Permit regular expressions in @var{symbolname}s used in other command
1141line options. The question mark (?), asterisk (*), backslash (\) and
1142square brackets ([]) operators can be used anywhere in the symbol
1143name. If the first character of the symbol name is the exclamation
1144point (!) then the sense of the switch is reversed for that symbol.
1145For example:
1146
1147@smallexample
1148 -w -W !foo -W fo*
1149@end smallexample
1150
1151would cause objcopy to weaken all symbols that start with ``fo''
1152except for the symbol ``foo''.
1153
252b5132
RH
1154@item -x
1155@itemx --discard-all
1156Do not copy non-global symbols from the source file.
1157@c FIXME any reason to prefer "non-global" to "local" here?
1158
1159@item -X
1160@itemx --discard-locals
1161Do not copy compiler-generated local symbols.
1162(These usually start with @samp{L} or @samp{.}.)
1163
1164@item -b @var{byte}
1165@itemx --byte=@var{byte}
1166Keep only every @var{byte}th byte of the input file (header data is not
1167affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
c7c55b78 1168where @var{interleave} is given by the @option{-i} or @option{--interleave}
252b5132
RH
1169option, or the default of 4. This option is useful for creating files
1170to program @sc{rom}. It is typically used with an @code{srec} output
1171target.
1172
1173@item -i @var{interleave}
1174@itemx --interleave=@var{interleave}
1175Only copy one out of every @var{interleave} bytes. Select which byte to
c7c55b78
NC
1176copy with the @option{-b} or @option{--byte} option. The default is 4.
1177@command{objcopy} ignores this option if you do not specify either @option{-b} or
1178@option{--byte}.
252b5132
RH
1179
1180@item -p
1181@itemx --preserve-dates
1182Set the access and modification dates of the output file to be the same
1183as those of the input file.
1184
1185@item --debugging
1186Convert debugging information, if possible. This is not the default
1187because only certain debugging formats are supported, and the
1188conversion process can be time consuming.
1189
1190@item --gap-fill @var{val}
1191Fill gaps between sections with @var{val}. This operation applies to
1192the @emph{load address} (LMA) of the sections. It is done by increasing
1193the size of the section with the lower address, and filling in the extra
1194space created with @var{val}.
1195
1196@item --pad-to @var{address}
1197Pad the output file up to the load address @var{address}. This is
1198done by increasing the size of the last section. The extra space is
c7c55b78 1199filled in with the value specified by @option{--gap-fill} (default zero).
252b5132
RH
1200
1201@item --set-start @var{val}
f20a759a 1202Set the start address of the new file to @var{val}. Not all object file
252b5132
RH
1203formats support setting the start address.
1204
1205@item --change-start @var{incr}
1206@itemx --adjust-start @var{incr}
1207@cindex changing start address
1208Change the start address by adding @var{incr}. Not all object file
1209formats support setting the start address.
1210
1211@item --change-addresses @var{incr}
1212@itemx --adjust-vma @var{incr}
1213@cindex changing object addresses
1214Change the VMA and LMA addresses of all sections, as well as the start
1215address, by adding @var{incr}. Some object file formats do not permit
1216section addresses to be changed arbitrarily. Note that this does not
1217relocate the sections; if the program expects sections to be loaded at a
1218certain address, and this option is used to change the sections such
1219that they are loaded at a different address, the program may fail.
1220
1221@item --change-section-address @var{section}@{=,+,-@}@var{val}
1222@itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1223@cindex changing section address
1224Set or change both the VMA address and the LMA address of the named
1225@var{section}. If @samp{=} is used, the section address is set to
1226@var{val}. Otherwise, @var{val} is added to or subtracted from the
c7c55b78 1227section address. See the comments under @option{--change-addresses},
252b5132 1228above. If @var{section} does not exist in the input file, a warning will
c7c55b78 1229be issued, unless @option{--no-change-warnings} is used.
252b5132
RH
1230
1231@item --change-section-lma @var{section}@{=,+,-@}@var{val}
1232@cindex changing section LMA
1233Set or change the LMA address of the named @var{section}. The LMA
1234address is the address where the section will be loaded into memory at
1235program load time. Normally this is the same as the VMA address, which
1236is the address of the section at program run time, but on some systems,
1237especially those where a program is held in ROM, the two can be
1238different. If @samp{=} is used, the section address is set to
1239@var{val}. Otherwise, @var{val} is added to or subtracted from the
c7c55b78 1240section address. See the comments under @option{--change-addresses},
252b5132 1241above. If @var{section} does not exist in the input file, a warning
c7c55b78 1242will be issued, unless @option{--no-change-warnings} is used.
252b5132
RH
1243
1244@item --change-section-vma @var{section}@{=,+,-@}@var{val}
1245@cindex changing section VMA
1246Set or change the VMA address of the named @var{section}. The VMA
1247address is the address where the section will be located once the
1248program has started executing. Normally this is the same as the LMA
1249address, which is the address where the section will be loaded into
1250memory, but on some systems, especially those where a program is held in
1251ROM, the two can be different. If @samp{=} is used, the section address
1252is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1253from the section address. See the comments under
c7c55b78 1254@option{--change-addresses}, above. If @var{section} does not exist in
252b5132 1255the input file, a warning will be issued, unless
c7c55b78 1256@option{--no-change-warnings} is used.
252b5132
RH
1257
1258@item --change-warnings
1259@itemx --adjust-warnings
c7c55b78
NC
1260If @option{--change-section-address} or @option{--change-section-lma} or
1261@option{--change-section-vma} is used, and the named section does not
252b5132
RH
1262exist, issue a warning. This is the default.
1263
1264@item --no-change-warnings
1265@itemx --no-adjust-warnings
c7c55b78
NC
1266Do not issue a warning if @option{--change-section-address} or
1267@option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
252b5132
RH
1268if the named section does not exist.
1269
1270@item --set-section-flags @var{section}=@var{flags}
1271Set the flags for the named section. The @var{flags} argument is a
1272comma separated string of flag names. The recognized names are
3994e2c6
ILT
1273@samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1274@samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1275@samp{debug}. You can set the @samp{contents} flag for a section which
1276does not have contents, but it is not meaningful to clear the
1277@samp{contents} flag of a section which does have contents--just remove
1278the section instead. Not all flags are meaningful for all object file
1279formats.
252b5132
RH
1280
1281@item --add-section @var{sectionname}=@var{filename}
1282Add a new section named @var{sectionname} while copying the file. The
1283contents of the new section are taken from the file @var{filename}. The
1284size of the section will be the size of the file. This option only
1285works on file formats which can support sections with arbitrary names.
1286
594ef5db
NC
1287@item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1288Rename a section from @var{oldname} to @var{newname}, optionally
1289changing the section's flags to @var{flags} in the process. This has
1290the advantage over usng a linker script to perform the rename in that
1291the output stays as an object file and does not become a linked
1292executable.
1293
1294This option is particularly helpful when the input format is binary,
1295since this will always create a section called .data. If for example,
1296you wanted instead to create a section called .rodata containing binary
1297data you could use the following command line to achieve it:
1298
1299@smallexample
1300 objcopy -I binary -O <output_format> -B <architecture> \
1301 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1302 <input_binary_file> <output_object_file>
1303@end smallexample
1304
252b5132
RH
1305@item --change-leading-char
1306Some object file formats use special characters at the start of
1307symbols. The most common such character is underscore, which compilers
c7c55b78 1308often add before every symbol. This option tells @command{objcopy} to
252b5132
RH
1309change the leading character of every symbol when it converts between
1310object file formats. If the object file formats use the same leading
1311character, this option has no effect. Otherwise, it will add a
1312character, or remove a character, or change a character, as
1313appropriate.
1314
1315@item --remove-leading-char
1316If the first character of a global symbol is a special symbol leading
1317character used by the object file format, remove the character. The
1318most common symbol leading character is underscore. This option will
1319remove a leading underscore from all global symbols. This can be useful
1320if you want to link together objects of different file formats with
1321different conventions for symbol names. This is different from
c7c55b78 1322@option{--change-leading-char} because it always changes the symbol name
252b5132
RH
1323when appropriate, regardless of the object file format of the output
1324file.
1325
420496c1
NC
1326@item --srec-len=@var{ival}
1327Meaningful only for srec output. Set the maximum length of the Srecords
1328being produced to @var{ival}. This length covers both address, data and
1329crc fields.
1330
1331@item --srec-forceS3
1332Meaningful only for srec output. Avoid generation of S1/S2 records,
1333creating S3-only record format.
1334
57938635
AM
1335@item --redefine-sym @var{old}=@var{new}
1336Change the name of a symbol @var{old}, to @var{new}. This can be useful
1337when one is trying link two things together for which you have no
1338source, and there are name collisions.
1339
92991082
JT
1340@item --redefine-syms=@var{filename}
1341Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1342listed in the file @var{filename}. @var{filename} is simply a flat file,
1343with one symbol pair per line. Line comments may be introduced by the hash
1344character. This option may be given more than once.
1345
252b5132
RH
1346@item --weaken
1347Change all global symbols in the file to be weak. This can be useful
1348when building an object which will be linked against other objects using
c7c55b78 1349the @option{-R} option to the linker. This option is only effective when
252b5132
RH
1350using an object file format which supports weak symbols.
1351
16b2b71c 1352@item --keep-symbols=@var{filename}
c7c55b78 1353Apply @option{--keep-symbol} option to each symbol listed in the file
16b2b71c
NC
1354@var{filename}. @var{filename} is simply a flat file, with one symbol
1355name per line. Line comments may be introduced by the hash character.
1356This option may be given more than once.
1357
1358@item --strip-symbols=@var{filename}
c7c55b78 1359Apply @option{--strip-symbol} option to each symbol listed in the file
16b2b71c
NC
1360@var{filename}. @var{filename} is simply a flat file, with one symbol
1361name per line. Line comments may be introduced by the hash character.
1362This option may be given more than once.
1363
bcf32829
JB
1364@item --strip-unneeded-symbols=@var{filename}
1365Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1366the file @var{filename}. @var{filename} is simply a flat file, with one
1367symbol name per line. Line comments may be introduced by the hash
1368character. This option may be given more than once.
1369
16b2b71c 1370@item --keep-global-symbols=@var{filename}
c7c55b78 1371Apply @option{--keep-global-symbol} option to each symbol listed in the
16b2b71c
NC
1372file @var{filename}. @var{filename} is simply a flat file, with one
1373symbol name per line. Line comments may be introduced by the hash
1374character. This option may be given more than once.
1375
1376@item --localize-symbols=@var{filename}
c7c55b78 1377Apply @option{--localize-symbol} option to each symbol listed in the file
16b2b71c
NC
1378@var{filename}. @var{filename} is simply a flat file, with one symbol
1379name per line. Line comments may be introduced by the hash character.
1380This option may be given more than once.
1381
7b4a0685
NC
1382@item --globalize-symbols=@var{filename}
1383Apply @option{--globalize-symbol} option to each symbol listed in the file
1384@var{filename}. @var{filename} is simply a flat file, with one symbol
1385name per line. Line comments may be introduced by the hash character.
1386This option may be given more than once.
1387
16b2b71c 1388@item --weaken-symbols=@var{filename}
c7c55b78 1389Apply @option{--weaken-symbol} option to each symbol listed in the file
16b2b71c
NC
1390@var{filename}. @var{filename} is simply a flat file, with one symbol
1391name per line. Line comments may be introduced by the hash character.
1392This option may be given more than once.
1393
1ae8b3d2
AO
1394@item --alt-machine-code=@var{index}
1395If the output architecture has alternate machine codes, use the
1396@var{index}th code instead of the default one. This is useful in case
1397a machine is assigned an official code and the tool-chain adopts the
1398new code, but other applications still depend on the original code
1399being used.
1400
4087920c
MR
1401@item --writable-text
1402Mark the output text as writable. This option isn't meaningful for all
1403object file formats.
1404
1405@item --readonly-text
1406Make the output text write protected. This option isn't meaningful for all
1407object file formats.
1408
1409@item --pure
1410Mark the output file as demand paged. This option isn't meaningful for all
1411object file formats.
1412
1413@item --impure
1414Mark the output file as impure. This option isn't meaningful for all
1415object file formats.
1416
d7fb0dd2
NC
1417@item --prefix-symbols=@var{string}
1418Prefix all symbols in the output file with @var{string}.
1419
1420@item --prefix-sections=@var{string}
1421Prefix all section names in the output file with @var{string}.
1422
1423@item --prefix-alloc-sections=@var{string}
1424Prefix all the names of all allocated sections in the output file with
1425@var{string}.
1426
ed1653a7
NC
1427@item --add-gnu-debuglink=@var{path-to-file}
1428Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
1429and adds it to the output file.
1430
1431@item --only-keep-debug
36d3b955
MR
1432Strip a file, removing contents of any sections that would not be
1433stripped by @option{--strip-debug} and leaving the debugging sections
1434intact.
ed1653a7
NC
1435
1436The intention is that this option will be used in conjunction with
1437@option{--add-gnu-debuglink} to create a two part executable. One a
1438stripped binary which will occupy less space in RAM and in a
1439distribution and the second a debugging information file which is only
1440needed if debugging abilities are required. The suggested procedure
1441to create these files is as follows:
1442
1443@enumerate
1444@item Link the executable as normal. Assuming that is is called
1445@code{foo} then...
1446@item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1447create a file containing the debugging info.
1448@item Run @code{objcopy --strip-debug foo} to create a
1449stripped executable.
1450@item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1451to add a link to the debugging info into the stripped executable.
1452@end enumerate
1453
1454Note - the choice of @code{.dbg} as an extension for the debug info
1455file is arbitrary. Also the @code{--only-keep-debug} step is
1456optional. You could instead do this:
1457
1458@enumerate
1459@item Link the executable as normal.
1460@item Copy @code{foo} to @code{foo.full}
1461@item Run @code{objcopy --strip-debug foo}
1462@item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1463@end enumerate
1464
36d3b955 1465i.e. the file pointed to by the @option{--add-gnu-debuglink} can be the
ed1653a7
NC
1466full executable. It does not have to be a file created by the
1467@option{--only-keep-debug} switch.
1468
252b5132
RH
1469@item -V
1470@itemx --version
c7c55b78 1471Show the version number of @command{objcopy}.
252b5132
RH
1472
1473@item -v
1474@itemx --verbose
1475Verbose output: list all object files modified. In the case of
1476archives, @samp{objcopy -V} lists all members of the archive.
1477
1478@item --help
c7c55b78 1479Show a summary of the options to @command{objcopy}.
7c29036b
NC
1480
1481@item --info
1482Display a list showing all architectures and object formats available.
252b5132
RH
1483@end table
1484
0285c67d
NC
1485@c man end
1486
1487@ignore
1488@c man begin SEEALSO objcopy
1489ld(1), objdump(1), and the Info entries for @file{binutils}.
1490@c man end
1491@end ignore
1492
252b5132
RH
1493@node objdump
1494@chapter objdump
1495
1496@cindex object file information
1497@kindex objdump
1498
0285c67d
NC
1499@c man title objdump display information from object files.
1500
252b5132 1501@smallexample
0285c67d 1502@c man begin SYNOPSIS objdump
c7c55b78
NC
1503objdump [@option{-a}|@option{--archive-headers}]
1504 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1505 [@option{-C}|@option{--demangle}[=@var{style}] ]
1506 [@option{-d}|@option{--disassemble}]
1507 [@option{-D}|@option{--disassemble-all}]
1508 [@option{-z}|@option{--disassemble-zeroes}]
1509 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1510 [@option{-f}|@option{--file-headers}]
1511 [@option{--file-start-context}]
1512 [@option{-g}|@option{--debugging}]
51cdc6e0 1513 [@option{-e}|@option{--debugging-tags}]
c7c55b78
NC
1514 [@option{-h}|@option{--section-headers}|@option{--headers}]
1515 [@option{-i}|@option{--info}]
1516 [@option{-j} @var{section}|@option{--section=}@var{section}]
1517 [@option{-l}|@option{--line-numbers}]
1518 [@option{-S}|@option{--source}]
1519 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1520 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1521 [@option{-p}|@option{--private-headers}]
1522 [@option{-r}|@option{--reloc}]
1523 [@option{-R}|@option{--dynamic-reloc}]
1524 [@option{-s}|@option{--full-contents}]
4de2ad99 1525 [@option{-W}|@option{--dwarf}]
c7c55b78
NC
1526 [@option{-G}|@option{--stabs}]
1527 [@option{-t}|@option{--syms}]
1528 [@option{-T}|@option{--dynamic-syms}]
1529 [@option{-x}|@option{--all-headers}]
1530 [@option{-w}|@option{--wide}]
1531 [@option{--start-address=}@var{address}]
1532 [@option{--stop-address=}@var{address}]
1533 [@option{--prefix-addresses}]
1534 [@option{--[no-]show-raw-insn}]
1535 [@option{--adjust-vma=}@var{offset}]
3c9458e9 1536 [@option{--special-syms}]
c7c55b78
NC
1537 [@option{-V}|@option{--version}]
1538 [@option{-H}|@option{--help}]
252b5132 1539 @var{objfile}@dots{}
0285c67d 1540@c man end
252b5132
RH
1541@end smallexample
1542
0285c67d
NC
1543@c man begin DESCRIPTION objdump
1544
c7c55b78 1545@command{objdump} displays information about one or more object files.
252b5132
RH
1546The options control what particular information to display. This
1547information is mostly useful to programmers who are working on the
1548compilation tools, as opposed to programmers who just want their
1549program to compile and work.
1550
1551@var{objfile}@dots{} are the object files to be examined. When you
c7c55b78 1552specify archives, @command{objdump} shows information on each of the member
252b5132
RH
1553object files.
1554
0285c67d
NC
1555@c man end
1556
1557@c man begin OPTIONS objdump
1558
252b5132 1559The long and short forms of options, shown here as alternatives, are
1dada9c5 1560equivalent. At least one option from the list
155e0d23 1561@option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
252b5132 1562
c7c55b78 1563@table @env
252b5132
RH
1564@item -a
1565@itemx --archive-header
1566@cindex archive headers
1567If any of the @var{objfile} files are archives, display the archive
1568header information (in a format similar to @samp{ls -l}). Besides the
1569information you could list with @samp{ar tv}, @samp{objdump -a} shows
1570the object file format of each archive member.
1571
1572@item --adjust-vma=@var{offset}
1573@cindex section addresses in objdump
1574@cindex VMA in objdump
1575When dumping information, first add @var{offset} to all the section
1576addresses. This is useful if the section addresses do not correspond to
1577the symbol table, which can happen when putting sections at particular
1578addresses when using a format which can not represent section addresses,
1579such as a.out.
1580
1581@item -b @var{bfdname}
1582@itemx --target=@var{bfdname}
1583@cindex object code format
1584Specify that the object-code format for the object files is
1585@var{bfdname}. This option may not be necessary; @var{objdump} can
1586automatically recognize many formats.
1587
1588For example,
1589@example
1590objdump -b oasys -m vax -h fu.o
1591@end example
1592@noindent
c7c55b78
NC
1593displays summary information from the section headers (@option{-h}) of
1594@file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
252b5132 1595file in the format produced by Oasys compilers. You can list the
c7c55b78 1596formats available with the @option{-i} option.
252b5132
RH
1597@xref{Target Selection}, for more information.
1598
1599@item -C
28c309a2 1600@itemx --demangle[=@var{style}]
252b5132
RH
1601@cindex demangling in objdump
1602Decode (@dfn{demangle}) low-level symbol names into user-level names.
1603Besides removing any initial underscore prepended by the system, this
28c309a2
NC
1604makes C++ function names readable. Different compilers have different
1605mangling styles. The optional demangling style argument can be used to
1606choose an appropriate demangling style for your compiler. @xref{c++filt},
1607for more information on demangling.
252b5132 1608
947ed062
NC
1609@item -g
1610@itemx --debugging
252b5132
RH
1611Display debugging information. This attempts to parse debugging
1612information stored in the file and print it out using a C like syntax.
1613Only certain types of debugging information have been implemented.
c1124b23
AO
1614Some other types are supported by @command{readelf -w}.
1615@xref{readelf}.
252b5132 1616
51cdc6e0
NC
1617@item -e
1618@itemx --debugging-tags
1619Like @option{-g}, but the information is generated in a format compatible
1620with ctags tool.
1621
252b5132
RH
1622@item -d
1623@itemx --disassemble
1624@cindex disassembling object code
1625@cindex machine instructions
1626Display the assembler mnemonics for the machine instructions from
1627@var{objfile}. This option only disassembles those sections which are
1628expected to contain instructions.
1629
1630@item -D
1631@itemx --disassemble-all
c7c55b78 1632Like @option{-d}, but disassemble the contents of all sections, not just
252b5132
RH
1633those expected to contain instructions.
1634
1635@item --prefix-addresses
1636When disassembling, print the complete address on each line. This is
1637the older disassembly format.
1638
252b5132
RH
1639@item -EB
1640@itemx -EL
1641@itemx --endian=@{big|little@}
1642@cindex endianness
1643@cindex disassembly endianness
1644Specify the endianness of the object files. This only affects
1645disassembly. This can be useful when disassembling a file format which
1646does not describe endianness information, such as S-records.
1647
1648@item -f
947ed062 1649@itemx --file-headers
252b5132
RH
1650@cindex object file header
1651Display summary information from the overall header of
1652each of the @var{objfile} files.
1653
f1563258
TW
1654@item --file-start-context
1655@cindex source code context
1656Specify that when displaying interlisted source code/disassembly
c7c55b78 1657(assumes @option{-S}) from a file that has not yet been displayed, extend the
f1563258
TW
1658context to the start of the file.
1659
252b5132 1660@item -h
947ed062
NC
1661@itemx --section-headers
1662@itemx --headers
252b5132
RH
1663@cindex section headers
1664Display summary information from the section headers of the
1665object file.
1666
1667File segments may be relocated to nonstandard addresses, for example by
c7c55b78
NC
1668using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
1669@command{ld}. However, some object file formats, such as a.out, do not
252b5132 1670store the starting address of the file segments. In those situations,
c7c55b78 1671although @command{ld} relocates the sections correctly, using @samp{objdump
252b5132
RH
1672-h} to list the file section headers cannot show the correct addresses.
1673Instead, it shows the usual addresses, which are implicit for the
1674target.
1675
947ed062
NC
1676@item -H
1677@itemx --help
c7c55b78 1678Print a summary of the options to @command{objdump} and exit.
252b5132
RH
1679
1680@item -i
1681@itemx --info
1682@cindex architectures available
1683@cindex object formats available
1684Display a list showing all architectures and object formats available
c7c55b78 1685for specification with @option{-b} or @option{-m}.
252b5132
RH
1686
1687@item -j @var{name}
1688@itemx --section=@var{name}
1689@cindex section information
1690Display information only for section @var{name}.
1691
1692@item -l
1693@itemx --line-numbers
1694@cindex source filenames for object files
1695Label the display (using debugging information) with the filename and
1696source line numbers corresponding to the object code or relocs shown.
c7c55b78 1697Only useful with @option{-d}, @option{-D}, or @option{-r}.
252b5132
RH
1698
1699@item -m @var{machine}
1700@itemx --architecture=@var{machine}
1701@cindex architecture
1702@cindex disassembly architecture
1703Specify the architecture to use when disassembling object files. This
1704can be useful when disassembling object files which do not describe
1705architecture information, such as S-records. You can list the available
c7c55b78 1706architectures with the @option{-i} option.
252b5132 1707
dd92f639
NC
1708@item -M @var{options}
1709@itemx --disassembler-options=@var{options}
1710Pass target specific information to the disassembler. Only supported on
31e0f3cd
NC
1711some targets. If it is necessary to specify more than one
1712disassembler option then multiple @option{-M} options can be used or
1713can be placed together into a comma separated list.
dd92f639
NC
1714
1715If the target is an ARM architecture then this switch can be used to
1716select which register name set is used during disassembler. Specifying
9c092ace 1717@option{-M reg-names-std} (the default) will select the register names as
58efb6c0
NC
1718used in ARM's instruction set documentation, but with register 13 called
1719'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
c7c55b78
NC
1720@option{-M reg-names-apcs} will select the name set used by the ARM
1721Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
58efb6c0
NC
1722just use @samp{r} followed by the register number.
1723
1724There are also two variants on the APCS register naming scheme enabled
c7c55b78
NC
1725by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
1726use the ARM/Thumb Procedure Call Standard naming conventions. (Either
947ed062 1727with the normal register names or the special register names).
dd92f639 1728
8f915f68 1729This option can also be used for ARM architectures to force the
c36774d6 1730disassembler to interpret all instructions as Thumb instructions by
c7c55b78 1731using the switch @option{--disassembler-options=force-thumb}. This can be
8f915f68
NC
1732useful when attempting to disassemble thumb code produced by other
1733compilers.
1734
e396998b
AM
1735For the x86, some of the options duplicate functions of the @option{-m}
1736switch, but allow finer grained control. Multiple selections from the
1737following may be specified as a comma separated string.
b89e9eae 1738@option{x86-64}, @option{i386} and @option{i8086} select disassembly for
e396998b
AM
1739the given architecture. @option{intel} and @option{att} select between
1740intel syntax mode and AT&T syntax mode. @option{addr32},
1741@option{addr16}, @option{data32} and @option{data16} specify the default
1742address size and operand size. These four options will be overridden if
b89e9eae 1743@option{x86-64}, @option{i386} or @option{i8086} appear later in the
e396998b 1744option string. Lastly, @option{suffix}, when in AT&T mode,
b9e5d8e5 1745instructs the disassembler to print a mnemonic suffix even when the
e396998b
AM
1746suffix could be inferred by the operands.
1747
802a735e
AM
1748For PPC, @option{booke}, @option{booke32} and @option{booke64} select
1749disassembly of BookE instructions. @option{32} and @option{64} select
36ae0db3
DJ
1750PowerPC and PowerPC64 disassembly, respectively. @option{e300} selects
1751disassembly for the e300 family.
802a735e 1752
e39893d7
FF
1753For MIPS, this option controls the printing of instruction mneumonic
1754names and register names in disassembled instructions. Multiple
1755selections from the following may be specified as a comma separated
1756string, and invalid options are ignored:
640c0ccd
CD
1757
1758@table @code
e39893d7
FF
1759@item no-aliases
1760Print the 'raw' instruction mneumonic instead of some pseudo
1761instruction mneumonic. I.E. print 'daddu' or 'or' instead of 'move',
1762'sll' instead of 'nop', etc.
1763
640c0ccd
CD
1764@item gpr-names=@var{ABI}
1765Print GPR (general-purpose register) names as appropriate
1766for the specified ABI. By default, GPR names are selected according to
1767the ABI of the binary being disassembled.
1768
1769@item fpr-names=@var{ABI}
1770Print FPR (floating-point register) names as
1771appropriate for the specified ABI. By default, FPR numbers are printed
1772rather than names.
1773
1774@item cp0-names=@var{ARCH}
1775Print CP0 (system control coprocessor; coprocessor 0) register names
1776as appropriate for the CPU or architecture specified by
1777@var{ARCH}. By default, CP0 register names are selected according to
1778the architecture and CPU of the binary being disassembled.
1779
af7ee8bf
CD
1780@item hwr-names=@var{ARCH}
1781Print HWR (hardware register, used by the @code{rdhwr} instruction) names
1782as appropriate for the CPU or architecture specified by
1783@var{ARCH}. By default, HWR names are selected according to
1784the architecture and CPU of the binary being disassembled.
1785
640c0ccd
CD
1786@item reg-names=@var{ABI}
1787Print GPR and FPR names as appropriate for the selected ABI.
1788
1789@item reg-names=@var{ARCH}
af7ee8bf
CD
1790Print CPU-specific register names (CP0 register and HWR names)
1791as appropriate for the selected CPU or architecture.
640c0ccd
CD
1792@end table
1793
1794For any of the options listed above, @var{ABI} or
1795@var{ARCH} may be specified as @samp{numeric} to have numbers printed
1796rather than names, for the selected types of registers.
1797You can list the available values of @var{ABI} and @var{ARCH} using
1798the @option{--help} option.
1799
ec72cfe5
NC
1800For VAX, you can specify function entry addresses with @option{-M
1801entry:0xf00ba}. You can use this multiple times to properly
1802disassemble VAX binary files that don't contain symbol tables (like
1803ROM dumps). In these cases, the function entry mask would otherwise
1804be decoded as VAX instructions, which would probably lead the the rest
1805of the function being wrongly disassembled.
1806
252b5132
RH
1807@item -p
1808@itemx --private-headers
1809Print information that is specific to the object file format. The exact
1810information printed depends upon the object file format. For some
1811object file formats, no additional information is printed.
1812
1813@item -r
1814@itemx --reloc
1815@cindex relocation entries, in object file
c7c55b78
NC
1816Print the relocation entries of the file. If used with @option{-d} or
1817@option{-D}, the relocations are printed interspersed with the
252b5132
RH
1818disassembly.
1819
1820@item -R
1821@itemx --dynamic-reloc
1822@cindex dynamic relocation entries, in object file
1823Print the dynamic relocation entries of the file. This is only
1824meaningful for dynamic objects, such as certain types of shared
1825libraries.
1826
1827@item -s
1828@itemx --full-contents
1829@cindex sections, full contents
1830@cindex object file sections
155e0d23
NC
1831Display the full contents of any sections requested. By default all
1832non-empty sections are displayed.
252b5132
RH
1833
1834@item -S
1835@itemx --source
1836@cindex source disassembly
1837@cindex disassembly, with source
1838Display source code intermixed with disassembly, if possible. Implies
c7c55b78 1839@option{-d}.
252b5132
RH
1840
1841@item --show-raw-insn
1842When disassembling instructions, print the instruction in hex as well as
1843in symbolic form. This is the default except when
c7c55b78 1844@option{--prefix-addresses} is used.
252b5132
RH
1845
1846@item --no-show-raw-insn
1847When disassembling instructions, do not print the instruction bytes.
c7c55b78 1848This is the default when @option{--prefix-addresses} is used.
252b5132 1849
4de2ad99
L
1850@item -W
1851@itemx --dwarf
1852@cindex DWARF
1853@cindex debug symbols
1854Displays the contents of the DWARF debug sections in the file, if any
1855are present.
1856
1dada9c5 1857@item -G
947ed062 1858@itemx --stabs
252b5132
RH
1859@cindex stab
1860@cindex .stab
1861@cindex debug symbols
1862@cindex ELF object file format
1863Display the full contents of any sections requested. Display the
1864contents of the .stab and .stab.index and .stab.excl sections from an
1865ELF file. This is only useful on systems (such as Solaris 2.0) in which
1866@code{.stab} debugging symbol-table entries are carried in an ELF
1867section. In most other file formats, debugging symbol-table entries are
c7c55b78 1868interleaved with linkage symbols, and are visible in the @option{--syms}
0285c67d
NC
1869output.
1870@ifclear man
1871For more information on stabs symbols, see @ref{Top,Stabs,Stabs
252b5132 1872Overview,stabs.info, The ``stabs'' debug format}.
0285c67d 1873@end ifclear
252b5132
RH
1874
1875@item --start-address=@var{address}
1876@cindex start-address
1877Start displaying data at the specified address. This affects the output
c7c55b78 1878of the @option{-d}, @option{-r} and @option{-s} options.
252b5132
RH
1879
1880@item --stop-address=@var{address}
1881@cindex stop-address
1882Stop displaying data at the specified address. This affects the output
c7c55b78 1883of the @option{-d}, @option{-r} and @option{-s} options.
252b5132
RH
1884
1885@item -t
1886@itemx --syms
1887@cindex symbol table entries, printing
1888Print the symbol table entries of the file.
1889This is similar to the information provided by the @samp{nm} program.
1890
1891@item -T
1892@itemx --dynamic-syms
1893@cindex dynamic symbol table entries, printing
1894Print the dynamic symbol table entries of the file. This is only
1895meaningful for dynamic objects, such as certain types of shared
1896libraries. This is similar to the information provided by the @samp{nm}
c7c55b78 1897program when given the @option{-D} (@option{--dynamic}) option.
252b5132 1898
3c9458e9
NC
1899@item --special-syms
1900When displaying symbols include those which the target considers to be
1901special in some way and which would not normally be of interest to the
1902user.
1903
947ed062
NC
1904@item -V
1905@itemx --version
c7c55b78 1906Print the version number of @command{objdump} and exit.
252b5132
RH
1907
1908@item -x
947ed062 1909@itemx --all-headers
252b5132
RH
1910@cindex all header information, object file
1911@cindex header information, all
1912Display all available header information, including the symbol table and
c7c55b78 1913relocation entries. Using @option{-x} is equivalent to specifying all of
04c34128 1914@option{-a -f -h -p -r -t}.
252b5132
RH
1915
1916@item -w
1917@itemx --wide
1918@cindex wide output, printing
1919Format some lines for output devices that have more than 80 columns.
31104126 1920Also do not truncate symbol names when they are displayed.
aefbdd67
BE
1921
1922@item -z
2c0c15f9 1923@itemx --disassemble-zeroes
aefbdd67
BE
1924Normally the disassembly output will skip blocks of zeroes. This
1925option directs the disassembler to disassemble those blocks, just like
1926any other data.
252b5132
RH
1927@end table
1928
0285c67d
NC
1929@c man end
1930
1931@ignore
1932@c man begin SEEALSO objdump
1933nm(1), readelf(1), and the Info entries for @file{binutils}.
1934@c man end
1935@end ignore
1936
252b5132
RH
1937@node ranlib
1938@chapter ranlib
1939
1940@kindex ranlib
1941@cindex archive contents
1942@cindex symbol index
1943
0285c67d
NC
1944@c man title ranlib generate index to archive.
1945
252b5132 1946@smallexample
0285c67d 1947@c man begin SYNOPSIS ranlib
c7c55b78 1948ranlib [@option{-vV}] @var{archive}
0285c67d 1949@c man end
252b5132
RH
1950@end smallexample
1951
0285c67d
NC
1952@c man begin DESCRIPTION ranlib
1953
c7c55b78 1954@command{ranlib} generates an index to the contents of an archive and
252b5132
RH
1955stores it in the archive. The index lists each symbol defined by a
1956member of an archive that is a relocatable object file.
1957
1958You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
1959
1960An archive with such an index speeds up linking to the library and
1961allows routines in the library to call each other without regard to
1962their placement in the archive.
1963
c7c55b78
NC
1964The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
1965@command{ranlib} is completely equivalent to executing @samp{ar -s}.
252b5132
RH
1966@xref{ar}.
1967
0285c67d
NC
1968@c man end
1969
1970@c man begin OPTIONS ranlib
1971
c7c55b78 1972@table @env
252b5132
RH
1973@item -v
1974@itemx -V
f20a759a 1975@itemx --version
c7c55b78 1976Show the version number of @command{ranlib}.
252b5132
RH
1977@end table
1978
0285c67d
NC
1979@c man end
1980
1981@ignore
1982@c man begin SEEALSO ranlib
1983ar(1), nm(1), and the Info entries for @file{binutils}.
1984@c man end
1985@end ignore
1986
252b5132
RH
1987@node size
1988@chapter size
1989
1990@kindex size
1991@cindex section sizes
1992
0285c67d
NC
1993@c man title size list section sizes and total size.
1994
252b5132 1995@smallexample
0285c67d 1996@c man begin SYNOPSIS size
c7c55b78 1997size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
15c82623
NC
1998 [@option{--help}]
1999 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2000 [@option{-t}|@option{--totals}]
c7c55b78
NC
2001 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2002 [@var{objfile}@dots{}]
0285c67d 2003@c man end
252b5132
RH
2004@end smallexample
2005
0285c67d
NC
2006@c man begin DESCRIPTION size
2007
c7c55b78 2008The @sc{gnu} @command{size} utility lists the section sizes---and the total
252b5132
RH
2009size---for each of the object or archive files @var{objfile} in its
2010argument list. By default, one line of output is generated for each
2011object file or each module in an archive.
2012
2013@var{objfile}@dots{} are the object files to be examined.
2014If none are specified, the file @code{a.out} will be used.
2015
0285c67d
NC
2016@c man end
2017
2018@c man begin OPTIONS size
2019
252b5132
RH
2020The command line options have the following meanings:
2021
c7c55b78 2022@table @env
252b5132
RH
2023@item -A
2024@itemx -B
2025@itemx --format=@var{compatibility}
c7c55b78 2026@cindex @command{size} display format
252b5132 2027Using one of these options, you can choose whether the output from @sc{gnu}
c7c55b78
NC
2028@command{size} resembles output from System V @command{size} (using @option{-A},
2029or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2030@option{--format=berkeley}). The default is the one-line format similar to
252b5132
RH
2031Berkeley's.
2032@c Bonus for doc-source readers: you can also say --format=strange (or
2033@c anything else that starts with 's') for sysv, and --format=boring (or
2034@c anything else that starts with 'b') for Berkeley.
2035
2036Here is an example of the Berkeley (default) format of output from
c7c55b78 2037@command{size}:
252b5132 2038@smallexample
f20a759a 2039$ size --format=Berkeley ranlib size
252b5132
RH
2040text data bss dec hex filename
2041294880 81920 11592 388392 5ed28 ranlib
2042294880 81920 11888 388688 5ee50 size
2043@end smallexample
2044
2045@noindent
2046This is the same data, but displayed closer to System V conventions:
2047
2048@smallexample
f20a759a 2049$ size --format=SysV ranlib size
252b5132
RH
2050ranlib :
2051section size addr
2052.text 294880 8192
2053.data 81920 303104
2054.bss 11592 385024
2055Total 388392
2056
2057
2058size :
2059section size addr
2060.text 294880 8192
2061.data 81920 303104
2062.bss 11888 385024
2063Total 388688
2064@end smallexample
2065
2066@item --help
2067Show a summary of acceptable arguments and options.
2068
2069@item -d
2070@itemx -o
2071@itemx -x
2072@itemx --radix=@var{number}
c7c55b78 2073@cindex @command{size} number format
252b5132
RH
2074@cindex radix for section sizes
2075Using one of these options, you can control whether the size of each
c7c55b78
NC
2076section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2077(@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2078@option{--radix=16}). In @option{--radix=@var{number}}, only the three
252b5132 2079values (8, 10, 16) are supported. The total size is always given in two
c7c55b78
NC
2080radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2081octal and hexadecimal if you're using @option{-o}.
252b5132 2082
15c82623
NC
2083@item -t
2084@itemx --totals
2085Show totals of all objects listed (Berkeley format listing mode only).
2086
252b5132
RH
2087@item --target=@var{bfdname}
2088@cindex object code format
2089Specify that the object-code format for @var{objfile} is
c7c55b78 2090@var{bfdname}. This option may not be necessary; @command{size} can
252b5132
RH
2091automatically recognize many formats.
2092@xref{Target Selection}, for more information.
2093
2094@item -V
2095@itemx --version
c7c55b78 2096Display the version number of @command{size}.
252b5132
RH
2097@end table
2098
0285c67d
NC
2099@c man end
2100
2101@ignore
2102@c man begin SEEALSO size
2103ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2104@c man end
2105@end ignore
2106
252b5132
RH
2107@node strings
2108@chapter strings
2109@kindex strings
2110@cindex listings strings
2111@cindex printing strings
2112@cindex strings, printing
2113
0285c67d
NC
2114@c man title strings print the strings of printable characters in files.
2115
252b5132 2116@smallexample
0285c67d 2117@c man begin SYNOPSIS strings
d132876a
NC
2118strings [@option{-afov}] [@option{-}@var{min-len}]
2119 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2120 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2121 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2122 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2123 [@option{--target=}@var{bfdname}]
c7c55b78 2124 [@option{--help}] [@option{--version}] @var{file}@dots{}
0285c67d 2125@c man end
252b5132
RH
2126@end smallexample
2127
0285c67d
NC
2128@c man begin DESCRIPTION strings
2129
c7c55b78 2130For each @var{file} given, @sc{gnu} @command{strings} prints the printable
252b5132
RH
2131character sequences that are at least 4 characters long (or the number
2132given with the options below) and are followed by an unprintable
2133character. By default, it only prints the strings from the initialized
2134and loaded sections of object files; for other types of files, it prints
2135the strings from the whole file.
2136
c7c55b78 2137@command{strings} is mainly useful for determining the contents of non-text
252b5132
RH
2138files.
2139
0285c67d
NC
2140@c man end
2141
2142@c man begin OPTIONS strings
2143
c7c55b78 2144@table @env
252b5132
RH
2145@item -a
2146@itemx --all
2147@itemx -
2148Do not scan only the initialized and loaded sections of object files;
2149scan the whole files.
2150
2151@item -f
2152@itemx --print-file-name
2153Print the name of the file before each string.
2154
2155@item --help
2156Print a summary of the program usage on the standard output and exit.
2157
2158@item -@var{min-len}
2159@itemx -n @var{min-len}
2160@itemx --bytes=@var{min-len}
2161Print sequences of characters that are at least @var{min-len} characters
2162long, instead of the default 4.
2163
2164@item -o
c7c55b78 2165Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
252b5132
RH
2166act like @samp{-t d} instead. Since we can not be compatible with both
2167ways, we simply chose one.
2168
2169@item -t @var{radix}
2170@itemx --radix=@var{radix}
2171Print the offset within the file before each string. The single
2172character argument specifies the radix of the offset---@samp{o} for
2173octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2174
d132876a
NC
2175@item -e @var{encoding}
2176@itemx --encoding=@var{encoding}
2177Select the character encoding of the strings that are to be found.
8745eafa
NC
2178Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2179characters (ASCII, ISO 8859, etc., default), @samp{S} =
2180single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
218116-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2182littleendian. Useful for finding wide character strings.
d132876a 2183
252b5132
RH
2184@item --target=@var{bfdname}
2185@cindex object code format
2186Specify an object code format other than your system's default format.
2187@xref{Target Selection}, for more information.
2188
2189@item -v
2190@itemx --version
2191Print the program version number on the standard output and exit.
2192@end table
2193
0285c67d
NC
2194@c man end
2195
2196@ignore
2197@c man begin SEEALSO strings
2198ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2199and the Info entries for @file{binutils}.
2200@c man end
2201@end ignore
2202
252b5132
RH
2203@node strip
2204@chapter strip
2205
2206@kindex strip
2207@cindex removing symbols
2208@cindex discarding symbols
2209@cindex symbols, discarding
2210
0285c67d
NC
2211@c man title strip Discard symbols from object files.
2212
252b5132 2213@smallexample
0285c67d 2214@c man begin SYNOPSIS strip
2593f09a
NC
2215strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2216 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2217 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2218 [@option{-s}|@option{--strip-all}]
2219 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2220 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2221 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
5fe11841 2222 [@option{-w}|@option{--wildcard}]
2593f09a
NC
2223 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2224 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2225 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
ed1653a7 2226 [@option{--only-keep-debug}]
7c29036b
NC
2227 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2228 [@option{--help}] [@option{--info}]
252b5132 2229 @var{objfile}@dots{}
0285c67d 2230@c man end
252b5132
RH
2231@end smallexample
2232
0285c67d
NC
2233@c man begin DESCRIPTION strip
2234
c7c55b78 2235@sc{gnu} @command{strip} discards all symbols from object files
252b5132
RH
2236@var{objfile}. The list of object files may include archives.
2237At least one object file must be given.
2238
c7c55b78 2239@command{strip} modifies the files named in its argument,
252b5132
RH
2240rather than writing modified copies under different names.
2241
0285c67d
NC
2242@c man end
2243
2244@c man begin OPTIONS strip
2245
c7c55b78 2246@table @env
252b5132
RH
2247@item -F @var{bfdname}
2248@itemx --target=@var{bfdname}
2249Treat the original @var{objfile} as a file with the object
2250code format @var{bfdname}, and rewrite it in the same format.
2251@xref{Target Selection}, for more information.
2252
2253@item --help
c7c55b78 2254Show a summary of the options to @command{strip} and exit.
252b5132 2255
7c29036b
NC
2256@item --info
2257Display a list showing all architectures and object formats available.
2258
947ed062 2259@item -I @var{bfdname}
252b5132
RH
2260@itemx --input-target=@var{bfdname}
2261Treat the original @var{objfile} as a file with the object
2262code format @var{bfdname}.
2263@xref{Target Selection}, for more information.
2264
2265@item -O @var{bfdname}
2266@itemx --output-target=@var{bfdname}
2267Replace @var{objfile} with a file in the output format @var{bfdname}.
2268@xref{Target Selection}, for more information.
2269
2270@item -R @var{sectionname}
2271@itemx --remove-section=@var{sectionname}
2272Remove any section named @var{sectionname} from the output file. This
2273option may be given more than once. Note that using this option
2274inappropriately may make the output file unusable.
2275
2276@item -s
2277@itemx --strip-all
2278Remove all symbols.
2279
2280@item -g
2281@itemx -S
15c82623 2282@itemx -d
252b5132
RH
2283@itemx --strip-debug
2284Remove debugging symbols only.
2285
2286@item --strip-unneeded
2287Remove all symbols that are not needed for relocation processing.
2288
2289@item -K @var{symbolname}
2290@itemx --keep-symbol=@var{symbolname}
e7f918ad
NC
2291When stripping symbols, keep symbol @var{symbolname} even if it would
2292normally be stripped. This option may be given more than once.
252b5132
RH
2293
2294@item -N @var{symbolname}
2295@itemx --strip-symbol=@var{symbolname}
2296Remove symbol @var{symbolname} from the source file. This option may be
2297given more than once, and may be combined with strip options other than
c7c55b78 2298@option{-K}.
252b5132
RH
2299
2300@item -o @var{file}
2301Put the stripped output in @var{file}, rather than replacing the
2302existing file. When this argument is used, only one @var{objfile}
2303argument may be specified.
2304
2305@item -p
2306@itemx --preserve-dates
2307Preserve the access and modification dates of the file.
2308
5fe11841
NC
2309@item -w
2310@itemx --wildcard
2311Permit regular expressions in @var{symbolname}s used in other command
2312line options. The question mark (?), asterisk (*), backslash (\) and
2313square brackets ([]) operators can be used anywhere in the symbol
2314name. If the first character of the symbol name is the exclamation
2315point (!) then the sense of the switch is reversed for that symbol.
2316For example:
2317
2318@smallexample
2319 -w -K !foo -K fo*
2320@end smallexample
2321
2322would cause strip to only keep symbols that start with the letters
2323``fo'', but to discard the symbol ``foo''.
2324
252b5132
RH
2325@item -x
2326@itemx --discard-all
2327Remove non-global symbols.
2328
2329@item -X
2330@itemx --discard-locals
2331Remove compiler-generated local symbols.
2332(These usually start with @samp{L} or @samp{.}.)
2333
ed1653a7
NC
2334@item --only-keep-debug
2335Strip a file, removing any sections that would be stripped by
2336@option{--strip-debug} and leaving the debugging sections.
2337
2338The intention is that this option will be used in conjunction with
2339@option{--add-gnu-debuglink} to create a two part executable. One a
2340stripped binary which will occupy less space in RAM and in a
2341distribution and the second a debugging information file which is only
2342needed if debugging abilities are required. The suggested procedure
2343to create these files is as follows:
2344
2345@enumerate
2346@item Link the executable as normal. Assuming that is is called
2347@code{foo} then...
2348@item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2349create a file containing the debugging info.
2350@item Run @code{objcopy --strip-debug foo} to create a
2351stripped executable.
2352@item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2353to add a link to the debugging info into the stripped executable.
2354@end enumerate
2355
2356Note - the choice of @code{.dbg} as an extension for the debug info
2357file is arbitrary. Also the @code{--only-keep-debug} step is
2358optional. You could instead do this:
2359
2360@enumerate
2361@item Link the executable as normal.
2362@item Copy @code{foo} to @code{foo.full}
2363@item Run @code{strip --strip-debug foo}
2364@item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2365@end enumerate
2366
2367ie the file pointed to by the @option{--add-gnu-debuglink} can be the
2368full executable. It does not have to be a file created by the
2369@option{--only-keep-debug} switch.
2370
252b5132
RH
2371@item -V
2372@itemx --version
c7c55b78 2373Show the version number for @command{strip}.
252b5132
RH
2374
2375@item -v
2376@itemx --verbose
2377Verbose output: list all object files modified. In the case of
2378archives, @samp{strip -v} lists all members of the archive.
2379@end table
2380
0285c67d
NC
2381@c man end
2382
2383@ignore
2384@c man begin SEEALSO strip
2385the Info entries for @file{binutils}.
2386@c man end
2387@end ignore
2388
9d51cc66 2389@node c++filt, addr2line, strip, Top
252b5132
RH
2390@chapter c++filt
2391
2392@kindex c++filt
2393@cindex demangling C++ symbols
2394
0285c67d
NC
2395@c man title cxxfilt Demangle C++ and Java symbols.
2396
252b5132 2397@smallexample
0285c67d 2398@c man begin SYNOPSIS cxxfilt
c7c55b78 2399c++filt [@option{-_}|@option{--strip-underscores}]
c7c55b78 2400 [@option{-n}|@option{--no-strip-underscores}]
4e48c9dd 2401 [@option{-p}|@option{--no-params}]
ec948987 2402 [@option{-t}|@option{--types}]
cbf1f5df 2403 [@option{-i}|@option{--no-verbose}]
c7c55b78
NC
2404 [@option{-s} @var{format}|@option{--format=}@var{format}]
2405 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
0285c67d 2406@c man end
252b5132
RH
2407@end smallexample
2408
0285c67d
NC
2409@c man begin DESCRIPTION cxxfilt
2410
9d51cc66 2411@kindex cxxfilt
ec948987
NC
2412The C++ and Java languages provide function overloading, which means
2413that you can write many functions with the same name, providing that
2414each function takes parameters of different types. In order to be
2415able to distinguish these similarly named functions C++ and Java
2416encode them into a low-level assembler name which uniquely identifies
2417each different version. This process is known as @dfn{mangling}. The
2418@command{c++filt}
2419@footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
195a97ce 2420MS-DOS this program is named @command{CXXFILT}.}
9d51cc66 2421program does the inverse mapping: it decodes (@dfn{demangles}) low-level
ec948987 2422names into user-level names so that they can be read.
252b5132
RH
2423
2424Every alphanumeric word (consisting of letters, digits, underscores,
cbf1f5df
NC
2425dollars, or periods) seen in the input is a potential mangled name.
2426If the name decodes into a C++ name, the C++ name replaces the
ec948987
NC
2427low-level name in the output, otherwise the original word is output.
2428In this way you can pass an entire assembler source file, containing
2429mangled names, through @command{c++filt} and see the same source file
2430containing demangled names.
252b5132 2431
ec948987
NC
2432You can also use @command{c++filt} to decipher individual symbols by
2433passing them on the command line:
252b5132
RH
2434
2435@example
2436c++filt @var{symbol}
2437@end example
2438
c7c55b78 2439If no @var{symbol} arguments are given, @command{c++filt} reads symbol
ec948987
NC
2440names from the standard input instead. All the results are printed on
2441the standard output. The difference between reading names from the
2442command line versus reading names from the standard input is that
2443command line arguments are expected to be just mangled names and no
2444checking is performed to seperate them from surrounding text. Thus
2445for example:
2446
2447@smallexample
2448c++filt -n _Z1fv
2449@end smallexample
2450
2451will work and demangle the name to ``f()'' whereas:
2452
2453@smallexample
2454c++filt -n _Z1fv,
2455@end smallexample
2456
2457will not work. (Note the extra comma at the end of the mangled
2458name which makes it invalid). This command however will work:
2459
2460@smallexample
2461echo _Z1fv, | c++filt -n
2462@end smallexample
2463
2464and will display ``f(),'' ie the demangled name followed by a
2465trailing comma. This behaviour is because when the names are read
2466from the standard input it is expected that they might be part of an
2467assembler source file where there might be extra, extraneous
2468characters trailing after a mangled name. eg:
2469
2470@smallexample
2471 .type _Z1fv, @@function
2472@end smallexample
252b5132 2473
0285c67d
NC
2474@c man end
2475
2476@c man begin OPTIONS cxxfilt
2477
c7c55b78 2478@table @env
252b5132
RH
2479@item -_
2480@itemx --strip-underscores
2481On some systems, both the C and C++ compilers put an underscore in front
2482of every name. For example, the C name @code{foo} gets the low-level
2483name @code{_foo}. This option removes the initial underscore. Whether
c7c55b78 2484@command{c++filt} removes the underscore by default is target dependent.
252b5132
RH
2485
2486@item -j
2487@itemx --java
2488Prints demangled names using Java syntax. The default is to use C++
2489syntax.
2490
2491@item -n
2492@itemx --no-strip-underscores
2493Do not remove the initial underscore.
2494
4e48c9dd
ILT
2495@item -p
2496@itemx --no-params
2497When demangling the name of a function, do not display the types of
2498the function's parameters.
2499
cbf1f5df 2500@item -t
ec948987
NC
2501@itemx --types
2502Attempt to demangle types as well as function names. This is disabled
2503by default since mangled types are normally only used internally in
2504the compiler, and they can be confused with non-mangled names. eg
2505a function called ``a'' treated as a mangled type name would be
2506demangled to ``signed char''.
cbf1f5df
NC
2507
2508@item -i
2509@itemx --no-verbose
2510Do not include implementation details (if any) in the demangled
2511output.
2512
252b5132
RH
2513@item -s @var{format}
2514@itemx --format=@var{format}
947ed062
NC
2515@command{c++filt} can decode various methods of mangling, used by
2516different compilers. The argument to this option selects which
252b5132
RH
2517method it uses:
2518
2519@table @code
947ed062
NC
2520@item auto
2521Automatic selection based on executable (the default method)
252b5132 2522@item gnu
947ed062 2523the one used by the @sc{gnu} C++ compiler (g++)
252b5132 2524@item lucid
947ed062 2525the one used by the Lucid compiler (lcc)
252b5132
RH
2526@item arm
2527the one specified by the C++ Annotated Reference Manual
2528@item hp
947ed062 2529the one used by the HP compiler (aCC)
252b5132
RH
2530@item edg
2531the one used by the EDG compiler
b5e2a4f3 2532@item gnu-v3
947ed062
NC
2533the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
2534@item java
2535the one used by the @sc{gnu} Java compiler (gcj)
2536@item gnat
2537the one used by the @sc{gnu} Ada compiler (GNAT).
252b5132
RH
2538@end table
2539
2540@item --help
c7c55b78 2541Print a summary of the options to @command{c++filt} and exit.
252b5132
RH
2542
2543@item --version
c7c55b78 2544Print the version number of @command{c++filt} and exit.
252b5132
RH
2545@end table
2546
0285c67d
NC
2547@c man end
2548
2549@ignore
2550@c man begin SEEALSO cxxfilt
2551the Info entries for @file{binutils}.
2552@c man end
2553@end ignore
2554
252b5132 2555@quotation
c7c55b78 2556@emph{Warning:} @command{c++filt} is a new utility, and the details of its
252b5132
RH
2557user interface are subject to change in future releases. In particular,
2558a command-line option may be required in the the future to decode a name
2559passed as an argument on the command line; in other words,
2560
2561@example
2562c++filt @var{symbol}
2563@end example
2564
2565@noindent
2566may in a future release become
2567
2568@example
2569c++filt @var{option} @var{symbol}
2570@end example
2571@end quotation
2572
2573@node addr2line
2574@chapter addr2line
2575
2576@kindex addr2line
2577@cindex address to file name and line number
2578
0285c67d
NC
2579@c man title addr2line convert addresses into file names and line numbers.
2580
252b5132 2581@smallexample
0285c67d 2582@c man begin SYNOPSIS addr2line
c7c55b78 2583addr2line [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
bf44dd74 2584 [@option{-C}|@option{--demangle}[=@var{style}]]
c7c55b78
NC
2585 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
2586 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
0c552dc1 2587 [@option{-i}|@option{--inlines}]
c7c55b78
NC
2588 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
2589 [addr addr @dots{}]
0285c67d 2590@c man end
252b5132
RH
2591@end smallexample
2592
0285c67d
NC
2593@c man begin DESCRIPTION addr2line
2594
c7c55b78 2595@command{addr2line} translates program addresses into file names and line
252b5132
RH
2596numbers. Given an address and an executable, it uses the debugging
2597information in the executable to figure out which file name and line
2598number are associated with a given address.
2599
c7c55b78 2600The executable to use is specified with the @option{-e} option. The
f20a759a 2601default is the file @file{a.out}.
252b5132 2602
c7c55b78 2603@command{addr2line} has two modes of operation.
252b5132
RH
2604
2605In the first, hexadecimal addresses are specified on the command line,
c7c55b78 2606and @command{addr2line} displays the file name and line number for each
252b5132
RH
2607address.
2608
c7c55b78 2609In the second, @command{addr2line} reads hexadecimal addresses from
252b5132 2610standard input, and prints the file name and line number for each
c7c55b78 2611address on standard output. In this mode, @command{addr2line} may be used
252b5132
RH
2612in a pipe to convert dynamically chosen addresses.
2613
2614The format of the output is @samp{FILENAME:LINENO}. The file name and
2615line number for each address is printed on a separate line. If the
c7c55b78 2616@command{-f} option is used, then each @samp{FILENAME:LINENO} line is
252b5132
RH
2617preceded by a @samp{FUNCTIONNAME} line which is the name of the function
2618containing the address.
2619
2620If the file name or function name can not be determined,
c7c55b78
NC
2621@command{addr2line} will print two question marks in their place. If the
2622line number can not be determined, @command{addr2line} will print 0.
252b5132 2623
0285c67d
NC
2624@c man end
2625
2626@c man begin OPTIONS addr2line
2627
252b5132
RH
2628The long and short forms of options, shown here as alternatives, are
2629equivalent.
2630
c7c55b78 2631@table @env
252b5132
RH
2632@item -b @var{bfdname}
2633@itemx --target=@var{bfdname}
2634@cindex object code format
2635Specify that the object-code format for the object files is
2636@var{bfdname}.
2637
2638@item -C
28c309a2 2639@itemx --demangle[=@var{style}]
252b5132
RH
2640@cindex demangling in objdump
2641Decode (@dfn{demangle}) low-level symbol names into user-level names.
2642Besides removing any initial underscore prepended by the system, this
28c309a2
NC
2643makes C++ function names readable. Different compilers have different
2644mangling styles. The optional demangling style argument can be used to
2645choose an appropriate demangling style for your compiler. @xref{c++filt},
2646for more information on demangling.
252b5132
RH
2647
2648@item -e @var{filename}
2649@itemx --exe=@var{filename}
2650Specify the name of the executable for which addresses should be
2651translated. The default file is @file{a.out}.
2652
2653@item -f
2654@itemx --functions
2655Display function names as well as file and line number information.
2656
2657@item -s
2658@itemx --basenames
2659Display only the base of each file name.
0c552dc1
FF
2660
2661@item -i
2662@itemx --inlines
2663If the address belongs to a function that was inlined, the source
2664information for all enclosing scopes back to the first non-inlined
2665function will also be printed. For example, if @code{main} inlines
2666@code{callee1} which inlines @code{callee2}, and address is from
2667@code{callee2}, the source information for @code{callee1} and @code{main}
2668will also be printed.
e107c42f 2669@end table
252b5132 2670
0285c67d
NC
2671@c man end
2672
2673@ignore
2674@c man begin SEEALSO addr2line
2675Info entries for @file{binutils}.
2676@c man end
2677@end ignore
2678
252b5132
RH
2679@node nlmconv
2680@chapter nlmconv
2681
c7c55b78 2682@command{nlmconv} converts a relocatable object file into a NetWare
252b5132
RH
2683Loadable Module.
2684
2685@ignore
c7c55b78 2686@command{nlmconv} currently works with @samp{i386} object
252b5132
RH
2687files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
2688object files in @sc{elf}, or @code{a.out} format@footnote{
c7c55b78 2689@command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
252b5132
RH
2690format in the Binary File Descriptor library. It has only been tested
2691with the above formats.}.
2692@end ignore
2693
2694@quotation
c7c55b78 2695@emph{Warning:} @command{nlmconv} is not always built as part of the binary
252b5132
RH
2696utilities, since it is only useful for NLM targets.
2697@end quotation
2698
0285c67d
NC
2699@c man title nlmconv converts object code into an NLM.
2700
252b5132 2701@smallexample
0285c67d 2702@c man begin SYNOPSIS nlmconv
c7c55b78
NC
2703nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
2704 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
2705 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
2706 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
2707 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
252b5132 2708 @var{infile} @var{outfile}
0285c67d 2709@c man end
252b5132
RH
2710@end smallexample
2711
0285c67d
NC
2712@c man begin DESCRIPTION nlmconv
2713
c7c55b78 2714@command{nlmconv} converts the relocatable @samp{i386} object file
252b5132
RH
2715@var{infile} into the NetWare Loadable Module @var{outfile}, optionally
2716reading @var{headerfile} for NLM header information. For instructions
2717on writing the NLM command file language used in header files, see the
2718@samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
2719Development and Tools Overview}, which is part of the NLM Software
2720Developer's Kit (``NLM SDK''), available from Novell, Inc.
c7c55b78 2721@command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
0285c67d
NC
2722@var{infile};
2723@ifclear man
2724see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
2725@end ifclear
252b5132 2726
c7c55b78 2727@command{nlmconv} can perform a link step. In other words, you can list
252b5132
RH
2728more than one object file for input if you list them in the definitions
2729file (rather than simply specifying one input file on the command line).
c7c55b78 2730In this case, @command{nlmconv} calls the linker for you.
252b5132 2731
0285c67d
NC
2732@c man end
2733
2734@c man begin OPTIONS nlmconv
2735
c7c55b78 2736@table @env
252b5132
RH
2737@item -I @var{bfdname}
2738@itemx --input-target=@var{bfdname}
c7c55b78 2739Object format of the input file. @command{nlmconv} can usually determine
252b5132
RH
2740the format of a given file (so no default is necessary).
2741@xref{Target Selection}, for more information.
2742
2743@item -O @var{bfdname}
2744@itemx --output-target=@var{bfdname}
c7c55b78 2745Object format of the output file. @command{nlmconv} infers the output
252b5132
RH
2746format based on the input format, e.g. for a @samp{i386} input file the
2747output format is @samp{nlm32-i386}.
2748@xref{Target Selection}, for more information.
2749
2750@item -T @var{headerfile}
2751@itemx --header-file=@var{headerfile}
2752Reads @var{headerfile} for NLM header information. For instructions on
2753writing the NLM command file language used in header files, see@ see the
2754@samp{linkers} section, of the @cite{NLM Development and Tools
2755Overview}, which is part of the NLM Software Developer's Kit, available
2756from Novell, Inc.
2757
2758@item -d
2759@itemx --debug
c7c55b78 2760Displays (on standard error) the linker command line used by @command{nlmconv}.
252b5132
RH
2761
2762@item -l @var{linker}
2763@itemx --linker=@var{linker}
2764Use @var{linker} for any linking. @var{linker} can be an absolute or a
2765relative pathname.
2766
2767@item -h
2768@itemx --help
2769Prints a usage summary.
2770
2771@item -V
2772@itemx --version
c7c55b78 2773Prints the version number for @command{nlmconv}.
252b5132
RH
2774@end table
2775
0285c67d
NC
2776@c man end
2777
2778@ignore
2779@c man begin SEEALSO nlmconv
2780the Info entries for @file{binutils}.
2781@c man end
2782@end ignore
2783
252b5132
RH
2784@node windres
2785@chapter windres
2786
c7c55b78 2787@command{windres} may be used to manipulate Windows resources.
252b5132
RH
2788
2789@quotation
c7c55b78 2790@emph{Warning:} @command{windres} is not always built as part of the binary
252b5132
RH
2791utilities, since it is only useful for Windows targets.
2792@end quotation
2793
0285c67d
NC
2794@c man title windres manipulate Windows resources.
2795
252b5132 2796@smallexample
0285c67d 2797@c man begin SYNOPSIS windres
252b5132 2798windres [options] [input-file] [output-file]
0285c67d 2799@c man end
252b5132
RH
2800@end smallexample
2801
0285c67d
NC
2802@c man begin DESCRIPTION windres
2803
c7c55b78 2804@command{windres} reads resources from an input file and copies them into
252b5132
RH
2805an output file. Either file may be in one of three formats:
2806
2807@table @code
2808@item rc
2809A text format read by the Resource Compiler.
2810
2811@item res
2812A binary format generated by the Resource Compiler.
2813
2814@item coff
2815A COFF object or executable.
2816@end table
2817
2818The exact description of these different formats is available in
2819documentation from Microsoft.
2820
c7c55b78 2821When @command{windres} converts from the @code{rc} format to the @code{res}
252b5132 2822format, it is acting like the Windows Resource Compiler. When
c7c55b78 2823@command{windres} converts from the @code{res} format to the @code{coff}
252b5132
RH
2824format, it is acting like the Windows @code{CVTRES} program.
2825
c7c55b78 2826When @command{windres} generates an @code{rc} file, the output is similar
252b5132
RH
2827but not identical to the format expected for the input. When an input
2828@code{rc} file refers to an external filename, an output @code{rc} file
2829will instead include the file contents.
2830
c7c55b78 2831If the input or output format is not specified, @command{windres} will
252b5132
RH
2832guess based on the file name, or, for the input file, the file contents.
2833A file with an extension of @file{.rc} will be treated as an @code{rc}
2834file, a file with an extension of @file{.res} will be treated as a
2835@code{res} file, and a file with an extension of @file{.o} or
2836@file{.exe} will be treated as a @code{coff} file.
2837
c7c55b78 2838If no output file is specified, @command{windres} will print the resources
252b5132
RH
2839in @code{rc} format to standard output.
2840
c7c55b78 2841The normal use is for you to write an @code{rc} file, use @command{windres}
252b5132
RH
2842to convert it to a COFF object file, and then link the COFF file into
2843your application. This will make the resources described in the
2844@code{rc} file available to Windows.
2845
0285c67d
NC
2846@c man end
2847
2848@c man begin OPTIONS windres
2849
c7c55b78 2850@table @env
252b5132
RH
2851@item -i @var{filename}
2852@itemx --input @var{filename}
2853The name of the input file. If this option is not used, then
c7c55b78
NC
2854@command{windres} will use the first non-option argument as the input file
2855name. If there are no non-option arguments, then @command{windres} will
2856read from standard input. @command{windres} can not read a COFF file from
edbedb71 2857standard input.
252b5132
RH
2858
2859@item -o @var{filename}
2860@itemx --output @var{filename}
2861The name of the output file. If this option is not used, then
c7c55b78 2862@command{windres} will use the first non-option argument, after any used
252b5132 2863for the input file name, as the output file name. If there is no
c7c55b78 2864non-option argument, then @command{windres} will write to standard output.
edbedb71
NC
2865@command{windres} can not write a COFF file to standard output. Note,
2866for compatability with @command{rc} the option @option{-fo} is also
2867accepted, but its use is not recommended.
252b5132 2868
85eb5110 2869@item -J @var{format}
252b5132
RH
2870@itemx --input-format @var{format}
2871The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
c7c55b78 2872@samp{coff}. If no input format is specified, @command{windres} will
252b5132
RH
2873guess, as described above.
2874
2875@item -O @var{format}
2876@itemx --output-format @var{format}
2877The output format to generate. @var{format} may be @samp{res},
2878@samp{rc}, or @samp{coff}. If no output format is specified,
c7c55b78 2879@command{windres} will guess, as described above.
252b5132
RH
2880
2881@item -F @var{target}
2882@itemx --target @var{target}
2883Specify the BFD format to use for a COFF file as input or output. This
c7c55b78
NC
2884is a BFD target name; you can use the @option{--help} option to see a list
2885of supported targets. Normally @command{windres} will use the default
2886format, which is the first one listed by the @option{--help} option.
2887@ifclear man
252b5132 2888@ref{Target Selection}.
c7c55b78 2889@end ifclear
252b5132
RH
2890
2891@item --preprocessor @var{program}
c7c55b78 2892When @command{windres} reads an @code{rc} file, it runs it through the C
252b5132
RH
2893preprocessor first. This option may be used to specify the preprocessor
2894to use, including any leading arguments. The default preprocessor
2895argument is @code{gcc -E -xc-header -DRC_INVOKED}.
2896
85eb5110
NC
2897@item -I @var{directory}
2898@itemx --include-dir @var{directory}
252b5132 2899Specify an include directory to use when reading an @code{rc} file.
c7c55b78
NC
2900@command{windres} will pass this to the preprocessor as an @option{-I}
2901option. @command{windres} will also search this directory when looking for
85eb5110
NC
2902files named in the @code{rc} file. If the argument passed to this command
2903matches any of the supported @var{formats} (as descrived in the @option{-J}
2904option), it will issue a deprecation warning, and behave just like the
2905@option{-J} option. New programs should not use this behaviour. If a
2906directory happens to match a @var{format}, simple prefix it with @samp{./}
2907to disable the backward compatibility.
252b5132 2908
751d21b5 2909@item -D @var{target}
ad0481cd 2910@itemx --define @var{sym}[=@var{val}]
c7c55b78 2911Specify a @option{-D} option to pass to the preprocessor when reading an
252b5132
RH
2912@code{rc} file.
2913
29b058f1
NC
2914@item -U @var{target}
2915@itemx --undefine @var{sym}
2916Specify a @option{-U} option to pass to the preprocessor when reading an
2917@code{rc} file.
2918
3126d709
CF
2919@item -r
2920Ignored for compatibility with rc.
2921
751d21b5
DD
2922@item -v
2923Enable verbose mode. This tells you what the preprocessor is if you
2924didn't specify one.
2925
3077f5d8 2926@item -l @var{val}
252b5132
RH
2927@item --language @var{val}
2928Specify the default language to use when reading an @code{rc} file.
2929@var{val} should be a hexadecimal language code. The low eight bits are
2930the language, and the high eight bits are the sublanguage.
2931
5a298d2d
NC
2932@item --use-temp-file
2933Use a temporary file to instead of using popen to read the output of
2934the preprocessor. Use this option if the popen implementation is buggy
2935on the host (eg., certain non-English language versions of Windows 95 and
2936Windows 98 are known to have buggy popen where the output will instead
2937go the console).
2938
2939@item --no-use-temp-file
2940Use popen, not a temporary file, to read the output of the preprocessor.
2941This is the default behaviour.
2942
3077f5d8 2943@item -h
252b5132
RH
2944@item --help
2945Prints a usage summary.
2946
3077f5d8 2947@item -V
252b5132 2948@item --version
c7c55b78 2949Prints the version number for @command{windres}.
252b5132
RH
2950
2951@item --yydebug
c7c55b78 2952If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
252b5132
RH
2953this will turn on parser debugging.
2954@end table
2955
0285c67d
NC
2956@c man end
2957
2958@ignore
2959@c man begin SEEALSO windres
2960the Info entries for @file{binutils}.
2961@c man end
2962@end ignore
252b5132
RH
2963
2964@node dlltool
2aa9814e 2965@chapter dlltool
252b5132
RH
2966@cindex DLL
2967@kindex dlltool
2968
2aa9814e
BE
2969@command{dlltool} is used to create the files needed to create dynamic
2970link libraries (DLLs) on systems which understand PE format image
2971files such as Windows. A DLL contains an export table which contains
2972information that the runtime loader needs to resolve references from a
2973referencing program.
2974
2975The export table is generated by this program by reading in a
2976@file{.def} file or scanning the @file{.a} and @file{.o} files which
2977will be in the DLL. A @file{.o} file can contain information in
2978special @samp{.drectve} sections with export information.
252b5132
RH
2979
2980@quotation
2aa9814e
BE
2981@emph{Note:} @command{dlltool} is not always built as part of the
2982binary utilities, since it is only useful for those targets which
2983support DLLs.
252b5132
RH
2984@end quotation
2985
0285c67d
NC
2986@c man title dlltool Create files needed to build and use DLLs.
2987
252b5132 2988@smallexample
0285c67d 2989@c man begin SYNOPSIS dlltool
c7c55b78
NC
2990dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
2991 [@option{-b}|@option{--base-file} @var{base-file-name}]
2992 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
2993 [@option{-z}|@option{--output-def} @var{def-file-name}]
2994 [@option{-l}|@option{--output-lib} @var{library-file-name}]
2995 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
2996 [@option{--exclude-symbols} @var{list}]
2997 [@option{--no-default-excludes}]
2998 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
2999 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
3000 [@option{-a}|@option{--add-indirect}] [@option{-U}|@option{--add-underscore}] [@option{-k}|@option{--kill-at}]
3001 [@option{-A}|@option{--add-stdcall-alias}]
607dea97 3002 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
c7c55b78 3003 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}] [@option{-i}|@option{--interwork}]
f9346411
DS
3004 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
3005 [@option{-v}|@option{--verbose}]
c7c55b78 3006 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
252b5132 3007 [object-file @dots{}]
0285c67d 3008@c man end
252b5132
RH
3009@end smallexample
3010
0285c67d
NC
3011@c man begin DESCRIPTION dlltool
3012
c7c55b78
NC
3013@command{dlltool} reads its inputs, which can come from the @option{-d} and
3014@option{-b} options as well as object files specified on the command
3015line. It then processes these inputs and if the @option{-e} option has
3016been specified it creates a exports file. If the @option{-l} option
3017has been specified it creates a library file and if the @option{-z} option
3018has been specified it creates a def file. Any or all of the @option{-e},
3019@option{-l} and @option{-z} options can be present in one invocation of
3020dlltool.
252b5132
RH
3021
3022When creating a DLL, along with the source for the DLL, it is necessary
c7c55b78 3023to have three other files. @command{dlltool} can help with the creation of
252b5132
RH
3024these files.
3025
2aa9814e 3026The first file is a @file{.def} file which specifies which functions are
252b5132 3027exported from the DLL, which functions the DLL imports, and so on. This
c7c55b78
NC
3028is a text file and can be created by hand, or @command{dlltool} can be used
3029to create it using the @option{-z} option. In this case @command{dlltool}
252b5132
RH
3030will scan the object files specified on its command line looking for
3031those functions which have been specially marked as being exported and
2aa9814e 3032put entries for them in the @file{.def} file it creates.
252b5132
RH
3033
3034In order to mark a function as being exported from a DLL, it needs to
c7c55b78 3035have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
252b5132
RH
3036section of the object file. This can be done in C by using the
3037asm() operator:
3038
3039@smallexample
3040 asm (".section .drectve");
3041 asm (".ascii \"-export:my_func\"");
3042
3043 int my_func (void) @{ @dots{} @}
3044@end smallexample
3045
3046The second file needed for DLL creation is an exports file. This file
3047is linked with the object files that make up the body of the DLL and it
3048handles the interface between the DLL and the outside world. This is a
c7c55b78 3049binary file and it can be created by giving the @option{-e} option to
2aa9814e 3050@command{dlltool} when it is creating or reading in a @file{.def} file.
252b5132
RH
3051
3052The third file needed for DLL creation is the library file that programs
3053will link with in order to access the functions in the DLL. This file
c7c55b78 3054can be created by giving the @option{-l} option to dlltool when it
2aa9814e 3055is creating or reading in a @file{.def} file.
252b5132 3056
c7c55b78 3057@command{dlltool} builds the library file by hand, but it builds the
252b5132 3058exports file by creating temporary files containing assembler statements
c7c55b78 3059and then assembling these. The @option{-S} command line option can be
252b5132 3060used to specify the path to the assembler that dlltool will use,
c7c55b78
NC
3061and the @option{-f} option can be used to pass specific flags to that
3062assembler. The @option{-n} can be used to prevent dlltool from deleting
3063these temporary assembler files when it is done, and if @option{-n} is
252b5132
RH
3064specified twice then this will prevent dlltool from deleting the
3065temporary object files it used to build the library.
3066
3067Here is an example of creating a DLL from a source file @samp{dll.c} and
3068also creating a program (from an object file called @samp{program.o})
3069that uses that DLL:
3070
3071@smallexample
3072 gcc -c dll.c
3073 dlltool -e exports.o -l dll.lib dll.o
3074 gcc dll.o exports.o -o dll.dll
3075 gcc program.o dll.lib -o program
3076@end smallexample
3077
0285c67d
NC
3078@c man end
3079
3080@c man begin OPTIONS dlltool
3081
252b5132
RH
3082The command line options have the following meanings:
3083
c7c55b78 3084@table @env
252b5132
RH
3085
3086@item -d @var{filename}
3087@itemx --input-def @var{filename}
3088@cindex input .def file
2aa9814e 3089Specifies the name of a @file{.def} file to be read in and processed.
252b5132
RH
3090
3091@item -b @var{filename}
3092@itemx --base-file @var{filename}
3093@cindex base files
3094Specifies the name of a base file to be read in and processed. The
3095contents of this file will be added to the relocation section in the
3096exports file generated by dlltool.
3097
3098@item -e @var{filename}
3099@itemx --output-exp @var{filename}
3100Specifies the name of the export file to be created by dlltool.
3101
3102@item -z @var{filename}
3103@itemx --output-def @var{filename}
2aa9814e 3104Specifies the name of the @file{.def} file to be created by dlltool.
252b5132
RH
3105
3106@item -l @var{filename}
3107@itemx --output-lib @var{filename}
3108Specifies the name of the library file to be created by dlltool.
3109
3110@item --export-all-symbols
3111Treat all global and weak defined symbols found in the input object
3112files as symbols to be exported. There is a small list of symbols which
c7c55b78 3113are not exported by default; see the @option{--no-default-excludes}
252b5132 3114option. You may add to the list of symbols to not export by using the
c7c55b78 3115@option{--exclude-symbols} option.
252b5132
RH
3116
3117@item --no-export-all-symbols
2aa9814e 3118Only export symbols explicitly listed in an input @file{.def} file or in
252b5132
RH
3119@samp{.drectve} sections in the input object files. This is the default
3120behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
3121attributes in the source code.
3122
3123@item --exclude-symbols @var{list}
3124Do not export the symbols in @var{list}. This is a list of symbol names
3125separated by comma or colon characters. The symbol names should not
3126contain a leading underscore. This is only meaningful when
c7c55b78 3127@option{--export-all-symbols} is used.
252b5132
RH
3128
3129@item --no-default-excludes
c7c55b78 3130When @option{--export-all-symbols} is used, it will by default avoid
252b5132
RH
3131exporting certain special symbols. The current list of symbols to avoid
3132exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
c7c55b78 3133@samp{impure_ptr}. You may use the @option{--no-default-excludes} option
252b5132 3134to go ahead and export these special symbols. This is only meaningful
c7c55b78 3135when @option{--export-all-symbols} is used.
252b5132
RH
3136
3137@item -S @var{path}
3138@itemx --as @var{path}
3139Specifies the path, including the filename, of the assembler to be used
3140to create the exports file.
3141
6364e0b4
NC
3142@item -f @var{options}
3143@itemx --as-flags @var{options}
3144Specifies any specific command line options to be passed to the
252b5132 3145assembler when building the exports file. This option will work even if
c7c55b78 3146the @option{-S} option is not used. This option only takes one argument,
252b5132
RH
3147and if it occurs more than once on the command line, then later
3148occurrences will override earlier occurrences. So if it is necessary to
6364e0b4 3149pass multiple options to the assembler they should be enclosed in
252b5132
RH
3150double quotes.
3151
3152@item -D @var{name}
3153@itemx --dll-name @var{name}
2aa9814e
BE
3154Specifies the name to be stored in the @file{.def} file as the name of
3155the DLL when the @option{-e} option is used. If this option is not
3156present, then the filename given to the @option{-e} option will be
3157used as the name of the DLL.
252b5132
RH
3158
3159@item -m @var{machine}
3160@itemx -machine @var{machine}
3161Specifies the type of machine for which the library file should be
c7c55b78 3162built. @command{dlltool} has a built in default type, depending upon how
252b5132
RH
3163it was created, but this option can be used to override that. This is
3164normally only useful when creating DLLs for an ARM processor, when the
c36774d6 3165contents of the DLL are actually encode using Thumb instructions.
252b5132
RH
3166
3167@item -a
3168@itemx --add-indirect
c7c55b78 3169Specifies that when @command{dlltool} is creating the exports file it
252b5132
RH
3170should add a section which allows the exported functions to be
3171referenced without using the import library. Whatever the hell that
3172means!
3173
3174@item -U
3175@itemx --add-underscore
c7c55b78 3176Specifies that when @command{dlltool} is creating the exports file it
252b5132
RH
3177should prepend an underscore to the names of the exported functions.
3178
3179@item -k
3180@itemx --kill-at
c7c55b78 3181Specifies that when @command{dlltool} is creating the exports file it
d67a454c
NC
3182should not append the string @samp{@@ <number>}. These numbers are
3183called ordinal numbers and they represent another way of accessing the
3184function in a DLL, other than by name.
252b5132
RH
3185
3186@item -A
3187@itemx --add-stdcall-alias
c7c55b78 3188Specifies that when @command{dlltool} is creating the exports file it
252b5132
RH
3189should add aliases for stdcall symbols without @samp{@@ <number>}
3190in addition to the symbols with @samp{@@ <number>}.
3191
607dea97
NC
3192@item -p
3193@itemx --ext-prefix-alias @var{prefix}
3194Causes @command{dlltool} to create external aliases for all DLL
3195imports with the specified prefix. The aliases are created for both
3196external and import symbols with no leading underscore.
3197
252b5132
RH
3198@item -x
3199@itemx --no-idata4
c7c55b78
NC
3200Specifies that when @command{dlltool} is creating the exports and library
3201files it should omit the @code{.idata4} section. This is for compatibility
252b5132
RH
3202with certain operating systems.
3203
3204@item -c
3205@itemx --no-idata5
c7c55b78
NC
3206Specifies that when @command{dlltool} is creating the exports and library
3207files it should omit the @code{.idata5} section. This is for compatibility
252b5132
RH
3208with certain operating systems.
3209
3210@item -i
3211@itemx --interwork
c7c55b78 3212Specifies that @command{dlltool} should mark the objects in the library
252b5132 3213file and exports file that it produces as supporting interworking
c36774d6 3214between ARM and Thumb code.
252b5132
RH
3215
3216@item -n
3217@itemx --nodelete
c7c55b78 3218Makes @command{dlltool} preserve the temporary assembler files it used to
252b5132
RH
3219create the exports file. If this option is repeated then dlltool will
3220also preserve the temporary object files it uses to create the library
f9346411
DS
3221file.
3222
3223@item -t @var{prefix}
3224@itemx --temp-prefix @var{prefix}
3225Makes @command{dlltool} use @var{prefix} when constructing the names of
3226temporary assembler and object files. By default, the temp file prefix
3227is generated from the pid.
252b5132
RH
3228
3229@item -v
3230@itemx --verbose
3231Make dlltool describe what it is doing.
3232
3233@item -h
3234@itemx --help
3235Displays a list of command line options and then exits.
3236
3237@item -V
3238@itemx --version
3239Displays dlltool's version number and then exits.
3240
3241@end table
3242
0285c67d
NC
3243@c man end
3244
2aa9814e
BE
3245@menu
3246* def file format:: The format of the dlltool @file{.def} file
3247@end menu
3248
3249@node def file format
3250@section The format of the @command{dlltool} @file{.def} file
3251
3252A @file{.def} file contains any number of the following commands:
3253
3254@table @asis
3255
3256@item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
3257The result is going to be named @var{name}@code{.exe}.
3258
3259@item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
3260The result is going to be named @var{name}@code{.dll}.
3261
3262@item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) )}
3263@item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
3264Declares @var{name1} as an exported symbol from the DLL, with optional
3265ordinal number @var{integer}, or declares @var{name1} as an alias
3266(forward) of the function @var{external-name} in the DLL
3267@var{module-name}.
3268
3269@item @code{IMPORTS ( (} @var{internal-name} @code{=} @var{module-name} @code{.} @var{integer} @code{) | [} @var{internal-name} @code{= ]} @var{module-name} @code{.} @var{external-name} @code{) ) *}
3270Declares that @var{external-name} or the exported function whose
3271ordinal number is @var{integer} is to be imported from the file
3272@var{module-name}. If @var{internal-name} is specified then this is
3273the name that the imported function will be referred to in the body of
3274the DLL.
3275
3276@item @code{DESCRIPTION} @var{string}
3277Puts @var{string} into the output @file{.exp} file in the
3278@code{.rdata} section.
3279
3280@item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3281@item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3282Generates @code{--stack} or @code{--heap}
3283@var{number-reserve},@var{number-commit} in the output @code{.drectve}
3284section. The linker will see this and act upon it.
3285
3286@item @code{CODE} @var{attr} @code{+}
3287@item @code{DATA} @var{attr} @code{+}
3288@item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
3289Generates @code{--attr} @var{section-name} @var{attr} in the output
3290@code{.drectve} section, where @var{attr} is one of @code{READ},
3291@code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
3292this and act upon it.
3293
3294@end table
3295
0285c67d
NC
3296@ignore
3297@c man begin SEEALSO dlltool
2aa9814e 3298The Info pages for @file{binutils}.
0285c67d
NC
3299@c man end
3300@end ignore
3301
252b5132
RH
3302@node readelf
3303@chapter readelf
3304
3305@cindex ELF file information
3306@kindex readelf
3307
0285c67d
NC
3308@c man title readelf Displays information about ELF files.
3309
252b5132 3310@smallexample
0285c67d 3311@c man begin SYNOPSIS readelf
c7c55b78
NC
3312readelf [@option{-a}|@option{--all}]
3313 [@option{-h}|@option{--file-header}]
3314 [@option{-l}|@option{--program-headers}|@option{--segments}]
3315 [@option{-S}|@option{--section-headers}|@option{--sections}]
81fc812e 3316 [@option{-g}|@option{--section-groups}]
5477e8a0 3317 [@option{-t}|@option{--section-details}]
c7c55b78
NC
3318 [@option{-e}|@option{--headers}]
3319 [@option{-s}|@option{--syms}|@option{--symbols}]
3320 [@option{-n}|@option{--notes}]
3321 [@option{-r}|@option{--relocs}]
3322 [@option{-u}|@option{--unwind}]
3323 [@option{-d}|@option{--dynamic}]
3324 [@option{-V}|@option{--version-info}]
947ed062 3325 [@option{-A}|@option{--arch-specific}]
c7c55b78 3326 [@option{-D}|@option{--use-dynamic}]
aef1f6d0 3327 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
18bd398b
NC
3328 [@option{-w[liaprmfFsoR]}|
3329 @option{--debug-dump}[=line,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]]
947ed062 3330 [@option{-I}|@option{-histogram}]
c7c55b78 3331 [@option{-v}|@option{--version}]
d974e256 3332 [@option{-W}|@option{--wide}]
c7c55b78 3333 [@option{-H}|@option{--help}]
252b5132 3334 @var{elffile}@dots{}
0285c67d 3335@c man end
252b5132
RH
3336@end smallexample
3337
0285c67d
NC
3338@c man begin DESCRIPTION readelf
3339
c7c55b78 3340@command{readelf} displays information about one or more ELF format object
252b5132
RH
3341files. The options control what particular information to display.
3342
fb52b2f4
NC
3343@var{elffile}@dots{} are the object files to be examined. 32-bit and
334464-bit ELF files are supported, as are archives containing ELF files.
252b5132 3345
9eb20dd8
NC
3346This program performs a similar function to @command{objdump} but it
3347goes into more detail and it exists independently of the @sc{bfd}
3348library, so if there is a bug in @sc{bfd} then readelf will not be
3349affected.
3350
0285c67d
NC
3351@c man end
3352
3353@c man begin OPTIONS readelf
3354
252b5132
RH
3355The long and short forms of options, shown here as alternatives, are
3356equivalent. At least one option besides @samp{-v} or @samp{-H} must be
3357given.
3358
c7c55b78 3359@table @env
252b5132
RH
3360@item -a
3361@itemx --all
c7c55b78
NC
3362Equivalent to specifiying @option{--file-header},
3363@option{--program-headers}, @option{--sections}, @option{--symbols},
3364@option{--relocs}, @option{--dynamic}, @option{--notes} and
3365@option{--version-info}.
252b5132
RH
3366
3367@item -h
3368@itemx --file-header
3369@cindex ELF file header information
3370Displays the information contained in the ELF header at the start of the
3371file.
3372
3373@item -l
3374@itemx --program-headers
3375@itemx --segments
3376@cindex ELF program header information
3377@cindex ELF segment information
3378Displays the information contained in the file's segment headers, if it
3379has any.
3380
3381@item -S
3382@itemx --sections
3383@itemx --section-headers
3384@cindex ELF section information
3385Displays the information contained in the file's section headers, if it
3386has any.
3387
81fc812e
L
3388@item -g
3389@itemx --section-groups
3390@cindex ELF section group information
3391Displays the information contained in the file's section groups, if it
3392has any.
3393
5477e8a0
L
3394@item -t
3395@itemx --section-details
3396@cindex ELF section information
3397Displays the detailed section information. Implies @option{-S}.
81fc812e 3398
252b5132
RH
3399@item -s
3400@itemx --symbols
3401@itemx --syms
3402@cindex ELF symbol table information
3403Displays the entries in symbol table section of the file, if it has one.
3404
3405@item -e
3406@itemx --headers
c7c55b78 3407Display all the headers in the file. Equivalent to @option{-h -l -S}.
252b5132 3408
779fe533
NC
3409@item -n
3410@itemx --notes
1ec5cd37
NC
3411@cindex ELF notes
3412Displays the contents of the NOTE segments and/or sections, if any.
779fe533 3413
252b5132
RH
3414@item -r
3415@itemx --relocs
3416@cindex ELF reloc information
f5e21966
NC
3417Displays the contents of the file's relocation section, if it has one.
3418
3419@item -u
3420@itemx --unwind
3421@cindex unwind information
3422Displays the contents of the file's unwind section, if it has one. Only
3423the unwind sections for IA64 ELF files are currently supported.
252b5132
RH
3424
3425@item -d
3426@itemx --dynamic
3427@cindex ELF dynamic section information
3428Displays the contents of the file's dynamic section, if it has one.
3429
3430@item -V
3431@itemx --version-info
3432@cindex ELF version sections informations
3433Displays the contents of the version sections in the file, it they
3434exist.
3435
947ed062
NC
3436@item -A
3437@itemx --arch-specific
3438Displays architecture-specific information in the file, if there
3439is any.
3440
252b5132
RH
3441@item -D
3442@itemx --use-dynamic
c7c55b78 3443When displaying symbols, this option makes @command{readelf} use the
6dbb55b6 3444symbol table in the file's dynamic section, rather than the one in the
252b5132
RH
3445symbols section.
3446
aef1f6d0
DJ
3447@item -x <number or name>
3448@itemx --hex-dump=<number or name>
252b5132 3449Displays the contents of the indicated section as a hexadecimal dump.
aef1f6d0
DJ
3450A number identifies a particular section by index in the section table;
3451any other string identifies all sections with that name in the object file.
252b5132 3452
18bd398b
NC
3453@item -w[liaprmfFsoR]
3454@itemx --debug-dump[=line,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]
252b5132
RH
3455Displays the contents of the debug sections in the file, if any are
3456present. If one of the optional letters or words follows the switch
3457then only data found in those specific sections will be dumped.
3458
947ed062
NC
3459@item -I
3460@itemx --histogram
252b5132
RH
3461Display a histogram of bucket list lengths when displaying the contents
3462of the symbol tables.
3463
3464@item -v
3465@itemx --version
3466Display the version number of readelf.
3467
d974e256
JJ
3468@item -W
3469@itemx --wide
3470Don't break output lines to fit into 80 columns. By default
3471@command{readelf} breaks section header and segment listing lines for
347264-bit ELF files, so that they fit into 80 columns. This option causes
3473@command{readelf} to print each section header resp. each segment one a
3474single line, which is far more readable on terminals wider than 80 columns.
3475
252b5132
RH
3476@item -H
3477@itemx --help
c7c55b78 3478Display the command line options understood by @command{readelf}.
252b5132
RH
3479
3480@end table
3481
0285c67d
NC
3482@c man end
3483
3484@ignore
3485@c man begin SEEALSO readelf
3486objdump(1), and the Info entries for @file{binutils}.
3487@c man end
3488@end ignore
252b5132 3489
07012eee
MM
3490@node Common Options
3491@chapter Common Options
3492
3493The following command-line options are supported by all of the
3494programs described in this manual.
3495
3496@table @env
1334d4d5 3497@include @value{top_srcdir}/../libiberty/at-file.texi
07012eee
MM
3498
3499@item --help
3500Display the command-line options supported by the program.
3501
3502@item --version
3503Display the version number of the program.
3504
3505@end table
3506
252b5132 3507@node Selecting The Target System
947ed062 3508@chapter Selecting the Target System
252b5132 3509
947ed062 3510You can specify two aspects of the target system to the @sc{gnu}
252b5132
RH
3511binary file utilities, each in several ways:
3512
3513@itemize @bullet
3514@item
3515the target
3516
3517@item
3518the architecture
252b5132
RH
3519@end itemize
3520
3521In the following summaries, the lists of ways to specify values are in
3522order of decreasing precedence. The ways listed first override those
3523listed later.
3524
3525The commands to list valid values only list the values for which the
3526programs you are running were configured. If they were configured with
c7c55b78 3527@option{--enable-targets=all}, the commands list most of the available
252b5132
RH
3528values, but a few are left out; not all targets can be configured in at
3529once because some of them can only be configured @dfn{native} (on hosts
3530with the same type as the target system).
3531
3532@menu
3533* Target Selection::
3534* Architecture Selection::
252b5132
RH
3535@end menu
3536
3537@node Target Selection
3538@section Target Selection
3539
3540A @dfn{target} is an object file format. A given target may be
3541supported for multiple architectures (@pxref{Architecture Selection}).
3542A target selection may also have variations for different operating
3543systems or architectures.
3544
3545The command to list valid target values is @samp{objdump -i}
3546(the first column of output contains the relevant information).
3547
3548Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
3549@samp{a.out-sunos-big}.
3550
3551You can also specify a target using a configuration triplet. This is
f20a759a
ILT
3552the same sort of name that is passed to @file{configure} to specify a
3553target. When you use a configuration triplet as an argument, it must be
3554fully canonicalized. You can see the canonical version of a triplet by
252b5132
RH
3555running the shell script @file{config.sub} which is included with the
3556sources.
3557
3558Some sample configuration triplets are: @samp{m68k-hp-bsd},
3559@samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
3560
c7c55b78 3561@subheading @command{objdump} Target
252b5132
RH
3562
3563Ways to specify:
3564
3565@enumerate
3566@item
c7c55b78 3567command line option: @option{-b} or @option{--target}
252b5132
RH
3568
3569@item
3570environment variable @code{GNUTARGET}
3571
3572@item
3573deduced from the input file
3574@end enumerate
3575
c7c55b78 3576@subheading @command{objcopy} and @command{strip} Input Target
252b5132
RH
3577
3578Ways to specify:
3579
3580@enumerate
3581@item
c7c55b78 3582command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
252b5132
RH
3583
3584@item
3585environment variable @code{GNUTARGET}
3586
3587@item
3588deduced from the input file
3589@end enumerate
3590
c7c55b78 3591@subheading @command{objcopy} and @command{strip} Output Target
252b5132
RH
3592
3593Ways to specify:
3594
3595@enumerate
3596@item
c7c55b78 3597command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
252b5132
RH
3598
3599@item
c7c55b78 3600the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
252b5132
RH
3601
3602@item
3603environment variable @code{GNUTARGET}
3604
3605@item
3606deduced from the input file
3607@end enumerate
3608
c7c55b78 3609@subheading @command{nm}, @command{size}, and @command{strings} Target
252b5132
RH
3610
3611Ways to specify:
3612
3613@enumerate
3614@item
c7c55b78 3615command line option: @option{--target}
252b5132
RH
3616
3617@item
3618environment variable @code{GNUTARGET}
3619
3620@item
3621deduced from the input file
3622@end enumerate
3623
252b5132 3624@node Architecture Selection
947ed062 3625@section Architecture Selection
252b5132
RH
3626
3627An @dfn{architecture} is a type of @sc{cpu} on which an object file is
3628to run. Its name may contain a colon, separating the name of the
3629processor family from the name of the particular @sc{cpu}.
3630
3631The command to list valid architecture values is @samp{objdump -i} (the
3632second column contains the relevant information).
3633
3634Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
3635
c7c55b78 3636@subheading @command{objdump} Architecture
252b5132
RH
3637
3638Ways to specify:
3639
3640@enumerate
3641@item
c7c55b78 3642command line option: @option{-m} or @option{--architecture}
252b5132
RH
3643
3644@item
3645deduced from the input file
3646@end enumerate
3647
c7c55b78 3648@subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
252b5132
RH
3649
3650Ways to specify:
3651
3652@enumerate
3653@item
3654deduced from the input file
3655@end enumerate
3656
252b5132
RH
3657@node Reporting Bugs
3658@chapter Reporting Bugs
3659@cindex bugs
3660@cindex reporting bugs
3661
3662Your bug reports play an essential role in making the binary utilities
3663reliable.
3664
3665Reporting a bug may help you by bringing a solution to your problem, or
3666it may not. But in any case the principal function of a bug report is
3667to help the entire community by making the next version of the binary
3668utilities work better. Bug reports are your contribution to their
3669maintenance.
3670
3671In order for a bug report to serve its purpose, you must include the
3672information that enables us to fix the bug.
3673
3674@menu
3675* Bug Criteria:: Have you found a bug?
3676* Bug Reporting:: How to report bugs
3677@end menu
3678
3679@node Bug Criteria
947ed062 3680@section Have You Found a Bug?
252b5132
RH
3681@cindex bug criteria
3682
3683If you are not sure whether you have found a bug, here are some guidelines:
3684
3685@itemize @bullet
3686@cindex fatal signal
3687@cindex crash
3688@item
3689If a binary utility gets a fatal signal, for any input whatever, that is
3690a bug. Reliable utilities never crash.
3691
3692@cindex error on valid input
3693@item
3694If a binary utility produces an error message for valid input, that is a
3695bug.
3696
3697@item
3698If you are an experienced user of binary utilities, your suggestions for
3699improvement are welcome in any case.
3700@end itemize
3701
3702@node Bug Reporting
947ed062 3703@section How to Report Bugs
252b5132
RH
3704@cindex bug reports
3705@cindex bugs, reporting
3706
3707A number of companies and individuals offer support for @sc{gnu}
3708products. If you obtained the binary utilities from a support
3709organization, we recommend you contact that organization first.
3710
3711You can find contact information for many support companies and
3712individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
3713distribution.
3714
3715In any event, we also recommend that you send bug reports for the binary
2f952d20 3716utilities to @samp{bug-binutils@@gnu.org}.
252b5132
RH
3717
3718The fundamental principle of reporting bugs usefully is this:
3719@strong{report all the facts}. If you are not sure whether to state a
3720fact or leave it out, state it!
3721
3722Often people omit facts because they think they know what causes the
3723problem and assume that some details do not matter. Thus, you might
3724assume that the name of a file you use in an example does not matter.
3725Well, probably it does not, but one cannot be sure. Perhaps the bug is
3726a stray memory reference which happens to fetch from the location where
3727that pathname is stored in memory; perhaps, if the pathname were
3728different, the contents of that location would fool the utility into
3729doing the right thing despite the bug. Play it safe and give a
3730specific, complete example. That is the easiest thing for you to do,
3731and the most helpful.
3732
3733Keep in mind that the purpose of a bug report is to enable us to fix the bug if
3734it is new to us. Therefore, always write your bug reports on the assumption
3735that the bug has not been reported previously.
3736
3737Sometimes people give a few sketchy facts and ask, ``Does this ring a
947ed062
NC
3738bell?'' This cannot help us fix a bug, so it is basically useless. We
3739respond by asking for enough details to enable us to investigate.
3740You might as well expedite matters by sending them to begin with.
252b5132
RH
3741
3742To enable us to fix the bug, you should include all these things:
3743
3744@itemize @bullet
3745@item
3746The version of the utility. Each utility announces it if you start it
c7c55b78 3747with the @option{--version} argument.
252b5132
RH
3748
3749Without this, we will not know whether there is any point in looking for
3750the bug in the current version of the binary utilities.
3751
3752@item
3753Any patches you may have applied to the source, including any patches
3754made to the @code{BFD} library.
3755
3756@item
3757The type of machine you are using, and the operating system name and
3758version number.
3759
3760@item
3761What compiler (and its version) was used to compile the utilities---e.g.
3762``@code{gcc-2.7}''.
3763
3764@item
3765The command arguments you gave the utility to observe the bug. To
3766guarantee you will not omit something important, list them all. A copy
3767of the Makefile (or the output from make) is sufficient.
3768
3769If we were to try to guess the arguments, we would probably guess wrong
3770and then we might not encounter the bug.
3771
3772@item
3773A complete input file, or set of input files, that will reproduce the
3774bug. If the utility is reading an object file or files, then it is
3775generally most helpful to send the actual object files, uuencoded if
757acbc5 3776necessary to get them through the mail system. Note that
2f952d20 3777@samp{bug-binutils@@gnu.org} is a mailing list, so you should avoid
757acbc5
ILT
3778sending very large files to it. Making the files available for
3779anonymous FTP is OK.
252b5132
RH
3780
3781If the source files were produced exclusively using @sc{gnu} programs
c7c55b78 3782(e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
252b5132 3783may be OK to send the source files rather than the object files. In
c7c55b78 3784this case, be sure to say exactly what version of @command{gcc}, or
252b5132 3785whatever, was used to produce the object files. Also say how
c7c55b78 3786@command{gcc}, or whatever, was configured.
252b5132
RH
3787
3788@item
3789A description of what behavior you observe that you believe is
3790incorrect. For example, ``It gets a fatal signal.''
3791
3792Of course, if the bug is that the utility gets a fatal signal, then we
3793will certainly notice it. But if the bug is incorrect output, we might
3794not notice unless it is glaringly wrong. You might as well not give us
3795a chance to make a mistake.
3796
3797Even if the problem you experience is a fatal signal, you should still
f20a759a 3798say so explicitly. Suppose something strange is going on, such as your
252b5132
RH
3799copy of the utility is out of synch, or you have encountered a bug in
3800the C library on your system. (This has happened!) Your copy might
3801crash and ours would not. If you told us to expect a crash, then when
3802ours fails to crash, we would know that the bug was not happening for
3803us. If you had not told us to expect a crash, then we would not be able
3804to draw any conclusion from our observations.
3805
3806@item
3807If you wish to suggest changes to the source, send us context diffs, as
c7c55b78 3808generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
252b5132 3809option. Always send diffs from the old file to the new file. If you
c7c55b78 3810wish to discuss something in the @command{ld} source, refer to it by
f20a759a 3811context, not by line number.
252b5132
RH
3812
3813The line numbers in our development sources will not match those in your
3814sources. Your line numbers would convey no useful information to us.
3815@end itemize
3816
3817Here are some things that are not necessary:
3818
3819@itemize @bullet
3820@item
3821A description of the envelope of the bug.
3822
3823Often people who encounter a bug spend a lot of time investigating
3824which changes to the input file will make the bug go away and which
3825changes will not affect it.
3826
3827This is often time consuming and not very useful, because the way we
3828will find the bug is by running a single example under the debugger
3829with breakpoints, not by pure deduction from a series of examples.
3830We recommend that you save your time for something else.
3831
3832Of course, if you can find a simpler example to report @emph{instead}
3833of the original one, that is a convenience for us. Errors in the
3834output will be easier to spot, running under the debugger will take
3835less time, and so on.
3836
3837However, simplification is not vital; if you do not want to do this,
3838report the bug anyway and send us the entire test case you used.
3839
3840@item
3841A patch for the bug.
3842
3843A patch for the bug does help us if it is a good one. But do not omit
3844the necessary information, such as the test case, on the assumption that
3845a patch is all we need. We might see problems with your patch and decide
3846to fix the problem another way, or we might not understand it at all.
3847
3848Sometimes with programs as complicated as the binary utilities it is
3849very hard to construct an example that will make the program follow a
3850certain path through the code. If you do not send us the example, we
3851will not be able to construct one, so we will not be able to verify that
3852the bug is fixed.
3853
3854And if we cannot understand what bug you are trying to fix, or why your
3855patch should be an improvement, we will not install it. A test case will
3856help us to understand.
3857
3858@item
3859A guess about what the bug is or what it depends on.
3860
3861Such guesses are usually wrong. Even we cannot guess right about such
3862things without first using the debugger to find the facts.
3863@end itemize
3864
947ed062 3865@include fdl.texi
cf055d54 3866
252b5132
RH
3867@node Index
3868@unnumbered Index
3869
3870@printindex cp
3871
3872@contents
3873@bye
This page took 0.6345 seconds and 4 git commands to generate.