* ldlang.h (lang_input_section_type): Remove "ifile" field.
[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 993 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1637cd90 994 [@option{--keep-file-symbols}]
ed1653a7 995 [@option{--only-keep-debug}]
4087920c
MR
996 [@option{--writable-text}]
997 [@option{--readonly-text}]
998 [@option{--pure}]
999 [@option{--impure}]
c7c55b78
NC
1000 [@option{-v}|@option{--verbose}]
1001 [@option{-V}|@option{--version}]
7c29036b 1002 [@option{--help}] [@option{--info}]
252b5132 1003 @var{infile} [@var{outfile}]
0285c67d 1004@c man end
252b5132
RH
1005@end smallexample
1006
0285c67d 1007@c man begin DESCRIPTION objcopy
c7c55b78
NC
1008The @sc{gnu} @command{objcopy} utility copies the contents of an object
1009file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
252b5132
RH
1010read and write the object files. It can write the destination object
1011file in a format different from that of the source object file. The
c7c55b78
NC
1012exact behavior of @command{objcopy} is controlled by command-line options.
1013Note that @command{objcopy} should be able to copy a fully linked file
ccd13d18
L
1014between any two formats. However, copying a relocatable object file
1015between any two formats may not work as expected.
252b5132 1016
c7c55b78
NC
1017@command{objcopy} creates temporary files to do its translations and
1018deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
252b5132
RH
1019translation work; it has access to all the formats described in @sc{bfd}
1020and thus is able to recognize most formats without being told
1021explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1022
c7c55b78 1023@command{objcopy} can be used to generate S-records by using an output
252b5132
RH
1024target of @samp{srec} (e.g., use @samp{-O srec}).
1025
c7c55b78
NC
1026@command{objcopy} can be used to generate a raw binary file by using an
1027output target of @samp{binary} (e.g., use @option{-O binary}). When
1028@command{objcopy} generates a raw binary file, it will essentially produce
252b5132
RH
1029a memory dump of the contents of the input object file. All symbols and
1030relocation information will be discarded. The memory dump will start at
1031the load address of the lowest section copied into the output file.
1032
1033When generating an S-record or a raw binary file, it may be helpful to
c7c55b78
NC
1034use @option{-S} to remove sections containing debugging information. In
1035some cases @option{-R} will be useful to remove sections which contain
f20a759a 1036information that is not needed by the binary file.
252b5132 1037
947ed062
NC
1038Note---@command{objcopy} is not able to change the endianness of its input
1039files. If the input format has an endianness (some formats do not),
c7c55b78 1040@command{objcopy} can only copy the inputs into file formats that have the
947ed062 1041same endianness or which have no endianness (e.g., @samp{srec}).
18356cf2 1042
0285c67d
NC
1043@c man end
1044
1045@c man begin OPTIONS objcopy
1046
c7c55b78 1047@table @env
252b5132
RH
1048@item @var{infile}
1049@itemx @var{outfile}
f20a759a 1050The input and output files, respectively.
c7c55b78 1051If you do not specify @var{outfile}, @command{objcopy} creates a
252b5132
RH
1052temporary file and destructively renames the result with
1053the name of @var{infile}.
1054
c7c55b78 1055@item -I @var{bfdname}
252b5132
RH
1056@itemx --input-target=@var{bfdname}
1057Consider the source file's object format to be @var{bfdname}, rather than
1058attempting to deduce it. @xref{Target Selection}, for more information.
1059
1060@item -O @var{bfdname}
1061@itemx --output-target=@var{bfdname}
1062Write the output file using the object format @var{bfdname}.
1063@xref{Target Selection}, for more information.
1064
1065@item -F @var{bfdname}
1066@itemx --target=@var{bfdname}
1067Use @var{bfdname} as the object format for both the input and the output
1068file; i.e., simply transfer data from source to destination with no
1069translation. @xref{Target Selection}, for more information.
1070
43a0748c
NC
1071@item -B @var{bfdarch}
1072@itemx --binary-architecture=@var{bfdarch}
1073Useful when transforming a raw binary input file into an object file.
1074In this case the output architecture can be set to @var{bfdarch}. This
1075option will be ignored if the input file has a known @var{bfdarch}. You
1076can access this binary data inside a program by referencing the special
1077symbols that are created by the conversion process. These symbols are
1078called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1079_binary_@var{objfile}_size. e.g. you can transform a picture file into
1080an object file and then access it in your code using these symbols.
1081
f91ea849
ILT
1082@item -j @var{sectionname}
1083@itemx --only-section=@var{sectionname}
1084Copy only the named section from the input file to the output file.
1085This option may be given more than once. Note that using this option
1086inappropriately may make the output file unusable.
1087
252b5132
RH
1088@item -R @var{sectionname}
1089@itemx --remove-section=@var{sectionname}
1090Remove any section named @var{sectionname} from the output file. This
1091option may be given more than once. Note that using this option
1092inappropriately may make the output file unusable.
1093
1094@item -S
1095@itemx --strip-all
1096Do not copy relocation and symbol information from the source file.
1097
1098@item -g
1099@itemx --strip-debug
2593f09a 1100Do not copy debugging symbols or sections from the source file.
252b5132
RH
1101
1102@item --strip-unneeded
1103Strip all symbols that are not needed for relocation processing.
1104
1105@item -K @var{symbolname}
1106@itemx --keep-symbol=@var{symbolname}
e7f918ad
NC
1107When stripping symbols, keep symbol @var{symbolname} even if it would
1108normally be stripped. This option may be given more than once.
252b5132
RH
1109
1110@item -N @var{symbolname}
1111@itemx --strip-symbol=@var{symbolname}
1112Do not copy symbol @var{symbolname} from the source file. This option
1113may be given more than once.
1114
bcf32829
JB
1115@item --strip-unneeded-symbol=@var{symbolname}
1116Do not copy symbol @var{symbolname} from the source file unless it is needed
1117by a relocation. This option may be given more than once.
1118
16b2b71c
NC
1119@item -G @var{symbolname}
1120@itemx --keep-global-symbol=@var{symbolname}
1121Keep only symbol @var{symbolname} global. Make all other symbols local
1122to the file, so that they are not visible externally. This option may
1123be given more than once.
1124
252b5132
RH
1125@item -L @var{symbolname}
1126@itemx --localize-symbol=@var{symbolname}
1127Make symbol @var{symbolname} local to the file, so that it is not
1128visible externally. This option may be given more than once.
1129
1130@item -W @var{symbolname}
1131@itemx --weaken-symbol=@var{symbolname}
1132Make symbol @var{symbolname} weak. This option may be given more than once.
1133
7b4a0685
NC
1134@item --globalize-symbol=@var{symbolname}
1135Give symbol @var{symbolname} global scoping so that it is visible
1136outside of the file in which it is defined. This option may be given
1137more than once.
1138
5fe11841
NC
1139@item -w
1140@itemx --wildcard
1141Permit regular expressions in @var{symbolname}s used in other command
1142line options. The question mark (?), asterisk (*), backslash (\) and
1143square brackets ([]) operators can be used anywhere in the symbol
1144name. If the first character of the symbol name is the exclamation
1145point (!) then the sense of the switch is reversed for that symbol.
1146For example:
1147
1148@smallexample
1149 -w -W !foo -W fo*
1150@end smallexample
1151
1152would cause objcopy to weaken all symbols that start with ``fo''
1153except for the symbol ``foo''.
1154
252b5132
RH
1155@item -x
1156@itemx --discard-all
1157Do not copy non-global symbols from the source file.
1158@c FIXME any reason to prefer "non-global" to "local" here?
1159
1160@item -X
1161@itemx --discard-locals
1162Do not copy compiler-generated local symbols.
1163(These usually start with @samp{L} or @samp{.}.)
1164
1165@item -b @var{byte}
1166@itemx --byte=@var{byte}
1167Keep only every @var{byte}th byte of the input file (header data is not
1168affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
c7c55b78 1169where @var{interleave} is given by the @option{-i} or @option{--interleave}
252b5132
RH
1170option, or the default of 4. This option is useful for creating files
1171to program @sc{rom}. It is typically used with an @code{srec} output
1172target.
1173
1174@item -i @var{interleave}
1175@itemx --interleave=@var{interleave}
1176Only copy one out of every @var{interleave} bytes. Select which byte to
c7c55b78
NC
1177copy with the @option{-b} or @option{--byte} option. The default is 4.
1178@command{objcopy} ignores this option if you do not specify either @option{-b} or
1179@option{--byte}.
252b5132
RH
1180
1181@item -p
1182@itemx --preserve-dates
1183Set the access and modification dates of the output file to be the same
1184as those of the input file.
1185
1186@item --debugging
1187Convert debugging information, if possible. This is not the default
1188because only certain debugging formats are supported, and the
1189conversion process can be time consuming.
1190
1191@item --gap-fill @var{val}
1192Fill gaps between sections with @var{val}. This operation applies to
1193the @emph{load address} (LMA) of the sections. It is done by increasing
1194the size of the section with the lower address, and filling in the extra
1195space created with @var{val}.
1196
1197@item --pad-to @var{address}
1198Pad the output file up to the load address @var{address}. This is
1199done by increasing the size of the last section. The extra space is
c7c55b78 1200filled in with the value specified by @option{--gap-fill} (default zero).
252b5132
RH
1201
1202@item --set-start @var{val}
f20a759a 1203Set the start address of the new file to @var{val}. Not all object file
252b5132
RH
1204formats support setting the start address.
1205
1206@item --change-start @var{incr}
1207@itemx --adjust-start @var{incr}
1208@cindex changing start address
1209Change the start address by adding @var{incr}. Not all object file
1210formats support setting the start address.
1211
1212@item --change-addresses @var{incr}
1213@itemx --adjust-vma @var{incr}
1214@cindex changing object addresses
1215Change the VMA and LMA addresses of all sections, as well as the start
1216address, by adding @var{incr}. Some object file formats do not permit
1217section addresses to be changed arbitrarily. Note that this does not
1218relocate the sections; if the program expects sections to be loaded at a
1219certain address, and this option is used to change the sections such
1220that they are loaded at a different address, the program may fail.
1221
1222@item --change-section-address @var{section}@{=,+,-@}@var{val}
1223@itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1224@cindex changing section address
1225Set or change both the VMA address and the LMA address of the named
1226@var{section}. If @samp{=} is used, the section address is set to
1227@var{val}. Otherwise, @var{val} is added to or subtracted from the
c7c55b78 1228section address. See the comments under @option{--change-addresses},
252b5132 1229above. If @var{section} does not exist in the input file, a warning will
c7c55b78 1230be issued, unless @option{--no-change-warnings} is used.
252b5132
RH
1231
1232@item --change-section-lma @var{section}@{=,+,-@}@var{val}
1233@cindex changing section LMA
1234Set or change the LMA address of the named @var{section}. The LMA
1235address is the address where the section will be loaded into memory at
1236program load time. Normally this is the same as the VMA address, which
1237is the address of the section at program run time, but on some systems,
1238especially those where a program is held in ROM, the two can be
1239different. If @samp{=} is used, the section address is set to
1240@var{val}. Otherwise, @var{val} is added to or subtracted from the
c7c55b78 1241section address. See the comments under @option{--change-addresses},
252b5132 1242above. If @var{section} does not exist in the input file, a warning
c7c55b78 1243will be issued, unless @option{--no-change-warnings} is used.
252b5132
RH
1244
1245@item --change-section-vma @var{section}@{=,+,-@}@var{val}
1246@cindex changing section VMA
1247Set or change the VMA address of the named @var{section}. The VMA
1248address is the address where the section will be located once the
1249program has started executing. Normally this is the same as the LMA
1250address, which is the address where the section will be loaded into
1251memory, but on some systems, especially those where a program is held in
1252ROM, the two can be different. If @samp{=} is used, the section address
1253is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1254from the section address. See the comments under
c7c55b78 1255@option{--change-addresses}, above. If @var{section} does not exist in
252b5132 1256the input file, a warning will be issued, unless
c7c55b78 1257@option{--no-change-warnings} is used.
252b5132
RH
1258
1259@item --change-warnings
1260@itemx --adjust-warnings
c7c55b78
NC
1261If @option{--change-section-address} or @option{--change-section-lma} or
1262@option{--change-section-vma} is used, and the named section does not
252b5132
RH
1263exist, issue a warning. This is the default.
1264
1265@item --no-change-warnings
1266@itemx --no-adjust-warnings
c7c55b78
NC
1267Do not issue a warning if @option{--change-section-address} or
1268@option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
252b5132
RH
1269if the named section does not exist.
1270
1271@item --set-section-flags @var{section}=@var{flags}
1272Set the flags for the named section. The @var{flags} argument is a
1273comma separated string of flag names. The recognized names are
3994e2c6
ILT
1274@samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1275@samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1276@samp{debug}. You can set the @samp{contents} flag for a section which
1277does not have contents, but it is not meaningful to clear the
1278@samp{contents} flag of a section which does have contents--just remove
1279the section instead. Not all flags are meaningful for all object file
1280formats.
252b5132
RH
1281
1282@item --add-section @var{sectionname}=@var{filename}
1283Add a new section named @var{sectionname} while copying the file. The
1284contents of the new section are taken from the file @var{filename}. The
1285size of the section will be the size of the file. This option only
1286works on file formats which can support sections with arbitrary names.
1287
594ef5db
NC
1288@item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1289Rename a section from @var{oldname} to @var{newname}, optionally
1290changing the section's flags to @var{flags} in the process. This has
1291the advantage over usng a linker script to perform the rename in that
1292the output stays as an object file and does not become a linked
1293executable.
1294
1295This option is particularly helpful when the input format is binary,
1296since this will always create a section called .data. If for example,
1297you wanted instead to create a section called .rodata containing binary
1298data you could use the following command line to achieve it:
1299
1300@smallexample
1301 objcopy -I binary -O <output_format> -B <architecture> \
1302 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1303 <input_binary_file> <output_object_file>
1304@end smallexample
1305
252b5132
RH
1306@item --change-leading-char
1307Some object file formats use special characters at the start of
1308symbols. The most common such character is underscore, which compilers
c7c55b78 1309often add before every symbol. This option tells @command{objcopy} to
252b5132
RH
1310change the leading character of every symbol when it converts between
1311object file formats. If the object file formats use the same leading
1312character, this option has no effect. Otherwise, it will add a
1313character, or remove a character, or change a character, as
1314appropriate.
1315
1316@item --remove-leading-char
1317If the first character of a global symbol is a special symbol leading
1318character used by the object file format, remove the character. The
1319most common symbol leading character is underscore. This option will
1320remove a leading underscore from all global symbols. This can be useful
1321if you want to link together objects of different file formats with
1322different conventions for symbol names. This is different from
c7c55b78 1323@option{--change-leading-char} because it always changes the symbol name
252b5132
RH
1324when appropriate, regardless of the object file format of the output
1325file.
1326
420496c1
NC
1327@item --srec-len=@var{ival}
1328Meaningful only for srec output. Set the maximum length of the Srecords
1329being produced to @var{ival}. This length covers both address, data and
1330crc fields.
1331
1332@item --srec-forceS3
1333Meaningful only for srec output. Avoid generation of S1/S2 records,
1334creating S3-only record format.
1335
57938635
AM
1336@item --redefine-sym @var{old}=@var{new}
1337Change the name of a symbol @var{old}, to @var{new}. This can be useful
1338when one is trying link two things together for which you have no
1339source, and there are name collisions.
1340
92991082
JT
1341@item --redefine-syms=@var{filename}
1342Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1343listed in the file @var{filename}. @var{filename} is simply a flat file,
1344with one symbol pair per line. Line comments may be introduced by the hash
1345character. This option may be given more than once.
1346
252b5132
RH
1347@item --weaken
1348Change all global symbols in the file to be weak. This can be useful
1349when building an object which will be linked against other objects using
c7c55b78 1350the @option{-R} option to the linker. This option is only effective when
252b5132
RH
1351using an object file format which supports weak symbols.
1352
16b2b71c 1353@item --keep-symbols=@var{filename}
c7c55b78 1354Apply @option{--keep-symbol} option to each symbol listed in the file
16b2b71c
NC
1355@var{filename}. @var{filename} is simply a flat file, with one symbol
1356name per line. Line comments may be introduced by the hash character.
1357This option may be given more than once.
1358
1359@item --strip-symbols=@var{filename}
c7c55b78 1360Apply @option{--strip-symbol} option to each symbol listed in the file
16b2b71c
NC
1361@var{filename}. @var{filename} is simply a flat file, with one symbol
1362name per line. Line comments may be introduced by the hash character.
1363This option may be given more than once.
1364
bcf32829
JB
1365@item --strip-unneeded-symbols=@var{filename}
1366Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1367the file @var{filename}. @var{filename} is simply a flat file, with one
1368symbol name per line. Line comments may be introduced by the hash
1369character. This option may be given more than once.
1370
16b2b71c 1371@item --keep-global-symbols=@var{filename}
c7c55b78 1372Apply @option{--keep-global-symbol} option to each symbol listed in the
16b2b71c
NC
1373file @var{filename}. @var{filename} is simply a flat file, with one
1374symbol name per line. Line comments may be introduced by the hash
1375character. This option may be given more than once.
1376
1377@item --localize-symbols=@var{filename}
c7c55b78 1378Apply @option{--localize-symbol} option to each symbol listed in the file
16b2b71c
NC
1379@var{filename}. @var{filename} is simply a flat file, with one symbol
1380name per line. Line comments may be introduced by the hash character.
1381This option may be given more than once.
1382
7b4a0685
NC
1383@item --globalize-symbols=@var{filename}
1384Apply @option{--globalize-symbol} option to each symbol listed in the file
1385@var{filename}. @var{filename} is simply a flat file, with one symbol
1386name per line. Line comments may be introduced by the hash character.
1387This option may be given more than once.
1388
16b2b71c 1389@item --weaken-symbols=@var{filename}
c7c55b78 1390Apply @option{--weaken-symbol} option to each symbol listed in the file
16b2b71c
NC
1391@var{filename}. @var{filename} is simply a flat file, with one symbol
1392name per line. Line comments may be introduced by the hash character.
1393This option may be given more than once.
1394
1ae8b3d2
AO
1395@item --alt-machine-code=@var{index}
1396If the output architecture has alternate machine codes, use the
1397@var{index}th code instead of the default one. This is useful in case
1398a machine is assigned an official code and the tool-chain adopts the
1399new code, but other applications still depend on the original code
1400being used.
1401
4087920c
MR
1402@item --writable-text
1403Mark the output text as writable. This option isn't meaningful for all
1404object file formats.
1405
1406@item --readonly-text
1407Make the output text write protected. This option isn't meaningful for all
1408object file formats.
1409
1410@item --pure
1411Mark the output file as demand paged. This option isn't meaningful for all
1412object file formats.
1413
1414@item --impure
1415Mark the output file as impure. This option isn't meaningful for all
1416object file formats.
1417
d7fb0dd2
NC
1418@item --prefix-symbols=@var{string}
1419Prefix all symbols in the output file with @var{string}.
1420
1421@item --prefix-sections=@var{string}
1422Prefix all section names in the output file with @var{string}.
1423
1424@item --prefix-alloc-sections=@var{string}
1425Prefix all the names of all allocated sections in the output file with
1426@var{string}.
1427
ed1653a7
NC
1428@item --add-gnu-debuglink=@var{path-to-file}
1429Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
1430and adds it to the output file.
1431
1637cd90
JB
1432@item --keep-file-symbols
1433When stripping a file, perhaps with @option{--strip-debug} or
1434@option{--strip-unneeded}, retain any symbols specifying source file names,
1435which would otherwise get stripped.
1436
ed1653a7 1437@item --only-keep-debug
36d3b955
MR
1438Strip a file, removing contents of any sections that would not be
1439stripped by @option{--strip-debug} and leaving the debugging sections
1440intact.
ed1653a7
NC
1441
1442The intention is that this option will be used in conjunction with
1443@option{--add-gnu-debuglink} to create a two part executable. One a
1444stripped binary which will occupy less space in RAM and in a
1445distribution and the second a debugging information file which is only
1446needed if debugging abilities are required. The suggested procedure
1447to create these files is as follows:
1448
1449@enumerate
1450@item Link the executable as normal. Assuming that is is called
1451@code{foo} then...
1452@item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1453create a file containing the debugging info.
1454@item Run @code{objcopy --strip-debug foo} to create a
1455stripped executable.
1456@item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1457to add a link to the debugging info into the stripped executable.
1458@end enumerate
1459
1460Note - the choice of @code{.dbg} as an extension for the debug info
1461file is arbitrary. Also the @code{--only-keep-debug} step is
1462optional. You could instead do this:
1463
1464@enumerate
1465@item Link the executable as normal.
1466@item Copy @code{foo} to @code{foo.full}
1467@item Run @code{objcopy --strip-debug foo}
1468@item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1469@end enumerate
1470
36d3b955 1471i.e. the file pointed to by the @option{--add-gnu-debuglink} can be the
ed1653a7
NC
1472full executable. It does not have to be a file created by the
1473@option{--only-keep-debug} switch.
1474
252b5132
RH
1475@item -V
1476@itemx --version
c7c55b78 1477Show the version number of @command{objcopy}.
252b5132
RH
1478
1479@item -v
1480@itemx --verbose
1481Verbose output: list all object files modified. In the case of
1482archives, @samp{objcopy -V} lists all members of the archive.
1483
1484@item --help
c7c55b78 1485Show a summary of the options to @command{objcopy}.
7c29036b
NC
1486
1487@item --info
1488Display a list showing all architectures and object formats available.
252b5132
RH
1489@end table
1490
0285c67d
NC
1491@c man end
1492
1493@ignore
1494@c man begin SEEALSO objcopy
1495ld(1), objdump(1), and the Info entries for @file{binutils}.
1496@c man end
1497@end ignore
1498
252b5132
RH
1499@node objdump
1500@chapter objdump
1501
1502@cindex object file information
1503@kindex objdump
1504
0285c67d
NC
1505@c man title objdump display information from object files.
1506
252b5132 1507@smallexample
0285c67d 1508@c man begin SYNOPSIS objdump
c7c55b78
NC
1509objdump [@option{-a}|@option{--archive-headers}]
1510 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1511 [@option{-C}|@option{--demangle}[=@var{style}] ]
1512 [@option{-d}|@option{--disassemble}]
1513 [@option{-D}|@option{--disassemble-all}]
1514 [@option{-z}|@option{--disassemble-zeroes}]
1515 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1516 [@option{-f}|@option{--file-headers}]
1517 [@option{--file-start-context}]
1518 [@option{-g}|@option{--debugging}]
51cdc6e0 1519 [@option{-e}|@option{--debugging-tags}]
c7c55b78
NC
1520 [@option{-h}|@option{--section-headers}|@option{--headers}]
1521 [@option{-i}|@option{--info}]
1522 [@option{-j} @var{section}|@option{--section=}@var{section}]
1523 [@option{-l}|@option{--line-numbers}]
1524 [@option{-S}|@option{--source}]
1525 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1526 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1527 [@option{-p}|@option{--private-headers}]
1528 [@option{-r}|@option{--reloc}]
1529 [@option{-R}|@option{--dynamic-reloc}]
1530 [@option{-s}|@option{--full-contents}]
4de2ad99 1531 [@option{-W}|@option{--dwarf}]
c7c55b78
NC
1532 [@option{-G}|@option{--stabs}]
1533 [@option{-t}|@option{--syms}]
1534 [@option{-T}|@option{--dynamic-syms}]
1535 [@option{-x}|@option{--all-headers}]
1536 [@option{-w}|@option{--wide}]
1537 [@option{--start-address=}@var{address}]
1538 [@option{--stop-address=}@var{address}]
1539 [@option{--prefix-addresses}]
1540 [@option{--[no-]show-raw-insn}]
1541 [@option{--adjust-vma=}@var{offset}]
3c9458e9 1542 [@option{--special-syms}]
c7c55b78
NC
1543 [@option{-V}|@option{--version}]
1544 [@option{-H}|@option{--help}]
252b5132 1545 @var{objfile}@dots{}
0285c67d 1546@c man end
252b5132
RH
1547@end smallexample
1548
0285c67d
NC
1549@c man begin DESCRIPTION objdump
1550
c7c55b78 1551@command{objdump} displays information about one or more object files.
252b5132
RH
1552The options control what particular information to display. This
1553information is mostly useful to programmers who are working on the
1554compilation tools, as opposed to programmers who just want their
1555program to compile and work.
1556
1557@var{objfile}@dots{} are the object files to be examined. When you
c7c55b78 1558specify archives, @command{objdump} shows information on each of the member
252b5132
RH
1559object files.
1560
0285c67d
NC
1561@c man end
1562
1563@c man begin OPTIONS objdump
1564
252b5132 1565The long and short forms of options, shown here as alternatives, are
1dada9c5 1566equivalent. At least one option from the list
155e0d23 1567@option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
252b5132 1568
c7c55b78 1569@table @env
252b5132
RH
1570@item -a
1571@itemx --archive-header
1572@cindex archive headers
1573If any of the @var{objfile} files are archives, display the archive
1574header information (in a format similar to @samp{ls -l}). Besides the
1575information you could list with @samp{ar tv}, @samp{objdump -a} shows
1576the object file format of each archive member.
1577
1578@item --adjust-vma=@var{offset}
1579@cindex section addresses in objdump
1580@cindex VMA in objdump
1581When dumping information, first add @var{offset} to all the section
1582addresses. This is useful if the section addresses do not correspond to
1583the symbol table, which can happen when putting sections at particular
1584addresses when using a format which can not represent section addresses,
1585such as a.out.
1586
1587@item -b @var{bfdname}
1588@itemx --target=@var{bfdname}
1589@cindex object code format
1590Specify that the object-code format for the object files is
1591@var{bfdname}. This option may not be necessary; @var{objdump} can
1592automatically recognize many formats.
1593
1594For example,
1595@example
1596objdump -b oasys -m vax -h fu.o
1597@end example
1598@noindent
c7c55b78
NC
1599displays summary information from the section headers (@option{-h}) of
1600@file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
252b5132 1601file in the format produced by Oasys compilers. You can list the
c7c55b78 1602formats available with the @option{-i} option.
252b5132
RH
1603@xref{Target Selection}, for more information.
1604
1605@item -C
28c309a2 1606@itemx --demangle[=@var{style}]
252b5132
RH
1607@cindex demangling in objdump
1608Decode (@dfn{demangle}) low-level symbol names into user-level names.
1609Besides removing any initial underscore prepended by the system, this
28c309a2
NC
1610makes C++ function names readable. Different compilers have different
1611mangling styles. The optional demangling style argument can be used to
1612choose an appropriate demangling style for your compiler. @xref{c++filt},
1613for more information on demangling.
252b5132 1614
947ed062
NC
1615@item -g
1616@itemx --debugging
252b5132
RH
1617Display debugging information. This attempts to parse debugging
1618information stored in the file and print it out using a C like syntax.
1619Only certain types of debugging information have been implemented.
c1124b23
AO
1620Some other types are supported by @command{readelf -w}.
1621@xref{readelf}.
252b5132 1622
51cdc6e0
NC
1623@item -e
1624@itemx --debugging-tags
1625Like @option{-g}, but the information is generated in a format compatible
1626with ctags tool.
1627
252b5132
RH
1628@item -d
1629@itemx --disassemble
1630@cindex disassembling object code
1631@cindex machine instructions
1632Display the assembler mnemonics for the machine instructions from
1633@var{objfile}. This option only disassembles those sections which are
1634expected to contain instructions.
1635
1636@item -D
1637@itemx --disassemble-all
c7c55b78 1638Like @option{-d}, but disassemble the contents of all sections, not just
252b5132
RH
1639those expected to contain instructions.
1640
1641@item --prefix-addresses
1642When disassembling, print the complete address on each line. This is
1643the older disassembly format.
1644
252b5132
RH
1645@item -EB
1646@itemx -EL
1647@itemx --endian=@{big|little@}
1648@cindex endianness
1649@cindex disassembly endianness
1650Specify the endianness of the object files. This only affects
1651disassembly. This can be useful when disassembling a file format which
1652does not describe endianness information, such as S-records.
1653
1654@item -f
947ed062 1655@itemx --file-headers
252b5132
RH
1656@cindex object file header
1657Display summary information from the overall header of
1658each of the @var{objfile} files.
1659
f1563258
TW
1660@item --file-start-context
1661@cindex source code context
1662Specify that when displaying interlisted source code/disassembly
c7c55b78 1663(assumes @option{-S}) from a file that has not yet been displayed, extend the
f1563258
TW
1664context to the start of the file.
1665
252b5132 1666@item -h
947ed062
NC
1667@itemx --section-headers
1668@itemx --headers
252b5132
RH
1669@cindex section headers
1670Display summary information from the section headers of the
1671object file.
1672
1673File segments may be relocated to nonstandard addresses, for example by
c7c55b78
NC
1674using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
1675@command{ld}. However, some object file formats, such as a.out, do not
252b5132 1676store the starting address of the file segments. In those situations,
c7c55b78 1677although @command{ld} relocates the sections correctly, using @samp{objdump
252b5132
RH
1678-h} to list the file section headers cannot show the correct addresses.
1679Instead, it shows the usual addresses, which are implicit for the
1680target.
1681
947ed062
NC
1682@item -H
1683@itemx --help
c7c55b78 1684Print a summary of the options to @command{objdump} and exit.
252b5132
RH
1685
1686@item -i
1687@itemx --info
1688@cindex architectures available
1689@cindex object formats available
1690Display a list showing all architectures and object formats available
c7c55b78 1691for specification with @option{-b} or @option{-m}.
252b5132
RH
1692
1693@item -j @var{name}
1694@itemx --section=@var{name}
1695@cindex section information
1696Display information only for section @var{name}.
1697
1698@item -l
1699@itemx --line-numbers
1700@cindex source filenames for object files
1701Label the display (using debugging information) with the filename and
1702source line numbers corresponding to the object code or relocs shown.
c7c55b78 1703Only useful with @option{-d}, @option{-D}, or @option{-r}.
252b5132
RH
1704
1705@item -m @var{machine}
1706@itemx --architecture=@var{machine}
1707@cindex architecture
1708@cindex disassembly architecture
1709Specify the architecture to use when disassembling object files. This
1710can be useful when disassembling object files which do not describe
1711architecture information, such as S-records. You can list the available
c7c55b78 1712architectures with the @option{-i} option.
252b5132 1713
dd92f639
NC
1714@item -M @var{options}
1715@itemx --disassembler-options=@var{options}
1716Pass target specific information to the disassembler. Only supported on
31e0f3cd
NC
1717some targets. If it is necessary to specify more than one
1718disassembler option then multiple @option{-M} options can be used or
1719can be placed together into a comma separated list.
dd92f639
NC
1720
1721If the target is an ARM architecture then this switch can be used to
1722select which register name set is used during disassembler. Specifying
9c092ace 1723@option{-M reg-names-std} (the default) will select the register names as
58efb6c0
NC
1724used in ARM's instruction set documentation, but with register 13 called
1725'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
c7c55b78
NC
1726@option{-M reg-names-apcs} will select the name set used by the ARM
1727Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
58efb6c0
NC
1728just use @samp{r} followed by the register number.
1729
1730There are also two variants on the APCS register naming scheme enabled
c7c55b78
NC
1731by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
1732use the ARM/Thumb Procedure Call Standard naming conventions. (Either
947ed062 1733with the normal register names or the special register names).
dd92f639 1734
8f915f68 1735This option can also be used for ARM architectures to force the
c36774d6 1736disassembler to interpret all instructions as Thumb instructions by
c7c55b78 1737using the switch @option{--disassembler-options=force-thumb}. This can be
8f915f68
NC
1738useful when attempting to disassemble thumb code produced by other
1739compilers.
1740
e396998b
AM
1741For the x86, some of the options duplicate functions of the @option{-m}
1742switch, but allow finer grained control. Multiple selections from the
1743following may be specified as a comma separated string.
b89e9eae 1744@option{x86-64}, @option{i386} and @option{i8086} select disassembly for
e396998b
AM
1745the given architecture. @option{intel} and @option{att} select between
1746intel syntax mode and AT&T syntax mode. @option{addr32},
1747@option{addr16}, @option{data32} and @option{data16} specify the default
1748address size and operand size. These four options will be overridden if
b89e9eae 1749@option{x86-64}, @option{i386} or @option{i8086} appear later in the
e396998b 1750option string. Lastly, @option{suffix}, when in AT&T mode,
b9e5d8e5 1751instructs the disassembler to print a mnemonic suffix even when the
e396998b
AM
1752suffix could be inferred by the operands.
1753
802a735e
AM
1754For PPC, @option{booke}, @option{booke32} and @option{booke64} select
1755disassembly of BookE instructions. @option{32} and @option{64} select
36ae0db3
DJ
1756PowerPC and PowerPC64 disassembly, respectively. @option{e300} selects
1757disassembly for the e300 family.
802a735e 1758
e39893d7
FF
1759For MIPS, this option controls the printing of instruction mneumonic
1760names and register names in disassembled instructions. Multiple
1761selections from the following may be specified as a comma separated
1762string, and invalid options are ignored:
640c0ccd
CD
1763
1764@table @code
e39893d7
FF
1765@item no-aliases
1766Print the 'raw' instruction mneumonic instead of some pseudo
1767instruction mneumonic. I.E. print 'daddu' or 'or' instead of 'move',
1768'sll' instead of 'nop', etc.
1769
640c0ccd
CD
1770@item gpr-names=@var{ABI}
1771Print GPR (general-purpose register) names as appropriate
1772for the specified ABI. By default, GPR names are selected according to
1773the ABI of the binary being disassembled.
1774
1775@item fpr-names=@var{ABI}
1776Print FPR (floating-point register) names as
1777appropriate for the specified ABI. By default, FPR numbers are printed
1778rather than names.
1779
1780@item cp0-names=@var{ARCH}
1781Print CP0 (system control coprocessor; coprocessor 0) register names
1782as appropriate for the CPU or architecture specified by
1783@var{ARCH}. By default, CP0 register names are selected according to
1784the architecture and CPU of the binary being disassembled.
1785
af7ee8bf
CD
1786@item hwr-names=@var{ARCH}
1787Print HWR (hardware register, used by the @code{rdhwr} instruction) names
1788as appropriate for the CPU or architecture specified by
1789@var{ARCH}. By default, HWR names are selected according to
1790the architecture and CPU of the binary being disassembled.
1791
640c0ccd
CD
1792@item reg-names=@var{ABI}
1793Print GPR and FPR names as appropriate for the selected ABI.
1794
1795@item reg-names=@var{ARCH}
af7ee8bf
CD
1796Print CPU-specific register names (CP0 register and HWR names)
1797as appropriate for the selected CPU or architecture.
640c0ccd
CD
1798@end table
1799
1800For any of the options listed above, @var{ABI} or
1801@var{ARCH} may be specified as @samp{numeric} to have numbers printed
1802rather than names, for the selected types of registers.
1803You can list the available values of @var{ABI} and @var{ARCH} using
1804the @option{--help} option.
1805
ec72cfe5
NC
1806For VAX, you can specify function entry addresses with @option{-M
1807entry:0xf00ba}. You can use this multiple times to properly
1808disassemble VAX binary files that don't contain symbol tables (like
1809ROM dumps). In these cases, the function entry mask would otherwise
1810be decoded as VAX instructions, which would probably lead the the rest
1811of the function being wrongly disassembled.
1812
252b5132
RH
1813@item -p
1814@itemx --private-headers
1815Print information that is specific to the object file format. The exact
1816information printed depends upon the object file format. For some
1817object file formats, no additional information is printed.
1818
1819@item -r
1820@itemx --reloc
1821@cindex relocation entries, in object file
c7c55b78
NC
1822Print the relocation entries of the file. If used with @option{-d} or
1823@option{-D}, the relocations are printed interspersed with the
252b5132
RH
1824disassembly.
1825
1826@item -R
1827@itemx --dynamic-reloc
1828@cindex dynamic relocation entries, in object file
1829Print the dynamic relocation entries of the file. This is only
1830meaningful for dynamic objects, such as certain types of shared
1831libraries.
1832
1833@item -s
1834@itemx --full-contents
1835@cindex sections, full contents
1836@cindex object file sections
155e0d23
NC
1837Display the full contents of any sections requested. By default all
1838non-empty sections are displayed.
252b5132
RH
1839
1840@item -S
1841@itemx --source
1842@cindex source disassembly
1843@cindex disassembly, with source
1844Display source code intermixed with disassembly, if possible. Implies
c7c55b78 1845@option{-d}.
252b5132
RH
1846
1847@item --show-raw-insn
1848When disassembling instructions, print the instruction in hex as well as
1849in symbolic form. This is the default except when
c7c55b78 1850@option{--prefix-addresses} is used.
252b5132
RH
1851
1852@item --no-show-raw-insn
1853When disassembling instructions, do not print the instruction bytes.
c7c55b78 1854This is the default when @option{--prefix-addresses} is used.
252b5132 1855
4de2ad99
L
1856@item -W
1857@itemx --dwarf
1858@cindex DWARF
1859@cindex debug symbols
1860Displays the contents of the DWARF debug sections in the file, if any
1861are present.
1862
1dada9c5 1863@item -G
947ed062 1864@itemx --stabs
252b5132
RH
1865@cindex stab
1866@cindex .stab
1867@cindex debug symbols
1868@cindex ELF object file format
1869Display the full contents of any sections requested. Display the
1870contents of the .stab and .stab.index and .stab.excl sections from an
1871ELF file. This is only useful on systems (such as Solaris 2.0) in which
1872@code{.stab} debugging symbol-table entries are carried in an ELF
1873section. In most other file formats, debugging symbol-table entries are
c7c55b78 1874interleaved with linkage symbols, and are visible in the @option{--syms}
0285c67d
NC
1875output.
1876@ifclear man
1877For more information on stabs symbols, see @ref{Top,Stabs,Stabs
252b5132 1878Overview,stabs.info, The ``stabs'' debug format}.
0285c67d 1879@end ifclear
252b5132
RH
1880
1881@item --start-address=@var{address}
1882@cindex start-address
1883Start displaying data at the specified address. This affects the output
c7c55b78 1884of the @option{-d}, @option{-r} and @option{-s} options.
252b5132
RH
1885
1886@item --stop-address=@var{address}
1887@cindex stop-address
1888Stop displaying data at the specified address. This affects the output
c7c55b78 1889of the @option{-d}, @option{-r} and @option{-s} options.
252b5132
RH
1890
1891@item -t
1892@itemx --syms
1893@cindex symbol table entries, printing
1894Print the symbol table entries of the file.
1895This is similar to the information provided by the @samp{nm} program.
1896
1897@item -T
1898@itemx --dynamic-syms
1899@cindex dynamic symbol table entries, printing
1900Print the dynamic symbol table entries of the file. This is only
1901meaningful for dynamic objects, such as certain types of shared
1902libraries. This is similar to the information provided by the @samp{nm}
c7c55b78 1903program when given the @option{-D} (@option{--dynamic}) option.
252b5132 1904
3c9458e9
NC
1905@item --special-syms
1906When displaying symbols include those which the target considers to be
1907special in some way and which would not normally be of interest to the
1908user.
1909
947ed062
NC
1910@item -V
1911@itemx --version
c7c55b78 1912Print the version number of @command{objdump} and exit.
252b5132
RH
1913
1914@item -x
947ed062 1915@itemx --all-headers
252b5132
RH
1916@cindex all header information, object file
1917@cindex header information, all
1918Display all available header information, including the symbol table and
c7c55b78 1919relocation entries. Using @option{-x} is equivalent to specifying all of
04c34128 1920@option{-a -f -h -p -r -t}.
252b5132
RH
1921
1922@item -w
1923@itemx --wide
1924@cindex wide output, printing
1925Format some lines for output devices that have more than 80 columns.
31104126 1926Also do not truncate symbol names when they are displayed.
aefbdd67
BE
1927
1928@item -z
2c0c15f9 1929@itemx --disassemble-zeroes
aefbdd67
BE
1930Normally the disassembly output will skip blocks of zeroes. This
1931option directs the disassembler to disassemble those blocks, just like
1932any other data.
252b5132
RH
1933@end table
1934
0285c67d
NC
1935@c man end
1936
1937@ignore
1938@c man begin SEEALSO objdump
1939nm(1), readelf(1), and the Info entries for @file{binutils}.
1940@c man end
1941@end ignore
1942
252b5132
RH
1943@node ranlib
1944@chapter ranlib
1945
1946@kindex ranlib
1947@cindex archive contents
1948@cindex symbol index
1949
0285c67d
NC
1950@c man title ranlib generate index to archive.
1951
252b5132 1952@smallexample
0285c67d 1953@c man begin SYNOPSIS ranlib
c7c55b78 1954ranlib [@option{-vV}] @var{archive}
0285c67d 1955@c man end
252b5132
RH
1956@end smallexample
1957
0285c67d
NC
1958@c man begin DESCRIPTION ranlib
1959
c7c55b78 1960@command{ranlib} generates an index to the contents of an archive and
252b5132
RH
1961stores it in the archive. The index lists each symbol defined by a
1962member of an archive that is a relocatable object file.
1963
1964You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
1965
1966An archive with such an index speeds up linking to the library and
1967allows routines in the library to call each other without regard to
1968their placement in the archive.
1969
c7c55b78
NC
1970The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
1971@command{ranlib} is completely equivalent to executing @samp{ar -s}.
252b5132
RH
1972@xref{ar}.
1973
0285c67d
NC
1974@c man end
1975
1976@c man begin OPTIONS ranlib
1977
c7c55b78 1978@table @env
252b5132
RH
1979@item -v
1980@itemx -V
f20a759a 1981@itemx --version
c7c55b78 1982Show the version number of @command{ranlib}.
252b5132
RH
1983@end table
1984
0285c67d
NC
1985@c man end
1986
1987@ignore
1988@c man begin SEEALSO ranlib
1989ar(1), nm(1), and the Info entries for @file{binutils}.
1990@c man end
1991@end ignore
1992
252b5132
RH
1993@node size
1994@chapter size
1995
1996@kindex size
1997@cindex section sizes
1998
0285c67d
NC
1999@c man title size list section sizes and total size.
2000
252b5132 2001@smallexample
0285c67d 2002@c man begin SYNOPSIS size
c7c55b78 2003size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
15c82623
NC
2004 [@option{--help}]
2005 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2006 [@option{-t}|@option{--totals}]
c7c55b78
NC
2007 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2008 [@var{objfile}@dots{}]
0285c67d 2009@c man end
252b5132
RH
2010@end smallexample
2011
0285c67d
NC
2012@c man begin DESCRIPTION size
2013
c7c55b78 2014The @sc{gnu} @command{size} utility lists the section sizes---and the total
252b5132
RH
2015size---for each of the object or archive files @var{objfile} in its
2016argument list. By default, one line of output is generated for each
2017object file or each module in an archive.
2018
2019@var{objfile}@dots{} are the object files to be examined.
2020If none are specified, the file @code{a.out} will be used.
2021
0285c67d
NC
2022@c man end
2023
2024@c man begin OPTIONS size
2025
252b5132
RH
2026The command line options have the following meanings:
2027
c7c55b78 2028@table @env
252b5132
RH
2029@item -A
2030@itemx -B
2031@itemx --format=@var{compatibility}
c7c55b78 2032@cindex @command{size} display format
252b5132 2033Using one of these options, you can choose whether the output from @sc{gnu}
c7c55b78
NC
2034@command{size} resembles output from System V @command{size} (using @option{-A},
2035or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2036@option{--format=berkeley}). The default is the one-line format similar to
252b5132
RH
2037Berkeley's.
2038@c Bonus for doc-source readers: you can also say --format=strange (or
2039@c anything else that starts with 's') for sysv, and --format=boring (or
2040@c anything else that starts with 'b') for Berkeley.
2041
2042Here is an example of the Berkeley (default) format of output from
c7c55b78 2043@command{size}:
252b5132 2044@smallexample
f20a759a 2045$ size --format=Berkeley ranlib size
252b5132
RH
2046text data bss dec hex filename
2047294880 81920 11592 388392 5ed28 ranlib
2048294880 81920 11888 388688 5ee50 size
2049@end smallexample
2050
2051@noindent
2052This is the same data, but displayed closer to System V conventions:
2053
2054@smallexample
f20a759a 2055$ size --format=SysV ranlib size
252b5132
RH
2056ranlib :
2057section size addr
2058.text 294880 8192
2059.data 81920 303104
2060.bss 11592 385024
2061Total 388392
2062
2063
2064size :
2065section size addr
2066.text 294880 8192
2067.data 81920 303104
2068.bss 11888 385024
2069Total 388688
2070@end smallexample
2071
2072@item --help
2073Show a summary of acceptable arguments and options.
2074
2075@item -d
2076@itemx -o
2077@itemx -x
2078@itemx --radix=@var{number}
c7c55b78 2079@cindex @command{size} number format
252b5132
RH
2080@cindex radix for section sizes
2081Using one of these options, you can control whether the size of each
c7c55b78
NC
2082section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2083(@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2084@option{--radix=16}). In @option{--radix=@var{number}}, only the three
252b5132 2085values (8, 10, 16) are supported. The total size is always given in two
c7c55b78
NC
2086radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2087octal and hexadecimal if you're using @option{-o}.
252b5132 2088
15c82623
NC
2089@item -t
2090@itemx --totals
2091Show totals of all objects listed (Berkeley format listing mode only).
2092
252b5132
RH
2093@item --target=@var{bfdname}
2094@cindex object code format
2095Specify that the object-code format for @var{objfile} is
c7c55b78 2096@var{bfdname}. This option may not be necessary; @command{size} can
252b5132
RH
2097automatically recognize many formats.
2098@xref{Target Selection}, for more information.
2099
2100@item -V
2101@itemx --version
c7c55b78 2102Display the version number of @command{size}.
252b5132
RH
2103@end table
2104
0285c67d
NC
2105@c man end
2106
2107@ignore
2108@c man begin SEEALSO size
2109ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2110@c man end
2111@end ignore
2112
252b5132
RH
2113@node strings
2114@chapter strings
2115@kindex strings
2116@cindex listings strings
2117@cindex printing strings
2118@cindex strings, printing
2119
0285c67d
NC
2120@c man title strings print the strings of printable characters in files.
2121
252b5132 2122@smallexample
0285c67d 2123@c man begin SYNOPSIS strings
d132876a
NC
2124strings [@option{-afov}] [@option{-}@var{min-len}]
2125 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2126 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2127 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2128 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2129 [@option{--target=}@var{bfdname}]
c7c55b78 2130 [@option{--help}] [@option{--version}] @var{file}@dots{}
0285c67d 2131@c man end
252b5132
RH
2132@end smallexample
2133
0285c67d
NC
2134@c man begin DESCRIPTION strings
2135
c7c55b78 2136For each @var{file} given, @sc{gnu} @command{strings} prints the printable
252b5132
RH
2137character sequences that are at least 4 characters long (or the number
2138given with the options below) and are followed by an unprintable
2139character. By default, it only prints the strings from the initialized
2140and loaded sections of object files; for other types of files, it prints
2141the strings from the whole file.
2142
c7c55b78 2143@command{strings} is mainly useful for determining the contents of non-text
252b5132
RH
2144files.
2145
0285c67d
NC
2146@c man end
2147
2148@c man begin OPTIONS strings
2149
c7c55b78 2150@table @env
252b5132
RH
2151@item -a
2152@itemx --all
2153@itemx -
2154Do not scan only the initialized and loaded sections of object files;
2155scan the whole files.
2156
2157@item -f
2158@itemx --print-file-name
2159Print the name of the file before each string.
2160
2161@item --help
2162Print a summary of the program usage on the standard output and exit.
2163
2164@item -@var{min-len}
2165@itemx -n @var{min-len}
2166@itemx --bytes=@var{min-len}
2167Print sequences of characters that are at least @var{min-len} characters
2168long, instead of the default 4.
2169
2170@item -o
c7c55b78 2171Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
252b5132
RH
2172act like @samp{-t d} instead. Since we can not be compatible with both
2173ways, we simply chose one.
2174
2175@item -t @var{radix}
2176@itemx --radix=@var{radix}
2177Print the offset within the file before each string. The single
2178character argument specifies the radix of the offset---@samp{o} for
2179octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2180
d132876a
NC
2181@item -e @var{encoding}
2182@itemx --encoding=@var{encoding}
2183Select the character encoding of the strings that are to be found.
8745eafa
NC
2184Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2185characters (ASCII, ISO 8859, etc., default), @samp{S} =
2186single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
218716-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2188littleendian. Useful for finding wide character strings.
d132876a 2189
252b5132
RH
2190@item --target=@var{bfdname}
2191@cindex object code format
2192Specify an object code format other than your system's default format.
2193@xref{Target Selection}, for more information.
2194
2195@item -v
2196@itemx --version
2197Print the program version number on the standard output and exit.
2198@end table
2199
0285c67d
NC
2200@c man end
2201
2202@ignore
2203@c man begin SEEALSO strings
2204ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2205and the Info entries for @file{binutils}.
2206@c man end
2207@end ignore
2208
252b5132
RH
2209@node strip
2210@chapter strip
2211
2212@kindex strip
2213@cindex removing symbols
2214@cindex discarding symbols
2215@cindex symbols, discarding
2216
0285c67d
NC
2217@c man title strip Discard symbols from object files.
2218
252b5132 2219@smallexample
0285c67d 2220@c man begin SYNOPSIS strip
2593f09a
NC
2221strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2222 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2223 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2224 [@option{-s}|@option{--strip-all}]
2225 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2226 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2227 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
5fe11841 2228 [@option{-w}|@option{--wildcard}]
2593f09a
NC
2229 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2230 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2231 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
1637cd90 2232 [@option{--keep-file-symbols}]
ed1653a7 2233 [@option{--only-keep-debug}]
7c29036b
NC
2234 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2235 [@option{--help}] [@option{--info}]
252b5132 2236 @var{objfile}@dots{}
0285c67d 2237@c man end
252b5132
RH
2238@end smallexample
2239
0285c67d
NC
2240@c man begin DESCRIPTION strip
2241
c7c55b78 2242@sc{gnu} @command{strip} discards all symbols from object files
252b5132
RH
2243@var{objfile}. The list of object files may include archives.
2244At least one object file must be given.
2245
c7c55b78 2246@command{strip} modifies the files named in its argument,
252b5132
RH
2247rather than writing modified copies under different names.
2248
0285c67d
NC
2249@c man end
2250
2251@c man begin OPTIONS strip
2252
c7c55b78 2253@table @env
252b5132
RH
2254@item -F @var{bfdname}
2255@itemx --target=@var{bfdname}
2256Treat the original @var{objfile} as a file with the object
2257code format @var{bfdname}, and rewrite it in the same format.
2258@xref{Target Selection}, for more information.
2259
2260@item --help
c7c55b78 2261Show a summary of the options to @command{strip} and exit.
252b5132 2262
7c29036b
NC
2263@item --info
2264Display a list showing all architectures and object formats available.
2265
947ed062 2266@item -I @var{bfdname}
252b5132
RH
2267@itemx --input-target=@var{bfdname}
2268Treat the original @var{objfile} as a file with the object
2269code format @var{bfdname}.
2270@xref{Target Selection}, for more information.
2271
2272@item -O @var{bfdname}
2273@itemx --output-target=@var{bfdname}
2274Replace @var{objfile} with a file in the output format @var{bfdname}.
2275@xref{Target Selection}, for more information.
2276
2277@item -R @var{sectionname}
2278@itemx --remove-section=@var{sectionname}
2279Remove any section named @var{sectionname} from the output file. This
2280option may be given more than once. Note that using this option
2281inappropriately may make the output file unusable.
2282
2283@item -s
2284@itemx --strip-all
2285Remove all symbols.
2286
2287@item -g
2288@itemx -S
15c82623 2289@itemx -d
252b5132
RH
2290@itemx --strip-debug
2291Remove debugging symbols only.
2292
2293@item --strip-unneeded
2294Remove all symbols that are not needed for relocation processing.
2295
2296@item -K @var{symbolname}
2297@itemx --keep-symbol=@var{symbolname}
e7f918ad
NC
2298When stripping symbols, keep symbol @var{symbolname} even if it would
2299normally be stripped. This option may be given more than once.
252b5132
RH
2300
2301@item -N @var{symbolname}
2302@itemx --strip-symbol=@var{symbolname}
2303Remove symbol @var{symbolname} from the source file. This option may be
2304given more than once, and may be combined with strip options other than
c7c55b78 2305@option{-K}.
252b5132
RH
2306
2307@item -o @var{file}
2308Put the stripped output in @var{file}, rather than replacing the
2309existing file. When this argument is used, only one @var{objfile}
2310argument may be specified.
2311
2312@item -p
2313@itemx --preserve-dates
2314Preserve the access and modification dates of the file.
2315
5fe11841
NC
2316@item -w
2317@itemx --wildcard
2318Permit regular expressions in @var{symbolname}s used in other command
2319line options. The question mark (?), asterisk (*), backslash (\) and
2320square brackets ([]) operators can be used anywhere in the symbol
2321name. If the first character of the symbol name is the exclamation
2322point (!) then the sense of the switch is reversed for that symbol.
2323For example:
2324
2325@smallexample
2326 -w -K !foo -K fo*
2327@end smallexample
2328
2329would cause strip to only keep symbols that start with the letters
2330``fo'', but to discard the symbol ``foo''.
2331
252b5132
RH
2332@item -x
2333@itemx --discard-all
2334Remove non-global symbols.
2335
2336@item -X
2337@itemx --discard-locals
2338Remove compiler-generated local symbols.
2339(These usually start with @samp{L} or @samp{.}.)
2340
1637cd90
JB
2341@item --keep-file-symbols
2342When stripping a file, perhaps with @option{--strip-debug} or
2343@option{--strip-unneeded}, retain any symbols specifying source file names,
2344which would otherwise get stripped.
2345
ed1653a7
NC
2346@item --only-keep-debug
2347Strip a file, removing any sections that would be stripped by
2348@option{--strip-debug} and leaving the debugging sections.
2349
2350The intention is that this option will be used in conjunction with
2351@option{--add-gnu-debuglink} to create a two part executable. One a
2352stripped binary which will occupy less space in RAM and in a
2353distribution and the second a debugging information file which is only
2354needed if debugging abilities are required. The suggested procedure
2355to create these files is as follows:
2356
2357@enumerate
2358@item Link the executable as normal. Assuming that is is called
2359@code{foo} then...
2360@item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2361create a file containing the debugging info.
2362@item Run @code{objcopy --strip-debug foo} to create a
2363stripped executable.
2364@item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2365to add a link to the debugging info into the stripped executable.
2366@end enumerate
2367
2368Note - the choice of @code{.dbg} as an extension for the debug info
2369file is arbitrary. Also the @code{--only-keep-debug} step is
2370optional. You could instead do this:
2371
2372@enumerate
2373@item Link the executable as normal.
2374@item Copy @code{foo} to @code{foo.full}
2375@item Run @code{strip --strip-debug foo}
2376@item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2377@end enumerate
2378
2379ie the file pointed to by the @option{--add-gnu-debuglink} can be the
2380full executable. It does not have to be a file created by the
2381@option{--only-keep-debug} switch.
2382
252b5132
RH
2383@item -V
2384@itemx --version
c7c55b78 2385Show the version number for @command{strip}.
252b5132
RH
2386
2387@item -v
2388@itemx --verbose
2389Verbose output: list all object files modified. In the case of
2390archives, @samp{strip -v} lists all members of the archive.
2391@end table
2392
0285c67d
NC
2393@c man end
2394
2395@ignore
2396@c man begin SEEALSO strip
2397the Info entries for @file{binutils}.
2398@c man end
2399@end ignore
2400
9d51cc66 2401@node c++filt, addr2line, strip, Top
252b5132
RH
2402@chapter c++filt
2403
2404@kindex c++filt
2405@cindex demangling C++ symbols
2406
0285c67d
NC
2407@c man title cxxfilt Demangle C++ and Java symbols.
2408
252b5132 2409@smallexample
0285c67d 2410@c man begin SYNOPSIS cxxfilt
c7c55b78 2411c++filt [@option{-_}|@option{--strip-underscores}]
c7c55b78 2412 [@option{-n}|@option{--no-strip-underscores}]
4e48c9dd 2413 [@option{-p}|@option{--no-params}]
ec948987 2414 [@option{-t}|@option{--types}]
cbf1f5df 2415 [@option{-i}|@option{--no-verbose}]
c7c55b78
NC
2416 [@option{-s} @var{format}|@option{--format=}@var{format}]
2417 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
0285c67d 2418@c man end
252b5132
RH
2419@end smallexample
2420
0285c67d
NC
2421@c man begin DESCRIPTION cxxfilt
2422
9d51cc66 2423@kindex cxxfilt
ec948987
NC
2424The C++ and Java languages provide function overloading, which means
2425that you can write many functions with the same name, providing that
2426each function takes parameters of different types. In order to be
2427able to distinguish these similarly named functions C++ and Java
2428encode them into a low-level assembler name which uniquely identifies
2429each different version. This process is known as @dfn{mangling}. The
2430@command{c++filt}
2431@footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
195a97ce 2432MS-DOS this program is named @command{CXXFILT}.}
9d51cc66 2433program does the inverse mapping: it decodes (@dfn{demangles}) low-level
ec948987 2434names into user-level names so that they can be read.
252b5132
RH
2435
2436Every alphanumeric word (consisting of letters, digits, underscores,
cbf1f5df
NC
2437dollars, or periods) seen in the input is a potential mangled name.
2438If the name decodes into a C++ name, the C++ name replaces the
ec948987
NC
2439low-level name in the output, otherwise the original word is output.
2440In this way you can pass an entire assembler source file, containing
2441mangled names, through @command{c++filt} and see the same source file
2442containing demangled names.
252b5132 2443
ec948987
NC
2444You can also use @command{c++filt} to decipher individual symbols by
2445passing them on the command line:
252b5132
RH
2446
2447@example
2448c++filt @var{symbol}
2449@end example
2450
c7c55b78 2451If no @var{symbol} arguments are given, @command{c++filt} reads symbol
ec948987
NC
2452names from the standard input instead. All the results are printed on
2453the standard output. The difference between reading names from the
2454command line versus reading names from the standard input is that
2455command line arguments are expected to be just mangled names and no
2456checking is performed to seperate them from surrounding text. Thus
2457for example:
2458
2459@smallexample
2460c++filt -n _Z1fv
2461@end smallexample
2462
2463will work and demangle the name to ``f()'' whereas:
2464
2465@smallexample
2466c++filt -n _Z1fv,
2467@end smallexample
2468
2469will not work. (Note the extra comma at the end of the mangled
2470name which makes it invalid). This command however will work:
2471
2472@smallexample
2473echo _Z1fv, | c++filt -n
2474@end smallexample
2475
2476and will display ``f(),'' ie the demangled name followed by a
2477trailing comma. This behaviour is because when the names are read
2478from the standard input it is expected that they might be part of an
2479assembler source file where there might be extra, extraneous
2480characters trailing after a mangled name. eg:
2481
2482@smallexample
2483 .type _Z1fv, @@function
2484@end smallexample
252b5132 2485
0285c67d
NC
2486@c man end
2487
2488@c man begin OPTIONS cxxfilt
2489
c7c55b78 2490@table @env
252b5132
RH
2491@item -_
2492@itemx --strip-underscores
2493On some systems, both the C and C++ compilers put an underscore in front
2494of every name. For example, the C name @code{foo} gets the low-level
2495name @code{_foo}. This option removes the initial underscore. Whether
c7c55b78 2496@command{c++filt} removes the underscore by default is target dependent.
252b5132
RH
2497
2498@item -j
2499@itemx --java
2500Prints demangled names using Java syntax. The default is to use C++
2501syntax.
2502
2503@item -n
2504@itemx --no-strip-underscores
2505Do not remove the initial underscore.
2506
4e48c9dd
ILT
2507@item -p
2508@itemx --no-params
2509When demangling the name of a function, do not display the types of
2510the function's parameters.
2511
cbf1f5df 2512@item -t
ec948987
NC
2513@itemx --types
2514Attempt to demangle types as well as function names. This is disabled
2515by default since mangled types are normally only used internally in
2516the compiler, and they can be confused with non-mangled names. eg
2517a function called ``a'' treated as a mangled type name would be
2518demangled to ``signed char''.
cbf1f5df
NC
2519
2520@item -i
2521@itemx --no-verbose
2522Do not include implementation details (if any) in the demangled
2523output.
2524
252b5132
RH
2525@item -s @var{format}
2526@itemx --format=@var{format}
947ed062
NC
2527@command{c++filt} can decode various methods of mangling, used by
2528different compilers. The argument to this option selects which
252b5132
RH
2529method it uses:
2530
2531@table @code
947ed062
NC
2532@item auto
2533Automatic selection based on executable (the default method)
252b5132 2534@item gnu
947ed062 2535the one used by the @sc{gnu} C++ compiler (g++)
252b5132 2536@item lucid
947ed062 2537the one used by the Lucid compiler (lcc)
252b5132
RH
2538@item arm
2539the one specified by the C++ Annotated Reference Manual
2540@item hp
947ed062 2541the one used by the HP compiler (aCC)
252b5132
RH
2542@item edg
2543the one used by the EDG compiler
b5e2a4f3 2544@item gnu-v3
947ed062
NC
2545the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
2546@item java
2547the one used by the @sc{gnu} Java compiler (gcj)
2548@item gnat
2549the one used by the @sc{gnu} Ada compiler (GNAT).
252b5132
RH
2550@end table
2551
2552@item --help
c7c55b78 2553Print a summary of the options to @command{c++filt} and exit.
252b5132
RH
2554
2555@item --version
c7c55b78 2556Print the version number of @command{c++filt} and exit.
252b5132
RH
2557@end table
2558
0285c67d
NC
2559@c man end
2560
2561@ignore
2562@c man begin SEEALSO cxxfilt
2563the Info entries for @file{binutils}.
2564@c man end
2565@end ignore
2566
252b5132 2567@quotation
c7c55b78 2568@emph{Warning:} @command{c++filt} is a new utility, and the details of its
252b5132
RH
2569user interface are subject to change in future releases. In particular,
2570a command-line option may be required in the the future to decode a name
2571passed as an argument on the command line; in other words,
2572
2573@example
2574c++filt @var{symbol}
2575@end example
2576
2577@noindent
2578may in a future release become
2579
2580@example
2581c++filt @var{option} @var{symbol}
2582@end example
2583@end quotation
2584
2585@node addr2line
2586@chapter addr2line
2587
2588@kindex addr2line
2589@cindex address to file name and line number
2590
0285c67d
NC
2591@c man title addr2line convert addresses into file names and line numbers.
2592
252b5132 2593@smallexample
0285c67d 2594@c man begin SYNOPSIS addr2line
c7c55b78 2595addr2line [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
bf44dd74 2596 [@option{-C}|@option{--demangle}[=@var{style}]]
c7c55b78
NC
2597 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
2598 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
0c552dc1 2599 [@option{-i}|@option{--inlines}]
c7c55b78
NC
2600 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
2601 [addr addr @dots{}]
0285c67d 2602@c man end
252b5132
RH
2603@end smallexample
2604
0285c67d
NC
2605@c man begin DESCRIPTION addr2line
2606
c7c55b78 2607@command{addr2line} translates program addresses into file names and line
252b5132
RH
2608numbers. Given an address and an executable, it uses the debugging
2609information in the executable to figure out which file name and line
2610number are associated with a given address.
2611
c7c55b78 2612The executable to use is specified with the @option{-e} option. The
f20a759a 2613default is the file @file{a.out}.
252b5132 2614
c7c55b78 2615@command{addr2line} has two modes of operation.
252b5132
RH
2616
2617In the first, hexadecimal addresses are specified on the command line,
c7c55b78 2618and @command{addr2line} displays the file name and line number for each
252b5132
RH
2619address.
2620
c7c55b78 2621In the second, @command{addr2line} reads hexadecimal addresses from
252b5132 2622standard input, and prints the file name and line number for each
c7c55b78 2623address on standard output. In this mode, @command{addr2line} may be used
252b5132
RH
2624in a pipe to convert dynamically chosen addresses.
2625
2626The format of the output is @samp{FILENAME:LINENO}. The file name and
2627line number for each address is printed on a separate line. If the
c7c55b78 2628@command{-f} option is used, then each @samp{FILENAME:LINENO} line is
252b5132
RH
2629preceded by a @samp{FUNCTIONNAME} line which is the name of the function
2630containing the address.
2631
2632If the file name or function name can not be determined,
c7c55b78
NC
2633@command{addr2line} will print two question marks in their place. If the
2634line number can not be determined, @command{addr2line} will print 0.
252b5132 2635
0285c67d
NC
2636@c man end
2637
2638@c man begin OPTIONS addr2line
2639
252b5132
RH
2640The long and short forms of options, shown here as alternatives, are
2641equivalent.
2642
c7c55b78 2643@table @env
252b5132
RH
2644@item -b @var{bfdname}
2645@itemx --target=@var{bfdname}
2646@cindex object code format
2647Specify that the object-code format for the object files is
2648@var{bfdname}.
2649
2650@item -C
28c309a2 2651@itemx --demangle[=@var{style}]
252b5132
RH
2652@cindex demangling in objdump
2653Decode (@dfn{demangle}) low-level symbol names into user-level names.
2654Besides removing any initial underscore prepended by the system, this
28c309a2
NC
2655makes C++ function names readable. Different compilers have different
2656mangling styles. The optional demangling style argument can be used to
2657choose an appropriate demangling style for your compiler. @xref{c++filt},
2658for more information on demangling.
252b5132
RH
2659
2660@item -e @var{filename}
2661@itemx --exe=@var{filename}
2662Specify the name of the executable for which addresses should be
2663translated. The default file is @file{a.out}.
2664
2665@item -f
2666@itemx --functions
2667Display function names as well as file and line number information.
2668
2669@item -s
2670@itemx --basenames
2671Display only the base of each file name.
0c552dc1
FF
2672
2673@item -i
2674@itemx --inlines
2675If the address belongs to a function that was inlined, the source
2676information for all enclosing scopes back to the first non-inlined
2677function will also be printed. For example, if @code{main} inlines
2678@code{callee1} which inlines @code{callee2}, and address is from
2679@code{callee2}, the source information for @code{callee1} and @code{main}
2680will also be printed.
e107c42f 2681@end table
252b5132 2682
0285c67d
NC
2683@c man end
2684
2685@ignore
2686@c man begin SEEALSO addr2line
2687Info entries for @file{binutils}.
2688@c man end
2689@end ignore
2690
252b5132
RH
2691@node nlmconv
2692@chapter nlmconv
2693
c7c55b78 2694@command{nlmconv} converts a relocatable object file into a NetWare
252b5132
RH
2695Loadable Module.
2696
2697@ignore
c7c55b78 2698@command{nlmconv} currently works with @samp{i386} object
252b5132
RH
2699files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
2700object files in @sc{elf}, or @code{a.out} format@footnote{
c7c55b78 2701@command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
252b5132
RH
2702format in the Binary File Descriptor library. It has only been tested
2703with the above formats.}.
2704@end ignore
2705
2706@quotation
c7c55b78 2707@emph{Warning:} @command{nlmconv} is not always built as part of the binary
252b5132
RH
2708utilities, since it is only useful for NLM targets.
2709@end quotation
2710
0285c67d
NC
2711@c man title nlmconv converts object code into an NLM.
2712
252b5132 2713@smallexample
0285c67d 2714@c man begin SYNOPSIS nlmconv
c7c55b78
NC
2715nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
2716 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
2717 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
2718 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
2719 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
252b5132 2720 @var{infile} @var{outfile}
0285c67d 2721@c man end
252b5132
RH
2722@end smallexample
2723
0285c67d
NC
2724@c man begin DESCRIPTION nlmconv
2725
c7c55b78 2726@command{nlmconv} converts the relocatable @samp{i386} object file
252b5132
RH
2727@var{infile} into the NetWare Loadable Module @var{outfile}, optionally
2728reading @var{headerfile} for NLM header information. For instructions
2729on writing the NLM command file language used in header files, see the
2730@samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
2731Development and Tools Overview}, which is part of the NLM Software
2732Developer's Kit (``NLM SDK''), available from Novell, Inc.
c7c55b78 2733@command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
0285c67d
NC
2734@var{infile};
2735@ifclear man
2736see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
2737@end ifclear
252b5132 2738
c7c55b78 2739@command{nlmconv} can perform a link step. In other words, you can list
252b5132
RH
2740more than one object file for input if you list them in the definitions
2741file (rather than simply specifying one input file on the command line).
c7c55b78 2742In this case, @command{nlmconv} calls the linker for you.
252b5132 2743
0285c67d
NC
2744@c man end
2745
2746@c man begin OPTIONS nlmconv
2747
c7c55b78 2748@table @env
252b5132
RH
2749@item -I @var{bfdname}
2750@itemx --input-target=@var{bfdname}
c7c55b78 2751Object format of the input file. @command{nlmconv} can usually determine
252b5132
RH
2752the format of a given file (so no default is necessary).
2753@xref{Target Selection}, for more information.
2754
2755@item -O @var{bfdname}
2756@itemx --output-target=@var{bfdname}
c7c55b78 2757Object format of the output file. @command{nlmconv} infers the output
252b5132
RH
2758format based on the input format, e.g. for a @samp{i386} input file the
2759output format is @samp{nlm32-i386}.
2760@xref{Target Selection}, for more information.
2761
2762@item -T @var{headerfile}
2763@itemx --header-file=@var{headerfile}
2764Reads @var{headerfile} for NLM header information. For instructions on
2765writing the NLM command file language used in header files, see@ see the
2766@samp{linkers} section, of the @cite{NLM Development and Tools
2767Overview}, which is part of the NLM Software Developer's Kit, available
2768from Novell, Inc.
2769
2770@item -d
2771@itemx --debug
c7c55b78 2772Displays (on standard error) the linker command line used by @command{nlmconv}.
252b5132
RH
2773
2774@item -l @var{linker}
2775@itemx --linker=@var{linker}
2776Use @var{linker} for any linking. @var{linker} can be an absolute or a
2777relative pathname.
2778
2779@item -h
2780@itemx --help
2781Prints a usage summary.
2782
2783@item -V
2784@itemx --version
c7c55b78 2785Prints the version number for @command{nlmconv}.
252b5132
RH
2786@end table
2787
0285c67d
NC
2788@c man end
2789
2790@ignore
2791@c man begin SEEALSO nlmconv
2792the Info entries for @file{binutils}.
2793@c man end
2794@end ignore
2795
252b5132
RH
2796@node windres
2797@chapter windres
2798
c7c55b78 2799@command{windres} may be used to manipulate Windows resources.
252b5132
RH
2800
2801@quotation
c7c55b78 2802@emph{Warning:} @command{windres} is not always built as part of the binary
252b5132
RH
2803utilities, since it is only useful for Windows targets.
2804@end quotation
2805
0285c67d
NC
2806@c man title windres manipulate Windows resources.
2807
252b5132 2808@smallexample
0285c67d 2809@c man begin SYNOPSIS windres
252b5132 2810windres [options] [input-file] [output-file]
0285c67d 2811@c man end
252b5132
RH
2812@end smallexample
2813
0285c67d
NC
2814@c man begin DESCRIPTION windres
2815
c7c55b78 2816@command{windres} reads resources from an input file and copies them into
252b5132
RH
2817an output file. Either file may be in one of three formats:
2818
2819@table @code
2820@item rc
2821A text format read by the Resource Compiler.
2822
2823@item res
2824A binary format generated by the Resource Compiler.
2825
2826@item coff
2827A COFF object or executable.
2828@end table
2829
2830The exact description of these different formats is available in
2831documentation from Microsoft.
2832
c7c55b78 2833When @command{windres} converts from the @code{rc} format to the @code{res}
252b5132 2834format, it is acting like the Windows Resource Compiler. When
c7c55b78 2835@command{windres} converts from the @code{res} format to the @code{coff}
252b5132
RH
2836format, it is acting like the Windows @code{CVTRES} program.
2837
c7c55b78 2838When @command{windres} generates an @code{rc} file, the output is similar
252b5132
RH
2839but not identical to the format expected for the input. When an input
2840@code{rc} file refers to an external filename, an output @code{rc} file
2841will instead include the file contents.
2842
c7c55b78 2843If the input or output format is not specified, @command{windres} will
252b5132
RH
2844guess based on the file name, or, for the input file, the file contents.
2845A file with an extension of @file{.rc} will be treated as an @code{rc}
2846file, a file with an extension of @file{.res} will be treated as a
2847@code{res} file, and a file with an extension of @file{.o} or
2848@file{.exe} will be treated as a @code{coff} file.
2849
c7c55b78 2850If no output file is specified, @command{windres} will print the resources
252b5132
RH
2851in @code{rc} format to standard output.
2852
c7c55b78 2853The normal use is for you to write an @code{rc} file, use @command{windres}
252b5132
RH
2854to convert it to a COFF object file, and then link the COFF file into
2855your application. This will make the resources described in the
2856@code{rc} file available to Windows.
2857
0285c67d
NC
2858@c man end
2859
2860@c man begin OPTIONS windres
2861
c7c55b78 2862@table @env
252b5132
RH
2863@item -i @var{filename}
2864@itemx --input @var{filename}
2865The name of the input file. If this option is not used, then
c7c55b78
NC
2866@command{windres} will use the first non-option argument as the input file
2867name. If there are no non-option arguments, then @command{windres} will
2868read from standard input. @command{windres} can not read a COFF file from
edbedb71 2869standard input.
252b5132
RH
2870
2871@item -o @var{filename}
2872@itemx --output @var{filename}
2873The name of the output file. If this option is not used, then
c7c55b78 2874@command{windres} will use the first non-option argument, after any used
252b5132 2875for the input file name, as the output file name. If there is no
c7c55b78 2876non-option argument, then @command{windres} will write to standard output.
edbedb71
NC
2877@command{windres} can not write a COFF file to standard output. Note,
2878for compatability with @command{rc} the option @option{-fo} is also
2879accepted, but its use is not recommended.
252b5132 2880
85eb5110 2881@item -J @var{format}
252b5132
RH
2882@itemx --input-format @var{format}
2883The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
c7c55b78 2884@samp{coff}. If no input format is specified, @command{windres} will
252b5132
RH
2885guess, as described above.
2886
2887@item -O @var{format}
2888@itemx --output-format @var{format}
2889The output format to generate. @var{format} may be @samp{res},
2890@samp{rc}, or @samp{coff}. If no output format is specified,
c7c55b78 2891@command{windres} will guess, as described above.
252b5132
RH
2892
2893@item -F @var{target}
2894@itemx --target @var{target}
2895Specify the BFD format to use for a COFF file as input or output. This
c7c55b78
NC
2896is a BFD target name; you can use the @option{--help} option to see a list
2897of supported targets. Normally @command{windres} will use the default
2898format, which is the first one listed by the @option{--help} option.
2899@ifclear man
252b5132 2900@ref{Target Selection}.
c7c55b78 2901@end ifclear
252b5132
RH
2902
2903@item --preprocessor @var{program}
c7c55b78 2904When @command{windres} reads an @code{rc} file, it runs it through the C
252b5132
RH
2905preprocessor first. This option may be used to specify the preprocessor
2906to use, including any leading arguments. The default preprocessor
2907argument is @code{gcc -E -xc-header -DRC_INVOKED}.
2908
85eb5110
NC
2909@item -I @var{directory}
2910@itemx --include-dir @var{directory}
252b5132 2911Specify an include directory to use when reading an @code{rc} file.
c7c55b78
NC
2912@command{windres} will pass this to the preprocessor as an @option{-I}
2913option. @command{windres} will also search this directory when looking for
85eb5110
NC
2914files named in the @code{rc} file. If the argument passed to this command
2915matches any of the supported @var{formats} (as descrived in the @option{-J}
2916option), it will issue a deprecation warning, and behave just like the
2917@option{-J} option. New programs should not use this behaviour. If a
2918directory happens to match a @var{format}, simple prefix it with @samp{./}
2919to disable the backward compatibility.
252b5132 2920
751d21b5 2921@item -D @var{target}
ad0481cd 2922@itemx --define @var{sym}[=@var{val}]
c7c55b78 2923Specify a @option{-D} option to pass to the preprocessor when reading an
252b5132
RH
2924@code{rc} file.
2925
29b058f1
NC
2926@item -U @var{target}
2927@itemx --undefine @var{sym}
2928Specify a @option{-U} option to pass to the preprocessor when reading an
2929@code{rc} file.
2930
3126d709
CF
2931@item -r
2932Ignored for compatibility with rc.
2933
751d21b5
DD
2934@item -v
2935Enable verbose mode. This tells you what the preprocessor is if you
2936didn't specify one.
2937
3077f5d8 2938@item -l @var{val}
252b5132
RH
2939@item --language @var{val}
2940Specify the default language to use when reading an @code{rc} file.
2941@var{val} should be a hexadecimal language code. The low eight bits are
2942the language, and the high eight bits are the sublanguage.
2943
5a298d2d
NC
2944@item --use-temp-file
2945Use a temporary file to instead of using popen to read the output of
2946the preprocessor. Use this option if the popen implementation is buggy
2947on the host (eg., certain non-English language versions of Windows 95 and
2948Windows 98 are known to have buggy popen where the output will instead
2949go the console).
2950
2951@item --no-use-temp-file
2952Use popen, not a temporary file, to read the output of the preprocessor.
2953This is the default behaviour.
2954
3077f5d8 2955@item -h
252b5132
RH
2956@item --help
2957Prints a usage summary.
2958
3077f5d8 2959@item -V
252b5132 2960@item --version
c7c55b78 2961Prints the version number for @command{windres}.
252b5132
RH
2962
2963@item --yydebug
c7c55b78 2964If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
252b5132
RH
2965this will turn on parser debugging.
2966@end table
2967
0285c67d
NC
2968@c man end
2969
2970@ignore
2971@c man begin SEEALSO windres
2972the Info entries for @file{binutils}.
2973@c man end
2974@end ignore
252b5132
RH
2975
2976@node dlltool
2aa9814e 2977@chapter dlltool
252b5132
RH
2978@cindex DLL
2979@kindex dlltool
2980
2aa9814e
BE
2981@command{dlltool} is used to create the files needed to create dynamic
2982link libraries (DLLs) on systems which understand PE format image
2983files such as Windows. A DLL contains an export table which contains
2984information that the runtime loader needs to resolve references from a
2985referencing program.
2986
2987The export table is generated by this program by reading in a
2988@file{.def} file or scanning the @file{.a} and @file{.o} files which
2989will be in the DLL. A @file{.o} file can contain information in
2990special @samp{.drectve} sections with export information.
252b5132
RH
2991
2992@quotation
2aa9814e
BE
2993@emph{Note:} @command{dlltool} is not always built as part of the
2994binary utilities, since it is only useful for those targets which
2995support DLLs.
252b5132
RH
2996@end quotation
2997
0285c67d
NC
2998@c man title dlltool Create files needed to build and use DLLs.
2999
252b5132 3000@smallexample
0285c67d 3001@c man begin SYNOPSIS dlltool
c7c55b78
NC
3002dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
3003 [@option{-b}|@option{--base-file} @var{base-file-name}]
3004 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
3005 [@option{-z}|@option{--output-def} @var{def-file-name}]
3006 [@option{-l}|@option{--output-lib} @var{library-file-name}]
3007 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
3008 [@option{--exclude-symbols} @var{list}]
3009 [@option{--no-default-excludes}]
3010 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
3011 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
3012 [@option{-a}|@option{--add-indirect}] [@option{-U}|@option{--add-underscore}] [@option{-k}|@option{--kill-at}]
3013 [@option{-A}|@option{--add-stdcall-alias}]
607dea97 3014 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
c7c55b78 3015 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}] [@option{-i}|@option{--interwork}]
f9346411
DS
3016 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
3017 [@option{-v}|@option{--verbose}]
c7c55b78 3018 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
252b5132 3019 [object-file @dots{}]
0285c67d 3020@c man end
252b5132
RH
3021@end smallexample
3022
0285c67d
NC
3023@c man begin DESCRIPTION dlltool
3024
c7c55b78
NC
3025@command{dlltool} reads its inputs, which can come from the @option{-d} and
3026@option{-b} options as well as object files specified on the command
3027line. It then processes these inputs and if the @option{-e} option has
3028been specified it creates a exports file. If the @option{-l} option
3029has been specified it creates a library file and if the @option{-z} option
3030has been specified it creates a def file. Any or all of the @option{-e},
3031@option{-l} and @option{-z} options can be present in one invocation of
3032dlltool.
252b5132
RH
3033
3034When creating a DLL, along with the source for the DLL, it is necessary
c7c55b78 3035to have three other files. @command{dlltool} can help with the creation of
252b5132
RH
3036these files.
3037
2aa9814e 3038The first file is a @file{.def} file which specifies which functions are
252b5132 3039exported from the DLL, which functions the DLL imports, and so on. This
c7c55b78
NC
3040is a text file and can be created by hand, or @command{dlltool} can be used
3041to create it using the @option{-z} option. In this case @command{dlltool}
252b5132
RH
3042will scan the object files specified on its command line looking for
3043those functions which have been specially marked as being exported and
2aa9814e 3044put entries for them in the @file{.def} file it creates.
252b5132
RH
3045
3046In order to mark a function as being exported from a DLL, it needs to
c7c55b78 3047have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
252b5132
RH
3048section of the object file. This can be done in C by using the
3049asm() operator:
3050
3051@smallexample
3052 asm (".section .drectve");
3053 asm (".ascii \"-export:my_func\"");
3054
3055 int my_func (void) @{ @dots{} @}
3056@end smallexample
3057
3058The second file needed for DLL creation is an exports file. This file
3059is linked with the object files that make up the body of the DLL and it
3060handles the interface between the DLL and the outside world. This is a
c7c55b78 3061binary file and it can be created by giving the @option{-e} option to
2aa9814e 3062@command{dlltool} when it is creating or reading in a @file{.def} file.
252b5132
RH
3063
3064The third file needed for DLL creation is the library file that programs
3065will link with in order to access the functions in the DLL. This file
c7c55b78 3066can be created by giving the @option{-l} option to dlltool when it
2aa9814e 3067is creating or reading in a @file{.def} file.
252b5132 3068
c7c55b78 3069@command{dlltool} builds the library file by hand, but it builds the
252b5132 3070exports file by creating temporary files containing assembler statements
c7c55b78 3071and then assembling these. The @option{-S} command line option can be
252b5132 3072used to specify the path to the assembler that dlltool will use,
c7c55b78
NC
3073and the @option{-f} option can be used to pass specific flags to that
3074assembler. The @option{-n} can be used to prevent dlltool from deleting
3075these temporary assembler files when it is done, and if @option{-n} is
252b5132
RH
3076specified twice then this will prevent dlltool from deleting the
3077temporary object files it used to build the library.
3078
3079Here is an example of creating a DLL from a source file @samp{dll.c} and
3080also creating a program (from an object file called @samp{program.o})
3081that uses that DLL:
3082
3083@smallexample
3084 gcc -c dll.c
3085 dlltool -e exports.o -l dll.lib dll.o
3086 gcc dll.o exports.o -o dll.dll
3087 gcc program.o dll.lib -o program
3088@end smallexample
3089
0285c67d
NC
3090@c man end
3091
3092@c man begin OPTIONS dlltool
3093
252b5132
RH
3094The command line options have the following meanings:
3095
c7c55b78 3096@table @env
252b5132
RH
3097
3098@item -d @var{filename}
3099@itemx --input-def @var{filename}
3100@cindex input .def file
2aa9814e 3101Specifies the name of a @file{.def} file to be read in and processed.
252b5132
RH
3102
3103@item -b @var{filename}
3104@itemx --base-file @var{filename}
3105@cindex base files
3106Specifies the name of a base file to be read in and processed. The
3107contents of this file will be added to the relocation section in the
3108exports file generated by dlltool.
3109
3110@item -e @var{filename}
3111@itemx --output-exp @var{filename}
3112Specifies the name of the export file to be created by dlltool.
3113
3114@item -z @var{filename}
3115@itemx --output-def @var{filename}
2aa9814e 3116Specifies the name of the @file{.def} file to be created by dlltool.
252b5132
RH
3117
3118@item -l @var{filename}
3119@itemx --output-lib @var{filename}
3120Specifies the name of the library file to be created by dlltool.
3121
3122@item --export-all-symbols
3123Treat all global and weak defined symbols found in the input object
3124files as symbols to be exported. There is a small list of symbols which
c7c55b78 3125are not exported by default; see the @option{--no-default-excludes}
252b5132 3126option. You may add to the list of symbols to not export by using the
c7c55b78 3127@option{--exclude-symbols} option.
252b5132
RH
3128
3129@item --no-export-all-symbols
2aa9814e 3130Only export symbols explicitly listed in an input @file{.def} file or in
252b5132
RH
3131@samp{.drectve} sections in the input object files. This is the default
3132behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
3133attributes in the source code.
3134
3135@item --exclude-symbols @var{list}
3136Do not export the symbols in @var{list}. This is a list of symbol names
3137separated by comma or colon characters. The symbol names should not
3138contain a leading underscore. This is only meaningful when
c7c55b78 3139@option{--export-all-symbols} is used.
252b5132
RH
3140
3141@item --no-default-excludes
c7c55b78 3142When @option{--export-all-symbols} is used, it will by default avoid
252b5132
RH
3143exporting certain special symbols. The current list of symbols to avoid
3144exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
c7c55b78 3145@samp{impure_ptr}. You may use the @option{--no-default-excludes} option
252b5132 3146to go ahead and export these special symbols. This is only meaningful
c7c55b78 3147when @option{--export-all-symbols} is used.
252b5132
RH
3148
3149@item -S @var{path}
3150@itemx --as @var{path}
3151Specifies the path, including the filename, of the assembler to be used
3152to create the exports file.
3153
6364e0b4
NC
3154@item -f @var{options}
3155@itemx --as-flags @var{options}
3156Specifies any specific command line options to be passed to the
252b5132 3157assembler when building the exports file. This option will work even if
c7c55b78 3158the @option{-S} option is not used. This option only takes one argument,
252b5132
RH
3159and if it occurs more than once on the command line, then later
3160occurrences will override earlier occurrences. So if it is necessary to
6364e0b4 3161pass multiple options to the assembler they should be enclosed in
252b5132
RH
3162double quotes.
3163
3164@item -D @var{name}
3165@itemx --dll-name @var{name}
2aa9814e
BE
3166Specifies the name to be stored in the @file{.def} file as the name of
3167the DLL when the @option{-e} option is used. If this option is not
3168present, then the filename given to the @option{-e} option will be
3169used as the name of the DLL.
252b5132
RH
3170
3171@item -m @var{machine}
3172@itemx -machine @var{machine}
3173Specifies the type of machine for which the library file should be
c7c55b78 3174built. @command{dlltool} has a built in default type, depending upon how
252b5132
RH
3175it was created, but this option can be used to override that. This is
3176normally only useful when creating DLLs for an ARM processor, when the
c36774d6 3177contents of the DLL are actually encode using Thumb instructions.
252b5132
RH
3178
3179@item -a
3180@itemx --add-indirect
c7c55b78 3181Specifies that when @command{dlltool} is creating the exports file it
252b5132
RH
3182should add a section which allows the exported functions to be
3183referenced without using the import library. Whatever the hell that
3184means!
3185
3186@item -U
3187@itemx --add-underscore
c7c55b78 3188Specifies that when @command{dlltool} is creating the exports file it
252b5132
RH
3189should prepend an underscore to the names of the exported functions.
3190
3191@item -k
3192@itemx --kill-at
c7c55b78 3193Specifies that when @command{dlltool} is creating the exports file it
d67a454c
NC
3194should not append the string @samp{@@ <number>}. These numbers are
3195called ordinal numbers and they represent another way of accessing the
3196function in a DLL, other than by name.
252b5132
RH
3197
3198@item -A
3199@itemx --add-stdcall-alias
c7c55b78 3200Specifies that when @command{dlltool} is creating the exports file it
252b5132
RH
3201should add aliases for stdcall symbols without @samp{@@ <number>}
3202in addition to the symbols with @samp{@@ <number>}.
3203
607dea97
NC
3204@item -p
3205@itemx --ext-prefix-alias @var{prefix}
3206Causes @command{dlltool} to create external aliases for all DLL
3207imports with the specified prefix. The aliases are created for both
3208external and import symbols with no leading underscore.
3209
252b5132
RH
3210@item -x
3211@itemx --no-idata4
c7c55b78
NC
3212Specifies that when @command{dlltool} is creating the exports and library
3213files it should omit the @code{.idata4} section. This is for compatibility
252b5132
RH
3214with certain operating systems.
3215
3216@item -c
3217@itemx --no-idata5
c7c55b78
NC
3218Specifies that when @command{dlltool} is creating the exports and library
3219files it should omit the @code{.idata5} section. This is for compatibility
252b5132
RH
3220with certain operating systems.
3221
3222@item -i
3223@itemx --interwork
c7c55b78 3224Specifies that @command{dlltool} should mark the objects in the library
252b5132 3225file and exports file that it produces as supporting interworking
c36774d6 3226between ARM and Thumb code.
252b5132
RH
3227
3228@item -n
3229@itemx --nodelete
c7c55b78 3230Makes @command{dlltool} preserve the temporary assembler files it used to
252b5132
RH
3231create the exports file. If this option is repeated then dlltool will
3232also preserve the temporary object files it uses to create the library
f9346411
DS
3233file.
3234
3235@item -t @var{prefix}
3236@itemx --temp-prefix @var{prefix}
3237Makes @command{dlltool} use @var{prefix} when constructing the names of
3238temporary assembler and object files. By default, the temp file prefix
3239is generated from the pid.
252b5132
RH
3240
3241@item -v
3242@itemx --verbose
3243Make dlltool describe what it is doing.
3244
3245@item -h
3246@itemx --help
3247Displays a list of command line options and then exits.
3248
3249@item -V
3250@itemx --version
3251Displays dlltool's version number and then exits.
3252
3253@end table
3254
0285c67d
NC
3255@c man end
3256
2aa9814e
BE
3257@menu
3258* def file format:: The format of the dlltool @file{.def} file
3259@end menu
3260
3261@node def file format
3262@section The format of the @command{dlltool} @file{.def} file
3263
3264A @file{.def} file contains any number of the following commands:
3265
3266@table @asis
3267
3268@item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
3269The result is going to be named @var{name}@code{.exe}.
3270
3271@item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
3272The result is going to be named @var{name}@code{.dll}.
3273
3274@item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) )}
3275@item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
3276Declares @var{name1} as an exported symbol from the DLL, with optional
3277ordinal number @var{integer}, or declares @var{name1} as an alias
3278(forward) of the function @var{external-name} in the DLL
3279@var{module-name}.
3280
3281@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{) ) *}
3282Declares that @var{external-name} or the exported function whose
3283ordinal number is @var{integer} is to be imported from the file
3284@var{module-name}. If @var{internal-name} is specified then this is
3285the name that the imported function will be referred to in the body of
3286the DLL.
3287
3288@item @code{DESCRIPTION} @var{string}
3289Puts @var{string} into the output @file{.exp} file in the
3290@code{.rdata} section.
3291
3292@item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3293@item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
3294Generates @code{--stack} or @code{--heap}
3295@var{number-reserve},@var{number-commit} in the output @code{.drectve}
3296section. The linker will see this and act upon it.
3297
3298@item @code{CODE} @var{attr} @code{+}
3299@item @code{DATA} @var{attr} @code{+}
3300@item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
3301Generates @code{--attr} @var{section-name} @var{attr} in the output
3302@code{.drectve} section, where @var{attr} is one of @code{READ},
3303@code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
3304this and act upon it.
3305
3306@end table
3307
0285c67d
NC
3308@ignore
3309@c man begin SEEALSO dlltool
2aa9814e 3310The Info pages for @file{binutils}.
0285c67d
NC
3311@c man end
3312@end ignore
3313
252b5132
RH
3314@node readelf
3315@chapter readelf
3316
3317@cindex ELF file information
3318@kindex readelf
3319
0285c67d
NC
3320@c man title readelf Displays information about ELF files.
3321
252b5132 3322@smallexample
0285c67d 3323@c man begin SYNOPSIS readelf
c7c55b78
NC
3324readelf [@option{-a}|@option{--all}]
3325 [@option{-h}|@option{--file-header}]
3326 [@option{-l}|@option{--program-headers}|@option{--segments}]
3327 [@option{-S}|@option{--section-headers}|@option{--sections}]
81fc812e 3328 [@option{-g}|@option{--section-groups}]
5477e8a0 3329 [@option{-t}|@option{--section-details}]
c7c55b78
NC
3330 [@option{-e}|@option{--headers}]
3331 [@option{-s}|@option{--syms}|@option{--symbols}]
3332 [@option{-n}|@option{--notes}]
3333 [@option{-r}|@option{--relocs}]
3334 [@option{-u}|@option{--unwind}]
3335 [@option{-d}|@option{--dynamic}]
3336 [@option{-V}|@option{--version-info}]
947ed062 3337 [@option{-A}|@option{--arch-specific}]
c7c55b78 3338 [@option{-D}|@option{--use-dynamic}]
aef1f6d0 3339 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
18bd398b
NC
3340 [@option{-w[liaprmfFsoR]}|
3341 @option{--debug-dump}[=line,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]]
947ed062 3342 [@option{-I}|@option{-histogram}]
c7c55b78 3343 [@option{-v}|@option{--version}]
d974e256 3344 [@option{-W}|@option{--wide}]
c7c55b78 3345 [@option{-H}|@option{--help}]
252b5132 3346 @var{elffile}@dots{}
0285c67d 3347@c man end
252b5132
RH
3348@end smallexample
3349
0285c67d
NC
3350@c man begin DESCRIPTION readelf
3351
c7c55b78 3352@command{readelf} displays information about one or more ELF format object
252b5132
RH
3353files. The options control what particular information to display.
3354
fb52b2f4
NC
3355@var{elffile}@dots{} are the object files to be examined. 32-bit and
335664-bit ELF files are supported, as are archives containing ELF files.
252b5132 3357
9eb20dd8
NC
3358This program performs a similar function to @command{objdump} but it
3359goes into more detail and it exists independently of the @sc{bfd}
3360library, so if there is a bug in @sc{bfd} then readelf will not be
3361affected.
3362
0285c67d
NC
3363@c man end
3364
3365@c man begin OPTIONS readelf
3366
252b5132
RH
3367The long and short forms of options, shown here as alternatives, are
3368equivalent. At least one option besides @samp{-v} or @samp{-H} must be
3369given.
3370
c7c55b78 3371@table @env
252b5132
RH
3372@item -a
3373@itemx --all
c7c55b78
NC
3374Equivalent to specifiying @option{--file-header},
3375@option{--program-headers}, @option{--sections}, @option{--symbols},
3376@option{--relocs}, @option{--dynamic}, @option{--notes} and
3377@option{--version-info}.
252b5132
RH
3378
3379@item -h
3380@itemx --file-header
3381@cindex ELF file header information
3382Displays the information contained in the ELF header at the start of the
3383file.
3384
3385@item -l
3386@itemx --program-headers
3387@itemx --segments
3388@cindex ELF program header information
3389@cindex ELF segment information
3390Displays the information contained in the file's segment headers, if it
3391has any.
3392
3393@item -S
3394@itemx --sections
3395@itemx --section-headers
3396@cindex ELF section information
3397Displays the information contained in the file's section headers, if it
3398has any.
3399
81fc812e
L
3400@item -g
3401@itemx --section-groups
3402@cindex ELF section group information
3403Displays the information contained in the file's section groups, if it
3404has any.
3405
5477e8a0
L
3406@item -t
3407@itemx --section-details
3408@cindex ELF section information
3409Displays the detailed section information. Implies @option{-S}.
81fc812e 3410
252b5132
RH
3411@item -s
3412@itemx --symbols
3413@itemx --syms
3414@cindex ELF symbol table information
3415Displays the entries in symbol table section of the file, if it has one.
3416
3417@item -e
3418@itemx --headers
c7c55b78 3419Display all the headers in the file. Equivalent to @option{-h -l -S}.
252b5132 3420
779fe533
NC
3421@item -n
3422@itemx --notes
1ec5cd37
NC
3423@cindex ELF notes
3424Displays the contents of the NOTE segments and/or sections, if any.
779fe533 3425
252b5132
RH
3426@item -r
3427@itemx --relocs
3428@cindex ELF reloc information
f5e21966
NC
3429Displays the contents of the file's relocation section, if it has one.
3430
3431@item -u
3432@itemx --unwind
3433@cindex unwind information
3434Displays the contents of the file's unwind section, if it has one. Only
3435the unwind sections for IA64 ELF files are currently supported.
252b5132
RH
3436
3437@item -d
3438@itemx --dynamic
3439@cindex ELF dynamic section information
3440Displays the contents of the file's dynamic section, if it has one.
3441
3442@item -V
3443@itemx --version-info
3444@cindex ELF version sections informations
3445Displays the contents of the version sections in the file, it they
3446exist.
3447
947ed062
NC
3448@item -A
3449@itemx --arch-specific
3450Displays architecture-specific information in the file, if there
3451is any.
3452
252b5132
RH
3453@item -D
3454@itemx --use-dynamic
c7c55b78 3455When displaying symbols, this option makes @command{readelf} use the
6dbb55b6 3456symbol table in the file's dynamic section, rather than the one in the
252b5132
RH
3457symbols section.
3458
aef1f6d0
DJ
3459@item -x <number or name>
3460@itemx --hex-dump=<number or name>
252b5132 3461Displays the contents of the indicated section as a hexadecimal dump.
aef1f6d0
DJ
3462A number identifies a particular section by index in the section table;
3463any other string identifies all sections with that name in the object file.
252b5132 3464
18bd398b
NC
3465@item -w[liaprmfFsoR]
3466@itemx --debug-dump[=line,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]
252b5132
RH
3467Displays the contents of the debug sections in the file, if any are
3468present. If one of the optional letters or words follows the switch
3469then only data found in those specific sections will be dumped.
3470
947ed062
NC
3471@item -I
3472@itemx --histogram
252b5132
RH
3473Display a histogram of bucket list lengths when displaying the contents
3474of the symbol tables.
3475
3476@item -v
3477@itemx --version
3478Display the version number of readelf.
3479
d974e256
JJ
3480@item -W
3481@itemx --wide
3482Don't break output lines to fit into 80 columns. By default
3483@command{readelf} breaks section header and segment listing lines for
348464-bit ELF files, so that they fit into 80 columns. This option causes
3485@command{readelf} to print each section header resp. each segment one a
3486single line, which is far more readable on terminals wider than 80 columns.
3487
252b5132
RH
3488@item -H
3489@itemx --help
c7c55b78 3490Display the command line options understood by @command{readelf}.
252b5132
RH
3491
3492@end table
3493
0285c67d
NC
3494@c man end
3495
3496@ignore
3497@c man begin SEEALSO readelf
3498objdump(1), and the Info entries for @file{binutils}.
3499@c man end
3500@end ignore
252b5132 3501
07012eee
MM
3502@node Common Options
3503@chapter Common Options
3504
3505The following command-line options are supported by all of the
3506programs described in this manual.
3507
3508@table @env
1334d4d5 3509@include @value{top_srcdir}/../libiberty/at-file.texi
07012eee
MM
3510
3511@item --help
3512Display the command-line options supported by the program.
3513
3514@item --version
3515Display the version number of the program.
3516
3517@end table
3518
252b5132 3519@node Selecting The Target System
947ed062 3520@chapter Selecting the Target System
252b5132 3521
947ed062 3522You can specify two aspects of the target system to the @sc{gnu}
252b5132
RH
3523binary file utilities, each in several ways:
3524
3525@itemize @bullet
3526@item
3527the target
3528
3529@item
3530the architecture
252b5132
RH
3531@end itemize
3532
3533In the following summaries, the lists of ways to specify values are in
3534order of decreasing precedence. The ways listed first override those
3535listed later.
3536
3537The commands to list valid values only list the values for which the
3538programs you are running were configured. If they were configured with
c7c55b78 3539@option{--enable-targets=all}, the commands list most of the available
252b5132
RH
3540values, but a few are left out; not all targets can be configured in at
3541once because some of them can only be configured @dfn{native} (on hosts
3542with the same type as the target system).
3543
3544@menu
3545* Target Selection::
3546* Architecture Selection::
252b5132
RH
3547@end menu
3548
3549@node Target Selection
3550@section Target Selection
3551
3552A @dfn{target} is an object file format. A given target may be
3553supported for multiple architectures (@pxref{Architecture Selection}).
3554A target selection may also have variations for different operating
3555systems or architectures.
3556
3557The command to list valid target values is @samp{objdump -i}
3558(the first column of output contains the relevant information).
3559
3560Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
3561@samp{a.out-sunos-big}.
3562
3563You can also specify a target using a configuration triplet. This is
f20a759a
ILT
3564the same sort of name that is passed to @file{configure} to specify a
3565target. When you use a configuration triplet as an argument, it must be
3566fully canonicalized. You can see the canonical version of a triplet by
252b5132
RH
3567running the shell script @file{config.sub} which is included with the
3568sources.
3569
3570Some sample configuration triplets are: @samp{m68k-hp-bsd},
3571@samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
3572
c7c55b78 3573@subheading @command{objdump} Target
252b5132
RH
3574
3575Ways to specify:
3576
3577@enumerate
3578@item
c7c55b78 3579command line option: @option{-b} or @option{--target}
252b5132
RH
3580
3581@item
3582environment variable @code{GNUTARGET}
3583
3584@item
3585deduced from the input file
3586@end enumerate
3587
c7c55b78 3588@subheading @command{objcopy} and @command{strip} Input Target
252b5132
RH
3589
3590Ways to specify:
3591
3592@enumerate
3593@item
c7c55b78 3594command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
252b5132
RH
3595
3596@item
3597environment variable @code{GNUTARGET}
3598
3599@item
3600deduced from the input file
3601@end enumerate
3602
c7c55b78 3603@subheading @command{objcopy} and @command{strip} Output Target
252b5132
RH
3604
3605Ways to specify:
3606
3607@enumerate
3608@item
c7c55b78 3609command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
252b5132
RH
3610
3611@item
c7c55b78 3612the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
252b5132
RH
3613
3614@item
3615environment variable @code{GNUTARGET}
3616
3617@item
3618deduced from the input file
3619@end enumerate
3620
c7c55b78 3621@subheading @command{nm}, @command{size}, and @command{strings} Target
252b5132
RH
3622
3623Ways to specify:
3624
3625@enumerate
3626@item
c7c55b78 3627command line option: @option{--target}
252b5132
RH
3628
3629@item
3630environment variable @code{GNUTARGET}
3631
3632@item
3633deduced from the input file
3634@end enumerate
3635
252b5132 3636@node Architecture Selection
947ed062 3637@section Architecture Selection
252b5132
RH
3638
3639An @dfn{architecture} is a type of @sc{cpu} on which an object file is
3640to run. Its name may contain a colon, separating the name of the
3641processor family from the name of the particular @sc{cpu}.
3642
3643The command to list valid architecture values is @samp{objdump -i} (the
3644second column contains the relevant information).
3645
3646Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
3647
c7c55b78 3648@subheading @command{objdump} Architecture
252b5132
RH
3649
3650Ways to specify:
3651
3652@enumerate
3653@item
c7c55b78 3654command line option: @option{-m} or @option{--architecture}
252b5132
RH
3655
3656@item
3657deduced from the input file
3658@end enumerate
3659
c7c55b78 3660@subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
252b5132
RH
3661
3662Ways to specify:
3663
3664@enumerate
3665@item
3666deduced from the input file
3667@end enumerate
3668
252b5132
RH
3669@node Reporting Bugs
3670@chapter Reporting Bugs
3671@cindex bugs
3672@cindex reporting bugs
3673
3674Your bug reports play an essential role in making the binary utilities
3675reliable.
3676
3677Reporting a bug may help you by bringing a solution to your problem, or
3678it may not. But in any case the principal function of a bug report is
3679to help the entire community by making the next version of the binary
3680utilities work better. Bug reports are your contribution to their
3681maintenance.
3682
3683In order for a bug report to serve its purpose, you must include the
3684information that enables us to fix the bug.
3685
3686@menu
3687* Bug Criteria:: Have you found a bug?
3688* Bug Reporting:: How to report bugs
3689@end menu
3690
3691@node Bug Criteria
947ed062 3692@section Have You Found a Bug?
252b5132
RH
3693@cindex bug criteria
3694
3695If you are not sure whether you have found a bug, here are some guidelines:
3696
3697@itemize @bullet
3698@cindex fatal signal
3699@cindex crash
3700@item
3701If a binary utility gets a fatal signal, for any input whatever, that is
3702a bug. Reliable utilities never crash.
3703
3704@cindex error on valid input
3705@item
3706If a binary utility produces an error message for valid input, that is a
3707bug.
3708
3709@item
3710If you are an experienced user of binary utilities, your suggestions for
3711improvement are welcome in any case.
3712@end itemize
3713
3714@node Bug Reporting
947ed062 3715@section How to Report Bugs
252b5132
RH
3716@cindex bug reports
3717@cindex bugs, reporting
3718
3719A number of companies and individuals offer support for @sc{gnu}
3720products. If you obtained the binary utilities from a support
3721organization, we recommend you contact that organization first.
3722
3723You can find contact information for many support companies and
3724individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
3725distribution.
3726
3727In any event, we also recommend that you send bug reports for the binary
2f952d20 3728utilities to @samp{bug-binutils@@gnu.org}.
252b5132
RH
3729
3730The fundamental principle of reporting bugs usefully is this:
3731@strong{report all the facts}. If you are not sure whether to state a
3732fact or leave it out, state it!
3733
3734Often people omit facts because they think they know what causes the
3735problem and assume that some details do not matter. Thus, you might
3736assume that the name of a file you use in an example does not matter.
3737Well, probably it does not, but one cannot be sure. Perhaps the bug is
3738a stray memory reference which happens to fetch from the location where
3739that pathname is stored in memory; perhaps, if the pathname were
3740different, the contents of that location would fool the utility into
3741doing the right thing despite the bug. Play it safe and give a
3742specific, complete example. That is the easiest thing for you to do,
3743and the most helpful.
3744
3745Keep in mind that the purpose of a bug report is to enable us to fix the bug if
3746it is new to us. Therefore, always write your bug reports on the assumption
3747that the bug has not been reported previously.
3748
3749Sometimes people give a few sketchy facts and ask, ``Does this ring a
947ed062
NC
3750bell?'' This cannot help us fix a bug, so it is basically useless. We
3751respond by asking for enough details to enable us to investigate.
3752You might as well expedite matters by sending them to begin with.
252b5132
RH
3753
3754To enable us to fix the bug, you should include all these things:
3755
3756@itemize @bullet
3757@item
3758The version of the utility. Each utility announces it if you start it
c7c55b78 3759with the @option{--version} argument.
252b5132
RH
3760
3761Without this, we will not know whether there is any point in looking for
3762the bug in the current version of the binary utilities.
3763
3764@item
3765Any patches you may have applied to the source, including any patches
3766made to the @code{BFD} library.
3767
3768@item
3769The type of machine you are using, and the operating system name and
3770version number.
3771
3772@item
3773What compiler (and its version) was used to compile the utilities---e.g.
3774``@code{gcc-2.7}''.
3775
3776@item
3777The command arguments you gave the utility to observe the bug. To
3778guarantee you will not omit something important, list them all. A copy
3779of the Makefile (or the output from make) is sufficient.
3780
3781If we were to try to guess the arguments, we would probably guess wrong
3782and then we might not encounter the bug.
3783
3784@item
3785A complete input file, or set of input files, that will reproduce the
3786bug. If the utility is reading an object file or files, then it is
3787generally most helpful to send the actual object files, uuencoded if
757acbc5 3788necessary to get them through the mail system. Note that
2f952d20 3789@samp{bug-binutils@@gnu.org} is a mailing list, so you should avoid
757acbc5
ILT
3790sending very large files to it. Making the files available for
3791anonymous FTP is OK.
252b5132
RH
3792
3793If the source files were produced exclusively using @sc{gnu} programs
c7c55b78 3794(e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
252b5132 3795may be OK to send the source files rather than the object files. In
c7c55b78 3796this case, be sure to say exactly what version of @command{gcc}, or
252b5132 3797whatever, was used to produce the object files. Also say how
c7c55b78 3798@command{gcc}, or whatever, was configured.
252b5132
RH
3799
3800@item
3801A description of what behavior you observe that you believe is
3802incorrect. For example, ``It gets a fatal signal.''
3803
3804Of course, if the bug is that the utility gets a fatal signal, then we
3805will certainly notice it. But if the bug is incorrect output, we might
3806not notice unless it is glaringly wrong. You might as well not give us
3807a chance to make a mistake.
3808
3809Even if the problem you experience is a fatal signal, you should still
f20a759a 3810say so explicitly. Suppose something strange is going on, such as your
252b5132
RH
3811copy of the utility is out of synch, or you have encountered a bug in
3812the C library on your system. (This has happened!) Your copy might
3813crash and ours would not. If you told us to expect a crash, then when
3814ours fails to crash, we would know that the bug was not happening for
3815us. If you had not told us to expect a crash, then we would not be able
3816to draw any conclusion from our observations.
3817
3818@item
3819If you wish to suggest changes to the source, send us context diffs, as
c7c55b78 3820generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
252b5132 3821option. Always send diffs from the old file to the new file. If you
c7c55b78 3822wish to discuss something in the @command{ld} source, refer to it by
f20a759a 3823context, not by line number.
252b5132
RH
3824
3825The line numbers in our development sources will not match those in your
3826sources. Your line numbers would convey no useful information to us.
3827@end itemize
3828
3829Here are some things that are not necessary:
3830
3831@itemize @bullet
3832@item
3833A description of the envelope of the bug.
3834
3835Often people who encounter a bug spend a lot of time investigating
3836which changes to the input file will make the bug go away and which
3837changes will not affect it.
3838
3839This is often time consuming and not very useful, because the way we
3840will find the bug is by running a single example under the debugger
3841with breakpoints, not by pure deduction from a series of examples.
3842We recommend that you save your time for something else.
3843
3844Of course, if you can find a simpler example to report @emph{instead}
3845of the original one, that is a convenience for us. Errors in the
3846output will be easier to spot, running under the debugger will take
3847less time, and so on.
3848
3849However, simplification is not vital; if you do not want to do this,
3850report the bug anyway and send us the entire test case you used.
3851
3852@item
3853A patch for the bug.
3854
3855A patch for the bug does help us if it is a good one. But do not omit
3856the necessary information, such as the test case, on the assumption that
3857a patch is all we need. We might see problems with your patch and decide
3858to fix the problem another way, or we might not understand it at all.
3859
3860Sometimes with programs as complicated as the binary utilities it is
3861very hard to construct an example that will make the program follow a
3862certain path through the code. If you do not send us the example, we
3863will not be able to construct one, so we will not be able to verify that
3864the bug is fixed.
3865
3866And if we cannot understand what bug you are trying to fix, or why your
3867patch should be an improvement, we will not install it. A test case will
3868help us to understand.
3869
3870@item
3871A guess about what the bug is or what it depends on.
3872
3873Such guesses are usually wrong. Even we cannot guess right about such
3874things without first using the debugger to find the facts.
3875@end itemize
3876
947ed062 3877@include fdl.texi
cf055d54 3878
252b5132
RH
3879@node Index
3880@unnumbered Index
3881
3882@printindex cp
3883
3884@contents
3885@bye
This page took 0.469886 seconds and 4 git commands to generate.