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