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