s390: Fix gdb.base/all-architectures.exp with --enable-targets=all
[deliverable/binutils-gdb.git] / binutils / doc / binutils.texi
CommitLineData
252b5132
RH
1\input texinfo @c -*- Texinfo -*-
2@setfilename binutils.info
e016ec1f
NC
3@settitle @sc{gnu} Binary Utilities
4@finalout
5@synindex ky cp
8c2bc687 6
dff70155 7@c man begin INCLUDE
c428fa83 8@include bfdver.texi
dff70155 9@c man end
252b5132 10
0e9517a9 11@copying
0285c67d 12@c man begin COPYRIGHT
219d1afa 13Copyright @copyright{} 1991-2018 Free Software Foundation, Inc.
252b5132 14
0285c67d 15Permission is granted to copy, distribute and/or modify this document
793c5807 16under the terms of the GNU Free Documentation License, Version 1.3
0285c67d
NC
17or any later version published by the Free Software Foundation;
18with no Invariant Sections, with no Front-Cover Texts, and with no
19Back-Cover Texts. A copy of the license is included in the
947ed062 20section entitled ``GNU Free Documentation License''.
252b5132 21
0285c67d 22@c man end
0e9517a9 23@end copying
252b5132 24
e016ec1f
NC
25@dircategory Software development
26@direntry
27* Binutils: (binutils). The GNU binary utilities.
28@end direntry
29
30@dircategory Individual utilities
31@direntry
32* addr2line: (binutils)addr2line. Convert addresses to file and line.
33* ar: (binutils)ar. Create, modify, and extract from archives.
34* c++filt: (binutils)c++filt. Filter to demangle encoded C++ symbols.
35* cxxfilt: (binutils)c++filt. MS-DOS name for c++filt.
36* dlltool: (binutils)dlltool. Create files needed to build and use DLLs.
37* nlmconv: (binutils)nlmconv. Converts object code into an NLM.
38* nm: (binutils)nm. List symbols from object files.
39* objcopy: (binutils)objcopy. Copy and translate object files.
40* objdump: (binutils)objdump. Display information from object files.
41* ranlib: (binutils)ranlib. Generate index to archive contents.
42* readelf: (binutils)readelf. Display the contents of ELF format files.
43* size: (binutils)size. List section sizes and total size.
44* strings: (binutils)strings. List printable strings from files.
45* strip: (binutils)strip. Discard symbols.
30fd33bb 46* elfedit: (binutils)elfedit. Update the ELF header of ELF files.
e016ec1f
NC
47* windmc: (binutils)windmc. Generator for Windows message resources.
48* windres: (binutils)windres. Manipulate Windows resources.
49@end direntry
50
252b5132 51@titlepage
252b5132 52@title The @sc{gnu} Binary Utilities
e49e529d
JM
53@ifset VERSION_PACKAGE
54@subtitle @value{VERSION_PACKAGE}
55@end ifset
252b5132
RH
56@subtitle Version @value{VERSION}
57@sp 1
36607f99 58@subtitle @value{UPDATED}
252b5132
RH
59@author Roland H. Pesch
60@author Jeffrey M. Osier
61@author Cygnus Support
62@page
63
64@tex
65{\parskip=0pt \hfill Cygnus Support\par \hfill
e016ec1f 66Texinfo \texinfoversion\par }
252b5132
RH
67@end tex
68
69@vskip 0pt plus 1filll
e016ec1f 70@insertcopying
252b5132 71@end titlepage
4ecceb71 72@contents
252b5132
RH
73
74@node Top
75@top Introduction
76
77@cindex version
947ed062 78This brief manual contains documentation for the @sc{gnu} binary
e49e529d
JM
79utilities
80@ifset VERSION_PACKAGE
81@value{VERSION_PACKAGE}
82@end ifset
83version @value{VERSION}:
252b5132
RH
84
85@iftex
86@table @code
87@item ar
88Create, modify, and extract from archives
89
90@item nm
91List symbols from object files
92
93@item objcopy
94Copy and translate object files
95
96@item objdump
97Display information from object files
98
99@item ranlib
100Generate index to archive contents
101
102@item readelf
103Display the contents of ELF format files.
104
105@item size
106List file section sizes and total size
107
108@item strings
109List printable strings from files
110
111@item strip
112Discard symbols
113
30fd33bb
L
114@item elfedit
115Update the ELF header of ELF files.
116
252b5132 117@item c++filt
9d51cc66
ILT
118Demangle encoded C++ symbols (on MS-DOS, this program is named
119@code{cxxfilt})
252b5132
RH
120
121@item addr2line
122Convert addresses into file names and line numbers
123
124@item nlmconv
125Convert object code into a Netware Loadable Module
126
127@item windres
128Manipulate Windows resources
129
692ed3e7 130@item windmc
a8685210 131Generator for Windows message resources
692ed3e7 132
252b5132
RH
133@item dlltool
134Create the files needed to build and use Dynamic Link Libraries
135@end table
136@end iftex
137
cf055d54 138This document is distributed under the terms of the GNU Free
793c5807
NC
139Documentation License version 1.3. A copy of the license is included
140in the section entitled ``GNU Free Documentation License''.
cf055d54 141
252b5132
RH
142@menu
143* ar:: Create, modify, and extract from archives
144* nm:: List symbols from object files
145* objcopy:: Copy and translate object files
146* objdump:: Display information from object files
147* ranlib:: Generate index to archive contents
252b5132
RH
148* size:: List section sizes and total size
149* strings:: List printable strings from files
150* strip:: Discard symbols
151* c++filt:: Filter to demangle encoded C++ symbols
9d51cc66 152* cxxfilt: c++filt. MS-DOS name for c++filt
252b5132
RH
153* addr2line:: Convert addresses to file and line
154* nlmconv:: Converts object code into an NLM
692ed3e7 155* windmc:: Generator for Windows message resources
7ca01ed9 156* windres:: Manipulate Windows resources
252b5132 157* dlltool:: Create files needed to build and use DLLs
7ca01ed9
NC
158* readelf:: Display the contents of ELF format files
159* elfedit:: Update the ELF header of ELF files
07012eee 160* Common Options:: Command-line options for all utilities
fff279a7 161* Selecting the Target System:: How these utilities determine the target
252b5132 162* Reporting Bugs:: Reporting Bugs
cf055d54 163* GNU Free Documentation License:: GNU Free Documentation License
fa0d8a3e 164* Binutils Index:: Binutils Index
252b5132
RH
165@end menu
166
167@node ar
168@chapter ar
169
170@kindex ar
171@cindex archives
172@cindex collections of files
0285c67d
NC
173
174@c man title ar create, modify, and extract from archives
175
252b5132 176@smallexample
8a1373cc 177ar [-]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
252b5132
RH
178ar -M [ <mri-script ]
179@end smallexample
180
0285c67d
NC
181@c man begin DESCRIPTION ar
182
c7c55b78 183The @sc{gnu} @command{ar} program creates, modifies, and extracts from
252b5132
RH
184archives. An @dfn{archive} is a single file holding a collection of
185other files in a structure that makes it possible to retrieve
186the original individual files (called @dfn{members} of the archive).
187
188The original files' contents, mode (permissions), timestamp, owner, and
189group are preserved in the archive, and can be restored on
c1c0eb9e 190extraction.
252b5132
RH
191
192@cindex name length
c7c55b78
NC
193@sc{gnu} @command{ar} can maintain archives whose members have names of any
194length; however, depending on how @command{ar} is configured on your
252b5132
RH
195system, a limit on member-name length may be imposed for compatibility
196with archive formats maintained with other tools. If it exists, the
197limit is often 15 characters (typical of formats related to a.out) or 16
198characters (typical of formats related to coff).
199
200@cindex libraries
c7c55b78 201@command{ar} is considered a binary utility because archives of this sort
252b5132
RH
202are most often used as @dfn{libraries} holding commonly needed
203subroutines.
204
205@cindex symbol index
c7c55b78 206@command{ar} creates an index to the symbols defined in relocatable
252b5132 207object modules in the archive when you specify the modifier @samp{s}.
c7c55b78 208Once created, this index is updated in the archive whenever @command{ar}
252b5132
RH
209makes a change to its contents (save for the @samp{q} update operation).
210An archive with such an index speeds up linking to the library, and
211allows routines in the library to call each other without regard to
212their placement in the archive.
213
214You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
c7c55b78
NC
215table. If an archive lacks the table, another form of @command{ar} called
216@command{ranlib} can be used to add just the table.
252b5132 217
a8da6403
NC
218@cindex thin archives
219@sc{gnu} @command{ar} can optionally create a @emph{thin} archive,
220which contains a symbol index and references to the original copies
a043396b
NC
221of the member files of the archive. This is useful for building
222libraries for use within a local build tree, where the relocatable
223objects are expected to remain available, and copying the contents of
224each object would only waste time and space.
225
226An archive can either be @emph{thin} or it can be normal. It cannot
227be both at the same time. Once an archive is created its format
228cannot be changed without first deleting it and then creating a new
229archive in its place.
230
231Thin archives are also @emph{flattened}, so that adding one thin
232archive to another thin archive does not nest it, as would happen with
233a normal archive. Instead the elements of the first archive are added
234individually to the second archive.
235
a8da6403 236The paths to the elements of the archive are stored relative to the
d8f187c1 237archive itself.
a8da6403 238
c7c55b78
NC
239@cindex compatibility, @command{ar}
240@cindex @command{ar} compatibility
241@sc{gnu} @command{ar} is designed to be compatible with two different
252b5132 242facilities. You can control its activity using command-line options,
c7c55b78
NC
243like the different varieties of @command{ar} on Unix systems; or, if you
244specify the single command-line option @option{-M}, you can control it
252b5132
RH
245with a script supplied via standard input, like the MRI ``librarian''
246program.
247
0285c67d
NC
248@c man end
249
252b5132 250@menu
c7c55b78
NC
251* ar cmdline:: Controlling @command{ar} on the command line
252* ar scripts:: Controlling @command{ar} with a script
252b5132
RH
253@end menu
254
255@page
256@node ar cmdline
947ed062 257@section Controlling @command{ar} on the Command Line
252b5132
RH
258
259@smallexample
0285c67d 260@c man begin SYNOPSIS ar
8a1373cc 261ar [@option{-X32_64}] [@option{-}]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
0285c67d 262@c man end
252b5132
RH
263@end smallexample
264
c7c55b78
NC
265@cindex Unix compatibility, @command{ar}
266When you use @command{ar} in the Unix style, @command{ar} insists on at least two
252b5132
RH
267arguments to execute: one keyletter specifying the @emph{operation}
268(optionally accompanied by other keyletters specifying
269@emph{modifiers}), and the archive name to act on.
270
271Most operations can also accept further @var{member} arguments,
272specifying particular files to operate on.
273
0285c67d
NC
274@c man begin OPTIONS ar
275
c7c55b78 276@sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
252b5132
RH
277flags @var{mod} in any order, within the first command-line argument.
278
279If you wish, you may begin the first command-line argument with a
280dash.
281
282@cindex operations on archive
283The @var{p} keyletter specifies what operation to execute; it may be
284any of the following, but you must specify only one of them:
285
c7c55b78 286@table @samp
252b5132
RH
287@item d
288@cindex deleting from archive
289@emph{Delete} modules from the archive. Specify the names of modules to
290be deleted as @var{member}@dots{}; the archive is untouched if you
291specify no files to delete.
292
c7c55b78 293If you specify the @samp{v} modifier, @command{ar} lists each module
252b5132
RH
294as it is deleted.
295
296@item m
297@cindex moving in archive
298Use this operation to @emph{move} members in an archive.
299
300The ordering of members in an archive can make a difference in how
301programs are linked using the library, if a symbol is defined in more
c1c0eb9e 302than one member.
252b5132
RH
303
304If no modifiers are used with @code{m}, any members you name in the
305@var{member} arguments are moved to the @emph{end} of the archive;
306you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
307specified place instead.
308
309@item p
310@cindex printing from archive
311@emph{Print} the specified members of the archive, to the standard
312output file. If the @samp{v} modifier is specified, show the member
313name before copying its contents to standard output.
314
315If you specify no @var{member} arguments, all the files in the archive are
316printed.
317
318@item q
319@cindex quick append to archive
320@emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
321@var{archive}, without checking for replacement.
322
323The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
324operation; new members are always placed at the end of the archive.
325
c7c55b78 326The modifier @samp{v} makes @command{ar} list each file as it is appended.
252b5132 327
ce0570c7
NC
328Since the point of this operation is speed, implementations of
329@command{ar} have the option of not updating the archive's symbol
330table if one exists. Too many different systems however assume that
331symbol tables are always up-to-date, so @sc{gnu} @command{ar} will
332rebuild the table even with a quick append.
333
5e080929 334Note - @sc{gnu} @command{ar} treats the command @samp{qs} as a
ce0570c7
NC
335synonym for @samp{r} - replacing already existing files in the
336archive and appending new ones at the end.
252b5132
RH
337
338@item r
339@cindex replacement in archive
340Insert the files @var{member}@dots{} into @var{archive} (with
341@emph{replacement}). This operation differs from @samp{q} in that any
342previously existing members are deleted if their names match those being
343added.
344
c7c55b78 345If one of the files named in @var{member}@dots{} does not exist, @command{ar}
252b5132
RH
346displays an error message, and leaves undisturbed any existing members
347of the archive matching that name.
348
349By default, new members are added at the end of the file; but you may
350use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
351placement relative to some existing member.
352
353The modifier @samp{v} used with this operation elicits a line of
354output for each file inserted, along with one of the letters @samp{a} or
355@samp{r} to indicate whether the file was appended (no old member
356deleted) or replaced.
357
e58bcb8f
NC
358@item s
359@cindex ranlib
360Add an index to the archive, or update it if it already exists. Note
361this command is an exception to the rule that there can only be one
362command letter, as it is possible to use it as either a command or a
363modifier. In either case it does the same thing.
364
252b5132
RH
365@item t
366@cindex contents of archive
367Display a @emph{table} listing the contents of @var{archive}, or those
368of the files listed in @var{member}@dots{} that are present in the
369archive. Normally only the member name is shown; if you also want to
370see the modes (permissions), timestamp, owner, group, and size, you can
371request that by also specifying the @samp{v} modifier.
372
373If you do not specify a @var{member}, all files in the archive
374are listed.
375
376@cindex repeated names in archive
377@cindex name duplication in archive
378If there is more than one file with the same name (say, @samp{fie}) in
379an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
380first instance; to see them all, you must ask for a complete
381listing---in our example, @samp{ar t b.a}.
382@c WRS only; per Gumby, this is implementation-dependent, and in a more
383@c recent case in fact works the other way.
384
385@item x
386@cindex extract from archive
387@emph{Extract} members (named @var{member}) from the archive. You can
388use the @samp{v} modifier with this operation, to request that
c7c55b78 389@command{ar} list each name as it extracts it.
252b5132
RH
390
391If you do not specify a @var{member}, all files in the archive
392are extracted.
393
a8da6403 394Files cannot be extracted from a thin archive.
252b5132
RH
395@end table
396
397A number of modifiers (@var{mod}) may immediately follow the @var{p}
398keyletter, to specify variations on an operation's behavior:
399
c7c55b78 400@table @samp
252b5132
RH
401@item a
402@cindex relative placement in archive
403Add new files @emph{after} an existing member of the
404archive. If you use the modifier @samp{a}, the name of an existing archive
405member must be present as the @var{relpos} argument, before the
406@var{archive} specification.
407
408@item b
409Add new files @emph{before} an existing member of the
410archive. If you use the modifier @samp{b}, the name of an existing archive
411member must be present as the @var{relpos} argument, before the
412@var{archive} specification. (same as @samp{i}).
413
414@item c
415@cindex creating archives
416@emph{Create} the archive. The specified @var{archive} is always
417created if it did not exist, when you request an update. But a warning is
418issued unless you specify in advance that you expect to create it, by
419using this modifier.
420
36e4dce6
CD
421@item D
422@cindex deterministic archives
9cb80f72 423@kindex --enable-deterministic-archives
36e4dce6
CD
424Operate in @emph{deterministic} mode. When adding files and the archive
425index use zero for UIDs, GIDs, timestamps, and use consistent file modes
426for all files. When this option is used, if @command{ar} is used with
427identical options and identical input files, multiple runs will create
428identical output files regardless of the input files' owners, groups,
429file modes, or modification times.
430
9cb80f72
RM
431If @file{binutils} was configured with
432@option{--enable-deterministic-archives}, then this mode is on by default.
433It can be disabled with the @samp{U} modifier, below.
434
252b5132 435@item f
c7c55b78 436Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
252b5132 437names of any length. This will cause it to create archives which are
c7c55b78 438not compatible with the native @command{ar} program on some systems. If
252b5132
RH
439this is a concern, the @samp{f} modifier may be used to truncate file
440names when putting them in the archive.
441
442@item i
443Insert new files @emph{before} an existing member of the
444archive. If you use the modifier @samp{i}, the name of an existing archive
445member must be present as the @var{relpos} argument, before the
446@var{archive} specification. (same as @samp{b}).
447
448@item l
449This modifier is accepted but not used.
450@c whaffor ar l modifier??? presumably compat; with
c1c0eb9e 451@c what???---doc@@cygnus.com, 25jan91
252b5132 452
3de39064
ILT
453@item N
454Uses the @var{count} parameter. This is used if there are multiple
455entries in the archive with the same name. Extract or delete instance
456@var{count} of the given name from the archive.
457
252b5132
RH
458@item o
459@cindex dates in archive
460Preserve the @emph{original} dates of members when extracting them. If
461you do not specify this modifier, files extracted from the archive
462are stamped with the time of extraction.
463
3de39064
ILT
464@item P
465Use the full path name when matching names in the archive. @sc{gnu}
c7c55b78 466@command{ar} can not create an archive with a full path name (such archives
3de39064 467are not POSIX complaint), but other archive creators can. This option
c7c55b78 468will cause @sc{gnu} @command{ar} to match file names using a complete path
3de39064
ILT
469name, which can be convenient when extracting a single file from an
470archive created by another tool.
471
252b5132
RH
472@item s
473@cindex writing archive index
474Write an object-file index into the archive, or update an existing one,
475even if no other change is made to the archive. You may use this modifier
476flag either with any operation, or alone. Running @samp{ar s} on an
477archive is equivalent to running @samp{ranlib} on it.
478
479@item S
480@cindex not writing archive index
481Do not generate an archive symbol table. This can speed up building a
482large library in several steps. The resulting archive can not be used
483with the linker. In order to build a symbol table, you must omit the
484@samp{S} modifier on the last execution of @samp{ar}, or you must run
485@samp{ranlib} on the archive.
486
a8da6403
NC
487@item T
488@cindex creating thin archive
489Make the specified @var{archive} a @emph{thin} archive. If it already
490exists and is a regular archive, the existing members must be present
491in the same directory as @var{archive}.
492
252b5132
RH
493@item u
494@cindex updating an archive
495Normally, @samp{ar r}@dots{} inserts all files
496listed into the archive. If you would like to insert @emph{only} those
497of the files you list that are newer than existing members of the same
498names, use this modifier. The @samp{u} modifier is allowed only for the
499operation @samp{r} (replace). In particular, the combination @samp{qu} is
500not allowed, since checking the timestamps would lose any speed
501advantage from the operation @samp{q}.
502
9cb80f72
RM
503@item U
504@cindex deterministic archives
505@kindex --enable-deterministic-archives
506Do @emph{not} operate in @emph{deterministic} mode. This is the inverse
507of the @samp{D} modifier, above: added files and the archive index will
508get their actual UID, GID, timestamp, and file mode values.
509
510This is the default unless @file{binutils} was configured with
511@option{--enable-deterministic-archives}.
512
252b5132
RH
513@item v
514This modifier requests the @emph{verbose} version of an operation. Many
515operations display additional information, such as filenames processed,
516when the modifier @samp{v} is appended.
517
518@item V
c7c55b78 519This modifier shows the version number of @command{ar}.
252b5132
RH
520@end table
521
387dd777
DP
522The @command{ar} program also supports some command line options which
523are neither modifiers nor actions, but which do change its behaviour
524in specific ways:
525
526@table @samp
527@item --help
528Displays the list of command line options supported by @command{ar}
529and then exits.
530
531@item --version
532Displays the version information of @command{ar} and then exits.
533
534@item -X32_64
c7c55b78 535@command{ar} ignores an initial option spelt @samp{-X32_64}, for
6e800839 536compatibility with AIX. The behaviour produced by this option is the
387dd777
DP
537default for @sc{gnu} @command{ar}. @command{ar} does not support any
538of the other @samp{-X} options; in particular, it does not support
539@option{-X32} which is the default for AIX @command{ar}.
6e800839 540
387dd777
DP
541@item --plugin @var{name}
542@cindex plugins
543The optional command line switch @option{--plugin @var{name}} causes
ce3c775b 544@command{ar} to load the plugin called @var{name} which adds support
387dd777
DP
545for more file formats, including object files with link-time
546optimization information.
547
548This option is only available if the toolchain has been built with
549plugin support enabled.
550
551If @option{--plugin} is not provided, but plugin support has been
552enabled then @command{ar} iterates over the files in
553@file{$@{libdir@}/bfd-plugins} in alphabetic order and the first
554plugin that claims the object in question is used.
555
556Please note that this plugin search directory is @emph{not} the one
557used by @command{ld}'s @option{-plugin} option. In order to make
558@command{ar} use the linker plugin it must be copied into the
559@file{$@{libdir@}/bfd-plugins} directory. For GCC based compilations
560the linker plugin is called @file{liblto_plugin.so.0.0.0}. For Clang
561based compilations it is called @file{LLVMgold.so}. The GCC plugin
562is always backwards compatible with earlier versions, so it is
563sufficient to just copy the newest one.
564
565@item --target @var{target}
566The optional command line switch @option{--target @var{bfdname}}
8adf5d70
NC
567specifies that the archive members are in an object code format
568different from your system's default format. See
569@xref{Target Selection}, for more information.
387dd777 570@end table
0285c67d
NC
571@c man end
572
573@ignore
574@c man begin SEEALSO ar
575nm(1), ranlib(1), and the Info entries for @file{binutils}.
576@c man end
577@end ignore
578
252b5132 579@node ar scripts
947ed062 580@section Controlling @command{ar} with a Script
252b5132
RH
581
582@smallexample
583ar -M [ <@var{script} ]
584@end smallexample
585
c7c55b78
NC
586@cindex MRI compatibility, @command{ar}
587@cindex scripts, @command{ar}
588If you use the single command-line option @samp{-M} with @command{ar}, you
252b5132 589can control its operation with a rudimentary command language. This
c7c55b78
NC
590form of @command{ar} operates interactively if standard input is coming
591directly from a terminal. During interactive use, @command{ar} prompts for
252b5132
RH
592input (the prompt is @samp{AR >}), and continues executing even after
593errors. If you redirect standard input to a script file, no prompts are
c7c55b78 594issued, and @command{ar} abandons execution (with a nonzero exit code)
252b5132
RH
595on any error.
596
c7c55b78 597The @command{ar} command language is @emph{not} designed to be equivalent
252b5132
RH
598to the command-line options; in fact, it provides somewhat less control
599over archives. The only purpose of the command language is to ease the
c7c55b78 600transition to @sc{gnu} @command{ar} for developers who already have scripts
252b5132
RH
601written for the MRI ``librarian'' program.
602
c7c55b78 603The syntax for the @command{ar} command language is straightforward:
252b5132
RH
604@itemize @bullet
605@item
606commands are recognized in upper or lower case; for example, @code{LIST}
607is the same as @code{list}. In the following descriptions, commands are
608shown in upper case for clarity.
609
610@item
611a single command may appear on each line; it is the first word on the
612line.
613
614@item
615empty lines are allowed, and have no effect.
616
617@item
618comments are allowed; text after either of the characters @samp{*}
619or @samp{;} is ignored.
620
621@item
c7c55b78 622Whenever you use a list of names as part of the argument to an @command{ar}
252b5132
RH
623command, you can separate the individual names with either commas or
624blanks. Commas are shown in the explanations below, for clarity.
625
626@item
627@samp{+} is used as a line continuation character; if @samp{+} appears
628at the end of a line, the text on the following line is considered part
629of the current command.
630@end itemize
631
c7c55b78
NC
632Here are the commands you can use in @command{ar} scripts, or when using
633@command{ar} interactively. Three of them have special significance:
252b5132
RH
634
635@code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
636a temporary file required for most of the other commands.
637
638@code{SAVE} commits the changes so far specified by the script. Prior
639to @code{SAVE}, commands affect only the temporary copy of the current
640archive.
641
642@table @code
c1c0eb9e 643@item ADDLIB @var{archive}
252b5132
RH
644@itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
645Add all the contents of @var{archive} (or, if specified, each named
646@var{module} from @var{archive}) to the current archive.
647
648Requires prior use of @code{OPEN} or @code{CREATE}.
649
650@item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
651@c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
652@c else like "ar q..."
653Add each named @var{member} as a module in the current archive.
654
655Requires prior use of @code{OPEN} or @code{CREATE}.
656
657@item CLEAR
658Discard the contents of the current archive, canceling the effect of
659any operations since the last @code{SAVE}. May be executed (with no
660effect) even if no current archive is specified.
661
662@item CREATE @var{archive}
663Creates an archive, and makes it the current archive (required for many
664other commands). The new archive is created with a temporary name; it
665is not actually saved as @var{archive} until you use @code{SAVE}.
666You can overwrite existing archives; similarly, the contents of any
667existing file named @var{archive} will not be destroyed until @code{SAVE}.
668
669@item DELETE @var{module}, @var{module}, @dots{} @var{module}
670Delete each listed @var{module} from the current archive; equivalent to
671@samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
672
673Requires prior use of @code{OPEN} or @code{CREATE}.
674
675@item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
676@itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
677List each named @var{module} present in @var{archive}. The separate
678command @code{VERBOSE} specifies the form of the output: when verbose
679output is off, output is like that of @samp{ar -t @var{archive}
680@var{module}@dots{}}. When verbose output is on, the listing is like
681@samp{ar -tv @var{archive} @var{module}@dots{}}.
682
683Output normally goes to the standard output stream; however, if you
c7c55b78 684specify @var{outputfile} as a final argument, @command{ar} directs the
252b5132
RH
685output to that file.
686
687@item END
c7c55b78 688Exit from @command{ar}, with a @code{0} exit code to indicate successful
252b5132
RH
689completion. This command does not save the output file; if you have
690changed the current archive since the last @code{SAVE} command, those
691changes are lost.
692
693@item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
694Extract each named @var{module} from the current archive, writing them
695into the current directory as separate files. Equivalent to @samp{ar -x
696@var{archive} @var{module}@dots{}}.
697
698Requires prior use of @code{OPEN} or @code{CREATE}.
699
700@ignore
701@c FIXME Tokens but no commands???
702@item FULLDIR
703
704@item HELP
705@end ignore
706
707@item LIST
708Display full contents of the current archive, in ``verbose'' style
709regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
c7c55b78 710tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
252b5132
RH
711enhancement, rather than present for MRI compatibility.)
712
713Requires prior use of @code{OPEN} or @code{CREATE}.
714
715@item OPEN @var{archive}
716Opens an existing archive for use as the current archive (required for
717many other commands). Any changes as the result of subsequent commands
718will not actually affect @var{archive} until you next use @code{SAVE}.
719
720@item REPLACE @var{module}, @var{module}, @dots{} @var{module}
721In the current archive, replace each existing @var{module} (named in
722the @code{REPLACE} arguments) from files in the current working directory.
723To execute this command without errors, both the file, and the module in
c1c0eb9e 724the current archive, must exist.
252b5132
RH
725
726Requires prior use of @code{OPEN} or @code{CREATE}.
727
728@item VERBOSE
729Toggle an internal flag governing the output from @code{DIRECTORY}.
730When the flag is on, @code{DIRECTORY} output matches output from
731@samp{ar -tv }@dots{}.
732
733@item SAVE
734Commit your changes to the current archive, and actually save it as a
735file with the name specified in the last @code{CREATE} or @code{OPEN}
c1c0eb9e 736command.
252b5132
RH
737
738Requires prior use of @code{OPEN} or @code{CREATE}.
739
740@end table
741
742@iftex
743@node ld
744@chapter ld
745@cindex linker
746@kindex ld
c7c55b78 747The @sc{gnu} linker @command{ld} is now described in a separate manual.
252b5132
RH
748@xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
749@end iftex
750
751@node nm
752@chapter nm
753@cindex symbols
754@kindex nm
755
0285c67d
NC
756@c man title nm list symbols from object files
757
252b5132 758@smallexample
0285c67d 759@c man begin SYNOPSIS nm
fa8f3997
NC
760nm [@option{-A}|@option{-o}|@option{--print-file-name}] [@option{-a}|@option{--debug-syms}]
761 [@option{-B}|@option{--format=bsd}] [@option{-C}|@option{--demangle}[=@var{style}]]
762 [@option{-D}|@option{--dynamic}] [@option{-f}@var{format}|@option{--format=}@var{format}]
763 [@option{-g}|@option{--extern-only}] [@option{-h}|@option{--help}]
4a14e306
AK
764 [@option{-l}|@option{--line-numbers}] [@option{--inlines}]
765 [@option{-n}|@option{-v}|@option{--numeric-sort}]
fa8f3997
NC
766 [@option{-P}|@option{--portability}] [@option{-p}|@option{--no-sort}]
767 [@option{-r}|@option{--reverse-sort}] [@option{-S}|@option{--print-size}]
768 [@option{-s}|@option{--print-armap}] [@option{-t} @var{radix}|@option{--radix=}@var{radix}]
769 [@option{-u}|@option{--undefined-only}] [@option{-V}|@option{--version}]
770 [@option{-X 32_64}] [@option{--defined-only}] [@option{--no-demangle}]
771 [@option{--plugin} @var{name}] [@option{--size-sort}] [@option{--special-syms}]
df2c87b5 772 [@option{--synthetic}] [@option{--with-symbol-versions}] [@option{--target=}@var{bfdname}]
fa8f3997 773 [@var{objfile}@dots{}]
0285c67d 774@c man end
252b5132
RH
775@end smallexample
776
0285c67d 777@c man begin DESCRIPTION nm
c7c55b78
NC
778@sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
779If no object files are listed as arguments, @command{nm} assumes the file
252b5132
RH
780@file{a.out}.
781
c7c55b78 782For each symbol, @command{nm} shows:
252b5132
RH
783
784@itemize @bullet
785@item
786The symbol value, in the radix selected by options (see below), or
787hexadecimal by default.
788
789@item
790The symbol type. At least the following types are used; others are, as
791well, depending on the object file format. If lowercase, the symbol is
0ba0c2b3
NC
792usually local; if uppercase, the symbol is global (external). There
793are however a few lowercase symbols that are shown for special global
794symbols (@code{u}, @code{v} and @code{w}).
252b5132
RH
795
796@c Some more detail on exactly what these symbol types are used for
797@c would be nice.
798@table @code
799@item A
800The symbol's value is absolute, and will not be changed by further
801linking.
802
803@item B
a1039809 804@itemx b
252b5132
RH
805The symbol is in the uninitialized data section (known as BSS).
806
807@item C
808The symbol is common. Common symbols are uninitialized data. When
809linking, multiple common symbols may appear with the same name. If the
810symbol is defined anywhere, the common symbols are treated as undefined
0285c67d
NC
811references.
812@ifclear man
813For more details on common symbols, see the discussion of
252b5132 814--warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
0879a67a 815@end ifclear
252b5132
RH
816
817@item D
a1039809 818@itemx d
252b5132
RH
819The symbol is in the initialized data section.
820
821@item G
a1039809 822@itemx g
252b5132
RH
823The symbol is in an initialized data section for small objects. Some
824object file formats permit more efficient access to small data objects,
825such as a global int variable as opposed to a large global array.
826
a1039809 827@item i
3e7a7d11
NC
828For PE format files this indicates that the symbol is in a section
829specific to the implementation of DLLs. For ELF format files this
830indicates that the symbol is an indirect function. This is a GNU
831extension to the standard set of ELF symbol types. It indicates a
832symbol which if referenced by a relocation does not evaluate to its
833address, but instead must be invoked at runtime. The runtime
834execution will then return the value to be used in the relocation.
a1039809 835
021f8a30
NC
836@item I
837The symbol is an indirect reference to another symbol.
838
252b5132
RH
839@item N
840The symbol is a debugging symbol.
841
a1039809
NC
842@item p
843The symbols is in a stack unwind section.
844
252b5132 845@item R
a1039809 846@itemx r
252b5132
RH
847The symbol is in a read only data section.
848
849@item S
a1039809 850@itemx s
252b5132
RH
851The symbol is in an uninitialized data section for small objects.
852
853@item T
a1039809 854@itemx t
252b5132
RH
855The symbol is in the text (code) section.
856
857@item U
858The symbol is undefined.
859
3e7a7d11
NC
860@item u
861The symbol is a unique global symbol. This is a GNU extension to the
862standard set of ELF symbol bindings. For such a symbol the dynamic linker
863will make sure that in the entire process there is just one symbol with
864this name and type in use.
865
fad6fcbb 866@item V
a1039809 867@itemx v
fad6fcbb
NC
868The symbol is a weak object. When a weak defined symbol is linked with
869a normal defined symbol, the normal defined symbol is used with no error.
870When a weak undefined symbol is linked and the symbol is not defined,
a1039809
NC
871the value of the weak symbol becomes zero with no error. On some
872systems, uppercase indicates that a default value has been specified.
fad6fcbb 873
252b5132 874@item W
a1039809 875@itemx w
fad6fcbb
NC
876The symbol is a weak symbol that has not been specifically tagged as a
877weak object symbol. When a weak defined symbol is linked with a normal
878defined symbol, the normal defined symbol is used with no error.
879When a weak undefined symbol is linked and the symbol is not defined,
c87db184 880the value of the symbol is determined in a system-specific manner without
c1c0eb9e 881error. On some systems, uppercase indicates that a default value has been
977cdf5a
NC
882specified.
883
252b5132
RH
884@item -
885The symbol is a stabs symbol in an a.out object file. In this case, the
886next values printed are the stabs other field, the stabs desc field, and
c7c55b78 887the stab type. Stabs symbols are used to hold debugging information.
252b5132
RH
888
889@item ?
890The symbol type is unknown, or object file format specific.
891@end table
892
893@item
894The symbol name.
895@end itemize
896
0285c67d
NC
897@c man end
898
899@c man begin OPTIONS nm
252b5132
RH
900The long and short forms of options, shown here as alternatives, are
901equivalent.
902
c7c55b78 903@table @env
252b5132
RH
904@item -A
905@itemx -o
c1c0eb9e 906@itemx --print-file-name
252b5132
RH
907@cindex input file name
908@cindex file name
909@cindex source file name
f20a759a 910Precede each symbol by the name of the input file (or archive member)
252b5132
RH
911in which it was found, rather than identifying the input file once only,
912before all of its symbols.
913
914@item -a
c1c0eb9e 915@itemx --debug-syms
252b5132
RH
916@cindex debugging symbols
917Display all symbols, even debugger-only symbols; normally these are not
918listed.
919
920@item -B
c7c55b78
NC
921@cindex @command{nm} format
922@cindex @command{nm} compatibility
923The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
252b5132
RH
924
925@item -C
28c309a2 926@itemx --demangle[=@var{style}]
252b5132
RH
927@cindex demangling in nm
928Decode (@dfn{demangle}) low-level symbol names into user-level names.
929Besides removing any initial underscore prepended by the system, this
28c309a2 930makes C++ function names readable. Different compilers have different
c1c0eb9e
RM
931mangling styles. The optional demangling style argument can be used to
932choose an appropriate demangling style for your compiler. @xref{c++filt},
28c309a2 933for more information on demangling.
252b5132
RH
934
935@item --no-demangle
936Do not demangle low-level symbol names. This is the default.
937
938@item -D
939@itemx --dynamic
940@cindex dynamic symbols
941Display the dynamic symbols rather than the normal symbols. This is
942only meaningful for dynamic objects, such as certain types of shared
943libraries.
944
945@item -f @var{format}
946@itemx --format=@var{format}
c7c55b78
NC
947@cindex @command{nm} format
948@cindex @command{nm} compatibility
252b5132
RH
949Use the output format @var{format}, which can be @code{bsd},
950@code{sysv}, or @code{posix}. The default is @code{bsd}.
951Only the first character of @var{format} is significant; it can be
952either upper or lower case.
953
954@item -g
c1c0eb9e 955@itemx --extern-only
252b5132
RH
956@cindex external symbols
957Display only external symbols.
958
fa8f3997
NC
959@item -h
960@itemx --help
961Show a summary of the options to @command{nm} and exit.
ce3c775b 962
252b5132
RH
963@item -l
964@itemx --line-numbers
965@cindex symbol line numbers
966For each symbol, use debugging information to try to find a filename and
967line number. For a defined symbol, look for the line number of the
968address of the symbol. For an undefined symbol, look for the line
969number of a relocation entry which refers to the symbol. If line number
970information can be found, print it after the other symbol information.
971
4a14e306
AK
972@item --inlines
973@cindex objdump inlines
974When option @option{-l} is active, if the address belongs to a
975function that was inlined, then this option causes the source
976information for all enclosing scopes back to the first non-inlined
977function to be printed as well. For example, if @code{main} inlines
978@code{callee1} which inlines @code{callee2}, and address is from
979@code{callee2}, the source information for @code{callee1} and @code{main}
980will also be printed.
981
252b5132
RH
982@item -n
983@itemx -v
c1c0eb9e 984@itemx --numeric-sort
252b5132 985Sort symbols numerically by their addresses, rather than alphabetically
c1c0eb9e 986by their names.
252b5132
RH
987
988@item -p
c1c0eb9e 989@itemx --no-sort
252b5132
RH
990@cindex sorting symbols
991Do not bother to sort the symbols in any order; print them in the order
992encountered.
993
994@item -P
995@itemx --portability
996Use the POSIX.2 standard output format instead of the default format.
997Equivalent to @samp{-f posix}.
998
fa8f3997
NC
999@item -r
1000@itemx --reverse-sort
1001Reverse the order of the sort (whether numeric or alphabetic); let the
1002last come first.
1003
72797995
L
1004@item -S
1005@itemx --print-size
1533edfb
AM
1006Print both value and size of defined symbols for the @code{bsd} output style.
1007This option has no effect for object formats that do not record symbol
1008sizes, unless @samp{--size-sort} is also used in which case a
1009calculated size is displayed.
72797995 1010
252b5132
RH
1011@item -s
1012@itemx --print-armap
1013@cindex symbol index, listing
1014When listing symbols from archive members, include the index: a mapping
c7c55b78 1015(stored in the archive by @command{ar} or @command{ranlib}) of which modules
252b5132
RH
1016contain definitions for which names.
1017
fa8f3997
NC
1018@item -t @var{radix}
1019@itemx --radix=@var{radix}
1020Use @var{radix} as the radix for printing the symbol values. It must be
1021@samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
1022
1023@item -u
1024@itemx --undefined-only
1025@cindex external symbols
1026@cindex undefined symbols
1027Display only undefined symbols (those external to each object file).
1028
1029@item -V
1030@itemx --version
1031Show the version number of @command{nm} and exit.
1032
1033@item -X
1034This option is ignored for compatibility with the AIX version of
1035@command{nm}. It takes one parameter which must be the string
1036@option{32_64}. The default mode of AIX @command{nm} corresponds
1037to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
1038
1039@item --defined-only
1040@cindex external symbols
1041@cindex undefined symbols
1042Display only defined symbols for each object file.
1043
1044@item --plugin @var{name}
387dd777 1045@cindex plugins
fa8f3997
NC
1046Load the plugin called @var{name} to add support for extra target
1047types. This option is only available if the toolchain has been built
1048with plugin support enabled.
252b5132 1049
387dd777
DP
1050If @option{--plugin} is not provided, but plugin support has been
1051enabled then @command{nm} iterates over the files in
1052@file{$@{libdir@}/bfd-plugins} in alphabetic order and the first
1053plugin that claims the object in question is used.
1054
1055Please note that this plugin search directory is @emph{not} the one
1056used by @command{ld}'s @option{-plugin} option. In order to make
1057@command{nm} use the linker plugin it must be copied into the
1058@file{$@{libdir@}/bfd-plugins} directory. For GCC based compilations
1059the linker plugin is called @file{liblto_plugin.so.0.0.0}. For Clang
1060based compilations it is called @file{LLVMgold.so}. The GCC plugin
1061is always backwards compatible with earlier versions, so it is
1062sufficient to just copy the newest one.
1063
252b5132 1064@item --size-sort
29f4fdc4
AB
1065Sort symbols by size. For ELF objects symbol sizes are read from the
1066ELF, for other object types the symbol sizes are computed as the
1067difference between the value of the symbol and the value of the symbol
1068with the next higher value. If the @code{bsd} output format is used
1069the size of the symbol is printed, rather than the value, and
1070@samp{-S} must be used in order both size and value to be printed.
252b5132 1071
3c9458e9
NC
1072@item --special-syms
1073Display symbols which have a target-specific special meaning. These
1074symbols are usually used by the target for some special processing and
a575c958
NC
1075are not normally helpful when included in the normal symbol lists.
1076For example for ARM targets this option would skip the mapping symbols
1077used to mark transitions between ARM code, THUMB code and data.
3c9458e9 1078
fa8f3997
NC
1079@item --synthetic
1080Include synthetic symbols in the output. These are special symbols
1081created by the linker for various purposes. They are not shown by
1082default since they are not part of the binary's original source code.
252b5132 1083
df2c87b5
NC
1084@item --with-symbol-versions
1085Enables the display of symbol version information if any exists. The
1086version string is displayed as a suffix to the symbol name, preceeded by
1087an @@ character. For example @samp{foo@@VER_1}. If the version is
1088the default version to be used when resolving unversioned references
1089to the symbol then it is displayed as a suffix preceeded by two @@
1090characters. For example @samp{foo@@@@VER_2}.
1091
252b5132
RH
1092@item --target=@var{bfdname}
1093@cindex object code format
1094Specify an object code format other than your system's default format.
1095@xref{Target Selection}, for more information.
1096
252b5132
RH
1097@end table
1098
0285c67d
NC
1099@c man end
1100
1101@ignore
1102@c man begin SEEALSO nm
1103ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1104@c man end
1105@end ignore
1106
252b5132
RH
1107@node objcopy
1108@chapter objcopy
1109
0285c67d
NC
1110@c man title objcopy copy and translate object files
1111
252b5132 1112@smallexample
0285c67d 1113@c man begin SYNOPSIS objcopy
c7c55b78
NC
1114objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1115 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1116 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1117 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
2593f09a
NC
1118 [@option{-S}|@option{--strip-all}]
1119 [@option{-g}|@option{--strip-debug}]
0fbdde94 1120 [@option{--strip-unneeded}]
c7c55b78
NC
1121 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1122 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
bcf32829 1123 [@option{--strip-unneeded-symbol=}@var{symbolname}]
c7c55b78 1124 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
d58c2e3a 1125 [@option{--localize-hidden}]
c7c55b78 1126 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
7b4a0685 1127 [@option{--globalize-symbol=}@var{symbolname}]
c7c55b78 1128 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
5fe11841 1129 [@option{-w}|@option{--wildcard}]
2593f09a
NC
1130 [@option{-x}|@option{--discard-all}]
1131 [@option{-X}|@option{--discard-locals}]
c7c55b78 1132 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
b7dd81f7
NC
1133 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1134 [@option{--interleave-width=}@var{width}]
2e62b721
NC
1135 [@option{-j} @var{sectionpattern}|@option{--only-section=}@var{sectionpattern}]
1136 [@option{-R} @var{sectionpattern}|@option{--remove-section=}@var{sectionpattern}]
d3e5f6c8 1137 [@option{--remove-relocations=}@var{sectionpattern}]
c7c55b78 1138 [@option{-p}|@option{--preserve-dates}]
2e30cb57 1139 [@option{-D}|@option{--enable-deterministic-archives}]
955d0b3b 1140 [@option{-U}|@option{--disable-deterministic-archives}]
c7c55b78 1141 [@option{--debugging}]
2593f09a
NC
1142 [@option{--gap-fill=}@var{val}]
1143 [@option{--pad-to=}@var{address}]
1144 [@option{--set-start=}@var{val}]
1145 [@option{--adjust-start=}@var{incr}]
c7c55b78 1146 [@option{--change-addresses=}@var{incr}]
2e62b721
NC
1147 [@option{--change-section-address} @var{sectionpattern}@{=,+,-@}@var{val}]
1148 [@option{--change-section-lma} @var{sectionpattern}@{=,+,-@}@var{val}]
1149 [@option{--change-section-vma} @var{sectionpattern}@{=,+,-@}@var{val}]
c7c55b78 1150 [@option{--change-warnings}] [@option{--no-change-warnings}]
2e62b721 1151 [@option{--set-section-flags} @var{sectionpattern}=@var{flags}]
c7c55b78 1152 [@option{--add-section} @var{sectionname}=@var{filename}]
bbad633b 1153 [@option{--dump-section} @var{sectionname}=@var{filename}]
acf1419f 1154 [@option{--update-section} @var{sectionname}=@var{filename}]
c7c55b78 1155 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
0408dee6 1156 [@option{--long-section-names} @{enable,disable,keep@}]
2593f09a 1157 [@option{--change-leading-char}] [@option{--remove-leading-char}]
9e48b4c6 1158 [@option{--reverse-bytes=}@var{num}]
2593f09a
NC
1159 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1160 [@option{--redefine-sym} @var{old}=@var{new}]
1161 [@option{--redefine-syms=}@var{filename}]
c7c55b78
NC
1162 [@option{--weaken}]
1163 [@option{--keep-symbols=}@var{filename}]
1164 [@option{--strip-symbols=}@var{filename}]
bcf32829 1165 [@option{--strip-unneeded-symbols=}@var{filename}]
c7c55b78
NC
1166 [@option{--keep-global-symbols=}@var{filename}]
1167 [@option{--localize-symbols=}@var{filename}]
7b4a0685 1168 [@option{--globalize-symbols=}@var{filename}]
c7c55b78 1169 [@option{--weaken-symbols=}@var{filename}]
2b35fb28 1170 [@option{--add-symbol} @var{name}=[@var{section}:]@var{value}[,@var{flags}]
c51238bc
DA
1171 [@option{--alt-machine-code=}@var{index}]
1172 [@option{--prefix-symbols=}@var{string}]
1173 [@option{--prefix-sections=}@var{string}]
1174 [@option{--prefix-alloc-sections=}@var{string}]
ed1653a7 1175 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1637cd90 1176 [@option{--keep-file-symbols}]
ed1653a7 1177 [@option{--only-keep-debug}]
96109726
CC
1178 [@option{--strip-dwo}]
1179 [@option{--extract-dwo}]
d3e52d40 1180 [@option{--extract-symbol}]
4087920c
MR
1181 [@option{--writable-text}]
1182 [@option{--readonly-text}]
1183 [@option{--pure}]
1184 [@option{--impure}]
92dd4511
L
1185 [@option{--file-alignment=}@var{num}]
1186 [@option{--heap=}@var{size}]
1187 [@option{--image-base=}@var{address}]
1188 [@option{--section-alignment=}@var{num}]
1189 [@option{--stack=}@var{size}]
1190 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
4a114e3e
L
1191 [@option{--compress-debug-sections}]
1192 [@option{--decompress-debug-sections}]
b8871f35 1193 [@option{--elf-stt-common=@var{val}}]
9ef920e9 1194 [@option{--merge-notes}]
1d15e434 1195 [@option{--no-merge-notes}]
c7c55b78 1196 [@option{-v}|@option{--verbose}]
c1c0eb9e 1197 [@option{-V}|@option{--version}]
7c29036b 1198 [@option{--help}] [@option{--info}]
252b5132 1199 @var{infile} [@var{outfile}]
0285c67d 1200@c man end
252b5132
RH
1201@end smallexample
1202
0285c67d 1203@c man begin DESCRIPTION objcopy
c7c55b78
NC
1204The @sc{gnu} @command{objcopy} utility copies the contents of an object
1205file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
252b5132
RH
1206read and write the object files. It can write the destination object
1207file in a format different from that of the source object file. The
c7c55b78
NC
1208exact behavior of @command{objcopy} is controlled by command-line options.
1209Note that @command{objcopy} should be able to copy a fully linked file
ccd13d18
L
1210between any two formats. However, copying a relocatable object file
1211between any two formats may not work as expected.
252b5132 1212
c7c55b78
NC
1213@command{objcopy} creates temporary files to do its translations and
1214deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
252b5132
RH
1215translation work; it has access to all the formats described in @sc{bfd}
1216and thus is able to recognize most formats without being told
1217explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1218
c7c55b78 1219@command{objcopy} can be used to generate S-records by using an output
252b5132
RH
1220target of @samp{srec} (e.g., use @samp{-O srec}).
1221
c7c55b78
NC
1222@command{objcopy} can be used to generate a raw binary file by using an
1223output target of @samp{binary} (e.g., use @option{-O binary}). When
1224@command{objcopy} generates a raw binary file, it will essentially produce
252b5132
RH
1225a memory dump of the contents of the input object file. All symbols and
1226relocation information will be discarded. The memory dump will start at
1227the load address of the lowest section copied into the output file.
1228
1229When generating an S-record or a raw binary file, it may be helpful to
c7c55b78
NC
1230use @option{-S} to remove sections containing debugging information. In
1231some cases @option{-R} will be useful to remove sections which contain
f20a759a 1232information that is not needed by the binary file.
252b5132 1233
947ed062
NC
1234Note---@command{objcopy} is not able to change the endianness of its input
1235files. If the input format has an endianness (some formats do not),
c7c55b78 1236@command{objcopy} can only copy the inputs into file formats that have the
947ed062 1237same endianness or which have no endianness (e.g., @samp{srec}).
9e48b4c6 1238(However, see the @option{--reverse-bytes} option.)
18356cf2 1239
0285c67d
NC
1240@c man end
1241
1242@c man begin OPTIONS objcopy
1243
c7c55b78 1244@table @env
252b5132
RH
1245@item @var{infile}
1246@itemx @var{outfile}
f20a759a 1247The input and output files, respectively.
c7c55b78 1248If you do not specify @var{outfile}, @command{objcopy} creates a
252b5132
RH
1249temporary file and destructively renames the result with
1250the name of @var{infile}.
1251
c7c55b78 1252@item -I @var{bfdname}
252b5132
RH
1253@itemx --input-target=@var{bfdname}
1254Consider the source file's object format to be @var{bfdname}, rather than
1255attempting to deduce it. @xref{Target Selection}, for more information.
1256
1257@item -O @var{bfdname}
1258@itemx --output-target=@var{bfdname}
1259Write the output file using the object format @var{bfdname}.
1260@xref{Target Selection}, for more information.
1261
1262@item -F @var{bfdname}
1263@itemx --target=@var{bfdname}
1264Use @var{bfdname} as the object format for both the input and the output
1265file; i.e., simply transfer data from source to destination with no
1266translation. @xref{Target Selection}, for more information.
1267
43a0748c
NC
1268@item -B @var{bfdarch}
1269@itemx --binary-architecture=@var{bfdarch}
8b31b6c4
NC
1270Useful when transforming a architecture-less input file into an object file.
1271In this case the output architecture can be set to @var{bfdarch}. This
1272option will be ignored if the input file has a known @var{bfdarch}. You
43a0748c
NC
1273can access this binary data inside a program by referencing the special
1274symbols that are created by the conversion process. These symbols are
1275called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1276_binary_@var{objfile}_size. e.g. you can transform a picture file into
c1c0eb9e 1277an object file and then access it in your code using these symbols.
43a0748c 1278
2e62b721
NC
1279@item -j @var{sectionpattern}
1280@itemx --only-section=@var{sectionpattern}
1281Copy only the indicated sections from the input file to the output file.
f91ea849 1282This option may be given more than once. Note that using this option
2e62b721
NC
1283inappropriately may make the output file unusable. Wildcard
1284characters are accepted in @var{sectionpattern}.
f91ea849 1285
e511c9b1
AB
1286If the first character of @var{sectionpattern} is the exclamation
1287point (!) then matching sections will not be copied, even if earlier
1288use of @option{--only-section} on the same command line would
1289otherwise copy it. For example:
1290
1291@smallexample
1292 --only-section=.text.* --only-section=!.text.foo
1293@end smallexample
1294
1295will copy all sectinos maching '.text.*' but not the section
1296'.text.foo'.
1297
2e62b721
NC
1298@item -R @var{sectionpattern}
1299@itemx --remove-section=@var{sectionpattern}
1300Remove any section matching @var{sectionpattern} from the output file.
1301This option may be given more than once. Note that using this option
1302inappropriately may make the output file unusable. Wildcard
1303characters are accepted in @var{sectionpattern}. Using both the
1304@option{-j} and @option{-R} options together results in undefined
1305behaviour.
252b5132 1306
e511c9b1
AB
1307If the first character of @var{sectionpattern} is the exclamation
1308point (!) then matching sections will not be removed even if an
1309earlier use of @option{--remove-section} on the same command line
1310would otherwise remove it. For example:
1311
1312@smallexample
1313 --remove-section=.text.* --remove-section=!.text.foo
1314@end smallexample
1315
1316will remove all sections matching the pattern '.text.*', but will not
1317remove the section '.text.foo'.
1318
d3e5f6c8
AB
1319@item --remove-relocations=@var{sectionpattern}
1320Remove relocations from the output file for any section matching
1321@var{sectionpattern}. This option may be given more than once. Note
1322that using this option inappropriately may make the output file
1323unusable. Wildcard characters are accepted in @var{sectionpattern}.
1324For example:
1325
1326@smallexample
1327 --remove-relocations=.text.*
1328@end smallexample
1329
1330will remove the relocations for all sections matching the patter
1331'.text.*'.
1332
1333If the first character of @var{sectionpattern} is the exclamation
1334point (!) then matching sections will not have their relocation
1335removed even if an earlier use of @option{--remove-relocations} on the
1336same command line would otherwise cause the relocations to be removed.
1337For example:
1338
1339@smallexample
1340 --remove-relocations=.text.* --remove-relocations=!.text.foo
1341@end smallexample
1342
1343will remove all relocations for sections matching the pattern
1344'.text.*', but will not remove relocations for the section
1345'.text.foo'.
1346
252b5132
RH
1347@item -S
1348@itemx --strip-all
1349Do not copy relocation and symbol information from the source file.
1350
1351@item -g
1352@itemx --strip-debug
2593f09a 1353Do not copy debugging symbols or sections from the source file.
252b5132
RH
1354
1355@item --strip-unneeded
1356Strip all symbols that are not needed for relocation processing.
1357
1358@item -K @var{symbolname}
1359@itemx --keep-symbol=@var{symbolname}
e7f918ad
NC
1360When stripping symbols, keep symbol @var{symbolname} even if it would
1361normally be stripped. This option may be given more than once.
252b5132
RH
1362
1363@item -N @var{symbolname}
1364@itemx --strip-symbol=@var{symbolname}
1365Do not copy symbol @var{symbolname} from the source file. This option
1366may be given more than once.
1367
bcf32829
JB
1368@item --strip-unneeded-symbol=@var{symbolname}
1369Do not copy symbol @var{symbolname} from the source file unless it is needed
1370by a relocation. This option may be given more than once.
1371
16b2b71c
NC
1372@item -G @var{symbolname}
1373@itemx --keep-global-symbol=@var{symbolname}
1374Keep only symbol @var{symbolname} global. Make all other symbols local
1375to the file, so that they are not visible externally. This option may
1376be given more than once.
1377
d58c2e3a
RS
1378@item --localize-hidden
1379In an ELF object, mark all symbols that have hidden or internal visibility
1380as local. This option applies on top of symbol-specific localization options
1381such as @option{-L}.
1382
252b5132
RH
1383@item -L @var{symbolname}
1384@itemx --localize-symbol=@var{symbolname}
f2629855
NC
1385Convert a global or weak symbol called @var{symbolname} into a local
1386symbol, so that it is not visible externally. This option may be
1387given more than once. Note - unique symbols are not converted.
252b5132
RH
1388
1389@item -W @var{symbolname}
1390@itemx --weaken-symbol=@var{symbolname}
1391Make symbol @var{symbolname} weak. This option may be given more than once.
1392
7b4a0685
NC
1393@item --globalize-symbol=@var{symbolname}
1394Give symbol @var{symbolname} global scoping so that it is visible
1395outside of the file in which it is defined. This option may be given
1396more than once.
1397
5fe11841
NC
1398@item -w
1399@itemx --wildcard
1400Permit regular expressions in @var{symbolname}s used in other command
1401line options. The question mark (?), asterisk (*), backslash (\) and
1402square brackets ([]) operators can be used anywhere in the symbol
1403name. If the first character of the symbol name is the exclamation
1404point (!) then the sense of the switch is reversed for that symbol.
1405For example:
1406
1407@smallexample
1408 -w -W !foo -W fo*
1409@end smallexample
1410
1411would cause objcopy to weaken all symbols that start with ``fo''
1412except for the symbol ``foo''.
1413
252b5132
RH
1414@item -x
1415@itemx --discard-all
1416Do not copy non-global symbols from the source file.
1417@c FIXME any reason to prefer "non-global" to "local" here?
1418
1419@item -X
1420@itemx --discard-locals
1421Do not copy compiler-generated local symbols.
1422(These usually start with @samp{L} or @samp{.}.)
1423
1424@item -b @var{byte}
1425@itemx --byte=@var{byte}
b7dd81f7
NC
1426If interleaving has been enabled via the @option{--interleave} option
1427then start the range of bytes to keep at the @var{byte}th byte.
1428@var{byte} can be in the range from 0 to @var{breadth}-1, where
1429@var{breadth} is the value given by the @option{--interleave} option.
1430
1431@item -i [@var{breadth}]
1432@itemx --interleave[=@var{breadth}]
1433Only copy a range out of every @var{breadth} bytes. (Header data is
1434not affected). Select which byte in the range begins the copy with
1435the @option{--byte} option. Select the width of the range with the
1436@option{--interleave-width} option.
1437
1438This option is useful for creating files to program @sc{rom}. It is
1439typically used with an @code{srec} output target. Note that
1440@command{objcopy} will complain if you do not specify the
1441@option{--byte} option as well.
1442
1443The default interleave breadth is 4, so with @option{--byte} set to 0,
1444@command{objcopy} would copy the first byte out of every four bytes
1445from the input to the output.
1446
1447@item --interleave-width=@var{width}
1448When used with the @option{--interleave} option, copy @var{width}
1449bytes at a time. The start of the range of bytes to be copied is set
1450by the @option{--byte} option, and the extent of the range is set with
1451the @option{--interleave} option.
1452
1453The default value for this option is 1. The value of @var{width} plus
1454the @var{byte} value set by the @option{--byte} option must not exceed
1455the interleave breadth set by the @option{--interleave} option.
1456
1457This option can be used to create images for two 16-bit flashes interleaved
1458in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1459and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1460commands. If the input was '12345678' then the outputs would be
1461'1256' and '3478' respectively.
252b5132
RH
1462
1463@item -p
1464@itemx --preserve-dates
1465Set the access and modification dates of the output file to be the same
1466as those of the input file.
1467
2e30cb57
CC
1468@item -D
1469@itemx --enable-deterministic-archives
955d0b3b
RM
1470@cindex deterministic archives
1471@kindex --enable-deterministic-archives
2e30cb57
CC
1472Operate in @emph{deterministic} mode. When copying archive members
1473and writing the archive index, use zero for UIDs, GIDs, timestamps,
1474and use consistent file modes for all files.
1475
955d0b3b
RM
1476If @file{binutils} was configured with
1477@option{--enable-deterministic-archives}, then this mode is on by default.
1478It can be disabled with the @samp{-U} option, below.
1479
1480@item -U
1481@itemx --disable-deterministic-archives
1482@cindex deterministic archives
1483@kindex --enable-deterministic-archives
1484Do @emph{not} operate in @emph{deterministic} mode. This is the
1485inverse of the @option{-D} option, above: when copying archive members
1486and writing the archive index, use their actual UID, GID, timestamp,
1487and file mode values.
1488
1489This is the default unless @file{binutils} was configured with
1490@option{--enable-deterministic-archives}.
1491
252b5132
RH
1492@item --debugging
1493Convert debugging information, if possible. This is not the default
1494because only certain debugging formats are supported, and the
1495conversion process can be time consuming.
1496
1497@item --gap-fill @var{val}
1498Fill gaps between sections with @var{val}. This operation applies to
1499the @emph{load address} (LMA) of the sections. It is done by increasing
1500the size of the section with the lower address, and filling in the extra
1501space created with @var{val}.
1502
1503@item --pad-to @var{address}
1504Pad the output file up to the load address @var{address}. This is
1505done by increasing the size of the last section. The extra space is
c7c55b78 1506filled in with the value specified by @option{--gap-fill} (default zero).
252b5132
RH
1507
1508@item --set-start @var{val}
f20a759a 1509Set the start address of the new file to @var{val}. Not all object file
252b5132
RH
1510formats support setting the start address.
1511
1512@item --change-start @var{incr}
1513@itemx --adjust-start @var{incr}
1514@cindex changing start address
1515Change the start address by adding @var{incr}. Not all object file
1516formats support setting the start address.
1517
1518@item --change-addresses @var{incr}
1519@itemx --adjust-vma @var{incr}
1520@cindex changing object addresses
1521Change the VMA and LMA addresses of all sections, as well as the start
1522address, by adding @var{incr}. Some object file formats do not permit
1523section addresses to be changed arbitrarily. Note that this does not
1524relocate the sections; if the program expects sections to be loaded at a
1525certain address, and this option is used to change the sections such
c1c0eb9e 1526that they are loaded at a different address, the program may fail.
252b5132 1527
2e62b721
NC
1528@item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1529@itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
252b5132 1530@cindex changing section address
2e62b721
NC
1531Set or change both the VMA address and the LMA address of any section
1532matching @var{sectionpattern}. If @samp{=} is used, the section
1533address is set to @var{val}. Otherwise, @var{val} is added to or
1534subtracted from the section address. See the comments under
1535@option{--change-addresses}, above. If @var{sectionpattern} does not
1536match any sections in the input file, a warning will be issued, unless
1537@option{--no-change-warnings} is used.
252b5132 1538
2e62b721 1539@item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
252b5132 1540@cindex changing section LMA
2e62b721
NC
1541Set or change the LMA address of any sections matching
1542@var{sectionpattern}. The LMA address is the address where the
1543section will be loaded into memory at program load time. Normally
1544this is the same as the VMA address, which is the address of the
1545section at program run time, but on some systems, especially those
1546where a program is held in ROM, the two can be different. If @samp{=}
1547is used, the section address is set to @var{val}. Otherwise,
1548@var{val} is added to or subtracted from the section address. See the
1549comments under @option{--change-addresses}, above. If
1550@var{sectionpattern} does not match any sections in the input file, a
1551warning will be issued, unless @option{--no-change-warnings} is used.
1552
1553@item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1554@cindex changing section VMA
1555Set or change the VMA address of any section matching
1556@var{sectionpattern}. The VMA address is the address where the
1557section will be located once the program has started executing.
1558Normally this is the same as the LMA address, which is the address
1559where the section will be loaded into memory, but on some systems,
252b5132
RH
1560especially those where a program is held in ROM, the two can be
1561different. If @samp{=} is used, the section address is set to
1562@var{val}. Otherwise, @var{val} is added to or subtracted from the
c7c55b78 1563section address. See the comments under @option{--change-addresses},
2e62b721
NC
1564above. If @var{sectionpattern} does not match any sections in the
1565input file, a warning will be issued, unless
c1c0eb9e 1566@option{--no-change-warnings} is used.
252b5132
RH
1567
1568@item --change-warnings
1569@itemx --adjust-warnings
c7c55b78 1570If @option{--change-section-address} or @option{--change-section-lma} or
2e62b721
NC
1571@option{--change-section-vma} is used, and the section pattern does not
1572match any sections, issue a warning. This is the default.
252b5132
RH
1573
1574@item --no-change-warnings
1575@itemx --no-adjust-warnings
c7c55b78
NC
1576Do not issue a warning if @option{--change-section-address} or
1577@option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
2e62b721
NC
1578if the section pattern does not match any sections.
1579
1580@item --set-section-flags @var{sectionpattern}=@var{flags}
1581Set the flags for any sections matching @var{sectionpattern}. The
1582@var{flags} argument is a comma separated string of flag names. The
1583recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1584@samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1585@samp{share}, and @samp{debug}. You can set the @samp{contents} flag
1586for a section which does not have contents, but it is not meaningful
1587to clear the @samp{contents} flag of a section which does have
1588contents--just remove the section instead. Not all flags are
1589meaningful for all object file formats.
252b5132
RH
1590
1591@item --add-section @var{sectionname}=@var{filename}
1592Add a new section named @var{sectionname} while copying the file. The
1593contents of the new section are taken from the file @var{filename}. The
1594size of the section will be the size of the file. This option only
1595works on file formats which can support sections with arbitrary names.
bbad633b
NC
1596Note - it may be necessary to use the @option{--set-section-flags}
1597option to set the attributes of the newly created section.
1598
1599@item --dump-section @var{sectionname}=@var{filename}
1600Place the contents of section named @var{sectionname} into the file
1601@var{filename}, overwriting any contents that may have been there
1602previously. This option is the inverse of @option{--add-section}.
1603This option is similar to the @option{--only-section} option except
1604that it does not create a formatted file, it just dumps the contents
1605as raw binary data, without applying any relocations. The option can
1606be specified more than once.
252b5132 1607
acf1419f
AB
1608@item --update-section @var{sectionname}=@var{filename}
1609Replace the existing contents of a section named @var{sectionname}
1610with the contents of file @var{filename}. The size of the section
1611will be adjusted to the size of the file. The section flags for
1612@var{sectionname} will be unchanged. For ELF format files the section
1613to segment mapping will also remain unchanged, something which is not
1614possible using @option{--remove-section} followed by
1615@option{--add-section}. The option can be specified more than once.
1616
1617Note - it is possible to use @option{--rename-section} and
1618@option{--update-section} to both update and rename a section from one
1619command line. In this case, pass the original section name to
1620@option{--update-section}, and the original and new section names to
1621@option{--rename-section}.
1622
2b35fb28
RH
1623@item --add-symbol @var{name}=[@var{section}:]@var{value}[,@var{flags}]
1624Add a new symbol named @var{name} while copying the file. This option may be
1625specified multiple times. If the @var{section} is given, the symbol will be
1626associated with and relative to that section, otherwise it will be an ABS
1627symbol. Specifying an undefined section will result in a fatal error. There
1628is no check for the value, it will be taken as specified. Symbol flags can
1629be specified and not all flags will be meaningful for all object file
1630formats. By default, the symbol will be global. The special flag
1631'before=@var{othersym}' will insert the new symbol in front of the specified
1632@var{othersym}, otherwise the symbol(s) will be added at the end of the
1633symbol table in the order they appear.
1634
594ef5db
NC
1635@item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1636Rename a section from @var{oldname} to @var{newname}, optionally
1637changing the section's flags to @var{flags} in the process. This has
1ea332d6 1638the advantage over using a linker script to perform the rename in that
594ef5db
NC
1639the output stays as an object file and does not become a linked
1640executable.
1641
1642This option is particularly helpful when the input format is binary,
1643since this will always create a section called .data. If for example,
1644you wanted instead to create a section called .rodata containing binary
1645data you could use the following command line to achieve it:
1646
1647@smallexample
1648 objcopy -I binary -O <output_format> -B <architecture> \
1649 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1650 <input_binary_file> <output_object_file>
1651@end smallexample
1652
0408dee6
DK
1653@item --long-section-names @{enable,disable,keep@}
1654Controls the handling of long section names when processing @code{COFF}
1655and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1656is to preserve long section names if any are present in the input file.
1657The @samp{enable} and @samp{disable} options forcibly enable or disable
1658the use of long section names in the output object; when @samp{disable}
1659is in effect, any long section names in the input object will be truncated.
1660The @samp{enable} option will only emit long section names if any are
1661present in the inputs; this is mostly the same as @samp{keep}, but it
b3364cb9 1662is left undefined whether the @samp{enable} option might force the
0408dee6
DK
1663creation of an empty string table in the output file.
1664
252b5132
RH
1665@item --change-leading-char
1666Some object file formats use special characters at the start of
1667symbols. The most common such character is underscore, which compilers
c7c55b78 1668often add before every symbol. This option tells @command{objcopy} to
252b5132
RH
1669change the leading character of every symbol when it converts between
1670object file formats. If the object file formats use the same leading
1671character, this option has no effect. Otherwise, it will add a
1672character, or remove a character, or change a character, as
1673appropriate.
1674
1675@item --remove-leading-char
1676If the first character of a global symbol is a special symbol leading
1677character used by the object file format, remove the character. The
1678most common symbol leading character is underscore. This option will
1679remove a leading underscore from all global symbols. This can be useful
1680if you want to link together objects of different file formats with
1681different conventions for symbol names. This is different from
c7c55b78 1682@option{--change-leading-char} because it always changes the symbol name
252b5132
RH
1683when appropriate, regardless of the object file format of the output
1684file.
1685
9e48b4c6
NC
1686@item --reverse-bytes=@var{num}
1687Reverse the bytes in a section with output contents. A section length must
1688be evenly divisible by the value given in order for the swap to be able to
1689take place. Reversing takes place before the interleaving is performed.
1690
1691This option is used typically in generating ROM images for problematic
1692target systems. For example, on some target boards, the 32-bit words
1693fetched from 8-bit ROMs are re-assembled in little-endian byte order
1694regardless of the CPU byte order. Depending on the programming model, the
1695endianness of the ROM may need to be modified.
1696
1697Consider a simple file with a section containing the following eight
1698bytes: @code{12345678}.
1699
1700Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1701output file would be ordered @code{21436587}.
1702
1703Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1704output file would be ordered @code{43218765}.
1705
1706By using @samp{--reverse-bytes=2} for the above example, followed by
1707@samp{--reverse-bytes=4} on the output file, the bytes in the second
1708output file would be ordered @code{34127856}.
1709
420496c1
NC
1710@item --srec-len=@var{ival}
1711Meaningful only for srec output. Set the maximum length of the Srecords
1712being produced to @var{ival}. This length covers both address, data and
1713crc fields.
1714
1715@item --srec-forceS3
c1c0eb9e 1716Meaningful only for srec output. Avoid generation of S1/S2 records,
420496c1
NC
1717creating S3-only record format.
1718
57938635
AM
1719@item --redefine-sym @var{old}=@var{new}
1720Change the name of a symbol @var{old}, to @var{new}. This can be useful
1721when one is trying link two things together for which you have no
1722source, and there are name collisions.
1723
92991082
JT
1724@item --redefine-syms=@var{filename}
1725Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1726listed in the file @var{filename}. @var{filename} is simply a flat file,
1727with one symbol pair per line. Line comments may be introduced by the hash
1728character. This option may be given more than once.
1729
252b5132
RH
1730@item --weaken
1731Change all global symbols in the file to be weak. This can be useful
1732when building an object which will be linked against other objects using
c7c55b78 1733the @option{-R} option to the linker. This option is only effective when
252b5132
RH
1734using an object file format which supports weak symbols.
1735
16b2b71c 1736@item --keep-symbols=@var{filename}
c7c55b78 1737Apply @option{--keep-symbol} option to each symbol listed in the file
16b2b71c
NC
1738@var{filename}. @var{filename} is simply a flat file, with one symbol
1739name per line. Line comments may be introduced by the hash character.
1740This option may be given more than once.
1741
1742@item --strip-symbols=@var{filename}
c7c55b78 1743Apply @option{--strip-symbol} option to each symbol listed in the file
16b2b71c
NC
1744@var{filename}. @var{filename} is simply a flat file, with one symbol
1745name per line. Line comments may be introduced by the hash character.
1746This option may be given more than once.
1747
bcf32829
JB
1748@item --strip-unneeded-symbols=@var{filename}
1749Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1750the file @var{filename}. @var{filename} is simply a flat file, with one
1751symbol name per line. Line comments may be introduced by the hash
1752character. This option may be given more than once.
1753
16b2b71c 1754@item --keep-global-symbols=@var{filename}
c7c55b78 1755Apply @option{--keep-global-symbol} option to each symbol listed in the
16b2b71c
NC
1756file @var{filename}. @var{filename} is simply a flat file, with one
1757symbol name per line. Line comments may be introduced by the hash
1758character. This option may be given more than once.
1759
1760@item --localize-symbols=@var{filename}
c7c55b78 1761Apply @option{--localize-symbol} option to each symbol listed in the file
16b2b71c
NC
1762@var{filename}. @var{filename} is simply a flat file, with one symbol
1763name per line. Line comments may be introduced by the hash character.
1764This option may be given more than once.
1765
7b4a0685
NC
1766@item --globalize-symbols=@var{filename}
1767Apply @option{--globalize-symbol} option to each symbol listed in the file
1768@var{filename}. @var{filename} is simply a flat file, with one symbol
1769name per line. Line comments may be introduced by the hash character.
1770This option may be given more than once.
1771
16b2b71c 1772@item --weaken-symbols=@var{filename}
c7c55b78 1773Apply @option{--weaken-symbol} option to each symbol listed in the file
16b2b71c
NC
1774@var{filename}. @var{filename} is simply a flat file, with one symbol
1775name per line. Line comments may be introduced by the hash character.
1776This option may be given more than once.
1777
1ae8b3d2
AO
1778@item --alt-machine-code=@var{index}
1779If the output architecture has alternate machine codes, use the
1780@var{index}th code instead of the default one. This is useful in case
c1c0eb9e 1781a machine is assigned an official code and the tool-chain adopts the
1ae8b3d2 1782new code, but other applications still depend on the original code
f9d4ad2a
NC
1783being used. For ELF based architectures if the @var{index}
1784alternative does not exist then the value is treated as an absolute
1785number to be stored in the e_machine field of the ELF header.
1ae8b3d2 1786
4087920c
MR
1787@item --writable-text
1788Mark the output text as writable. This option isn't meaningful for all
1789object file formats.
1790
1791@item --readonly-text
1792Make the output text write protected. This option isn't meaningful for all
1793object file formats.
1794
1795@item --pure
1796Mark the output file as demand paged. This option isn't meaningful for all
1797object file formats.
1798
1799@item --impure
1800Mark the output file as impure. This option isn't meaningful for all
1801object file formats.
1802
d7fb0dd2
NC
1803@item --prefix-symbols=@var{string}
1804Prefix all symbols in the output file with @var{string}.
1805
1806@item --prefix-sections=@var{string}
1807Prefix all section names in the output file with @var{string}.
1808
1809@item --prefix-alloc-sections=@var{string}
1810Prefix all the names of all allocated sections in the output file with
1811@var{string}.
1812
ed1653a7 1813@item --add-gnu-debuglink=@var{path-to-file}
4fd77a3d
NC
1814Creates a .gnu_debuglink section which contains a reference to
1815@var{path-to-file} and adds it to the output file. Note: the file at
1816@var{path-to-file} must exist. Part of the process of adding the
1817.gnu_debuglink section involves embedding a checksum of the contents
1818of the debug info file into the section.
1819
1820If the debug info file is built in one location but it is going to be
1821installed at a later time into a different location then do not use
1822the path to the installed location. The @option{--add-gnu-debuglink}
1823option will fail because the installed file does not exist yet.
1824Instead put the debug info file in the current directory and use the
1825@option{--add-gnu-debuglink} option without any directory components,
1826like this:
1827
1828@smallexample
1829 objcopy --add-gnu-debuglink=foo.debug
1830@end smallexample
1831
1832At debug time the debugger will attempt to look for the separate debug
1833info file in a set of known locations. The exact set of these
1834locations varies depending upon the distribution being used, but it
1835typically includes:
1836
1837@table @code
1838
1839@item * The same directory as the executable.
1840
1841@item * A sub-directory of the directory containing the executable
1842called .debug
1843
1844@item * A global debug directory such as /usr/lib/debug.
1845@end table
1846
1847As long as the debug info file has been installed into one of these
1848locations before the debugger is run everything should work
1849correctly.
ed1653a7 1850
1637cd90
JB
1851@item --keep-file-symbols
1852When stripping a file, perhaps with @option{--strip-debug} or
1853@option{--strip-unneeded}, retain any symbols specifying source file names,
1854which would otherwise get stripped.
1855
ed1653a7 1856@item --only-keep-debug
36d3b955
MR
1857Strip a file, removing contents of any sections that would not be
1858stripped by @option{--strip-debug} and leaving the debugging sections
c1c0eb9e 1859intact. In ELF files, this preserves all note sections in the output.
ed1653a7 1860
63b9bbb7
NC
1861Note - the section headers of the stripped sections are preserved,
1862including their sizes, but the contents of the section are discarded.
1863The section headers are preserved so that other tools can match up the
1864debuginfo file with the real executable, even if that executable has
1865been relocated to a different address space.
1866
ed1653a7
NC
1867The intention is that this option will be used in conjunction with
1868@option{--add-gnu-debuglink} to create a two part executable. One a
1869stripped binary which will occupy less space in RAM and in a
1870distribution and the second a debugging information file which is only
1871needed if debugging abilities are required. The suggested procedure
1872to create these files is as follows:
1873
b96fec5e
DK
1874@enumerate
1875@item Link the executable as normal. Assuming that is is called
1876@code{foo} then...
1877@item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1878create a file containing the debugging info.
1879@item Run @code{objcopy --strip-debug foo} to create a
1880stripped executable.
1881@item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1882to add a link to the debugging info into the stripped executable.
1883@end enumerate
1884
1885Note---the choice of @code{.dbg} as an extension for the debug info
1886file is arbitrary. Also the @code{--only-keep-debug} step is
1887optional. You could instead do this:
1888
1889@enumerate
1890@item Link the executable as normal.
1891@item Copy @code{foo} to @code{foo.full}
1892@item Run @code{objcopy --strip-debug foo}
1893@item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1894@end enumerate
1895
1896i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1897full executable. It does not have to be a file created by the
1898@option{--only-keep-debug} switch.
1899
1900Note---this switch is only intended for use on fully linked files. It
1901does not make sense to use it on object files where the debugging
1902information may be incomplete. Besides the gnu_debuglink feature
1903currently only supports the presence of one filename containing
1904debugging information, not multiple filenames on a one-per-object-file
1905basis.
1906
96109726
CC
1907@item --strip-dwo
1908Remove the contents of all DWARF .dwo sections, leaving the
1909remaining debugging sections and all symbols intact.
1910This option is intended for use by the compiler as part of
1911the @option{-gsplit-dwarf} option, which splits debug information
1912between the .o file and a separate .dwo file. The compiler
1913generates all debug information in the same file, then uses
1914the @option{--extract-dwo} option to copy the .dwo sections to
1915the .dwo file, then the @option{--strip-dwo} option to remove
1916those sections from the original .o file.
1917
1918@item --extract-dwo
1919Extract the contents of all DWARF .dwo sections. See the
1920@option{--strip-dwo} option for more information.
1921
92dd4511
L
1922@item --file-alignment @var{num}
1923Specify the file alignment. Sections in the file will always begin at
1924file offsets which are multiples of this number. This defaults to
1925512.
1926[This option is specific to PE targets.]
1927
1928@item --heap @var{reserve}
1929@itemx --heap @var{reserve},@var{commit}
1930Specify the number of bytes of memory to reserve (and optionally commit)
1931to be used as heap for this program.
1932[This option is specific to PE targets.]
1933
1934@item --image-base @var{value}
1935Use @var{value} as the base address of your program or dll. This is
1936the lowest memory location that will be used when your program or dll
1937is loaded. To reduce the need to relocate and improve performance of
1938your dlls, each should have a unique base address and not overlap any
1939other dlls. The default is 0x400000 for executables, and 0x10000000
1940for dlls.
1941[This option is specific to PE targets.]
1942
1943@item --section-alignment @var{num}
1944Sets the section alignment. Sections in memory will always begin at
1945addresses which are a multiple of this number. Defaults to 0x1000.
1946[This option is specific to PE targets.]
1947
1948@item --stack @var{reserve}
1949@itemx --stack @var{reserve},@var{commit}
1950Specify the number of bytes of memory to reserve (and optionally commit)
1951to be used as stack for this program.
1952[This option is specific to PE targets.]
1953
1954@item --subsystem @var{which}
1955@itemx --subsystem @var{which}:@var{major}
1956@itemx --subsystem @var{which}:@var{major}.@var{minor}
1957Specifies the subsystem under which your program will execute. The
1958legal values for @var{which} are @code{native}, @code{windows},
1959@code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
d9118602 1960@code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
92dd4511
L
1961the subsystem version also. Numeric values are also accepted for
1962@var{which}.
1963[This option is specific to PE targets.]
1964
d3e52d40
RS
1965@item --extract-symbol
1966Keep the file's section flags and symbols but remove all section data.
1967Specifically, the option:
1968
1969@itemize
d3e52d40
RS
1970@item removes the contents of all sections;
1971@item sets the size of every section to zero; and
1972@item sets the file's start address to zero.
1973@end itemize
c1c0eb9e 1974
d3e52d40
RS
1975This option is used to build a @file{.sym} file for a VxWorks kernel.
1976It can also be a useful way of reducing the size of a @option{--just-symbols}
1977linker input file.
1978
4a114e3e 1979@item --compress-debug-sections
19a7fe52
L
1980Compress DWARF debug sections using zlib with SHF_COMPRESSED from the
1981ELF ABI. Note - if compression would actually make a section
1982@emph{larger}, then it is not compressed.
4a114e3e 1983
151411f8
L
1984@item --compress-debug-sections=none
1985@itemx --compress-debug-sections=zlib
1986@itemx --compress-debug-sections=zlib-gnu
1987@itemx --compress-debug-sections=zlib-gabi
1988For ELF files, these options control how DWARF debug sections are
1989compressed. @option{--compress-debug-sections=none} is equivalent
96d491cf 1990to @option{--decompress-debug-sections}.
151411f8 1991@option{--compress-debug-sections=zlib} and
19a7fe52 1992@option{--compress-debug-sections=zlib-gabi} are equivalent to
151411f8 1993@option{--compress-debug-sections}.
19a7fe52
L
1994@option{--compress-debug-sections=zlib-gnu} compresses DWARF debug
1995sections using zlib. The debug sections are renamed to begin with
1996@samp{.zdebug} instead of @samp{.debug}. Note - if compression would
1997actually make a section @emph{larger}, then it is not compressed nor
1998renamed.
151411f8 1999
4a114e3e 2000@item --decompress-debug-sections
273a4985
JT
2001Decompress DWARF debug sections using zlib. The original section
2002names of the compressed sections are restored.
4a114e3e 2003
b8871f35
L
2004@item --elf-stt-common=yes
2005@itemx --elf-stt-common=no
2006For ELF files, these options control whether common symbols should be
2007converted to the @code{STT_COMMON} or @code{STT_OBJECT} type.
2008@option{--elf-stt-common=yes} converts common symbol type to
2009@code{STT_COMMON}. @option{--elf-stt-common=no} converts common symbol
2010type to @code{STT_OBJECT}.
2011
9ef920e9 2012@item --merge-notes
1d15e434
NC
2013@itemx --no-merge-notes
2014For ELF files, attempt (or do not attempt) to reduce the size of any
2015SHT_NOTE type sections by removing duplicate notes.
9ef920e9 2016
252b5132
RH
2017@item -V
2018@itemx --version
c7c55b78 2019Show the version number of @command{objcopy}.
252b5132
RH
2020
2021@item -v
2022@itemx --verbose
2023Verbose output: list all object files modified. In the case of
2024archives, @samp{objcopy -V} lists all members of the archive.
2025
2026@item --help
c7c55b78 2027Show a summary of the options to @command{objcopy}.
7c29036b
NC
2028
2029@item --info
2030Display a list showing all architectures and object formats available.
252b5132
RH
2031@end table
2032
0285c67d
NC
2033@c man end
2034
2035@ignore
2036@c man begin SEEALSO objcopy
2037ld(1), objdump(1), and the Info entries for @file{binutils}.
2038@c man end
2039@end ignore
2040
252b5132
RH
2041@node objdump
2042@chapter objdump
2043
2044@cindex object file information
2045@kindex objdump
2046
0285c67d
NC
2047@c man title objdump display information from object files.
2048
252b5132 2049@smallexample
0285c67d 2050@c man begin SYNOPSIS objdump
c7c55b78
NC
2051objdump [@option{-a}|@option{--archive-headers}]
2052 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
2053 [@option{-C}|@option{--demangle}[=@var{style}] ]
2054 [@option{-d}|@option{--disassemble}]
2055 [@option{-D}|@option{--disassemble-all}]
2056 [@option{-z}|@option{--disassemble-zeroes}]
2057 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
2058 [@option{-f}|@option{--file-headers}]
98ec6e72 2059 [@option{-F}|@option{--file-offsets}]
c7c55b78
NC
2060 [@option{--file-start-context}]
2061 [@option{-g}|@option{--debugging}]
51cdc6e0 2062 [@option{-e}|@option{--debugging-tags}]
c7c55b78
NC
2063 [@option{-h}|@option{--section-headers}|@option{--headers}]
2064 [@option{-i}|@option{--info}]
2065 [@option{-j} @var{section}|@option{--section=}@var{section}]
2066 [@option{-l}|@option{--line-numbers}]
2067 [@option{-S}|@option{--source}]
2068 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
2069 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
2070 [@option{-p}|@option{--private-headers}]
6abcee90 2071 [@option{-P} @var{options}|@option{--private=}@var{options}]
c7c55b78
NC
2072 [@option{-r}|@option{--reloc}]
2073 [@option{-R}|@option{--dynamic-reloc}]
2074 [@option{-s}|@option{--full-contents}]
dda8d76d
NC
2075 [@option{-W[lLiaprmfFsoRtUuTgAckK]}|
2076 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
c7c55b78
NC
2077 [@option{-G}|@option{--stabs}]
2078 [@option{-t}|@option{--syms}]
2079 [@option{-T}|@option{--dynamic-syms}]
2080 [@option{-x}|@option{--all-headers}]
2081 [@option{-w}|@option{--wide}]
2082 [@option{--start-address=}@var{address}]
2083 [@option{--stop-address=}@var{address}]
2084 [@option{--prefix-addresses}]
2085 [@option{--[no-]show-raw-insn}]
2086 [@option{--adjust-vma=}@var{offset}]
b2a40aa5
TG
2087 [@option{--dwarf-depth=@var{n}}]
2088 [@option{--dwarf-start=@var{n}}]
3c9458e9 2089 [@option{--special-syms}]
0dafdf3f
L
2090 [@option{--prefix=}@var{prefix}]
2091 [@option{--prefix-strip=}@var{level}]
3dcb3fcb 2092 [@option{--insn-width=}@var{width}]
c7c55b78
NC
2093 [@option{-V}|@option{--version}]
2094 [@option{-H}|@option{--help}]
252b5132 2095 @var{objfile}@dots{}
0285c67d 2096@c man end
252b5132
RH
2097@end smallexample
2098
0285c67d
NC
2099@c man begin DESCRIPTION objdump
2100
c7c55b78 2101@command{objdump} displays information about one or more object files.
252b5132
RH
2102The options control what particular information to display. This
2103information is mostly useful to programmers who are working on the
2104compilation tools, as opposed to programmers who just want their
2105program to compile and work.
2106
2107@var{objfile}@dots{} are the object files to be examined. When you
c7c55b78 2108specify archives, @command{objdump} shows information on each of the member
252b5132
RH
2109object files.
2110
0285c67d
NC
2111@c man end
2112
2113@c man begin OPTIONS objdump
2114
252b5132 2115The long and short forms of options, shown here as alternatives, are
1dada9c5 2116equivalent. At least one option from the list
6abcee90 2117@option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
252b5132 2118
c7c55b78 2119@table @env
252b5132
RH
2120@item -a
2121@itemx --archive-header
2122@cindex archive headers
2123If any of the @var{objfile} files are archives, display the archive
2124header information (in a format similar to @samp{ls -l}). Besides the
2125information you could list with @samp{ar tv}, @samp{objdump -a} shows
2126the object file format of each archive member.
2127
2128@item --adjust-vma=@var{offset}
2129@cindex section addresses in objdump
2130@cindex VMA in objdump
2131When dumping information, first add @var{offset} to all the section
2132addresses. This is useful if the section addresses do not correspond to
2133the symbol table, which can happen when putting sections at particular
2134addresses when using a format which can not represent section addresses,
2135such as a.out.
2136
2137@item -b @var{bfdname}
2138@itemx --target=@var{bfdname}
2139@cindex object code format
2140Specify that the object-code format for the object files is
2141@var{bfdname}. This option may not be necessary; @var{objdump} can
2142automatically recognize many formats.
2143
2144For example,
2145@example
2146objdump -b oasys -m vax -h fu.o
2147@end example
2148@noindent
c7c55b78
NC
2149displays summary information from the section headers (@option{-h}) of
2150@file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
252b5132 2151file in the format produced by Oasys compilers. You can list the
c7c55b78 2152formats available with the @option{-i} option.
252b5132
RH
2153@xref{Target Selection}, for more information.
2154
2155@item -C
28c309a2 2156@itemx --demangle[=@var{style}]
252b5132
RH
2157@cindex demangling in objdump
2158Decode (@dfn{demangle}) low-level symbol names into user-level names.
2159Besides removing any initial underscore prepended by the system, this
28c309a2 2160makes C++ function names readable. Different compilers have different
c1c0eb9e
RM
2161mangling styles. The optional demangling style argument can be used to
2162choose an appropriate demangling style for your compiler. @xref{c++filt},
28c309a2 2163for more information on demangling.
252b5132 2164
947ed062
NC
2165@item -g
2166@itemx --debugging
b922d590
NC
2167Display debugging information. This attempts to parse STABS and IEEE
2168debugging format information stored in the file and print it out using
2169a C like syntax. If neither of these formats are found this option
2170falls back on the @option{-W} option to print any DWARF information in
2171the file.
252b5132 2172
51cdc6e0
NC
2173@item -e
2174@itemx --debugging-tags
2175Like @option{-g}, but the information is generated in a format compatible
2176with ctags tool.
2177
252b5132
RH
2178@item -d
2179@itemx --disassemble
2180@cindex disassembling object code
2181@cindex machine instructions
2182Display the assembler mnemonics for the machine instructions from
2183@var{objfile}. This option only disassembles those sections which are
2184expected to contain instructions.
2185
2186@item -D
2187@itemx --disassemble-all
c7c55b78 2188Like @option{-d}, but disassemble the contents of all sections, not just
252b5132
RH
2189those expected to contain instructions.
2190
bdc4de1b
NC
2191This option also has a subtle effect on the disassembly of
2192instructions in code sections. When option @option{-d} is in effect
2193objdump will assume that any symbols present in a code section occur
2194on the boundary between instructions and it will refuse to disassemble
2195across such a boundary. When option @option{-D} is in effect however
2196this assumption is supressed. This means that it is possible for the
2197output of @option{-d} and @option{-D} to differ if, for example, data
2198is stored in code sections.
2199
0313a2b8
NC
2200If the target is an ARM architecture this switch also has the effect
2201of forcing the disassembler to decode pieces of data found in code
2202sections as if they were instructions.
2203
252b5132
RH
2204@item --prefix-addresses
2205When disassembling, print the complete address on each line. This is
2206the older disassembly format.
2207
252b5132
RH
2208@item -EB
2209@itemx -EL
2210@itemx --endian=@{big|little@}
2211@cindex endianness
2212@cindex disassembly endianness
2213Specify the endianness of the object files. This only affects
2214disassembly. This can be useful when disassembling a file format which
2215does not describe endianness information, such as S-records.
2216
2217@item -f
947ed062 2218@itemx --file-headers
252b5132
RH
2219@cindex object file header
2220Display summary information from the overall header of
2221each of the @var{objfile} files.
2222
98ec6e72
NC
2223@item -F
2224@itemx --file-offsets
2225@cindex object file offsets
2226When disassembling sections, whenever a symbol is displayed, also
2227display the file offset of the region of data that is about to be
2228dumped. If zeroes are being skipped, then when disassembly resumes,
2229tell the user how many zeroes were skipped and the file offset of the
32760852
NC
2230location from where the disassembly resumes. When dumping sections,
2231display the file offset of the location from where the dump starts.
98ec6e72 2232
f1563258
TW
2233@item --file-start-context
2234@cindex source code context
2235Specify that when displaying interlisted source code/disassembly
c7c55b78 2236(assumes @option{-S}) from a file that has not yet been displayed, extend the
f1563258
TW
2237context to the start of the file.
2238
252b5132 2239@item -h
947ed062
NC
2240@itemx --section-headers
2241@itemx --headers
252b5132
RH
2242@cindex section headers
2243Display summary information from the section headers of the
2244object file.
2245
2246File segments may be relocated to nonstandard addresses, for example by
c7c55b78
NC
2247using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2248@command{ld}. However, some object file formats, such as a.out, do not
252b5132 2249store the starting address of the file segments. In those situations,
c7c55b78 2250although @command{ld} relocates the sections correctly, using @samp{objdump
252b5132
RH
2251-h} to list the file section headers cannot show the correct addresses.
2252Instead, it shows the usual addresses, which are implicit for the
2253target.
2254
91f68a68
MG
2255Note, in some cases it is possible for a section to have both the
2256READONLY and the NOREAD attributes set. In such cases the NOREAD
2257attribute takes precedence, but @command{objdump} will report both
2258since the exact setting of the flag bits might be important.
2259
947ed062
NC
2260@item -H
2261@itemx --help
c7c55b78 2262Print a summary of the options to @command{objdump} and exit.
252b5132
RH
2263
2264@item -i
2265@itemx --info
2266@cindex architectures available
2267@cindex object formats available
2268Display a list showing all architectures and object formats available
c7c55b78 2269for specification with @option{-b} or @option{-m}.
252b5132
RH
2270
2271@item -j @var{name}
2272@itemx --section=@var{name}
2273@cindex section information
2274Display information only for section @var{name}.
2275
2276@item -l
2277@itemx --line-numbers
2278@cindex source filenames for object files
2279Label the display (using debugging information) with the filename and
2280source line numbers corresponding to the object code or relocs shown.
c7c55b78 2281Only useful with @option{-d}, @option{-D}, or @option{-r}.
252b5132
RH
2282
2283@item -m @var{machine}
2284@itemx --architecture=@var{machine}
2285@cindex architecture
2286@cindex disassembly architecture
2287Specify the architecture to use when disassembling object files. This
2288can be useful when disassembling object files which do not describe
2289architecture information, such as S-records. You can list the available
c7c55b78 2290architectures with the @option{-i} option.
252b5132 2291
0313a2b8
NC
2292If the target is an ARM architecture then this switch has an
2293additional effect. It restricts the disassembly to only those
2294instructions supported by the architecture specified by @var{machine}.
2295If it is necessary to use this switch because the input file does not
2296contain any architecture information, but it is also desired to
2297disassemble all the instructions use @option{-marm}.
2298
dd92f639
NC
2299@item -M @var{options}
2300@itemx --disassembler-options=@var{options}
2301Pass target specific information to the disassembler. Only supported on
31e0f3cd
NC
2302some targets. If it is necessary to specify more than one
2303disassembler option then multiple @option{-M} options can be used or
2304can be placed together into a comma separated list.
dd92f639 2305
7982a1dd
NC
2306For ARC, @option{dsp} controls the printing of DSP instructions,
2307@option{spfp} selects the printing of FPX single precision FP
2308instructions, @option{dpfp} selects the printing of FPX double
2309precision FP instructions, @option{quarkse_em} selects the printing of
2310special QuarkSE-EM instructions, @option{fpuda} selects the printing
2311of double precision assist instructions, @option{fpus} selects the
2312printing of FPU single precision FP instructions, while @option{fpud}
2313selects the printing of FPU souble precision FP instructions.
fdddd290 2314Additionally, one can choose to have all the immediates printed in
2315hexadecimal using @option{hex}. By default, the short immediates are
2316printed using the decimal representation, while the long immediate
2317values are printed as hexadecimal.
37fd5ef3 2318
10045478
AK
2319@option{cpu=...} allows to enforce a particular ISA when disassembling
2320instructions, overriding the @option{-m} value or whatever is in the ELF file.
2321This might be useful to select ARC EM or HS ISA, because architecture is same
2322for those and disassembler relies on private ELF header data to decide if code
2323is for EM or HS. This option might be specified multiple times - only the
2324latest value will be used. Valid values are same as for the assembler
2325@option{-mcpu=...} option.
2326
dd92f639
NC
2327If the target is an ARM architecture then this switch can be used to
2328select which register name set is used during disassembler. Specifying
9c092ace 2329@option{-M reg-names-std} (the default) will select the register names as
58efb6c0
NC
2330used in ARM's instruction set documentation, but with register 13 called
2331'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
c7c55b78
NC
2332@option{-M reg-names-apcs} will select the name set used by the ARM
2333Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
58efb6c0
NC
2334just use @samp{r} followed by the register number.
2335
2336There are also two variants on the APCS register naming scheme enabled
c7c55b78
NC
2337by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2338use the ARM/Thumb Procedure Call Standard naming conventions. (Either
947ed062 2339with the normal register names or the special register names).
dd92f639 2340
8f915f68 2341This option can also be used for ARM architectures to force the
c36774d6 2342disassembler to interpret all instructions as Thumb instructions by
c7c55b78 2343using the switch @option{--disassembler-options=force-thumb}. This can be
8f915f68
NC
2344useful when attempting to disassemble thumb code produced by other
2345compilers.
2346
e396998b
AM
2347For the x86, some of the options duplicate functions of the @option{-m}
2348switch, but allow finer grained control. Multiple selections from the
2349following may be specified as a comma separated string.
c4416f30
NC
2350@table @code
2351@item x86-64
2352@itemx i386
2353@itemx i8086
2354Select disassembly for the given architecture.
2355
2356@item intel
2357@itemx att
2358Select between intel syntax mode and AT&T syntax mode.
2359
5db04b09
L
2360@item amd64
2361@itemx intel64
2362Select between AMD64 ISA and Intel64 ISA.
2363
c4416f30
NC
2364@item intel-mnemonic
2365@itemx att-mnemonic
2366Select between intel mnemonic mode and AT&T mnemonic mode.
2367Note: @code{intel-mnemonic} implies @code{intel} and
2368@code{att-mnemonic} implies @code{att}.
2369
2370@item addr64
2371@itemx addr32
2372@itemx addr16
2373@itemx data32
2374@itemx data16
2375Specify the default address size and operand size. These four options
2376will be overridden if @code{x86-64}, @code{i386} or @code{i8086}
2377appear later in the option string.
2378
2379@item suffix
2380When in AT&T mode, instructs the disassembler to print a mnemonic
2381suffix even when the suffix could be inferred by the operands.
2382@end table
e396998b 2383
52be03fd
AM
2384For PowerPC, the @option{-M} argument @option{raw} selects
2385disasssembly of hardware insns rather than aliases. For example, you
2386will see @code{rlwinm} rather than @code{clrlwi}, and @code{addi}
2387rather than @code{li}. All of the @option{-m} arguments for
2388@command{gas} that select a CPU are supported. These are:
2389@option{403}, @option{405}, @option{440}, @option{464}, @option{476},
2390@option{601}, @option{603}, @option{604}, @option{620}, @option{7400},
2391@option{7410}, @option{7450}, @option{7455}, @option{750cl},
2392@option{821}, @option{850}, @option{860}, @option{a2}, @option{booke},
2393@option{booke32}, @option{cell}, @option{com}, @option{e200z4},
2394@option{e300}, @option{e500}, @option{e500mc}, @option{e500mc64},
2395@option{e500x2}, @option{e5500}, @option{e6500}, @option{efs},
2396@option{power4}, @option{power5}, @option{power6}, @option{power7},
2397@option{power8}, @option{power9}, @option{ppc}, @option{ppc32},
2398@option{ppc64}, @option{ppc64bridge}, @option{ppcps}, @option{pwr},
2399@option{pwr2}, @option{pwr4}, @option{pwr5}, @option{pwr5x},
2400@option{pwr6}, @option{pwr7}, @option{pwr8}, @option{pwr9},
2401@option{pwrx}, @option{titan}, and @option{vle}.
2402@option{32} and @option{64} modify the default or a prior CPU
2403selection, disabling and enabling 64-bit insns respectively. In
2404addition, @option{altivec}, @option{any}, @option{htm}, @option{vsx},
2405and @option{spe} add capabilities to a previous @emph{or later} CPU
2406selection. @option{any} will disassemble any opcode known to
2407binutils, but in cases where an opcode has two different meanings or
2408different arguments, you may not see the disassembly you expect.
2409If you disassemble without giving a CPU selection, a default will be
2410chosen from information gleaned by BFD from the object files headers,
2411but the result again may not be as you expect.
802a735e 2412
b45619c0 2413For MIPS, this option controls the printing of instruction mnemonic
e39893d7
FF
2414names and register names in disassembled instructions. Multiple
2415selections from the following may be specified as a comma separated
2416string, and invalid options are ignored:
640c0ccd
CD
2417
2418@table @code
e39893d7 2419@item no-aliases
b45619c0
NC
2420Print the 'raw' instruction mnemonic instead of some pseudo
2421instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
e39893d7
FF
2422'sll' instead of 'nop', etc.
2423
a9f58168
CF
2424@item msa
2425Disassemble MSA instructions.
2426
b015e599
AP
2427@item virt
2428Disassemble the virtualization ASE instructions.
2429
7d64c587
AB
2430@item xpa
2431Disassemble the eXtended Physical Address (XPA) ASE instructions.
2432
640c0ccd
CD
2433@item gpr-names=@var{ABI}
2434Print GPR (general-purpose register) names as appropriate
2435for the specified ABI. By default, GPR names are selected according to
2436the ABI of the binary being disassembled.
2437
2438@item fpr-names=@var{ABI}
2439Print FPR (floating-point register) names as
2440appropriate for the specified ABI. By default, FPR numbers are printed
2441rather than names.
2442
2443@item cp0-names=@var{ARCH}
2444Print CP0 (system control coprocessor; coprocessor 0) register names
2445as appropriate for the CPU or architecture specified by
2446@var{ARCH}. By default, CP0 register names are selected according to
2447the architecture and CPU of the binary being disassembled.
2448
af7ee8bf
CD
2449@item hwr-names=@var{ARCH}
2450Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2451as appropriate for the CPU or architecture specified by
2452@var{ARCH}. By default, HWR names are selected according to
2453the architecture and CPU of the binary being disassembled.
2454
640c0ccd
CD
2455@item reg-names=@var{ABI}
2456Print GPR and FPR names as appropriate for the selected ABI.
2457
2458@item reg-names=@var{ARCH}
af7ee8bf
CD
2459Print CPU-specific register names (CP0 register and HWR names)
2460as appropriate for the selected CPU or architecture.
640c0ccd
CD
2461@end table
2462
2463For any of the options listed above, @var{ABI} or
2464@var{ARCH} may be specified as @samp{numeric} to have numbers printed
2465rather than names, for the selected types of registers.
2466You can list the available values of @var{ABI} and @var{ARCH} using
2467the @option{--help} option.
2468
ec72cfe5
NC
2469For VAX, you can specify function entry addresses with @option{-M
2470entry:0xf00ba}. You can use this multiple times to properly
2471disassemble VAX binary files that don't contain symbol tables (like
2472ROM dumps). In these cases, the function entry mask would otherwise
b45619c0 2473be decoded as VAX instructions, which would probably lead the rest
ec72cfe5
NC
2474of the function being wrongly disassembled.
2475
252b5132
RH
2476@item -p
2477@itemx --private-headers
2478Print information that is specific to the object file format. The exact
2479information printed depends upon the object file format. For some
2480object file formats, no additional information is printed.
2481
6abcee90
TG
2482@item -P @var{options}
2483@itemx --private=@var{options}
2484Print information that is specific to the object file format. The
2485argument @var{options} is a comma separated list that depends on the
2486format (the lists of options is displayed with the help).
2487
c4416f30
NC
2488For XCOFF, the available options are:
2489@table @code
2490@item header
2491@item aout
2492@item sections
2493@item syms
2494@item relocs
2495@item lineno,
2496@item loader
2497@item except
2498@item typchk
2499@item traceback
2500@item toc
2501@item ldinfo
2502@end table
2503
2504Not all object formats support this option. In particular the ELF
2505format does not use it.
6abcee90 2506
252b5132
RH
2507@item -r
2508@itemx --reloc
2509@cindex relocation entries, in object file
c7c55b78
NC
2510Print the relocation entries of the file. If used with @option{-d} or
2511@option{-D}, the relocations are printed interspersed with the
252b5132
RH
2512disassembly.
2513
2514@item -R
2515@itemx --dynamic-reloc
2516@cindex dynamic relocation entries, in object file
2517Print the dynamic relocation entries of the file. This is only
2518meaningful for dynamic objects, such as certain types of shared
840b96a7
AM
2519libraries. As for @option{-r}, if used with @option{-d} or
2520@option{-D}, the relocations are printed interspersed with the
2521disassembly.
252b5132
RH
2522
2523@item -s
2524@itemx --full-contents
2525@cindex sections, full contents
2526@cindex object file sections
155e0d23
NC
2527Display the full contents of any sections requested. By default all
2528non-empty sections are displayed.
252b5132
RH
2529
2530@item -S
2531@itemx --source
2532@cindex source disassembly
2533@cindex disassembly, with source
2534Display source code intermixed with disassembly, if possible. Implies
c7c55b78 2535@option{-d}.
252b5132 2536
0dafdf3f
L
2537@item --prefix=@var{prefix}
2538@cindex Add prefix to absolute paths
2539Specify @var{prefix} to add to the absolute paths when used with
b3364cb9 2540@option{-S}.
0dafdf3f
L
2541
2542@item --prefix-strip=@var{level}
2543@cindex Strip absolute paths
2544Indicate how many initial directory names to strip off the hardwired
2545absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2546
252b5132
RH
2547@item --show-raw-insn
2548When disassembling instructions, print the instruction in hex as well as
2549in symbolic form. This is the default except when
c7c55b78 2550@option{--prefix-addresses} is used.
252b5132
RH
2551
2552@item --no-show-raw-insn
2553When disassembling instructions, do not print the instruction bytes.
c7c55b78 2554This is the default when @option{--prefix-addresses} is used.
252b5132 2555
3dcb3fcb 2556@item --insn-width=@var{width}
b3364cb9 2557@cindex Instruction width
3dcb3fcb
L
2558Display @var{width} bytes on a single line when disassembling
2559instructions.
2560
dda8d76d
NC
2561@item -W[lLiaprmfFsoRtUuTgAckK]
2562@itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
2563@include debug.options.texi
fd2f0033 2564
4723351a
CC
2565@item --dwarf-check
2566Enable additional checks for consistency of Dwarf information.
2567
1dada9c5 2568@item -G
947ed062 2569@itemx --stabs
252b5132
RH
2570@cindex stab
2571@cindex .stab
2572@cindex debug symbols
2573@cindex ELF object file format
2574Display the full contents of any sections requested. Display the
2575contents of the .stab and .stab.index and .stab.excl sections from an
2576ELF file. This is only useful on systems (such as Solaris 2.0) in which
2577@code{.stab} debugging symbol-table entries are carried in an ELF
2578section. In most other file formats, debugging symbol-table entries are
c7c55b78 2579interleaved with linkage symbols, and are visible in the @option{--syms}
0285c67d 2580output.
252b5132
RH
2581
2582@item --start-address=@var{address}
2583@cindex start-address
2584Start displaying data at the specified address. This affects the output
c7c55b78 2585of the @option{-d}, @option{-r} and @option{-s} options.
252b5132
RH
2586
2587@item --stop-address=@var{address}
2588@cindex stop-address
2589Stop displaying data at the specified address. This affects the output
c7c55b78 2590of the @option{-d}, @option{-r} and @option{-s} options.
252b5132
RH
2591
2592@item -t
2593@itemx --syms
2594@cindex symbol table entries, printing
2595Print the symbol table entries of the file.
a1039809
NC
2596This is similar to the information provided by the @samp{nm} program,
2597although the display format is different. The format of the output
2598depends upon the format of the file being dumped, but there are two main
2599types. One looks like this:
2600
2601@smallexample
2602[ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2603[ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2604@end smallexample
2605
2606where the number inside the square brackets is the number of the entry
2607in the symbol table, the @var{sec} number is the section number, the
2608@var{fl} value are the symbol's flag bits, the @var{ty} number is the
2609symbol's type, the @var{scl} number is the symbol's storage class and
2610the @var{nx} value is the number of auxilary entries associated with
2611the symbol. The last two fields are the symbol's value and its name.
2612
2613The other common output format, usually seen with ELF based files,
2614looks like this:
2615
2616@smallexample
261700000000 l d .bss 00000000 .bss
261800000000 g .text 00000000 fred
2619@end smallexample
2620
2621Here the first number is the symbol's value (sometimes refered to as
2622its address). The next field is actually a set of characters and
2623spaces indicating the flag bits that are set on the symbol. These
af3e16d9
NC
2624characters are described below. Next is the section with which the
2625symbol is associated or @emph{*ABS*} if the section is absolute (ie
2626not connected with any section), or @emph{*UND*} if the section is
2627referenced in the file being dumped, but not defined there.
2628
2629After the section name comes another field, a number, which for common
2630symbols is the alignment and for other symbol is the size. Finally
2631the symbol's name is displayed.
a1039809
NC
2632
2633The flag characters are divided into 7 groups as follows:
2634@table @code
2635@item l
2636@itemx g
3e7a7d11 2637@itemx u
a1039809 2638@itemx !
3e7a7d11
NC
2639The symbol is a local (l), global (g), unique global (u), neither
2640global nor local (a space) or both global and local (!). A
928a4139 2641symbol can be neither local or global for a variety of reasons, e.g.,
a1039809 2642because it is used for debugging, but it is probably an indication of
3e7a7d11
NC
2643a bug if it is ever both local and global. Unique global symbols are
2644a GNU extension to the standard set of ELF symbol bindings. For such
2645a symbol the dynamic linker will make sure that in the entire process
2646there is just one symbol with this name and type in use.
a1039809
NC
2647
2648@item w
2649The symbol is weak (w) or strong (a space).
2650
2651@item C
2652The symbol denotes a constructor (C) or an ordinary symbol (a space).
2653
2654@item W
2655The symbol is a warning (W) or a normal symbol (a space). A warning
2656symbol's name is a message to be displayed if the symbol following the
2657warning symbol is ever referenced.
2658
2659@item I
171191ba
NC
2660@item i
2661The symbol is an indirect reference to another symbol (I), a function
2662to be evaluated during reloc processing (i) or a normal symbol (a
2663space).
a1039809
NC
2664
2665@item d
2666@itemx D
2667The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2668normal symbol (a space).
2669
2670@item F
2671@item f
2672@item O
af3e16d9 2673The symbol is the name of a function (F) or a file (f) or an object
a1039809
NC
2674(O) or just a normal symbol (a space).
2675@end table
252b5132
RH
2676
2677@item -T
2678@itemx --dynamic-syms
2679@cindex dynamic symbol table entries, printing
2680Print the dynamic symbol table entries of the file. This is only
2681meaningful for dynamic objects, such as certain types of shared
2682libraries. This is similar to the information provided by the @samp{nm}
c7c55b78 2683program when given the @option{-D} (@option{--dynamic}) option.
252b5132 2684
df2c87b5
NC
2685The output format is similar to that produced by the @option{--syms}
2686option, except that an extra field is inserted before the symbol's
2687name, giving the version information associated with the symbol.
2f7d9953
NC
2688If the version is the default version to be used when resolving
2689unversioned references to the symbol then it's displayed as is,
2690otherwise it's put into parentheses.
df2c87b5 2691
3c9458e9
NC
2692@item --special-syms
2693When displaying symbols include those which the target considers to be
2694special in some way and which would not normally be of interest to the
2695user.
2696
947ed062
NC
2697@item -V
2698@itemx --version
c7c55b78 2699Print the version number of @command{objdump} and exit.
252b5132
RH
2700
2701@item -x
947ed062 2702@itemx --all-headers
252b5132
RH
2703@cindex all header information, object file
2704@cindex header information, all
2705Display all available header information, including the symbol table and
c7c55b78 2706relocation entries. Using @option{-x} is equivalent to specifying all of
04c34128 2707@option{-a -f -h -p -r -t}.
252b5132
RH
2708
2709@item -w
2710@itemx --wide
2711@cindex wide output, printing
2712Format some lines for output devices that have more than 80 columns.
31104126 2713Also do not truncate symbol names when they are displayed.
aefbdd67
BE
2714
2715@item -z
2c0c15f9 2716@itemx --disassemble-zeroes
aefbdd67
BE
2717Normally the disassembly output will skip blocks of zeroes. This
2718option directs the disassembler to disassemble those blocks, just like
2719any other data.
252b5132
RH
2720@end table
2721
0285c67d
NC
2722@c man end
2723
2724@ignore
2725@c man begin SEEALSO objdump
2726nm(1), readelf(1), and the Info entries for @file{binutils}.
2727@c man end
2728@end ignore
2729
252b5132
RH
2730@node ranlib
2731@chapter ranlib
2732
2733@kindex ranlib
2734@cindex archive contents
2735@cindex symbol index
2736
0285c67d
NC
2737@c man title ranlib generate index to archive.
2738
252b5132 2739@smallexample
0285c67d 2740@c man begin SYNOPSIS ranlib
36e32b27 2741ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
0285c67d 2742@c man end
252b5132
RH
2743@end smallexample
2744
0285c67d
NC
2745@c man begin DESCRIPTION ranlib
2746
c7c55b78 2747@command{ranlib} generates an index to the contents of an archive and
252b5132 2748stores it in the archive. The index lists each symbol defined by a
c1c0eb9e 2749member of an archive that is a relocatable object file.
252b5132
RH
2750
2751You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2752
2753An archive with such an index speeds up linking to the library and
2754allows routines in the library to call each other without regard to
2755their placement in the archive.
2756
c7c55b78
NC
2757The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2758@command{ranlib} is completely equivalent to executing @samp{ar -s}.
252b5132
RH
2759@xref{ar}.
2760
0285c67d
NC
2761@c man end
2762
2763@c man begin OPTIONS ranlib
2764
c7c55b78 2765@table @env
b3364cb9
RM
2766@item -h
2767@itemx -H
2768@itemx --help
2769Show usage information for @command{ranlib}.
2770
252b5132
RH
2771@item -v
2772@itemx -V
f20a759a 2773@itemx --version
c7c55b78 2774Show the version number of @command{ranlib}.
b14f9da0 2775
b3364cb9
RM
2776@item -D
2777@cindex deterministic archives
9cb80f72 2778@kindex --enable-deterministic-archives
b3364cb9
RM
2779Operate in @emph{deterministic} mode. The symbol map archive member's
2780header will show zero for the UID, GID, and timestamp. When this
2781option is used, multiple runs will produce identical output files.
2782
e956b7d3
NC
2783If @file{binutils} was configured with
2784@option{--enable-deterministic-archives}, then this mode is on by
2785default. It can be disabled with the @samp{-U} option, described
2786below.
9cb80f72 2787
b14f9da0
NC
2788@item -t
2789Update the timestamp of the symbol map of an archive.
9cb80f72
RM
2790
2791@item -U
2792@cindex deterministic archives
2793@kindex --enable-deterministic-archives
2794Do @emph{not} operate in @emph{deterministic} mode. This is the
2795inverse of the @samp{-D} option, above: the archive index will get
2796actual UID, GID, timestamp, and file mode values.
2797
e956b7d3
NC
2798If @file{binutils} was configured @emph{without}
2799@option{--enable-deterministic-archives}, then this mode is on by
2800default.
2801
252b5132
RH
2802@end table
2803
0285c67d
NC
2804@c man end
2805
2806@ignore
2807@c man begin SEEALSO ranlib
2808ar(1), nm(1), and the Info entries for @file{binutils}.
2809@c man end
2810@end ignore
2811
252b5132
RH
2812@node size
2813@chapter size
2814
2815@kindex size
2816@cindex section sizes
2817
0285c67d
NC
2818@c man title size list section sizes and total size.
2819
252b5132 2820@smallexample
0285c67d 2821@c man begin SYNOPSIS size
c7c55b78 2822size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
15c82623
NC
2823 [@option{--help}]
2824 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
29422971 2825 [@option{--common}]
15c82623 2826 [@option{-t}|@option{--totals}]
c1c0eb9e 2827 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
c7c55b78 2828 [@var{objfile}@dots{}]
0285c67d 2829@c man end
252b5132
RH
2830@end smallexample
2831
0285c67d
NC
2832@c man begin DESCRIPTION size
2833
c7c55b78 2834The @sc{gnu} @command{size} utility lists the section sizes---and the total
252b5132
RH
2835size---for each of the object or archive files @var{objfile} in its
2836argument list. By default, one line of output is generated for each
2837object file or each module in an archive.
2838
2839@var{objfile}@dots{} are the object files to be examined.
2840If none are specified, the file @code{a.out} will be used.
2841
0285c67d
NC
2842@c man end
2843
2844@c man begin OPTIONS size
2845
252b5132
RH
2846The command line options have the following meanings:
2847
c7c55b78 2848@table @env
252b5132
RH
2849@item -A
2850@itemx -B
2851@itemx --format=@var{compatibility}
c7c55b78 2852@cindex @command{size} display format
252b5132 2853Using one of these options, you can choose whether the output from @sc{gnu}
c7c55b78
NC
2854@command{size} resembles output from System V @command{size} (using @option{-A},
2855or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2856@option{--format=berkeley}). The default is the one-line format similar to
c1c0eb9e 2857Berkeley's.
252b5132
RH
2858@c Bonus for doc-source readers: you can also say --format=strange (or
2859@c anything else that starts with 's') for sysv, and --format=boring (or
2860@c anything else that starts with 'b') for Berkeley.
2861
2862Here is an example of the Berkeley (default) format of output from
c1c0eb9e 2863@command{size}:
252b5132 2864@smallexample
f20a759a 2865$ size --format=Berkeley ranlib size
252b5132
RH
2866text data bss dec hex filename
2867294880 81920 11592 388392 5ed28 ranlib
2868294880 81920 11888 388688 5ee50 size
2869@end smallexample
2870
2871@noindent
2872This is the same data, but displayed closer to System V conventions:
2873
2874@smallexample
f20a759a 2875$ size --format=SysV ranlib size
252b5132
RH
2876ranlib :
2877section size addr
c1c0eb9e
RM
2878.text 294880 8192
2879.data 81920 303104
2880.bss 11592 385024
2881Total 388392
252b5132
RH
2882
2883
2884size :
2885section size addr
c1c0eb9e
RM
2886.text 294880 8192
2887.data 81920 303104
2888.bss 11888 385024
2889Total 388688
252b5132
RH
2890@end smallexample
2891
2892@item --help
2893Show a summary of acceptable arguments and options.
2894
2895@item -d
2896@itemx -o
2897@itemx -x
2898@itemx --radix=@var{number}
c7c55b78 2899@cindex @command{size} number format
252b5132
RH
2900@cindex radix for section sizes
2901Using one of these options, you can control whether the size of each
c7c55b78
NC
2902section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2903(@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2904@option{--radix=16}). In @option{--radix=@var{number}}, only the three
252b5132 2905values (8, 10, 16) are supported. The total size is always given in two
c7c55b78
NC
2906radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2907octal and hexadecimal if you're using @option{-o}.
252b5132 2908
29422971
AM
2909@item --common
2910Print total size of common symbols in each file. When using Berkeley
2911format these are included in the bss size.
2912
15c82623
NC
2913@item -t
2914@itemx --totals
2915Show totals of all objects listed (Berkeley format listing mode only).
2916
252b5132
RH
2917@item --target=@var{bfdname}
2918@cindex object code format
2919Specify that the object-code format for @var{objfile} is
c7c55b78 2920@var{bfdname}. This option may not be necessary; @command{size} can
252b5132
RH
2921automatically recognize many formats.
2922@xref{Target Selection}, for more information.
2923
2924@item -V
2925@itemx --version
c7c55b78 2926Display the version number of @command{size}.
252b5132
RH
2927@end table
2928
0285c67d
NC
2929@c man end
2930
2931@ignore
2932@c man begin SEEALSO size
2933ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2934@c man end
2935@end ignore
2936
252b5132
RH
2937@node strings
2938@chapter strings
2939@kindex strings
2940@cindex listings strings
2941@cindex printing strings
2942@cindex strings, printing
2943
0285c67d
NC
2944@c man title strings print the strings of printable characters in files.
2945
252b5132 2946@smallexample
0285c67d 2947@c man begin SYNOPSIS strings
ffbe5983 2948strings [@option{-afovV}] [@option{-}@var{min-len}]
d132876a
NC
2949 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2950 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2951 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2952 [@option{-}] [@option{--all}] [@option{--print-file-name}]
3bf31ec9 2953 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
334ac421 2954 [@option{-w}] [@option{--include-all-whitespace}]
55edd97b 2955 [@option{-s}] [@option{--output-separator}@var{sep_string}]
c7c55b78 2956 [@option{--help}] [@option{--version}] @var{file}@dots{}
0285c67d 2957@c man end
252b5132
RH
2958@end smallexample
2959
0285c67d
NC
2960@c man begin DESCRIPTION strings
2961
7fac9594
NC
2962For each @var{file} given, @sc{gnu} @command{strings} prints the
2963printable character sequences that are at least 4 characters long (or
2964the number given with the options below) and are followed by an
2965unprintable character.
252b5132 2966
7fac9594
NC
2967Depending upon how the strings program was configured it will default
2968to either displaying all the printable sequences that it can find in
2969each file, or only those sequences that are in loadable, initialized
2970data sections. If the file type in unrecognizable, or if strings is
2971reading from stdin then it will always display all of the printable
2972sequences that it can find.
2973
2974For backwards compatibility any file that occurs after a command line
2975option of just @option{-} will also be scanned in full, regardless of
2976the presence of any @option{-d} option.
2977
2978@command{strings} is mainly useful for determining the contents of
2979non-text files.
252b5132 2980
0285c67d
NC
2981@c man end
2982
2983@c man begin OPTIONS strings
2984
c7c55b78 2985@table @env
252b5132
RH
2986@item -a
2987@itemx --all
2988@itemx -
7fac9594
NC
2989Scan the whole file, regardless of what sections it contains or
2990whether those sections are loaded or initialized. Normally this is
2991the default behaviour, but strings can be configured so that the
2992@option{-d} is the default instead.
2993
2994The @option{-} option is position dependent and forces strings to
2995perform full scans of any file that is mentioned after the @option{-}
2996on the command line, even if the @option{-d} option has been
2997specified.
2998
2999@item -d
3000@itemx --data
3001Only print strings from initialized, loaded data sections in the
3002file. This may reduce the amount of garbage in the output, but it
3003also exposes the strings program to any security flaws that may be
3004present in the BFD library used to scan and load sections. Strings
3005can be configured so that this option is the default behaviour. In
3006such cases the @option{-a} option can be used to avoid using the BFD
3007library and instead just print all of the strings found in the file.
252b5132
RH
3008
3009@item -f
3010@itemx --print-file-name
3011Print the name of the file before each string.
3012
3013@item --help
3014Print a summary of the program usage on the standard output and exit.
3015
3016@item -@var{min-len}
3017@itemx -n @var{min-len}
3018@itemx --bytes=@var{min-len}
3019Print sequences of characters that are at least @var{min-len} characters
3020long, instead of the default 4.
3021
3022@item -o
c7c55b78 3023Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
252b5132
RH
3024act like @samp{-t d} instead. Since we can not be compatible with both
3025ways, we simply chose one.
3026
3027@item -t @var{radix}
3028@itemx --radix=@var{radix}
3029Print the offset within the file before each string. The single
3030character argument specifies the radix of the offset---@samp{o} for
3031octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
3032
d132876a
NC
3033@item -e @var{encoding}
3034@itemx --encoding=@var{encoding}
3035Select the character encoding of the strings that are to be found.
8745eafa
NC
3036Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
3037characters (ASCII, ISO 8859, etc., default), @samp{S} =
3038single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
303916-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
830bf75c
NC
3040littleendian. Useful for finding wide character strings. (@samp{l}
3041and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
d132876a 3042
3bf31ec9
NC
3043@item -T @var{bfdname}
3044@itemx --target=@var{bfdname}
252b5132
RH
3045@cindex object code format
3046Specify an object code format other than your system's default format.
3047@xref{Target Selection}, for more information.
3048
3049@item -v
ffbe5983 3050@itemx -V
252b5132
RH
3051@itemx --version
3052Print the program version number on the standard output and exit.
334ac421
EA
3053
3054@item -w
3055@itemx --include-all-whitespace
3056By default tab and space characters are included in the strings that
3057are displayed, but other whitespace characters, such a newlines and
3058carriage returns, are not. The @option{-w} option changes this so
3059that all whitespace characters are considered to be part of a string.
55edd97b
EA
3060
3061@item -s
3062@itemx --output-separator
3063By default, output strings are delimited by a new-line. This option
3064allows you to supply any string to be used as the output record
3065separator. Useful with --include-all-whitespace where strings
3066may contain new-lines internally.
252b5132
RH
3067@end table
3068
0285c67d
NC
3069@c man end
3070
3071@ignore
3072@c man begin SEEALSO strings
3073ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
3074and the Info entries for @file{binutils}.
3075@c man end
3076@end ignore
3077
252b5132
RH
3078@node strip
3079@chapter strip
3080
3081@kindex strip
3082@cindex removing symbols
3083@cindex discarding symbols
3084@cindex symbols, discarding
3085
0285c67d
NC
3086@c man title strip Discard symbols from object files.
3087
252b5132 3088@smallexample
0285c67d 3089@c man begin SYNOPSIS strip
2593f09a
NC
3090strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
3091 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
3092 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
3093 [@option{-s}|@option{--strip-all}]
3094 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
96109726 3095 [@option{--strip-dwo}]
1d15e434
NC
3096 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
3097 [@option{-M}|@option{--merge-notes}][@option{--no-merge-notes}]
2593f09a 3098 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
5fe11841 3099 [@option{-w}|@option{--wildcard}]
2593f09a
NC
3100 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
3101 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
d3e5f6c8 3102 [@option{--remove-relocations=}@var{sectionpattern}]
2593f09a 3103 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2e30cb57 3104 [@option{-D}|@option{--enable-deterministic-archives}]
955d0b3b 3105 [@option{-U}|@option{--disable-deterministic-archives}]
1637cd90 3106 [@option{--keep-file-symbols}]
ed1653a7 3107 [@option{--only-keep-debug}]
7c29036b
NC
3108 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
3109 [@option{--help}] [@option{--info}]
252b5132 3110 @var{objfile}@dots{}
0285c67d 3111@c man end
252b5132
RH
3112@end smallexample
3113
0285c67d
NC
3114@c man begin DESCRIPTION strip
3115
c7c55b78 3116@sc{gnu} @command{strip} discards all symbols from object files
252b5132
RH
3117@var{objfile}. The list of object files may include archives.
3118At least one object file must be given.
3119
c7c55b78 3120@command{strip} modifies the files named in its argument,
252b5132
RH
3121rather than writing modified copies under different names.
3122
0285c67d
NC
3123@c man end
3124
3125@c man begin OPTIONS strip
3126
c7c55b78 3127@table @env
252b5132
RH
3128@item -F @var{bfdname}
3129@itemx --target=@var{bfdname}
3130Treat the original @var{objfile} as a file with the object
3131code format @var{bfdname}, and rewrite it in the same format.
3132@xref{Target Selection}, for more information.
3133
3134@item --help
c7c55b78 3135Show a summary of the options to @command{strip} and exit.
252b5132 3136
7c29036b
NC
3137@item --info
3138Display a list showing all architectures and object formats available.
3139
947ed062 3140@item -I @var{bfdname}
252b5132
RH
3141@itemx --input-target=@var{bfdname}
3142Treat the original @var{objfile} as a file with the object
3143code format @var{bfdname}.
3144@xref{Target Selection}, for more information.
3145
3146@item -O @var{bfdname}
3147@itemx --output-target=@var{bfdname}
3148Replace @var{objfile} with a file in the output format @var{bfdname}.
3149@xref{Target Selection}, for more information.
3150
3151@item -R @var{sectionname}
3152@itemx --remove-section=@var{sectionname}
805b1c8b
AS
3153Remove any section named @var{sectionname} from the output file, in
3154addition to whatever sections would otherwise be removed. This
252b5132 3155option may be given more than once. Note that using this option
2e62b721
NC
3156inappropriately may make the output file unusable. The wildcard
3157character @samp{*} may be given at the end of @var{sectionname}. If
3158so, then any section starting with @var{sectionname} will be removed.
252b5132 3159
e511c9b1
AB
3160If the first character of @var{sectionpattern} is the exclamation
3161point (!) then matching sections will not be removed even if an
3162earlier use of @option{--remove-section} on the same command line
3163would otherwise remove it. For example:
3164
3165@smallexample
3166 --remove-section=.text.* --remove-section=!.text.foo
3167@end smallexample
3168
3169will remove all sections matching the pattern '.text.*', but will not
3170remove the section '.text.foo'.
3171
d3e5f6c8
AB
3172@item --remove-relocations=@var{sectionpattern}
3173Remove relocations from the output file for any section matching
3174@var{sectionpattern}. This option may be given more than once. Note
3175that using this option inappropriately may make the output file
3176unusable. Wildcard characters are accepted in @var{sectionpattern}.
3177For example:
3178
3179@smallexample
3180 --remove-relocations=.text.*
3181@end smallexample
3182
3183will remove the relocations for all sections matching the patter
3184'.text.*'.
3185
3186If the first character of @var{sectionpattern} is the exclamation
3187point (!) then matching sections will not have their relocation
3188removed even if an earlier use of @option{--remove-relocations} on the
3189same command line would otherwise cause the relocations to be removed.
3190For example:
3191
3192@smallexample
3193 --remove-relocations=.text.* --remove-relocations=!.text.foo
3194@end smallexample
3195
3196will remove all relocations for sections matching the pattern
3197'.text.*', but will not remove relocations for the section
3198'.text.foo'.
3199
252b5132
RH
3200@item -s
3201@itemx --strip-all
3202Remove all symbols.
3203
3204@item -g
3205@itemx -S
15c82623 3206@itemx -d
252b5132
RH
3207@itemx --strip-debug
3208Remove debugging symbols only.
96109726
CC
3209
3210@item --strip-dwo
3211Remove the contents of all DWARF .dwo sections, leaving the
3212remaining debugging sections and all symbols intact.
3213See the description of this option in the @command{objcopy} section
3214for more information.
252b5132
RH
3215
3216@item --strip-unneeded
3217Remove all symbols that are not needed for relocation processing.
3218
3219@item -K @var{symbolname}
3220@itemx --keep-symbol=@var{symbolname}
e7f918ad
NC
3221When stripping symbols, keep symbol @var{symbolname} even if it would
3222normally be stripped. This option may be given more than once.
252b5132 3223
1d15e434
NC
3224@item -M
3225@itemx --merge-notes
3226@itemx --no-merge-notes
3227For ELF files, attempt (or do not attempt) to reduce the size of any
3228SHT_NOTE type sections by removing duplicate notes. The default is to
3229attempt this reduction.
3230
252b5132
RH
3231@item -N @var{symbolname}
3232@itemx --strip-symbol=@var{symbolname}
3233Remove symbol @var{symbolname} from the source file. This option may be
3234given more than once, and may be combined with strip options other than
c7c55b78 3235@option{-K}.
252b5132
RH
3236
3237@item -o @var{file}
3238Put the stripped output in @var{file}, rather than replacing the
3239existing file. When this argument is used, only one @var{objfile}
3240argument may be specified.
3241
3242@item -p
3243@itemx --preserve-dates
3244Preserve the access and modification dates of the file.
3245
2e30cb57
CC
3246@item -D
3247@itemx --enable-deterministic-archives
955d0b3b
RM
3248@cindex deterministic archives
3249@kindex --enable-deterministic-archives
2e30cb57
CC
3250Operate in @emph{deterministic} mode. When copying archive members
3251and writing the archive index, use zero for UIDs, GIDs, timestamps,
3252and use consistent file modes for all files.
3253
955d0b3b
RM
3254If @file{binutils} was configured with
3255@option{--enable-deterministic-archives}, then this mode is on by default.
3256It can be disabled with the @samp{-U} option, below.
3257
3258@item -U
3259@itemx --disable-deterministic-archives
3260@cindex deterministic archives
3261@kindex --enable-deterministic-archives
3262Do @emph{not} operate in @emph{deterministic} mode. This is the
3263inverse of the @option{-D} option, above: when copying archive members
3264and writing the archive index, use their actual UID, GID, timestamp,
3265and file mode values.
3266
3267This is the default unless @file{binutils} was configured with
3268@option{--enable-deterministic-archives}.
3269
5fe11841
NC
3270@item -w
3271@itemx --wildcard
3272Permit regular expressions in @var{symbolname}s used in other command
3273line options. The question mark (?), asterisk (*), backslash (\) and
3274square brackets ([]) operators can be used anywhere in the symbol
3275name. If the first character of the symbol name is the exclamation
3276point (!) then the sense of the switch is reversed for that symbol.
3277For example:
3278
3279@smallexample
3280 -w -K !foo -K fo*
3281@end smallexample
3282
3283would cause strip to only keep symbols that start with the letters
3284``fo'', but to discard the symbol ``foo''.
3285
252b5132
RH
3286@item -x
3287@itemx --discard-all
3288Remove non-global symbols.
3289
3290@item -X
3291@itemx --discard-locals
3292Remove compiler-generated local symbols.
3293(These usually start with @samp{L} or @samp{.}.)
3294
1637cd90
JB
3295@item --keep-file-symbols
3296When stripping a file, perhaps with @option{--strip-debug} or
3297@option{--strip-unneeded}, retain any symbols specifying source file names,
3298which would otherwise get stripped.
3299
ed1653a7 3300@item --only-keep-debug
63b9bbb7 3301Strip a file, emptying the contents of any sections that would not be
c1c0eb9e 3302stripped by @option{--strip-debug} and leaving the debugging sections
63b9bbb7
NC
3303intact. In ELF files, this preserves all the note sections in the
3304output as well.
3305
3306Note - the section headers of the stripped sections are preserved,
3307including their sizes, but the contents of the section are discarded.
3308The section headers are preserved so that other tools can match up the
3309debuginfo file with the real executable, even if that executable has
3310been relocated to a different address space.
ed1653a7
NC
3311
3312The intention is that this option will be used in conjunction with
3313@option{--add-gnu-debuglink} to create a two part executable. One a
3314stripped binary which will occupy less space in RAM and in a
3315distribution and the second a debugging information file which is only
3316needed if debugging abilities are required. The suggested procedure
3317to create these files is as follows:
3318
3319@enumerate
3320@item Link the executable as normal. Assuming that is is called
3321@code{foo} then...
3322@item Run @code{objcopy --only-keep-debug foo foo.dbg} to
3323create a file containing the debugging info.
3324@item Run @code{objcopy --strip-debug foo} to create a
3325stripped executable.
3326@item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
3327to add a link to the debugging info into the stripped executable.
3328@end enumerate
3329
928a4139 3330Note---the choice of @code{.dbg} as an extension for the debug info
ed1653a7
NC
3331file is arbitrary. Also the @code{--only-keep-debug} step is
3332optional. You could instead do this:
3333
3334@enumerate
3335@item Link the executable as normal.
928a4139 3336@item Copy @code{foo} to @code{foo.full}
ed1653a7
NC
3337@item Run @code{strip --strip-debug foo}
3338@item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
3339@end enumerate
3340
928a4139 3341i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
ed1653a7
NC
3342full executable. It does not have to be a file created by the
3343@option{--only-keep-debug} switch.
3344
928a4139 3345Note---this switch is only intended for use on fully linked files. It
91bb255c
NC
3346does not make sense to use it on object files where the debugging
3347information may be incomplete. Besides the gnu_debuglink feature
3348currently only supports the presence of one filename containing
3349debugging information, not multiple filenames on a one-per-object-file
3350basis.
3351
252b5132
RH
3352@item -V
3353@itemx --version
c7c55b78 3354Show the version number for @command{strip}.
252b5132
RH
3355
3356@item -v
3357@itemx --verbose
3358Verbose output: list all object files modified. In the case of
3359archives, @samp{strip -v} lists all members of the archive.
3360@end table
3361
0285c67d
NC
3362@c man end
3363
3364@ignore
3365@c man begin SEEALSO strip
3366the Info entries for @file{binutils}.
3367@c man end
3368@end ignore
3369
7ca01ed9 3370@node c++filt, addr2line, strip, Top
252b5132
RH
3371@chapter c++filt
3372
3373@kindex c++filt
3374@cindex demangling C++ symbols
3375
0285c67d
NC
3376@c man title cxxfilt Demangle C++ and Java symbols.
3377
252b5132 3378@smallexample
0285c67d 3379@c man begin SYNOPSIS cxxfilt
ae9ab7c0
NC
3380c++filt [@option{-_}|@option{--strip-underscore}]
3381 [@option{-n}|@option{--no-strip-underscore}]
4e48c9dd 3382 [@option{-p}|@option{--no-params}]
ec948987 3383 [@option{-t}|@option{--types}]
cbf1f5df 3384 [@option{-i}|@option{--no-verbose}]
c7c55b78
NC
3385 [@option{-s} @var{format}|@option{--format=}@var{format}]
3386 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
0285c67d 3387@c man end
252b5132
RH
3388@end smallexample
3389
0285c67d
NC
3390@c man begin DESCRIPTION cxxfilt
3391
9d51cc66 3392@kindex cxxfilt
ec948987
NC
3393The C++ and Java languages provide function overloading, which means
3394that you can write many functions with the same name, providing that
3395each function takes parameters of different types. In order to be
3396able to distinguish these similarly named functions C++ and Java
3397encode them into a low-level assembler name which uniquely identifies
3398each different version. This process is known as @dfn{mangling}. The
3399@command{c++filt}
c1c0eb9e 3400@footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
195a97ce 3401MS-DOS this program is named @command{CXXFILT}.}
9d51cc66 3402program does the inverse mapping: it decodes (@dfn{demangles}) low-level
ec948987 3403names into user-level names so that they can be read.
252b5132
RH
3404
3405Every alphanumeric word (consisting of letters, digits, underscores,
cbf1f5df
NC
3406dollars, or periods) seen in the input is a potential mangled name.
3407If the name decodes into a C++ name, the C++ name replaces the
ec948987
NC
3408low-level name in the output, otherwise the original word is output.
3409In this way you can pass an entire assembler source file, containing
3410mangled names, through @command{c++filt} and see the same source file
3411containing demangled names.
252b5132 3412
ec948987
NC
3413You can also use @command{c++filt} to decipher individual symbols by
3414passing them on the command line:
252b5132
RH
3415
3416@example
3417c++filt @var{symbol}
3418@end example
3419
c7c55b78 3420If no @var{symbol} arguments are given, @command{c++filt} reads symbol
ec948987
NC
3421names from the standard input instead. All the results are printed on
3422the standard output. The difference between reading names from the
3423command line versus reading names from the standard input is that
3424command line arguments are expected to be just mangled names and no
b45619c0 3425checking is performed to separate them from surrounding text. Thus
ec948987
NC
3426for example:
3427
3428@smallexample
3429c++filt -n _Z1fv
3430@end smallexample
3431
3432will work and demangle the name to ``f()'' whereas:
3433
3434@smallexample
3435c++filt -n _Z1fv,
3436@end smallexample
3437
3438will not work. (Note the extra comma at the end of the mangled
3439name which makes it invalid). This command however will work:
3440
3441@smallexample
3442echo _Z1fv, | c++filt -n
3443@end smallexample
3444
928a4139 3445and will display ``f(),'', i.e., the demangled name followed by a
ec948987
NC
3446trailing comma. This behaviour is because when the names are read
3447from the standard input it is expected that they might be part of an
3448assembler source file where there might be extra, extraneous
928a4139 3449characters trailing after a mangled name. For example:
ec948987
NC
3450
3451@smallexample
3452 .type _Z1fv, @@function
3453@end smallexample
252b5132 3454
0285c67d
NC
3455@c man end
3456
3457@c man begin OPTIONS cxxfilt
3458
c7c55b78 3459@table @env
252b5132 3460@item -_
ae9ab7c0 3461@itemx --strip-underscore
252b5132
RH
3462On some systems, both the C and C++ compilers put an underscore in front
3463of every name. For example, the C name @code{foo} gets the low-level
3464name @code{_foo}. This option removes the initial underscore. Whether
c7c55b78 3465@command{c++filt} removes the underscore by default is target dependent.
252b5132 3466
252b5132 3467@item -n
ae9ab7c0 3468@itemx --no-strip-underscore
252b5132
RH
3469Do not remove the initial underscore.
3470
4e48c9dd
ILT
3471@item -p
3472@itemx --no-params
3473When demangling the name of a function, do not display the types of
3474the function's parameters.
3475
cbf1f5df 3476@item -t
ec948987
NC
3477@itemx --types
3478Attempt to demangle types as well as function names. This is disabled
3479by default since mangled types are normally only used internally in
928a4139 3480the compiler, and they can be confused with non-mangled names. For example,
ec948987
NC
3481a function called ``a'' treated as a mangled type name would be
3482demangled to ``signed char''.
cbf1f5df
NC
3483
3484@item -i
3485@itemx --no-verbose
3486Do not include implementation details (if any) in the demangled
3487output.
3488
252b5132
RH
3489@item -s @var{format}
3490@itemx --format=@var{format}
947ed062
NC
3491@command{c++filt} can decode various methods of mangling, used by
3492different compilers. The argument to this option selects which
252b5132
RH
3493method it uses:
3494
3495@table @code
947ed062
NC
3496@item auto
3497Automatic selection based on executable (the default method)
252b5132 3498@item gnu
947ed062 3499the one used by the @sc{gnu} C++ compiler (g++)
252b5132 3500@item lucid
947ed062 3501the one used by the Lucid compiler (lcc)
252b5132
RH
3502@item arm
3503the one specified by the C++ Annotated Reference Manual
3504@item hp
947ed062 3505the one used by the HP compiler (aCC)
252b5132
RH
3506@item edg
3507the one used by the EDG compiler
b5e2a4f3 3508@item gnu-v3
947ed062
NC
3509the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3510@item java
3511the one used by the @sc{gnu} Java compiler (gcj)
3512@item gnat
3513the one used by the @sc{gnu} Ada compiler (GNAT).
252b5132
RH
3514@end table
3515
3516@item --help
c7c55b78 3517Print a summary of the options to @command{c++filt} and exit.
252b5132
RH
3518
3519@item --version
c7c55b78 3520Print the version number of @command{c++filt} and exit.
252b5132
RH
3521@end table
3522
0285c67d
NC
3523@c man end
3524
3525@ignore
3526@c man begin SEEALSO cxxfilt
3527the Info entries for @file{binutils}.
3528@c man end
3529@end ignore
3530
252b5132 3531@quotation
c7c55b78 3532@emph{Warning:} @command{c++filt} is a new utility, and the details of its
252b5132 3533user interface are subject to change in future releases. In particular,
b45619c0 3534a command-line option may be required in the future to decode a name
c1c0eb9e 3535passed as an argument on the command line; in other words,
252b5132
RH
3536
3537@example
3538c++filt @var{symbol}
3539@end example
3540
3541@noindent
3542may in a future release become
3543
3544@example
3545c++filt @var{option} @var{symbol}
3546@end example
3547@end quotation
3548
3549@node addr2line
3550@chapter addr2line
3551
3552@kindex addr2line
3553@cindex address to file name and line number
3554
0285c67d
NC
3555@c man title addr2line convert addresses into file names and line numbers.
3556
252b5132 3557@smallexample
0285c67d 3558@c man begin SYNOPSIS addr2line
be6f6493
TG
3559addr2line [@option{-a}|@option{--addresses}]
3560 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
bf44dd74 3561 [@option{-C}|@option{--demangle}[=@var{style}]]
c7c55b78
NC
3562 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3563 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
0c552dc1 3564 [@option{-i}|@option{--inlines}]
68cdf72f 3565 [@option{-p}|@option{--pretty-print}]
c5f8c388 3566 [@option{-j}|@option{--section=}@var{name}]
c7c55b78
NC
3567 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3568 [addr addr @dots{}]
0285c67d 3569@c man end
252b5132
RH
3570@end smallexample
3571
0285c67d
NC
3572@c man begin DESCRIPTION addr2line
3573
c5f8c388
EB
3574@command{addr2line} translates addresses into file names and line numbers.
3575Given an address in an executable or an offset in a section of a relocatable
3576object, it uses the debugging information to figure out which file name and
3577line number are associated with it.
252b5132 3578
c5f8c388
EB
3579The executable or relocatable object to use is specified with the @option{-e}
3580option. The default is the file @file{a.out}. The section in the relocatable
3581object to use is specified with the @option{-j} option.
252b5132 3582
c7c55b78 3583@command{addr2line} has two modes of operation.
252b5132
RH
3584
3585In the first, hexadecimal addresses are specified on the command line,
c7c55b78 3586and @command{addr2line} displays the file name and line number for each
252b5132
RH
3587address.
3588
c7c55b78 3589In the second, @command{addr2line} reads hexadecimal addresses from
252b5132 3590standard input, and prints the file name and line number for each
c7c55b78 3591address on standard output. In this mode, @command{addr2line} may be used
252b5132
RH
3592in a pipe to convert dynamically chosen addresses.
3593
8d112f9e
TG
3594The format of the output is @samp{FILENAME:LINENO}. By default
3595each input address generates one line of output.
9cf03b7e 3596
8d112f9e
TG
3597Two options can generate additional lines before each
3598@samp{FILENAME:LINENO} line (in that order).
3599
3600If the @option{-a} option is used then a line with the input address
3601is displayed.
3602
3603If the @option{-f} option is used, then a line with the
3604@samp{FUNCTIONNAME} is displayed. This is the name of the function
3605containing the address.
3606
3607One option can generate additional lines after the
3608@samp{FILENAME:LINENO} line.
9cf03b7e
NC
3609
3610If the @option{-i} option is used and the code at the given address is
8d112f9e
TG
3611present there because of inlining by the compiler then additional
3612lines are displayed afterwards. One or two extra lines (if the
3613@option{-f} option is used) are displayed for each inlined function.
3614
3615Alternatively if the @option{-p} option is used then each input
3616address generates a single, long, output line containing the address,
3617the function name, the file name and the line number. If the
3618@option{-i} option has also been used then any inlined functions will
3619be displayed in the same manner, but on separate lines, and prefixed
3620by the text @samp{(inlined by)}.
252b5132
RH
3621
3622If the file name or function name can not be determined,
c7c55b78
NC
3623@command{addr2line} will print two question marks in their place. If the
3624line number can not be determined, @command{addr2line} will print 0.
252b5132 3625
0285c67d
NC
3626@c man end
3627
3628@c man begin OPTIONS addr2line
3629
252b5132
RH
3630The long and short forms of options, shown here as alternatives, are
3631equivalent.
3632
c7c55b78 3633@table @env
be6f6493
TG
3634@item -a
3635@itemx --addresses
9cf03b7e 3636Display the address before the function name, file and line number
be6f6493
TG
3637information. The address is printed with a @samp{0x} prefix to easily
3638identify it.
3639
252b5132
RH
3640@item -b @var{bfdname}
3641@itemx --target=@var{bfdname}
3642@cindex object code format
3643Specify that the object-code format for the object files is
3644@var{bfdname}.
3645
3646@item -C
28c309a2 3647@itemx --demangle[=@var{style}]
252b5132
RH
3648@cindex demangling in objdump
3649Decode (@dfn{demangle}) low-level symbol names into user-level names.
3650Besides removing any initial underscore prepended by the system, this
28c309a2 3651makes C++ function names readable. Different compilers have different
c1c0eb9e
RM
3652mangling styles. The optional demangling style argument can be used to
3653choose an appropriate demangling style for your compiler. @xref{c++filt},
28c309a2 3654for more information on demangling.
252b5132
RH
3655
3656@item -e @var{filename}
3657@itemx --exe=@var{filename}
3658Specify the name of the executable for which addresses should be
3659translated. The default file is @file{a.out}.
3660
3661@item -f
3662@itemx --functions
3663Display function names as well as file and line number information.
3664
3665@item -s
3666@itemx --basenames
3667Display only the base of each file name.
0c552dc1
FF
3668
3669@item -i
3670@itemx --inlines
3671If the address belongs to a function that was inlined, the source
3672information for all enclosing scopes back to the first non-inlined
3673function will also be printed. For example, if @code{main} inlines
3674@code{callee1} which inlines @code{callee2}, and address is from
3675@code{callee2}, the source information for @code{callee1} and @code{main}
3676will also be printed.
c5f8c388
EB
3677
3678@item -j
3679@itemx --section
3680Read offsets relative to the specified section instead of absolute addresses.
68cdf72f
TG
3681
3682@item -p
3683@itemx --pretty-print
3684Make the output more human friendly: each location are printed on one line.
3685If option @option{-i} is specified, lines for all enclosing scopes are
3686prefixed with @samp{(inlined by)}.
e107c42f 3687@end table
252b5132 3688
0285c67d
NC
3689@c man end
3690
3691@ignore
3692@c man begin SEEALSO addr2line
3693Info entries for @file{binutils}.
3694@c man end
3695@end ignore
3696
252b5132
RH
3697@node nlmconv
3698@chapter nlmconv
3699
c7c55b78 3700@command{nlmconv} converts a relocatable object file into a NetWare
252b5132
RH
3701Loadable Module.
3702
3703@ignore
c7c55b78 3704@command{nlmconv} currently works with @samp{i386} object
252b5132
RH
3705files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
3706object files in @sc{elf}, or @code{a.out} format@footnote{
c7c55b78 3707@command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
252b5132
RH
3708format in the Binary File Descriptor library. It has only been tested
3709with the above formats.}.
3710@end ignore
3711
3712@quotation
c7c55b78 3713@emph{Warning:} @command{nlmconv} is not always built as part of the binary
252b5132
RH
3714utilities, since it is only useful for NLM targets.
3715@end quotation
3716
0285c67d
NC
3717@c man title nlmconv converts object code into an NLM.
3718
252b5132 3719@smallexample
0285c67d 3720@c man begin SYNOPSIS nlmconv
c7c55b78
NC
3721nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
3722 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
3723 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
3724 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
3725 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
252b5132 3726 @var{infile} @var{outfile}
0285c67d 3727@c man end
252b5132
RH
3728@end smallexample
3729
0285c67d
NC
3730@c man begin DESCRIPTION nlmconv
3731
c7c55b78 3732@command{nlmconv} converts the relocatable @samp{i386} object file
252b5132
RH
3733@var{infile} into the NetWare Loadable Module @var{outfile}, optionally
3734reading @var{headerfile} for NLM header information. For instructions
3735on writing the NLM command file language used in header files, see the
3736@samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
3737Development and Tools Overview}, which is part of the NLM Software
3738Developer's Kit (``NLM SDK''), available from Novell, Inc.
c7c55b78 3739@command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
0285c67d
NC
3740@var{infile};
3741@ifclear man
3742see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
3743@end ifclear
252b5132 3744
c7c55b78 3745@command{nlmconv} can perform a link step. In other words, you can list
252b5132
RH
3746more than one object file for input if you list them in the definitions
3747file (rather than simply specifying one input file on the command line).
c7c55b78 3748In this case, @command{nlmconv} calls the linker for you.
252b5132 3749
0285c67d
NC
3750@c man end
3751
3752@c man begin OPTIONS nlmconv
3753
c7c55b78 3754@table @env
252b5132
RH
3755@item -I @var{bfdname}
3756@itemx --input-target=@var{bfdname}
c7c55b78 3757Object format of the input file. @command{nlmconv} can usually determine
252b5132
RH
3758the format of a given file (so no default is necessary).
3759@xref{Target Selection}, for more information.
3760
3761@item -O @var{bfdname}
3762@itemx --output-target=@var{bfdname}
c7c55b78 3763Object format of the output file. @command{nlmconv} infers the output
252b5132
RH
3764format based on the input format, e.g. for a @samp{i386} input file the
3765output format is @samp{nlm32-i386}.
3766@xref{Target Selection}, for more information.
3767
3768@item -T @var{headerfile}
3769@itemx --header-file=@var{headerfile}
3770Reads @var{headerfile} for NLM header information. For instructions on
3771writing the NLM command file language used in header files, see@ see the
3772@samp{linkers} section, of the @cite{NLM Development and Tools
3773Overview}, which is part of the NLM Software Developer's Kit, available
3774from Novell, Inc.
3775
3776@item -d
3777@itemx --debug
c7c55b78 3778Displays (on standard error) the linker command line used by @command{nlmconv}.
252b5132
RH
3779
3780@item -l @var{linker}
3781@itemx --linker=@var{linker}
3782Use @var{linker} for any linking. @var{linker} can be an absolute or a
3783relative pathname.
3784
3785@item -h
3786@itemx --help
3787Prints a usage summary.
3788
3789@item -V
3790@itemx --version
c7c55b78 3791Prints the version number for @command{nlmconv}.
252b5132
RH
3792@end table
3793
0285c67d
NC
3794@c man end
3795
3796@ignore
3797@c man begin SEEALSO nlmconv
3798the Info entries for @file{binutils}.
692ed3e7
NC
3799@c man end
3800@end ignore
3801
3802@node windmc
3803@chapter windmc
3804
3805@command{windmc} may be used to generator Windows message resources.
3806
3807@quotation
3808@emph{Warning:} @command{windmc} is not always built as part of the binary
3809utilities, since it is only useful for Windows targets.
3810@end quotation
3811
3812@c man title windmc generates Windows message resources.
3813
3814@smallexample
826fec2f 3815@c man begin SYNOPSIS windmc
692ed3e7
NC
3816windmc [options] input-file
3817@c man end
3818@end smallexample
3819
3820@c man begin DESCRIPTION windmc
3821
3822@command{windmc} reads message definitions from an input file (.mc) and
3823translate them into a set of output files. The output files may be of
3824four kinds:
3825
3826@table @code
3827@item h
3828A C header file containing the message definitions.
3829
3830@item rc
3831A resource file compilable by the @command{windres} tool.
3832
3833@item bin
3834One or more binary files containing the resource data for a specific
3835message language.
3836
3837@item dbg
3838A C include file that maps message id's to their symbolic name.
3839@end table
3840
3841The exact description of these different formats is available in
3842documentation from Microsoft.
3843
3844When @command{windmc} converts from the @code{mc} format to the @code{bin}
3845format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3846Windows Message Compiler.
3847
3848@c man end
3849
3850@c man begin OPTIONS windmc
3851
3852@table @env
3853@item -a
3854@itemx --ascii_in
826fec2f 3855Specifies that the input file specified is ASCII. This is the default
692ed3e7
NC
3856behaviour.
3857
3858@item -A
3859@itemx --ascii_out
826fec2f 3860Specifies that messages in the output @code{bin} files should be in ASCII
692ed3e7
NC
3861format.
3862
3863@item -b
3864@itemx --binprefix
3865Specifies that @code{bin} filenames should have to be prefixed by the
3866basename of the source file.
3867
3868@item -c
3869@itemx --customflag
3870Sets the customer bit in all message id's.
3871
3872@item -C @var{codepage}
3873@itemx --codepage_in @var{codepage}
3874Sets the default codepage to be used to convert input file to UTF16. The
3875default is ocdepage 1252.
3876
3877@item -d
3878@itemx --decimal_values
3879Outputs the constants in the header file in decimal. Default is using
3880hexadecimal output.
3881
3882@item -e @var{ext}
3883@itemx --extension @var{ext}
3884The extension for the header file. The default is .h extension.
3885
3886@item -F @var{target}
3887@itemx --target @var{target}
3888Specify the BFD format to use for a bin file as output. This
3889is a BFD target name; you can use the @option{--help} option to see a list
3890of supported targets. Normally @command{windmc} will use the default
3891format, which is the first one listed by the @option{--help} option.
3892@ifclear man
3893@ref{Target Selection}.
3894@end ifclear
3895
3896@item -h @var{path}
3897@itemx --headerdir @var{path}
3898The target directory of the generated header file. The default is the
3899current directory.
3900
3901@item -H
3902@itemx --help
3903Displays a list of command line options and then exits.
3904
3905@item -m @var{characters}
3906@itemx --maxlength @var{characters}
3907Instructs @command{windmc} to generate a warning if the length
3908of any message exceeds the number specified.
3909
3910@item -n
3911@itemx --nullterminate
3912Terminate message text in @code{bin} files by zero. By default they are
3913terminated by CR/LF.
3914
3915@item -o
3916@itemx --hresult_use
3917Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3918file, using HRESULT definitions. Status codes are used if the flag is not
3919specified.
3920
3921@item -O @var{codepage}
3922@itemx --codepage_out @var{codepage}
3923Sets the default codepage to be used to output text files. The default
3924is ocdepage 1252.
3925
3926@item -r @var{path}
3927@itemx --rcdir @var{path}
3928The target directory for the generated @code{rc} script and the generated
3929@code{bin} files that the resource compiler script includes. The default
3930is the current directory.
3931
3932@item -u
3933@itemx --unicode_in
3934Specifies that the input file is UTF16.
3935
3936@item -U
3937@itemx --unicode_out
3938Specifies that messages in the output @code{bin} file should be in UTF16
3939format. This is the default behaviour.
3940
3941@item -v
3942@item --verbose
bd37ed49 3943Enable verbose mode.
692ed3e7
NC
3944
3945@item -V
3946@item --version
bd37ed49 3947Prints the version number for @command{windmc}.
692ed3e7
NC
3948
3949@item -x @var{path}
3950@itemx --xdgb @var{path}
3951The path of the @code{dbg} C include file that maps message id's to the
3952symbolic name. No such file is generated without specifying the switch.
3953@end table
3954
3955@c man end
3956
3957@ignore
3958@c man begin SEEALSO windmc
3959the Info entries for @file{binutils}.
0285c67d
NC
3960@c man end
3961@end ignore
3962
252b5132
RH
3963@node windres
3964@chapter windres
3965
c7c55b78 3966@command{windres} may be used to manipulate Windows resources.
252b5132
RH
3967
3968@quotation
c7c55b78 3969@emph{Warning:} @command{windres} is not always built as part of the binary
252b5132
RH
3970utilities, since it is only useful for Windows targets.
3971@end quotation
3972
0285c67d
NC
3973@c man title windres manipulate Windows resources.
3974
252b5132 3975@smallexample
0285c67d 3976@c man begin SYNOPSIS windres
252b5132 3977windres [options] [input-file] [output-file]
0285c67d 3978@c man end
252b5132
RH
3979@end smallexample
3980
0285c67d
NC
3981@c man begin DESCRIPTION windres
3982
c7c55b78 3983@command{windres} reads resources from an input file and copies them into
252b5132
RH
3984an output file. Either file may be in one of three formats:
3985
3986@table @code
3987@item rc
3988A text format read by the Resource Compiler.
3989
3990@item res
3991A binary format generated by the Resource Compiler.
3992
3993@item coff
3994A COFF object or executable.
3995@end table
3996
3997The exact description of these different formats is available in
3998documentation from Microsoft.
3999
c7c55b78 4000When @command{windres} converts from the @code{rc} format to the @code{res}
252b5132 4001format, it is acting like the Windows Resource Compiler. When
c7c55b78 4002@command{windres} converts from the @code{res} format to the @code{coff}
252b5132
RH
4003format, it is acting like the Windows @code{CVTRES} program.
4004
c7c55b78 4005When @command{windres} generates an @code{rc} file, the output is similar
252b5132
RH
4006but not identical to the format expected for the input. When an input
4007@code{rc} file refers to an external filename, an output @code{rc} file
4008will instead include the file contents.
4009
c7c55b78 4010If the input or output format is not specified, @command{windres} will
252b5132
RH
4011guess based on the file name, or, for the input file, the file contents.
4012A file with an extension of @file{.rc} will be treated as an @code{rc}
4013file, a file with an extension of @file{.res} will be treated as a
4014@code{res} file, and a file with an extension of @file{.o} or
4015@file{.exe} will be treated as a @code{coff} file.
4016
c7c55b78 4017If no output file is specified, @command{windres} will print the resources
252b5132
RH
4018in @code{rc} format to standard output.
4019
c7c55b78 4020The normal use is for you to write an @code{rc} file, use @command{windres}
252b5132
RH
4021to convert it to a COFF object file, and then link the COFF file into
4022your application. This will make the resources described in the
4023@code{rc} file available to Windows.
4024
0285c67d
NC
4025@c man end
4026
4027@c man begin OPTIONS windres
4028
c7c55b78 4029@table @env
252b5132
RH
4030@item -i @var{filename}
4031@itemx --input @var{filename}
4032The name of the input file. If this option is not used, then
c7c55b78
NC
4033@command{windres} will use the first non-option argument as the input file
4034name. If there are no non-option arguments, then @command{windres} will
4035read from standard input. @command{windres} can not read a COFF file from
edbedb71 4036standard input.
252b5132
RH
4037
4038@item -o @var{filename}
4039@itemx --output @var{filename}
4040The name of the output file. If this option is not used, then
c7c55b78 4041@command{windres} will use the first non-option argument, after any used
252b5132 4042for the input file name, as the output file name. If there is no
c7c55b78 4043non-option argument, then @command{windres} will write to standard output.
edbedb71 4044@command{windres} can not write a COFF file to standard output. Note,
b45619c0 4045for compatibility with @command{rc} the option @option{-fo} is also
edbedb71 4046accepted, but its use is not recommended.
252b5132 4047
85eb5110 4048@item -J @var{format}
252b5132
RH
4049@itemx --input-format @var{format}
4050The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
c7c55b78 4051@samp{coff}. If no input format is specified, @command{windres} will
252b5132
RH
4052guess, as described above.
4053
4054@item -O @var{format}
4055@itemx --output-format @var{format}
4056The output format to generate. @var{format} may be @samp{res},
4057@samp{rc}, or @samp{coff}. If no output format is specified,
c7c55b78 4058@command{windres} will guess, as described above.
252b5132
RH
4059
4060@item -F @var{target}
4061@itemx --target @var{target}
4062Specify the BFD format to use for a COFF file as input or output. This
c7c55b78
NC
4063is a BFD target name; you can use the @option{--help} option to see a list
4064of supported targets. Normally @command{windres} will use the default
4065format, which is the first one listed by the @option{--help} option.
4066@ifclear man
252b5132 4067@ref{Target Selection}.
c7c55b78 4068@end ifclear
252b5132
RH
4069
4070@item --preprocessor @var{program}
c7c55b78 4071When @command{windres} reads an @code{rc} file, it runs it through the C
252b5132
RH
4072preprocessor first. This option may be used to specify the preprocessor
4073to use, including any leading arguments. The default preprocessor
4074argument is @code{gcc -E -xc-header -DRC_INVOKED}.
4075
ec25acb3
NC
4076@item --preprocessor-arg @var{option}
4077When @command{windres} reads an @code{rc} file, it runs it through
4078the C preprocessor first. This option may be used to specify additional
4079text to be passed to preprocessor on its command line.
4080This option can be used multiple times to add multiple options to the
4081preprocessor command line.
4082
85eb5110
NC
4083@item -I @var{directory}
4084@itemx --include-dir @var{directory}
252b5132 4085Specify an include directory to use when reading an @code{rc} file.
c7c55b78
NC
4086@command{windres} will pass this to the preprocessor as an @option{-I}
4087option. @command{windres} will also search this directory when looking for
85eb5110 4088files named in the @code{rc} file. If the argument passed to this command
c1c0eb9e 4089matches any of the supported @var{formats} (as described in the @option{-J}
85eb5110
NC
4090option), it will issue a deprecation warning, and behave just like the
4091@option{-J} option. New programs should not use this behaviour. If a
4092directory happens to match a @var{format}, simple prefix it with @samp{./}
4093to disable the backward compatibility.
252b5132 4094
751d21b5 4095@item -D @var{target}
ad0481cd 4096@itemx --define @var{sym}[=@var{val}]
c7c55b78 4097Specify a @option{-D} option to pass to the preprocessor when reading an
252b5132
RH
4098@code{rc} file.
4099
29b058f1
NC
4100@item -U @var{target}
4101@itemx --undefine @var{sym}
4102Specify a @option{-U} option to pass to the preprocessor when reading an
4103@code{rc} file.
4104
3126d709
CF
4105@item -r
4106Ignored for compatibility with rc.
4107
751d21b5
DD
4108@item -v
4109Enable verbose mode. This tells you what the preprocessor is if you
4110didn't specify one.
4111
30ff741f
NC
4112@item -c @var{val}
4113@item --codepage @var{val}
4114Specify the default codepage to use when reading an @code{rc} file.
4115@var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
4116codepage code. The valid range is from zero up to 0xffff, but the
4117validity of the codepage is host and configuration dependent.
4118
3077f5d8 4119@item -l @var{val}
252b5132
RH
4120@item --language @var{val}
4121Specify the default language to use when reading an @code{rc} file.
4122@var{val} should be a hexadecimal language code. The low eight bits are
4123the language, and the high eight bits are the sublanguage.
4124
5a298d2d
NC
4125@item --use-temp-file
4126Use a temporary file to instead of using popen to read the output of
c1c0eb9e
RM
4127the preprocessor. Use this option if the popen implementation is buggy
4128on the host (eg., certain non-English language versions of Windows 95 and
5a298d2d
NC
4129Windows 98 are known to have buggy popen where the output will instead
4130go the console).
4131
4132@item --no-use-temp-file
4133Use popen, not a temporary file, to read the output of the preprocessor.
4134This is the default behaviour.
4135
3077f5d8 4136@item -h
252b5132
RH
4137@item --help
4138Prints a usage summary.
4139
3077f5d8 4140@item -V
252b5132 4141@item --version
c7c55b78 4142Prints the version number for @command{windres}.
252b5132
RH
4143
4144@item --yydebug
c7c55b78 4145If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
252b5132
RH
4146this will turn on parser debugging.
4147@end table
4148
0285c67d
NC
4149@c man end
4150
4151@ignore
4152@c man begin SEEALSO windres
4153the Info entries for @file{binutils}.
4154@c man end
4155@end ignore
252b5132
RH
4156
4157@node dlltool
2aa9814e 4158@chapter dlltool
252b5132
RH
4159@cindex DLL
4160@kindex dlltool
4161
2aa9814e
BE
4162@command{dlltool} is used to create the files needed to create dynamic
4163link libraries (DLLs) on systems which understand PE format image
4164files such as Windows. A DLL contains an export table which contains
4165information that the runtime loader needs to resolve references from a
4166referencing program.
4167
4168The export table is generated by this program by reading in a
4169@file{.def} file or scanning the @file{.a} and @file{.o} files which
4170will be in the DLL. A @file{.o} file can contain information in
4171special @samp{.drectve} sections with export information.
252b5132
RH
4172
4173@quotation
2aa9814e
BE
4174@emph{Note:} @command{dlltool} is not always built as part of the
4175binary utilities, since it is only useful for those targets which
4176support DLLs.
252b5132
RH
4177@end quotation
4178
0285c67d
NC
4179@c man title dlltool Create files needed to build and use DLLs.
4180
252b5132 4181@smallexample
0285c67d 4182@c man begin SYNOPSIS dlltool
c7c55b78
NC
4183dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
4184 [@option{-b}|@option{--base-file} @var{base-file-name}]
4185 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
4186 [@option{-z}|@option{--output-def} @var{def-file-name}]
c1c0eb9e 4187 [@option{-l}|@option{--output-lib} @var{library-file-name}]
10e636d2 4188 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
c7c55b78
NC
4189 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
4190 [@option{--exclude-symbols} @var{list}]
4191 [@option{--no-default-excludes}]
4192 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
4193 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
14288fdc
DS
4194 [@option{-a}|@option{--add-indirect}]
4195 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
4196 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
607dea97 4197 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
d4732f7c 4198 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
e77b97d4 4199 [@option{--use-nul-prefixed-import-tables}]
71c57c16
NC
4200 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
4201 [@option{-i}|@option{--interwork}]
f9346411 4202 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
c1c0eb9e 4203 [@option{-v}|@option{--verbose}]
c7c55b78 4204 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
36d21de5 4205 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
252b5132 4206 [object-file @dots{}]
0285c67d 4207@c man end
252b5132
RH
4208@end smallexample
4209
0285c67d
NC
4210@c man begin DESCRIPTION dlltool
4211
c7c55b78
NC
4212@command{dlltool} reads its inputs, which can come from the @option{-d} and
4213@option{-b} options as well as object files specified on the command
4214line. It then processes these inputs and if the @option{-e} option has
4215been specified it creates a exports file. If the @option{-l} option
4216has been specified it creates a library file and if the @option{-z} option
c1c0eb9e
RM
4217has been specified it creates a def file. Any or all of the @option{-e},
4218@option{-l} and @option{-z} options can be present in one invocation of
c7c55b78 4219dlltool.
252b5132
RH
4220
4221When creating a DLL, along with the source for the DLL, it is necessary
c7c55b78 4222to have three other files. @command{dlltool} can help with the creation of
252b5132
RH
4223these files.
4224
2aa9814e 4225The first file is a @file{.def} file which specifies which functions are
252b5132 4226exported from the DLL, which functions the DLL imports, and so on. This
c7c55b78
NC
4227is a text file and can be created by hand, or @command{dlltool} can be used
4228to create it using the @option{-z} option. In this case @command{dlltool}
252b5132
RH
4229will scan the object files specified on its command line looking for
4230those functions which have been specially marked as being exported and
2aa9814e 4231put entries for them in the @file{.def} file it creates.
252b5132
RH
4232
4233In order to mark a function as being exported from a DLL, it needs to
c7c55b78 4234have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
252b5132
RH
4235section of the object file. This can be done in C by using the
4236asm() operator:
4237
4238@smallexample
c1c0eb9e 4239 asm (".section .drectve");
252b5132
RH
4240 asm (".ascii \"-export:my_func\"");
4241
4242 int my_func (void) @{ @dots{} @}
4243@end smallexample
4244
4245The second file needed for DLL creation is an exports file. This file
4246is linked with the object files that make up the body of the DLL and it
4247handles the interface between the DLL and the outside world. This is a
c7c55b78 4248binary file and it can be created by giving the @option{-e} option to
c1c0eb9e 4249@command{dlltool} when it is creating or reading in a @file{.def} file.
252b5132
RH
4250
4251The third file needed for DLL creation is the library file that programs
d4732f7c
CW
4252will link with in order to access the functions in the DLL (an `import
4253library'). This file can be created by giving the @option{-l} option to
4254dlltool when it is creating or reading in a @file{.def} file.
252b5132 4255
10e636d2
DK
4256If the @option{-y} option is specified, dlltool generates a delay-import
4257library that can be used instead of the normal import library to allow
4258a program to link to the dll only as soon as an imported function is
4259called for the first time. The resulting executable will need to be
4260linked to the static delayimp library containing __delayLoadHelper2(),
4261which in turn will import LoadLibraryA and GetProcAddress from kernel32.
4262
c7c55b78 4263@command{dlltool} builds the library file by hand, but it builds the
252b5132 4264exports file by creating temporary files containing assembler statements
c7c55b78 4265and then assembling these. The @option{-S} command line option can be
252b5132 4266used to specify the path to the assembler that dlltool will use,
c7c55b78
NC
4267and the @option{-f} option can be used to pass specific flags to that
4268assembler. The @option{-n} can be used to prevent dlltool from deleting
4269these temporary assembler files when it is done, and if @option{-n} is
252b5132
RH
4270specified twice then this will prevent dlltool from deleting the
4271temporary object files it used to build the library.
4272
4273Here is an example of creating a DLL from a source file @samp{dll.c} and
4274also creating a program (from an object file called @samp{program.o})
4275that uses that DLL:
4276
4277@smallexample
4278 gcc -c dll.c
4279 dlltool -e exports.o -l dll.lib dll.o
4280 gcc dll.o exports.o -o dll.dll
4281 gcc program.o dll.lib -o program
4282@end smallexample
4283
d4732f7c
CW
4284
4285@command{dlltool} may also be used to query an existing import library
b3364cb9 4286to determine the name of the DLL to which it is associated. See the
d4732f7c 4287description of the @option{-I} or @option{--identify} option.
b3364cb9 4288
0285c67d
NC
4289@c man end
4290
4291@c man begin OPTIONS dlltool
4292
252b5132
RH
4293The command line options have the following meanings:
4294
c7c55b78 4295@table @env
252b5132
RH
4296
4297@item -d @var{filename}
4298@itemx --input-def @var{filename}
4299@cindex input .def file
2aa9814e 4300Specifies the name of a @file{.def} file to be read in and processed.
252b5132
RH
4301
4302@item -b @var{filename}
4303@itemx --base-file @var{filename}
4304@cindex base files
4305Specifies the name of a base file to be read in and processed. The
4306contents of this file will be added to the relocation section in the
4307exports file generated by dlltool.
4308
4309@item -e @var{filename}
4310@itemx --output-exp @var{filename}
4311Specifies the name of the export file to be created by dlltool.
4312
4313@item -z @var{filename}
4314@itemx --output-def @var{filename}
2aa9814e 4315Specifies the name of the @file{.def} file to be created by dlltool.
252b5132
RH
4316
4317@item -l @var{filename}
4318@itemx --output-lib @var{filename}
4319Specifies the name of the library file to be created by dlltool.
4320
10e636d2
DK
4321@item -y @var{filename}
4322@itemx --output-delaylib @var{filename}
4323Specifies the name of the delay-import library file to be created by dlltool.
4324
252b5132
RH
4325@item --export-all-symbols
4326Treat all global and weak defined symbols found in the input object
4327files as symbols to be exported. There is a small list of symbols which
c7c55b78 4328are not exported by default; see the @option{--no-default-excludes}
252b5132 4329option. You may add to the list of symbols to not export by using the
c7c55b78 4330@option{--exclude-symbols} option.
252b5132
RH
4331
4332@item --no-export-all-symbols
2aa9814e 4333Only export symbols explicitly listed in an input @file{.def} file or in
252b5132
RH
4334@samp{.drectve} sections in the input object files. This is the default
4335behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
4336attributes in the source code.
4337
4338@item --exclude-symbols @var{list}
4339Do not export the symbols in @var{list}. This is a list of symbol names
4340separated by comma or colon characters. The symbol names should not
4341contain a leading underscore. This is only meaningful when
c7c55b78 4342@option{--export-all-symbols} is used.
252b5132
RH
4343
4344@item --no-default-excludes
c7c55b78 4345When @option{--export-all-symbols} is used, it will by default avoid
252b5132
RH
4346exporting certain special symbols. The current list of symbols to avoid
4347exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
c7c55b78 4348@samp{impure_ptr}. You may use the @option{--no-default-excludes} option
252b5132 4349to go ahead and export these special symbols. This is only meaningful
c7c55b78 4350when @option{--export-all-symbols} is used.
252b5132
RH
4351
4352@item -S @var{path}
4353@itemx --as @var{path}
4354Specifies the path, including the filename, of the assembler to be used
4355to create the exports file.
4356
6364e0b4
NC
4357@item -f @var{options}
4358@itemx --as-flags @var{options}
4359Specifies any specific command line options to be passed to the
252b5132 4360assembler when building the exports file. This option will work even if
c7c55b78 4361the @option{-S} option is not used. This option only takes one argument,
252b5132
RH
4362and if it occurs more than once on the command line, then later
4363occurrences will override earlier occurrences. So if it is necessary to
6364e0b4 4364pass multiple options to the assembler they should be enclosed in
252b5132
RH
4365double quotes.
4366
4367@item -D @var{name}
4368@itemx --dll-name @var{name}
2aa9814e
BE
4369Specifies the name to be stored in the @file{.def} file as the name of
4370the DLL when the @option{-e} option is used. If this option is not
4371present, then the filename given to the @option{-e} option will be
4372used as the name of the DLL.
252b5132
RH
4373
4374@item -m @var{machine}
4375@itemx -machine @var{machine}
4376Specifies the type of machine for which the library file should be
c7c55b78 4377built. @command{dlltool} has a built in default type, depending upon how
252b5132
RH
4378it was created, but this option can be used to override that. This is
4379normally only useful when creating DLLs for an ARM processor, when the
c36774d6 4380contents of the DLL are actually encode using Thumb instructions.
252b5132
RH
4381
4382@item -a
4383@itemx --add-indirect
c7c55b78 4384Specifies that when @command{dlltool} is creating the exports file it
252b5132
RH
4385should add a section which allows the exported functions to be
4386referenced without using the import library. Whatever the hell that
c1c0eb9e 4387means!
252b5132
RH
4388
4389@item -U
4390@itemx --add-underscore
c7c55b78 4391Specifies that when @command{dlltool} is creating the exports file it
c1c0eb9e 4392should prepend an underscore to the names of @emph{all} exported symbols.
14288fdc 4393
36d21de5
KT
4394@item --no-leading-underscore
4395@item --leading-underscore
4396Specifies whether standard symbol should be forced to be prefixed, or
4397not.
4398
14288fdc
DS
4399@item --add-stdcall-underscore
4400Specifies that when @command{dlltool} is creating the exports file it
4401should prepend an underscore to the names of exported @emph{stdcall}
4402functions. Variable names and non-stdcall function names are not modified.
4403This option is useful when creating GNU-compatible import libs for third
4404party DLLs that were built with MS-Windows tools.
252b5132
RH
4405
4406@item -k
4407@itemx --kill-at
c1724c7f
DK
4408Specifies that @samp{@@<number>} suffixes should be omitted from the names
4409of stdcall functions that will be imported from the DLL. This is
4410useful when creating an import library for a DLL which exports stdcall
4411functions but without the usual @samp{@@<number>} symbol name suffix.
4412
4413This does not change the naming of symbols provided by the import library
4414to programs linked against it, but only the entries in the import table
4415(ie the .idata section).
252b5132
RH
4416
4417@item -A
4418@itemx --add-stdcall-alias
c7c55b78 4419Specifies that when @command{dlltool} is creating the exports file it
252b5132
RH
4420should add aliases for stdcall symbols without @samp{@@ <number>}
4421in addition to the symbols with @samp{@@ <number>}.
4422
607dea97
NC
4423@item -p
4424@itemx --ext-prefix-alias @var{prefix}
4425Causes @command{dlltool} to create external aliases for all DLL
4426imports with the specified prefix. The aliases are created for both
4427external and import symbols with no leading underscore.
4428
252b5132
RH
4429@item -x
4430@itemx --no-idata4
c7c55b78
NC
4431Specifies that when @command{dlltool} is creating the exports and library
4432files it should omit the @code{.idata4} section. This is for compatibility
252b5132
RH
4433with certain operating systems.
4434
e77b97d4
KT
4435@item --use-nul-prefixed-import-tables
4436Specifies that when @command{dlltool} is creating the exports and library
4437files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4438element. This emulates old gnu import library generation of
4439@code{dlltool}. By default this option is turned off.
4440
252b5132
RH
4441@item -c
4442@itemx --no-idata5
c7c55b78
NC
4443Specifies that when @command{dlltool} is creating the exports and library
4444files it should omit the @code{.idata5} section. This is for compatibility
252b5132
RH
4445with certain operating systems.
4446
d4732f7c
CW
4447@item -I @var{filename}
4448@itemx --identify @var{filename}
4449Specifies that @command{dlltool} should inspect the import library
71c57c16
NC
4450indicated by @var{filename} and report, on @code{stdout}, the name(s)
4451of the associated DLL(s). This can be performed in addition to any
4452other operations indicated by the other options and arguments.
4453@command{dlltool} fails if the import library does not exist or is not
4454actually an import library. See also @option{--identify-strict}.
4455
4456@item --identify-strict
4457Modifies the behavior of the @option{--identify} option, such
4458that an error is reported if @var{filename} is associated with
4459more than one DLL.
d4732f7c 4460
252b5132
RH
4461@item -i
4462@itemx --interwork
c7c55b78 4463Specifies that @command{dlltool} should mark the objects in the library
252b5132 4464file and exports file that it produces as supporting interworking
c36774d6 4465between ARM and Thumb code.
252b5132
RH
4466
4467@item -n
4468@itemx --nodelete
c7c55b78 4469Makes @command{dlltool} preserve the temporary assembler files it used to
252b5132
RH
4470create the exports file. If this option is repeated then dlltool will
4471also preserve the temporary object files it uses to create the library
f9346411
DS
4472file.
4473
4474@item -t @var{prefix}
4475@itemx --temp-prefix @var{prefix}
4476Makes @command{dlltool} use @var{prefix} when constructing the names of
4477temporary assembler and object files. By default, the temp file prefix
c1c0eb9e 4478is generated from the pid.
252b5132
RH
4479
4480@item -v
4481@itemx --verbose
4482Make dlltool describe what it is doing.
4483
4484@item -h
4485@itemx --help
4486Displays a list of command line options and then exits.
4487
4488@item -V
4489@itemx --version
4490Displays dlltool's version number and then exits.
4491
4492@end table
4493
0285c67d
NC
4494@c man end
4495
2aa9814e
BE
4496@menu
4497* def file format:: The format of the dlltool @file{.def} file
4498@end menu
4499
4500@node def file format
4501@section The format of the @command{dlltool} @file{.def} file
4502
4503A @file{.def} file contains any number of the following commands:
4504
4505@table @asis
4506
4507@item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4508The result is going to be named @var{name}@code{.exe}.
4509
4510@item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4511The result is going to be named @var{name}@code{.dll}.
5b3d386e
KT
4512Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4513this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4514details).
2aa9814e 4515
bf201fdd 4516@item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
2aa9814e
BE
4517@item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4518Declares @var{name1} as an exported symbol from the DLL, with optional
4519ordinal number @var{integer}, or declares @var{name1} as an alias
bf201fdd
KT
4520(forward) of the function @var{external-name} in the DLL.
4521If @var{its_name} is specified, this name is used as string in export table.
2aa9814e 4522@var{module-name}.
5b3d386e
KT
4523Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4524are treated - beside @code{LIBRARY} - as simple name-identifiers.
4525If you want to use LIBRARY as name then you need to quote it.
2aa9814e 4526
bf201fdd 4527@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{) [ == ) @var{its_name} @code{]} *}
2aa9814e
BE
4528Declares that @var{external-name} or the exported function whose
4529ordinal number is @var{integer} is to be imported from the file
4530@var{module-name}. If @var{internal-name} is specified then this is
4531the name that the imported function will be referred to in the body of
4532the DLL.
bf201fdd 4533If @var{its_name} is specified, this name is used as string in import table.
5b3d386e
KT
4534Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4535are treated - beside @code{LIBRARY} - as simple name-identifiers.
4536If you want to use LIBRARY as name then you need to quote it.
2aa9814e
BE
4537
4538@item @code{DESCRIPTION} @var{string}
4539Puts @var{string} into the output @file{.exp} file in the
4540@code{.rdata} section.
4541
4542@item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4543@item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4544Generates @code{--stack} or @code{--heap}
4545@var{number-reserve},@var{number-commit} in the output @code{.drectve}
4546section. The linker will see this and act upon it.
4547
4548@item @code{CODE} @var{attr} @code{+}
4549@item @code{DATA} @var{attr} @code{+}
4550@item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4551Generates @code{--attr} @var{section-name} @var{attr} in the output
4552@code{.drectve} section, where @var{attr} is one of @code{READ},
4553@code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4554this and act upon it.
4555
4556@end table
4557
0285c67d
NC
4558@ignore
4559@c man begin SEEALSO dlltool
2aa9814e 4560The Info pages for @file{binutils}.
0285c67d
NC
4561@c man end
4562@end ignore
4563
252b5132
RH
4564@node readelf
4565@chapter readelf
4566
4567@cindex ELF file information
4568@kindex readelf
4569
0285c67d
NC
4570@c man title readelf Displays information about ELF files.
4571
252b5132 4572@smallexample
0285c67d 4573@c man begin SYNOPSIS readelf
c1c0eb9e 4574readelf [@option{-a}|@option{--all}]
c7c55b78
NC
4575 [@option{-h}|@option{--file-header}]
4576 [@option{-l}|@option{--program-headers}|@option{--segments}]
4577 [@option{-S}|@option{--section-headers}|@option{--sections}]
81fc812e 4578 [@option{-g}|@option{--section-groups}]
5477e8a0 4579 [@option{-t}|@option{--section-details}]
c7c55b78
NC
4580 [@option{-e}|@option{--headers}]
4581 [@option{-s}|@option{--syms}|@option{--symbols}]
2c610e4b 4582 [@option{--dyn-syms}]
c7c55b78
NC
4583 [@option{-n}|@option{--notes}]
4584 [@option{-r}|@option{--relocs}]
4585 [@option{-u}|@option{--unwind}]
4586 [@option{-d}|@option{--dynamic}]
4587 [@option{-V}|@option{--version-info}]
947ed062 4588 [@option{-A}|@option{--arch-specific}]
c7c55b78 4589 [@option{-D}|@option{--use-dynamic}]
aef1f6d0 4590 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
09c11c86 4591 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
cf13d699 4592 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
0e602686 4593 [@option{-z}|@option{--decompress}]
4145f1d5 4594 [@option{-c}|@option{--archive-index}]
dda8d76d
NC
4595 [@option{-w[lLiaprmfFsoRtUuTgAckK]}|
4596 @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]]
fd2f0033
TT
4597 [@option{--dwarf-depth=@var{n}}]
4598 [@option{--dwarf-start=@var{n}}]
ed22650e 4599 [@option{-I}|@option{--histogram}]
c7c55b78 4600 [@option{-v}|@option{--version}]
d974e256 4601 [@option{-W}|@option{--wide}]
c7c55b78 4602 [@option{-H}|@option{--help}]
252b5132 4603 @var{elffile}@dots{}
0285c67d 4604@c man end
252b5132
RH
4605@end smallexample
4606
0285c67d
NC
4607@c man begin DESCRIPTION readelf
4608
c7c55b78 4609@command{readelf} displays information about one or more ELF format object
252b5132
RH
4610files. The options control what particular information to display.
4611
fb52b2f4
NC
4612@var{elffile}@dots{} are the object files to be examined. 32-bit and
461364-bit ELF files are supported, as are archives containing ELF files.
252b5132 4614
9eb20dd8
NC
4615This program performs a similar function to @command{objdump} but it
4616goes into more detail and it exists independently of the @sc{bfd}
4617library, so if there is a bug in @sc{bfd} then readelf will not be
4618affected.
4619
0285c67d
NC
4620@c man end
4621
4622@c man begin OPTIONS readelf
4623
252b5132
RH
4624The long and short forms of options, shown here as alternatives, are
4625equivalent. At least one option besides @samp{-v} or @samp{-H} must be
c1c0eb9e 4626given.
252b5132 4627
c7c55b78 4628@table @env
252b5132
RH
4629@item -a
4630@itemx --all
d95ef3ab 4631Equivalent to specifying @option{--file-header},
c7c55b78 4632@option{--program-headers}, @option{--sections}, @option{--symbols},
ee357486
NC
4633@option{--relocs}, @option{--dynamic}, @option{--notes},
4634@option{--version-info}, @option{--arch-specific}, @option{--unwind},
4635@option{--section-groups} and @option{--histogram}.
4636
4637Note - this option does not enable @option{--use-dynamic} itself, so
4638if that option is not present on the command line then dynamic symbols
4639and dynamic relocs will not be displayed.
252b5132
RH
4640
4641@item -h
4642@itemx --file-header
4643@cindex ELF file header information
4644Displays the information contained in the ELF header at the start of the
4645file.
4646
4647@item -l
4648@itemx --program-headers
4649@itemx --segments
4650@cindex ELF program header information
4651@cindex ELF segment information
4652Displays the information contained in the file's segment headers, if it
4653has any.
4654
4655@item -S
4656@itemx --sections
4657@itemx --section-headers
4658@cindex ELF section information
4659Displays the information contained in the file's section headers, if it
4660has any.
4661
81fc812e
L
4662@item -g
4663@itemx --section-groups
4664@cindex ELF section group information
4665Displays the information contained in the file's section groups, if it
4666has any.
4667
5477e8a0
L
4668@item -t
4669@itemx --section-details
4670@cindex ELF section information
4671Displays the detailed section information. Implies @option{-S}.
81fc812e 4672
252b5132
RH
4673@item -s
4674@itemx --symbols
4675@itemx --syms
4676@cindex ELF symbol table information
4677Displays the entries in symbol table section of the file, if it has one.
df2c87b5
NC
4678If a symbol has version information associated with it then this is
4679displayed as well. The version string is displayed as a suffix to the
4680symbol name, preceeded by an @@ character. For example
4681@samp{foo@@VER_1}. If the version is the default version to be used
4682when resolving unversioned references to the symbol then it is
4683displayed as a suffix preceeded by two @@ characters. For example
4684@samp{foo@@@@VER_2}.
252b5132 4685
2c610e4b
L
4686@item --dyn-syms
4687@cindex ELF dynamic symbol table information
4688Displays the entries in dynamic symbol table section of the file, if it
df2c87b5
NC
4689has one. The output format is the same as the format used by the
4690@option{--syms} option.
2c610e4b 4691
252b5132
RH
4692@item -e
4693@itemx --headers
c7c55b78 4694Display all the headers in the file. Equivalent to @option{-h -l -S}.
252b5132 4695
779fe533
NC
4696@item -n
4697@itemx --notes
1ec5cd37
NC
4698@cindex ELF notes
4699Displays the contents of the NOTE segments and/or sections, if any.
779fe533 4700
252b5132
RH
4701@item -r
4702@itemx --relocs
4703@cindex ELF reloc information
f5e21966
NC
4704Displays the contents of the file's relocation section, if it has one.
4705
4706@item -u
4707@itemx --unwind
4708@cindex unwind information
4709Displays the contents of the file's unwind section, if it has one. Only
ba7f2642
TS
4710the unwind sections for IA64 ELF files, as well as ARM unwind tables
4711(@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported.
252b5132
RH
4712
4713@item -d
4714@itemx --dynamic
4715@cindex ELF dynamic section information
4716Displays the contents of the file's dynamic section, if it has one.
4717
4718@item -V
4719@itemx --version-info
a8685210 4720@cindex ELF version sections information
252b5132
RH
4721Displays the contents of the version sections in the file, it they
4722exist.
4723
947ed062
NC
4724@item -A
4725@itemx --arch-specific
4726Displays architecture-specific information in the file, if there
4727is any.
4728
252b5132
RH
4729@item -D
4730@itemx --use-dynamic
c7c55b78 4731When displaying symbols, this option makes @command{readelf} use the
2c610e4b
L
4732symbol hash tables in the file's dynamic section, rather than the
4733symbol table sections.
252b5132 4734
ee357486
NC
4735When displaying relocations, this option makes @command{readelf}
4736display the dynamic relocations rather than the static relocations.
4737
aef1f6d0
DJ
4738@item -x <number or name>
4739@itemx --hex-dump=<number or name>
cf13d699 4740Displays the contents of the indicated section as a hexadecimal bytes.
aef1f6d0
DJ
4741A number identifies a particular section by index in the section table;
4742any other string identifies all sections with that name in the object file.
252b5132 4743
cf13d699
NC
4744@item -R <number or name>
4745@itemx --relocated-dump=<number or name>
4746Displays the contents of the indicated section as a hexadecimal
4747bytes. A number identifies a particular section by index in the
4748section table; any other string identifies all sections with that name
4749in the object file. The contents of the section will be relocated
4750before they are displayed.
4751
09c11c86
NC
4752@item -p <number or name>
4753@itemx --string-dump=<number or name>
4754Displays the contents of the indicated section as printable strings.
4755A number identifies a particular section by index in the section table;
4756any other string identifies all sections with that name in the object file.
4757
0e602686
NC
4758@item -z
4759@itemx --decompress
4760Requests that the section(s) being dumped by @option{x}, @option{R} or
4761@option{p} options are decompressed before being displayed. If the
4762section(s) are not compressed then they are displayed as is.
4763
4145f1d5
NC
4764@item -c
4765@itemx --archive-index
4766@cindex Archive file symbol index information
a8685210 4767Displays the file symbol index information contained in the header part
4145f1d5
NC
4768of binary archives. Performs the same function as the @option{t}
4769command to @command{ar}, but without using the BFD library. @xref{ar}.
4770
dda8d76d
NC
4771@item -w[lLiaprmfFsoRtUuTgAckK]
4772@itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
4773@include debug.options.texi
fd2f0033 4774
947ed062
NC
4775@item -I
4776@itemx --histogram
252b5132
RH
4777Display a histogram of bucket list lengths when displaying the contents
4778of the symbol tables.
4779
4780@item -v
4781@itemx --version
4782Display the version number of readelf.
4783
d974e256
JJ
4784@item -W
4785@itemx --wide
4786Don't break output lines to fit into 80 columns. By default
4787@command{readelf} breaks section header and segment listing lines for
478864-bit ELF files, so that they fit into 80 columns. This option causes
4789@command{readelf} to print each section header resp. each segment one a
4790single line, which is far more readable on terminals wider than 80 columns.
4791
252b5132
RH
4792@item -H
4793@itemx --help
c7c55b78 4794Display the command line options understood by @command{readelf}.
252b5132
RH
4795
4796@end table
4797
0285c67d
NC
4798@c man end
4799
4800@ignore
4801@c man begin SEEALSO readelf
4802objdump(1), and the Info entries for @file{binutils}.
4803@c man end
4804@end ignore
252b5132 4805
30fd33bb
L
4806@node elfedit
4807@chapter elfedit
4808
4809@cindex Update ELF header
4810@kindex elfedit
4811
4812@c man title elfedit Update the ELF header of ELF files.
4813
4814@smallexample
4815@c man begin SYNOPSIS elfedit
4816elfedit [@option{--input-mach=}@var{machine}]
dd35de74 4817 [@option{--input-type=}@var{type}]
08ebfb8c 4818 [@option{--input-osabi=}@var{osabi}]
c7a795f8 4819 @option{--output-mach=}@var{machine}
dd35de74 4820 @option{--output-type=}@var{type}
08ebfb8c 4821 @option{--output-osabi=}@var{osabi}
30fd33bb
L
4822 [@option{-v}|@option{--version}]
4823 [@option{-h}|@option{--help}]
4824 @var{elffile}@dots{}
4825@c man end
4826@end smallexample
4827
4828@c man begin DESCRIPTION elfedit
4829
dd35de74
L
4830@command{elfedit} updates the ELF header of ELF files which have
4831the matching ELF machine and file types. The options control how and
4832which fields in the ELF header should be updated.
30fd33bb
L
4833
4834@var{elffile}@dots{} are the ELF files to be updated. 32-bit and
483564-bit ELF files are supported, as are archives containing ELF files.
4836@c man end
4837
4838@c man begin OPTIONS elfedit
4839
4840The long and short forms of options, shown here as alternatives, are
d0514c49
L
4841equivalent. At least one of the @option{--output-mach},
4842@option{--output-type} and @option{--output-osabi} options must be given.
30fd33bb
L
4843
4844@table @env
4845
574b25e8 4846@item --input-mach=@var{machine}
dd35de74
L
4847Set the matching input ELF machine type to @var{machine}. If
4848@option{--input-mach} isn't specified, it will match any ELF
4849machine types.
30fd33bb 4850
6c14750f
L
4851The supported ELF machine types are, @var{i386}, @var{IAMCU}, @var{L1OM},
4852@var{K1OM} and @var{x86-64}.
30fd33bb 4853
574b25e8 4854@item --output-mach=@var{machine}
30fd33bb
L
4855Change the ELF machine type in the ELF header to @var{machine}. The
4856supported ELF machine types are the same as @option{--input-mach}.
4857
574b25e8 4858@item --input-type=@var{type}
dd35de74
L
4859Set the matching input ELF file type to @var{type}. If
4860@option{--input-type} isn't specified, it will match any ELF file types.
4861
4862The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
4863
574b25e8 4864@item --output-type=@var{type}
dd35de74
L
4865Change the ELF file type in the ELF header to @var{type}. The
4866supported ELF types are the same as @option{--input-type}.
4867
574b25e8 4868@item --input-osabi=@var{osabi}
08ebfb8c 4869Set the matching input ELF file OSABI to @var{osabi}. If
d0514c49
L
4870@option{--input-osabi} isn't specified, it will match any ELF OSABIs.
4871
4872The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
9c55345c
TS
4873@var{GNU}, @var{Linux} (alias for @var{GNU}),
4874@var{Solaris}, @var{AIX}, @var{Irix},
d0514c49
L
4875@var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
4876@var{NSK}, @var{AROS} and @var{FenixOS}.
4877
574b25e8 4878@item --output-osabi=@var{osabi}
08ebfb8c 4879Change the ELF OSABI in the ELF header to @var{osabi}. The
d0514c49
L
4880supported ELF OSABI are the same as @option{--input-osabi}.
4881
30fd33bb
L
4882@item -v
4883@itemx --version
4884Display the version number of @command{elfedit}.
4885
4886@item -h
4887@itemx --help
4888Display the command line options understood by @command{elfedit}.
4889
4890@end table
4891
4892@c man end
4893
4894@ignore
4895@c man begin SEEALSO elfedit
4896readelf(1), and the Info entries for @file{binutils}.
4897@c man end
4898@end ignore
4899
07012eee
MM
4900@node Common Options
4901@chapter Common Options
4902
4903The following command-line options are supported by all of the
4904programs described in this manual.
4905
dff70155 4906@c man begin OPTIONS
07012eee 4907@table @env
38fc1cb1 4908@include at-file.texi
dff70155 4909@c man end
07012eee
MM
4910
4911@item --help
4912Display the command-line options supported by the program.
4913
4914@item --version
4915Display the version number of the program.
4916
dff70155 4917@c man begin OPTIONS
07012eee 4918@end table
dff70155 4919@c man end
07012eee 4920
fff279a7 4921@node Selecting the Target System
947ed062 4922@chapter Selecting the Target System
252b5132 4923
947ed062 4924You can specify two aspects of the target system to the @sc{gnu}
252b5132
RH
4925binary file utilities, each in several ways:
4926
4927@itemize @bullet
4928@item
4929the target
4930
4931@item
4932the architecture
252b5132
RH
4933@end itemize
4934
4935In the following summaries, the lists of ways to specify values are in
4936order of decreasing precedence. The ways listed first override those
4937listed later.
4938
4939The commands to list valid values only list the values for which the
4940programs you are running were configured. If they were configured with
c7c55b78 4941@option{--enable-targets=all}, the commands list most of the available
252b5132
RH
4942values, but a few are left out; not all targets can be configured in at
4943once because some of them can only be configured @dfn{native} (on hosts
4944with the same type as the target system).
4945
4946@menu
c1c0eb9e
RM
4947* Target Selection::
4948* Architecture Selection::
252b5132
RH
4949@end menu
4950
4951@node Target Selection
4952@section Target Selection
4953
4954A @dfn{target} is an object file format. A given target may be
4955supported for multiple architectures (@pxref{Architecture Selection}).
4956A target selection may also have variations for different operating
4957systems or architectures.
4958
4959The command to list valid target values is @samp{objdump -i}
4960(the first column of output contains the relevant information).
4961
4962Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
4963@samp{a.out-sunos-big}.
4964
4965You can also specify a target using a configuration triplet. This is
f20a759a
ILT
4966the same sort of name that is passed to @file{configure} to specify a
4967target. When you use a configuration triplet as an argument, it must be
4968fully canonicalized. You can see the canonical version of a triplet by
252b5132
RH
4969running the shell script @file{config.sub} which is included with the
4970sources.
4971
4972Some sample configuration triplets are: @samp{m68k-hp-bsd},
4973@samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
4974
c7c55b78 4975@subheading @command{objdump} Target
252b5132
RH
4976
4977Ways to specify:
4978
4979@enumerate
4980@item
c7c55b78 4981command line option: @option{-b} or @option{--target}
252b5132
RH
4982
4983@item
4984environment variable @code{GNUTARGET}
4985
4986@item
4987deduced from the input file
4988@end enumerate
4989
c7c55b78 4990@subheading @command{objcopy} and @command{strip} Input Target
252b5132
RH
4991
4992Ways to specify:
4993
4994@enumerate
4995@item
c7c55b78 4996command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
252b5132
RH
4997
4998@item
4999environment variable @code{GNUTARGET}
5000
5001@item
5002deduced from the input file
5003@end enumerate
5004
c7c55b78 5005@subheading @command{objcopy} and @command{strip} Output Target
252b5132
RH
5006
5007Ways to specify:
5008
5009@enumerate
5010@item
c7c55b78 5011command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
252b5132
RH
5012
5013@item
c7c55b78 5014the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
252b5132
RH
5015
5016@item
5017environment variable @code{GNUTARGET}
5018
5019@item
5020deduced from the input file
5021@end enumerate
5022
c7c55b78 5023@subheading @command{nm}, @command{size}, and @command{strings} Target
252b5132
RH
5024
5025Ways to specify:
5026
5027@enumerate
5028@item
c7c55b78 5029command line option: @option{--target}
252b5132
RH
5030
5031@item
5032environment variable @code{GNUTARGET}
5033
5034@item
5035deduced from the input file
5036@end enumerate
5037
252b5132 5038@node Architecture Selection
947ed062 5039@section Architecture Selection
252b5132
RH
5040
5041An @dfn{architecture} is a type of @sc{cpu} on which an object file is
5042to run. Its name may contain a colon, separating the name of the
5043processor family from the name of the particular @sc{cpu}.
5044
5045The command to list valid architecture values is @samp{objdump -i} (the
5046second column contains the relevant information).
5047
5048Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
5049
c7c55b78 5050@subheading @command{objdump} Architecture
252b5132
RH
5051
5052Ways to specify:
5053
5054@enumerate
5055@item
c7c55b78 5056command line option: @option{-m} or @option{--architecture}
252b5132
RH
5057
5058@item
5059deduced from the input file
5060@end enumerate
5061
c7c55b78 5062@subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
252b5132
RH
5063
5064Ways to specify:
5065
5066@enumerate
5067@item
5068deduced from the input file
5069@end enumerate
5070
252b5132
RH
5071@node Reporting Bugs
5072@chapter Reporting Bugs
5073@cindex bugs
5074@cindex reporting bugs
5075
5076Your bug reports play an essential role in making the binary utilities
5077reliable.
5078
5079Reporting a bug may help you by bringing a solution to your problem, or
5080it may not. But in any case the principal function of a bug report is
5081to help the entire community by making the next version of the binary
5082utilities work better. Bug reports are your contribution to their
5083maintenance.
5084
5085In order for a bug report to serve its purpose, you must include the
5086information that enables us to fix the bug.
5087
5088@menu
5089* Bug Criteria:: Have you found a bug?
5090* Bug Reporting:: How to report bugs
5091@end menu
5092
5093@node Bug Criteria
947ed062 5094@section Have You Found a Bug?
252b5132
RH
5095@cindex bug criteria
5096
5097If you are not sure whether you have found a bug, here are some guidelines:
5098
5099@itemize @bullet
5100@cindex fatal signal
5101@cindex crash
5102@item
5103If a binary utility gets a fatal signal, for any input whatever, that is
5104a bug. Reliable utilities never crash.
5105
5106@cindex error on valid input
5107@item
5108If a binary utility produces an error message for valid input, that is a
5109bug.
5110
5111@item
5112If you are an experienced user of binary utilities, your suggestions for
5113improvement are welcome in any case.
5114@end itemize
5115
5116@node Bug Reporting
947ed062 5117@section How to Report Bugs
252b5132
RH
5118@cindex bug reports
5119@cindex bugs, reporting
5120
5121A number of companies and individuals offer support for @sc{gnu}
5122products. If you obtained the binary utilities from a support
5123organization, we recommend you contact that organization first.
5124
5125You can find contact information for many support companies and
5126individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
5127distribution.
5128
ad22bfe8 5129@ifset BUGURL
252b5132 5130In any event, we also recommend that you send bug reports for the binary
ad22bfe8
JM
5131utilities to @value{BUGURL}.
5132@end ifset
252b5132
RH
5133
5134The fundamental principle of reporting bugs usefully is this:
5135@strong{report all the facts}. If you are not sure whether to state a
5136fact or leave it out, state it!
5137
5138Often people omit facts because they think they know what causes the
5139problem and assume that some details do not matter. Thus, you might
5140assume that the name of a file you use in an example does not matter.
5141Well, probably it does not, but one cannot be sure. Perhaps the bug is
5142a stray memory reference which happens to fetch from the location where
5143that pathname is stored in memory; perhaps, if the pathname were
5144different, the contents of that location would fool the utility into
5145doing the right thing despite the bug. Play it safe and give a
5146specific, complete example. That is the easiest thing for you to do,
5147and the most helpful.
5148
5149Keep in mind that the purpose of a bug report is to enable us to fix the bug if
5150it is new to us. Therefore, always write your bug reports on the assumption
5151that the bug has not been reported previously.
5152
5153Sometimes people give a few sketchy facts and ask, ``Does this ring a
947ed062
NC
5154bell?'' This cannot help us fix a bug, so it is basically useless. We
5155respond by asking for enough details to enable us to investigate.
5156You might as well expedite matters by sending them to begin with.
252b5132
RH
5157
5158To enable us to fix the bug, you should include all these things:
5159
5160@itemize @bullet
5161@item
5162The version of the utility. Each utility announces it if you start it
c7c55b78 5163with the @option{--version} argument.
252b5132
RH
5164
5165Without this, we will not know whether there is any point in looking for
5166the bug in the current version of the binary utilities.
5167
5168@item
5169Any patches you may have applied to the source, including any patches
5170made to the @code{BFD} library.
5171
5172@item
5173The type of machine you are using, and the operating system name and
5174version number.
5175
5176@item
5177What compiler (and its version) was used to compile the utilities---e.g.
5178``@code{gcc-2.7}''.
5179
5180@item
5181The command arguments you gave the utility to observe the bug. To
5182guarantee you will not omit something important, list them all. A copy
5183of the Makefile (or the output from make) is sufficient.
5184
5185If we were to try to guess the arguments, we would probably guess wrong
5186and then we might not encounter the bug.
5187
5188@item
5189A complete input file, or set of input files, that will reproduce the
5190bug. If the utility is reading an object file or files, then it is
ad22bfe8 5191generally most helpful to send the actual object files.
252b5132
RH
5192
5193If the source files were produced exclusively using @sc{gnu} programs
c7c55b78 5194(e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
252b5132 5195may be OK to send the source files rather than the object files. In
c7c55b78 5196this case, be sure to say exactly what version of @command{gcc}, or
252b5132 5197whatever, was used to produce the object files. Also say how
c7c55b78 5198@command{gcc}, or whatever, was configured.
252b5132
RH
5199
5200@item
5201A description of what behavior you observe that you believe is
5202incorrect. For example, ``It gets a fatal signal.''
5203
5204Of course, if the bug is that the utility gets a fatal signal, then we
5205will certainly notice it. But if the bug is incorrect output, we might
5206not notice unless it is glaringly wrong. You might as well not give us
5207a chance to make a mistake.
5208
5209Even if the problem you experience is a fatal signal, you should still
f20a759a 5210say so explicitly. Suppose something strange is going on, such as your
b45619c0 5211copy of the utility is out of sync, or you have encountered a bug in
252b5132
RH
5212the C library on your system. (This has happened!) Your copy might
5213crash and ours would not. If you told us to expect a crash, then when
5214ours fails to crash, we would know that the bug was not happening for
5215us. If you had not told us to expect a crash, then we would not be able
5216to draw any conclusion from our observations.
5217
5218@item
5219If you wish to suggest changes to the source, send us context diffs, as
c7c55b78 5220generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
252b5132 5221option. Always send diffs from the old file to the new file. If you
c7c55b78 5222wish to discuss something in the @command{ld} source, refer to it by
f20a759a 5223context, not by line number.
252b5132
RH
5224
5225The line numbers in our development sources will not match those in your
5226sources. Your line numbers would convey no useful information to us.
5227@end itemize
5228
5229Here are some things that are not necessary:
5230
5231@itemize @bullet
5232@item
5233A description of the envelope of the bug.
5234
5235Often people who encounter a bug spend a lot of time investigating
5236which changes to the input file will make the bug go away and which
5237changes will not affect it.
5238
5239This is often time consuming and not very useful, because the way we
5240will find the bug is by running a single example under the debugger
5241with breakpoints, not by pure deduction from a series of examples.
5242We recommend that you save your time for something else.
5243
5244Of course, if you can find a simpler example to report @emph{instead}
5245of the original one, that is a convenience for us. Errors in the
5246output will be easier to spot, running under the debugger will take
5247less time, and so on.
5248
5249However, simplification is not vital; if you do not want to do this,
5250report the bug anyway and send us the entire test case you used.
5251
5252@item
5253A patch for the bug.
5254
5255A patch for the bug does help us if it is a good one. But do not omit
5256the necessary information, such as the test case, on the assumption that
5257a patch is all we need. We might see problems with your patch and decide
5258to fix the problem another way, or we might not understand it at all.
5259
5260Sometimes with programs as complicated as the binary utilities it is
5261very hard to construct an example that will make the program follow a
5262certain path through the code. If you do not send us the example, we
5263will not be able to construct one, so we will not be able to verify that
5264the bug is fixed.
5265
5266And if we cannot understand what bug you are trying to fix, or why your
5267patch should be an improvement, we will not install it. A test case will
5268help us to understand.
5269
5270@item
5271A guess about what the bug is or what it depends on.
5272
5273Such guesses are usually wrong. Even we cannot guess right about such
5274things without first using the debugger to find the facts.
5275@end itemize
5276
fff279a7
NC
5277@node GNU Free Documentation License
5278@appendix GNU Free Documentation License
b3364cb9 5279
947ed062 5280@include fdl.texi
cf055d54 5281
fa0d8a3e
NC
5282@node Binutils Index
5283@unnumbered Binutils Index
252b5132
RH
5284
5285@printindex cp
5286
252b5132 5287@bye
This page took 1.125465 seconds and 4 git commands to generate.