Update objcopy's --section-alignment option so that it sets the alignment flag on...
[binutils-gdb.git] / binutils / doc / binutils.texi
blob79461559a568a260c66a39a354634d5c2ba4fa4a
1 \input texinfo       @c                    -*- Texinfo -*-
2 @setfilename binutils.info
3 @settitle @sc{gnu} Binary Utilities
4 @finalout
5 @synindex ky cp
7 @c man begin INCLUDE
8 @include bfdver.texi
9 @c man end
11 @copying
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1991-2024 Free Software Foundation, Inc.
15 Permission is granted to copy, distribute and/or modify this document
16 under the terms of the GNU Free Documentation License, Version 1.3
17 or any later version published by the Free Software Foundation;
18 with no Invariant Sections, with no Front-Cover Texts, and with no
19 Back-Cover Texts.  A copy of the license is included in the
20 section entitled ``GNU Free Documentation License''.
22 @c man end
23 @end copying
25 @dircategory Software development
26 @direntry
27 * Binutils: (binutils).         The GNU binary utilities.
28 @end direntry
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 * nm: (binutils)nm.               List symbols from object files.
38 * objcopy: (binutils)objcopy.     Copy and translate object files.
39 * objdump: (binutils)objdump.     Display information from object files.
40 * ranlib: (binutils)ranlib.       Generate index to archive contents.
41 * readelf: (binutils)readelf.     Display the contents of ELF format files.
42 * size: (binutils)size.           List section sizes and total size.
43 * strings: (binutils)strings.     List printable strings from files.
44 * strip: (binutils)strip.         Discard symbols.
45 * elfedit: (binutils)elfedit.     Update ELF header and property of ELF files.
46 * windmc: (binutils)windmc.       Generator for Windows message resources.
47 * windres: (binutils)windres.     Manipulate Windows resources.
48 @end direntry
50 @titlepage
51 @title The @sc{gnu} Binary Utilities
52 @ifset VERSION_PACKAGE
53 @subtitle @value{VERSION_PACKAGE}
54 @end ifset
55 @subtitle Version @value{VERSION}
56 @sp 1
57 @subtitle @value{UPDATED}
58 @author Roland H. Pesch
59 @author Jeffrey M. Osier
60 @author Cygnus Support
61 @page
63 @tex
64 {\parskip=0pt \hfill Cygnus Support\par \hfill
65 Texinfo \texinfoversion\par }
66 @end tex
68 @vskip 0pt plus 1filll
69 @insertcopying
70 @end titlepage
71 @contents
73 @node Top
74 @top Introduction
76 @cindex version
77 This brief manual contains documentation for the @sc{gnu} binary
78 utilities
79 @ifset VERSION_PACKAGE
80 @value{VERSION_PACKAGE}
81 @end ifset
82 version @value{VERSION}:
84 @iftex
85 @table @code
86 @item ar
87 Create, modify, and extract from archives
89 @item nm
90 List symbols from object files
92 @item objcopy
93 Copy and translate object files
95 @item objdump
96 Display information from object files
98 @item ranlib
99 Generate index to archive contents
101 @item readelf
102 Display the contents of ELF format files.
104 @item size
105 List file section sizes and total size
107 @item strings
108 List printable strings from files
110 @item strip
111 Discard symbols
113 @item elfedit
114 Update the ELF header and program property of ELF files.
116 @item c++filt
117 Demangle encoded C++ symbols (on MS-DOS, this program is named
118 @code{cxxfilt})
120 @item addr2line
121 Convert addresses or symbol+offset into file names and line numbers
123 @item windres
124 Manipulate Windows resources
126 @item windmc
127 Generator for Windows message resources
129 @item dlltool
130 Create the files needed to build and use Dynamic Link Libraries
131 @end table
132 @end iftex
134 This document is distributed under the terms of the GNU Free
135 Documentation License version 1.3.  A copy of the license is included
136 in the section entitled ``GNU Free Documentation License''.
138 @menu
139 * ar::                          Create, modify, and extract from archives
140 * nm::                          List symbols from object files
141 * objcopy::                     Copy and translate object files
142 * objdump::                     Display information from object files
143 * ranlib::                      Generate index to archive contents
144 * size::                        List section sizes and total size
145 * strings::                     List printable strings from files
146 * strip::                       Discard symbols
147 * c++filt::                     Filter to demangle encoded C++ symbols
148 * cxxfilt: c++filt.             MS-DOS name for c++filt
149 * addr2line::                   Convert addresses or symbol+offset to file and line
150 * windmc::                      Generator for Windows message resources
151 * windres::                     Manipulate Windows resources
152 * dlltool::                     Create files needed to build and use DLLs
153 * readelf::                     Display the contents of ELF format files
154 * elfedit::                     Update ELF header and property of ELF files
155 * Common Options::              Command-line options for all utilities
156 * Selecting the Target System:: How these utilities determine the target
157 * debuginfod::                  Using binutils with debuginfod
158 * Reporting Bugs::              Reporting Bugs
159 * GNU Free Documentation License::  GNU Free Documentation License
160 * Binutils Index::              Binutils Index
161 @end menu
163 @node ar
164 @chapter ar
166 @kindex ar
167 @cindex archives
168 @cindex collections of files
170 @c man title ar create, modify, and extract from archives
172 @smallexample
173 ar [-]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@option{--output} @var{dirname}] [@option{--record-libdeps} @var{libdeps}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
174 ar -M [ <mri-script ]
175 @end smallexample
177 @c man begin DESCRIPTION ar
179 The @sc{gnu} @command{ar} program creates, modifies, and extracts from
180 archives.  An @dfn{archive} is a single file holding a collection of
181 other files in a structure that makes it possible to retrieve
182 the original individual files (called @dfn{members} of the archive).
184 The original files' contents, mode (permissions), timestamp, owner, and
185 group are preserved in the archive, and can be restored on
186 extraction.
188 @cindex name length
189 @sc{gnu} @command{ar} can maintain archives whose members have names of any
190 length; however, depending on how @command{ar} is configured on your
191 system, a limit on member-name length may be imposed for compatibility
192 with archive formats maintained with other tools.  If it exists, the
193 limit is often 15 characters (typical of formats related to a.out) or 16
194 characters (typical of formats related to coff).
196 @cindex libraries
197 @command{ar} is considered a binary utility because archives of this sort
198 are most often used as @dfn{libraries} holding commonly needed
199 subroutines.  Since libraries often will depend on other libraries,
200 @command{ar} can also record the dependencies of a library when the
201 @option{--record-libdeps} option is specified.
203 @cindex symbol index
204 @command{ar} creates an index to the symbols defined in relocatable
205 object modules in the archive when you specify the modifier @samp{s}.
206 Once created, this index is updated in the archive whenever @command{ar}
207 makes a change to its contents (save for the @samp{q} update operation).
208 An archive with such an index speeds up linking to the library, and
209 allows routines in the library to call each other without regard to
210 their placement in the archive.
212 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
213 table.  If an archive lacks the table, another form of @command{ar} called
214 @command{ranlib} can be used to add just the table.
216 @cindex thin archives
217 @sc{gnu} @command{ar} can optionally create a @emph{thin} archive,
218 which contains a symbol index and references to the original copies
219 of the member files of the archive.  This is useful for building
220 libraries for use within a local build tree, where the relocatable
221 objects are expected to remain available, and copying the contents of
222 each object would only waste time and space.
224 An archive can either be @emph{thin} or it can be normal.  It cannot
225 be both at the same time.  Once an archive is created its format
226 cannot be changed without first deleting it and then creating a new
227 archive in its place.
229 Thin archives are also @emph{flattened}, so that adding one thin
230 archive to another thin archive does not nest it, as would happen with
231 a normal archive.  Instead the elements of the first archive are added
232 individually to the second archive.
234 The paths to the elements of the archive are stored relative to the
235 archive itself.
237 @cindex compatibility, @command{ar}
238 @cindex @command{ar} compatibility
239 @sc{gnu} @command{ar} is designed to be compatible with two different
240 facilities.  You can control its activity using command-line options,
241 like the different varieties of @command{ar} on Unix systems; or, if you
242 specify the single command-line option @option{-M}, you can control it
243 with a script supplied via standard input, like the MRI ``librarian''
244 program.
246 @c man end
248 @menu
249 * ar cmdline::                  Controlling @command{ar} on the command line
250 * ar scripts::                  Controlling @command{ar} with a script
251 @end menu
253 @page
254 @node ar cmdline
255 @section Controlling @command{ar} on the Command Line
257 @smallexample
258 @c man begin SYNOPSIS ar
259 ar [@option{-X32_64}] [@option{-}]@var{p}[@var{mod}] [@option{--plugin} @var{name}] [@option{--target} @var{bfdname}] [@option{--output} @var{dirname}] [@option{--record-libdeps} @var{libdeps}] [@option{--thin}] [@var{relpos}] [@var{count}] @var{archive} [@var{member}@dots{}]
260 @c man end
261 @end smallexample
263 @cindex Unix compatibility, @command{ar}
264 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
265 arguments to execute: one keyletter specifying the @emph{operation}
266 (optionally accompanied by other keyletters specifying
267 @emph{modifiers}), and the archive name to act on.
269 Most operations can also accept further @var{member} arguments,
270 specifying particular files to operate on.
272 @c man begin OPTIONS ar
274 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
275 flags @var{mod} in any order, within the first command-line argument.
277 If you wish, you may begin the first command-line argument with a
278 dash.
280 @cindex operations on archive
281 The @var{p} keyletter specifies what operation to execute; it may be
282 any of the following, but you must specify only one of them:
284 @table @samp
285 @item d
286 @cindex deleting from archive
287 @emph{Delete} modules from the archive.  Specify the names of modules to
288 be deleted as @var{member}@dots{}; the archive is untouched if you
289 specify no files to delete.
291 If you specify the @samp{v} modifier, @command{ar} lists each module
292 as it is deleted.
294 @item m
295 @cindex moving in archive
296 Use this operation to @emph{move} members in an archive.
298 The ordering of members in an archive can make a difference in how
299 programs are linked using the library, if a symbol is defined in more
300 than one member.
302 If no modifiers are used with @code{m}, any members you name in the
303 @var{member} arguments are moved to the @emph{end} of the archive;
304 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
305 specified place instead.
307 @item p
308 @cindex printing from archive
309 @emph{Print} the specified members of the archive, to the standard
310 output file.  If the @samp{v} modifier is specified, show the member
311 name before copying its contents to standard output.
313 If you specify no @var{member} arguments, all the files in the archive are
314 printed.
316 @item q
317 @cindex quick append to archive
318 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
319 @var{archive}, without checking for replacement.
321 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
322 operation; new members are always placed at the end of the archive.
324 The modifier @samp{v} makes @command{ar} list each file as it is appended.
326 Since the point of this operation is speed, implementations of
327 @command{ar} have the option of not updating the archive's symbol
328 table if one exists.  Too many different systems however assume that
329 symbol tables are always up-to-date, so @sc{gnu} @command{ar} will
330 rebuild the table even with a quick append.
332 Note - @sc{gnu} @command{ar} treats the command @samp{qs} as a
333 synonym for @samp{r} - replacing already existing files in the
334 archive and appending new ones at the end.
336 @item r
337 @cindex replacement in archive
338 Insert the files @var{member}@dots{} into @var{archive} (with
339 @emph{replacement}). This operation differs from @samp{q} in that any
340 previously existing members are deleted if their names match those being
341 added.
343 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
344 displays an error message, and leaves undisturbed any existing members
345 of the archive matching that name.
347 By default, new members are added at the end of the file; but you may
348 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
349 placement relative to some existing member.
351 The modifier @samp{v} used with this operation elicits a line of
352 output for each file inserted, along with one of the letters @samp{a} or
353 @samp{r} to indicate whether the file was appended (no old member
354 deleted) or replaced.
356 @item s
357 @cindex ranlib
358 Add an index to the archive, or update it if it already exists.  Note
359 this command is an exception to the rule that there can only be one
360 command letter, as it is possible to use it as either a command or a
361 modifier.  In either case it does the same thing.
363 @item t
364 @cindex contents of archive
365 Display a @emph{table} listing the contents of @var{archive}, or those
366 of the files listed in @var{member}@dots{} that are present in the
367 archive.  Normally only the member name is shown, but if the modifier
368 @samp{O} is specified, then the corresponding offset of the member is also
369 displayed.  Finally, in order to see the modes (permissions), timestamp,
370 owner, group, and size the @samp{v} modifier should be included.
372 If you do not specify a @var{member}, all files in the archive
373 are listed.
375 @cindex repeated names in archive
376 @cindex name duplication in archive
377 If there is more than one file with the same name (say, @samp{fie}) in
378 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
379 first instance; to see them all, you must ask for a complete
380 listing---in our example, @samp{ar t b.a}.
381 @c WRS only; per Gumby, this is implementation-dependent, and in a more
382 @c recent case in fact works the other way.
384 @item x
385 @cindex extract from archive
386 @emph{Extract} members (named @var{member}) from the archive.  You can
387 use the @samp{v} modifier with this operation, to request that
388 @command{ar} list each name as it extracts it.
390 If you do not specify a @var{member}, all files in the archive
391 are extracted.
393 Files cannot be extracted from a thin archive, and there are
394 restrictions on extracting from archives created with @option{P}: The
395 paths must not be absolute, may not contain @code{..}, and any
396 subdirectories in the paths must exist.  If it is desired to avoid
397 these restrictions then used the @option{--output} option to specify
398 an output directory.
399 @end table
401 A number of modifiers (@var{mod}) may immediately follow the @var{p}
402 keyletter, to specify variations on an operation's behavior:
404 @table @samp
405 @item a
406 @cindex relative placement in archive
407 Add new files @emph{after} an existing member of the
408 archive.  If you use the modifier @samp{a}, the name of an existing archive
409 member must be present as the @var{relpos} argument, before the
410 @var{archive} specification.
412 @item b
413 Add new files @emph{before} an existing member of the
414 archive.  If you use the modifier @samp{b}, the name of an existing archive
415 member must be present as the @var{relpos} argument, before the
416 @var{archive} specification.  (same as @samp{i}).
418 @item c
419 @cindex creating archives
420 @emph{Create} the archive.  The specified @var{archive} is always
421 created if it did not exist, when you request an update.  But a warning is
422 issued unless you specify in advance that you expect to create it, by
423 using this modifier.
425 @item D
426 @cindex deterministic archives
427 @kindex --enable-deterministic-archives
428 Operate in @emph{deterministic} mode.  When adding files and the archive
429 index use zero for UIDs, GIDs, timestamps, and use consistent file modes
430 for all files.  When this option is used, if @command{ar} is used with
431 identical options and identical input files, multiple runs will create
432 identical output files regardless of the input files' owners, groups,
433 file modes, or modification times.
435 If @file{binutils} was configured with
436 @option{--enable-deterministic-archives}, then this mode is on by default.
437 It can be disabled with the @samp{U} modifier, below.
439 @item f
440 Truncate names in the archive.  @sc{gnu} @command{ar} will normally permit file
441 names of any length.  This will cause it to create archives which are
442 not compatible with the native @command{ar} program on some systems.  If
443 this is a concern, the @samp{f} modifier may be used to truncate file
444 names when putting them in the archive.
446 @item i
447 Insert new files @emph{before} an existing member of the
448 archive.  If you use the modifier @samp{i}, the name of an existing archive
449 member must be present as the @var{relpos} argument, before the
450 @var{archive} specification.  (same as @samp{b}).
452 @item l
453 @c This modifier was accepted but not used.
454 @c whaffor ar l modifier??? presumably compat; with
455 @c what???---doc@@cygnus.com, 25jan91
456 Specify dependencies of this library.  The dependencies must immediately
457 follow this option character, must use the same syntax as the linker
458 command line, and must be specified within a single argument.  I.e., if
459 multiple items are needed, they must be quoted to form a single command
460 line argument.  For example @samp{L "-L/usr/local/lib -lmydep1 -lmydep2"}
462 @item N
463 Uses the @var{count} parameter.  This is used if there are multiple
464 entries in the archive with the same name.  Extract or delete instance
465 @var{count} of the given name from the archive.
467 @item o
468 @cindex dates in archive
469 Preserve the @emph{original} dates of members when extracting them.  If
470 you do not specify this modifier, files extracted from the archive
471 are stamped with the time of extraction.
473 @item O
474 @cindex offsets of files
475 Display member offsets inside the archive. Use together with the @samp{t}
476 option.
478 @item P
479 Use the full path name when matching or storing names in the archive.
480 Archives created with full path names are not POSIX compliant, and
481 thus may not work with tools other than up to date @sc{gnu} tools.
482 Modifying such archives with @sc{gnu} @command{ar} without using
483 @option{P} will remove the full path names unless the archive is a
484 thin archive.  Note that @option{P} may be useful when adding files to
485 a thin archive since @option{r} without @option{P} ignores the path
486 when choosing which element to replace.  Thus
487 @smallexample
488 ar rcST archive.a subdir/file1 subdir/file2 file1
489 @end smallexample
490 will result in the first @code{subdir/file1} being replaced with
491 @code{file1} from the current directory.  Adding @option{P} will
492 prevent this replacement.
494 @item s
495 @cindex writing archive index
496 Write an object-file index into the archive, or update an existing one,
497 even if no other change is made to the archive.  You may use this modifier
498 flag either with any operation, or alone.  Running @samp{ar s} on an
499 archive is equivalent to running @samp{ranlib} on it.
501 @item S
502 @cindex not writing archive index
503 Do not generate an archive symbol table.  This can speed up building a
504 large library in several steps.  The resulting archive can not be used
505 with the linker.  In order to build a symbol table, you must omit the
506 @samp{S} modifier on the last execution of @samp{ar}, or you must run
507 @samp{ranlib} on the archive.
509 @item T
510 Deprecated alias for @option{--thin}.  @option{T} is not recommended because in
511 many ar implementations @option{T} has a different meaning, as specified by
512 X/Open System Interface.
514 @item u
515 @cindex updating an archive
516 Normally, @samp{ar r}@dots{} inserts all files
517 listed into the archive.  If you would like to insert @emph{only} those
518 of the files you list that are newer than existing members of the same
519 names, use this modifier.  The @samp{u} modifier is allowed only for the
520 operation @samp{r} (replace).  In particular, the combination @samp{qu} is
521 not allowed, since checking the timestamps would lose any speed
522 advantage from the operation @samp{q}.
524 Note - if an archive has been created in a deterministic manner, eg
525 via the use of the @option{D} modifier, then replacement will always
526 happen and the @option{u} modifier will be ineffective.
528 @item U
529 @cindex deterministic archives
530 @kindex --enable-deterministic-archives
531 Do @emph{not} operate in @emph{deterministic} mode.  This is the inverse
532 of the @samp{D} modifier, above: added files and the archive index will
533 get their actual UID, GID, timestamp, and file mode values.
535 This is the default unless @file{binutils} was configured with
536 @option{--enable-deterministic-archives}.
538 @item v
539 This modifier requests the @emph{verbose} version of an operation.  Many
540 operations display additional information, such as filenames processed,
541 when the modifier @samp{v} is appended.
543 @item V
544 This modifier shows the version number of @command{ar}.
545 @end table
547 The @command{ar} program also supports some command-line options which
548 are neither modifiers nor actions, but which do change its behaviour
549 in specific ways:
551 @table @samp
552 @item --help
553 Displays the list of command-line options supported by @command{ar}
554 and then exits.
556 @item --version
557 Displays the version information of @command{ar} and then exits.
559 @item -X32_64
560 @command{ar} ignores an initial option spelled @samp{-X32_64}, for
561 compatibility with AIX.  The behaviour produced by this option is the
562 default for @sc{gnu} @command{ar}.  @command{ar} does not support any
563 of the other @samp{-X} options; in particular, it does not support
564 @option{-X32} which is the default for AIX @command{ar}.
566 @item --plugin @var{name}
567 @cindex plugins
568 The optional command-line switch @option{--plugin @var{name}} causes
569 @command{ar} to load the plugin called @var{name} which adds support
570 for more file formats, including object files with link-time
571 optimization information.
573 This option is only available if the toolchain has been built with
574 plugin support enabled.
576 If @option{--plugin} is not provided, but plugin support has been
577 enabled then @command{ar} iterates over the files in
578 @file{$@{libdir@}/bfd-plugins} in alphabetic order and the first
579 plugin that claims the object in question is used.
581 Please note that this plugin search directory is @emph{not} the one
582 used by @command{ld}'s @option{-plugin} option.  In order to make
583 @command{ar} use the  linker plugin it must be copied into the
584 @file{$@{libdir@}/bfd-plugins} directory.  For GCC based compilations
585 the linker plugin is called @file{liblto_plugin.so.0.0.0}.  For Clang
586 based compilations it is called @file{LLVMgold.so}.  The GCC plugin
587 is always backwards compatible with earlier versions, so it is
588 sufficient to just copy the newest one.
590 @item --target @var{target}
591 The optional command-line switch @option{--target @var{bfdname}}
592 specifies that the archive members are in an object code format
593 different from your system's default format.  See
594 @xref{Target Selection}, for more information.
596 @item --output @var{dirname}
597 The @option{--output} option can be used to specify a path to a
598 directory into which archive members should be extracted.  If this
599 option is not specified then the current directory will be used.
601 Note - although the presence of this option does imply a @option{x} 
602 extraction operation that option must still be included on the command
603 line.
605 @item --record-libdeps @var{libdeps}
606 The @option{--record-libdeps} option is identical to the @option{l} modifier,
607 just handled in long form.
609 @item --thin
610 @cindex creating thin archive
611 Make the specified @var{archive} a @emph{thin} archive.  If it already
612 exists and is a regular archive, the existing members must be present
613 in the same directory as @var{archive}.
615 @end table
616 @c man end
618 @ignore
619 @c man begin SEEALSO ar
620 nm(1), ranlib(1), and the Info entries for @file{binutils}.
621 @c man end
622 @end ignore
624 @node ar scripts
625 @section Controlling @command{ar} with a Script
627 @smallexample
628 ar -M [ <@var{script} ]
629 @end smallexample
631 @cindex MRI compatibility, @command{ar}
632 @cindex scripts, @command{ar}
633 If you use the single command-line option @samp{-M} with @command{ar}, you
634 can control its operation with a rudimentary command language.  This
635 form of @command{ar} operates interactively if standard input is coming
636 directly from a terminal.  During interactive use, @command{ar} prompts for
637 input (the prompt is @samp{AR >}), and continues executing even after
638 errors.  If you redirect standard input to a script file, no prompts are
639 issued, and @command{ar} abandons execution (with a nonzero exit code)
640 on any error.
642 The @command{ar} command language is @emph{not} designed to be equivalent
643 to the command-line options; in fact, it provides somewhat less control
644 over archives.  The only purpose of the command language is to ease the
645 transition to @sc{gnu} @command{ar} for developers who already have scripts
646 written for the MRI ``librarian'' program.
648 The syntax for the @command{ar} command language is straightforward:
649 @itemize @bullet
650 @item
651 commands are recognized in upper or lower case; for example, @code{LIST}
652 is the same as @code{list}.  In the following descriptions, commands are
653 shown in upper case for clarity.
655 @item
656 a single command may appear on each line; it is the first word on the
657 line.
659 @item
660 empty lines are allowed, and have no effect.
662 @item
663 comments are allowed; text after either of the characters @samp{*}
664 or @samp{;} is ignored.
666 @item
667 Whenever you use a list of names as part of the argument to an @command{ar}
668 command, you can separate the individual names with either commas or
669 blanks.  Commas are shown in the explanations below, for clarity.
671 @item
672 @samp{+} is used as a line continuation character; if @samp{+} appears
673 at the end of a line, the text on the following line is considered part
674 of the current command.
675 @end itemize
677 Here are the commands you can use in @command{ar} scripts, or when using
678 @command{ar} interactively.  Three of them have special significance:
680 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
681 a temporary file required for most of the other commands.
683 @code{SAVE} commits the changes so far specified by the script.  Prior
684 to @code{SAVE}, commands affect only the temporary copy of the current
685 archive.
687 @table @code
688 @item ADDLIB @var{archive}
689 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
690 Add all the contents of @var{archive} (or, if specified, each named
691 @var{module} from @var{archive}) to the current archive.
693 Requires prior use of @code{OPEN} or @code{CREATE}.
695 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
696 @c FIXME! w/Replacement??  If so, like "ar r @var{archive} @var{names}"
697 @c        else like "ar q..."
698 Add each named @var{member} as a module in the current archive.
700 Requires prior use of @code{OPEN} or @code{CREATE}.
702 @item CLEAR
703 Discard the contents of the current archive, canceling the effect of
704 any operations since the last @code{SAVE}.  May be executed (with no
705 effect) even if  no current archive is specified.
707 @item CREATE @var{archive}
708 Creates an archive, and makes it the current archive (required for many
709 other commands).  The new archive is created with a temporary name; it
710 is not actually saved as @var{archive} until you use @code{SAVE}.
711 You can overwrite existing archives; similarly, the contents of any
712 existing file named @var{archive} will not be destroyed until @code{SAVE}.
714 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
715 Delete each listed @var{module} from the current archive; equivalent to
716 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
718 Requires prior use of @code{OPEN} or @code{CREATE}.
720 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
721 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
722 List each named @var{module} present in @var{archive}.  The separate
723 command @code{VERBOSE} specifies the form of the output: when verbose
724 output is off, output is like that of @samp{ar -t @var{archive}
725 @var{module}@dots{}}.  When verbose output is on, the listing is like
726 @samp{ar -tv @var{archive} @var{module}@dots{}}.
728 Output normally goes to the standard output stream; however, if you
729 specify @var{outputfile} as a final argument, @command{ar} directs the
730 output to that file.
732 @item END
733 Exit from @command{ar}, with a @code{0} exit code to indicate successful
734 completion.  This command does not save the output file; if you have
735 changed the current archive since the last @code{SAVE} command, those
736 changes are lost.
738 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
739 Extract each named @var{module} from the current archive, writing them
740 into the current directory as separate files.  Equivalent to @samp{ar -x
741 @var{archive} @var{module}@dots{}}.
743 Requires prior use of @code{OPEN} or @code{CREATE}.
745 @ignore
746 @c FIXME Tokens but no commands???
747 @item FULLDIR
749 @item HELP
750 @end ignore
752 @item LIST
753 Display full contents of the current archive, in ``verbose'' style
754 regardless of the state of @code{VERBOSE}.  The effect is like @samp{ar
755 tv @var{archive}}.  (This single command is a @sc{gnu} @command{ar}
756 enhancement, rather than present for MRI compatibility.)
758 Requires prior use of @code{OPEN} or @code{CREATE}.
760 @item OPEN @var{archive}
761 Opens an existing archive for use as the current archive (required for
762 many other commands).  Any changes as the result of subsequent commands
763 will not actually affect @var{archive} until you next use @code{SAVE}.
765 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
766 In the current archive, replace each existing @var{module} (named in
767 the @code{REPLACE} arguments) from files in the current working directory.
768 To execute this command without errors, both the file, and the module in
769 the current archive, must exist.
771 Requires prior use of @code{OPEN} or @code{CREATE}.
773 @item VERBOSE
774 Toggle an internal flag governing the output from @code{DIRECTORY}.
775 When the flag is on, @code{DIRECTORY} output matches output from
776 @samp{ar -tv }@dots{}.
778 @item SAVE
779 Commit your changes to the current archive, and actually save it as a
780 file with the name specified in the last @code{CREATE} or @code{OPEN}
781 command.
783 Requires prior use of @code{OPEN} or @code{CREATE}.
785 @end table
787 @iftex
788 @node ld
789 @chapter ld
790 @cindex linker
791 @kindex ld
792 The @sc{gnu} linker @command{ld} is now described in a separate manual.
793 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
794 @end iftex
796 @node nm
797 @chapter nm
798 @cindex symbols
799 @kindex nm
801 @c man title nm list symbols from object files
803 @smallexample
804 @c man begin SYNOPSIS nm
805 nm [@option{-A}|@option{-o}|@option{--print-file-name}]
806    [@option{-a}|@option{--debug-syms}]
807    [@option{-B}|@option{--format=bsd}]
808    [@option{-C}|@option{--demangle}[=@var{style}]]
809    [@option{-D}|@option{--dynamic}]
810    [@option{-f}@var{format}|@option{--format=}@var{format}]
811    [@option{-g}|@option{--extern-only}]
812    [@option{-h}|@option{--help}]
813    [@option{--ifunc-chars=@var{CHARS}}]
814    [@option{-j}|@option{--format=just-symbols}]
815    [@option{-l}|@option{--line-numbers}] [@option{--inlines}]
816    [@option{-n}|@option{-v}|@option{--numeric-sort}]
817    [@option{-P}|@option{--portability}]
818    [@option{-p}|@option{--no-sort}]
819    [@option{-r}|@option{--reverse-sort}]
820    [@option{-S}|@option{--print-size}]
821    [@option{-s}|@option{--print-armap}]
822    [@option{-t} @var{radix}|@option{--radix=}@var{radix}]
823    [@option{-u}|@option{--undefined-only}]
824    [@option{-U}|@option{--defined-only}]
825    [@option{-V}|@option{--version}]
826    [@option{-W}|@option{--no-weak}]
827    [@option{-X 32_64}]
828    [@option{--no-demangle}]
829    [@option{--no-recurse-limit}|@option{--recurse-limit}]]
830    [@option{--plugin} @var{name}]
831    [@option{--size-sort}]
832    [@option{--special-syms}]
833    [@option{--synthetic}]
834    [@option{--target=}@var{bfdname}]
835    [@option{--unicode=}@var{method}]
836    [@option{--with-symbol-versions}]
837    [@option{--without-symbol-versions}]
838    [@var{objfile}@dots{}]
839 @c man end
840 @end smallexample
842 @c man begin DESCRIPTION nm
843 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
844 If no object files are listed as arguments, @command{nm} assumes the file
845 @file{a.out}.
847 For each symbol, @command{nm} shows:
849 @itemize @bullet
850 @item
851 The symbol value, in the radix selected by options (see below), or
852 hexadecimal by default.
854 @item
855 The symbol type.  At least the following types are used; others are, as
856 well, depending on the object file format.  If lowercase, the symbol is
857 usually local; if uppercase, the symbol is global (external).  There
858 are however a few lowercase symbols that are shown for special global
859 symbols (@code{u}, @code{v} and @code{w}).
861 @c Some more detail on exactly what these symbol types are used for
862 @c would be nice.
863 @table @code
864 @item A
865 The symbol's value is absolute, and will not be changed by further
866 linking.
868 @item B
869 @itemx b
870 The symbol is in the BSS data section.  This section typically
871 contains zero-initialized or uninitialized data, although the exact
872 behavior is system dependent.
874 @item C
875 @itemx c
876 The symbol is common.  Common symbols are uninitialized data.  When
877 linking, multiple common symbols may appear with the same name.  If the
878 symbol is defined anywhere, the common symbols are treated as undefined
879 references.
880 @ifclear man
881 For more details on common symbols, see the discussion of
882 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
883 @end ifclear
884 The lower case @var{c} character is used when the symbol is in a
885 special section for small commons.
887 @item D
888 @itemx d
889 The symbol is in the initialized data section.
891 @item G
892 @itemx g
893 The symbol is in an initialized data section for small objects.  Some
894 object file formats permit more efficient access to small data objects,
895 such as a global int variable as opposed to a large global array.
897 @item i
898 For PE format files this indicates that the symbol is in a section
899 specific to the implementation of DLLs.
901 For ELF format files this indicates that the symbol is an indirect
902 function.  This is a GNU extension to the standard set of ELF symbol
903 types.  It indicates a symbol which if referenced by a relocation does
904 not evaluate to its address, but instead must be invoked at runtime.
905 The runtime execution will then return the value to be used in the
906 relocation.
908 Note - the actual symbols display for GNU indirect symbols is
909 controlled by the @option{--ifunc-chars} command line option.  If this
910 option has been provided then the first character in the string will
911 be used for global indirect function symbols.  If the string contains
912 a second character then that will be used for local indirect function
913 symbols.
915 @item I
916 The symbol is an indirect reference to another symbol.
918 @item N
919 The symbol is a debugging symbol.
921 @item n
922 The symbol is in a non-data, non-code, non-debug read-only section.
924 @item p
925 The symbol is in a stack unwind section.
927 @item R
928 @itemx r
929 The symbol is in a read only data section.
931 @item S
932 @itemx s
933 The symbol is in an uninitialized or zero-initialized data section
934 for small objects.
936 @item T
937 @itemx t
938 The symbol is in the text (code) section.
940 @item U
941 The symbol is undefined.
943 @item u
944 The symbol is a unique global symbol.  This is a GNU extension to the
945 standard set of ELF symbol bindings.  For such a symbol the dynamic linker
946 will make sure that in the entire process there is just one symbol with
947 this name and type in use.
949 @item V
950 @itemx v
951 The symbol is a weak object.  When a weak defined symbol is linked with
952 a normal defined symbol, the normal defined symbol is used with no error.
953 When a weak undefined symbol is linked and the symbol is not defined,
954 the value of the weak symbol becomes zero with no error.  On some
955 systems, uppercase indicates that a default value has been specified.
957 @item W
958 @itemx w
959 The symbol is a weak symbol that has not been specifically tagged as a
960 weak object symbol.  When a weak defined symbol is linked with a normal
961 defined symbol, the normal defined symbol is used with no error.
962 When a weak undefined symbol is linked and the symbol is not defined,
963 the value of the symbol is determined in a system-specific manner without
964 error.  On some systems, uppercase indicates that a default value has been
965 specified.
967 @item -
968 The symbol is a stabs symbol in an a.out object file.  In this case, the
969 next values printed are the stabs other field, the stabs desc field, and
970 the stab type.  Stabs symbols are used to hold debugging information.
972 @item ?
973 The symbol type is unknown, or object file format specific.
974 @end table
976 @item
977 The symbol name.  If a symbol has version information associated with it,
978 then the version information is displayed as well.  If the versioned
979 symbol is undefined or hidden from linker, the version string is displayed
980 as a suffix to the symbol name, preceded by an @@ character.  For example
981 @samp{foo@@VER_1}.  If the version is the default version to be used when
982 resolving unversioned references to the symbol, then it is displayed as a
983 suffix preceded by two @@ characters.  For example @samp{foo@@@@VER_2}.
984 @end itemize
986 @c man end
988 @c man begin OPTIONS nm
989 The long and short forms of options, shown here as alternatives, are
990 equivalent.
992 @table @env
993 @item -A
994 @itemx -o
995 @itemx --print-file-name
996 @cindex input file name
997 @cindex file name
998 @cindex source file name
999 Precede each symbol by the name of the input file (or archive member)
1000 in which it was found, rather than identifying the input file once only,
1001 before all of its symbols.
1003 @item -a
1004 @itemx --debug-syms
1005 @cindex debugging symbols
1006 Display all symbols, even debugger-only symbols; normally these are not
1007 listed.
1009 @item -B
1010 @cindex @command{nm} format
1011 @cindex @command{nm} compatibility
1012 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
1014 @item -C
1015 @itemx --demangle[=@var{style}]
1016 @cindex demangling in nm
1017 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1018 Besides removing any initial underscore prepended by the system, this
1019 makes C++ function names readable. Different compilers have different
1020 mangling styles. The optional demangling style argument can be used to
1021 choose an appropriate demangling style for your compiler. @xref{c++filt},
1022 for more information on demangling.
1024 @item --no-demangle
1025 Do not demangle low-level symbol names.  This is the default.
1027 @item --recurse-limit
1028 @itemx --no-recurse-limit
1029 @itemx --recursion-limit
1030 @itemx --no-recursion-limit
1031 Enables or disables a limit on the amount of recursion performed
1032 whilst demangling strings.  Since the name mangling formats allow for
1033 an infinite level of recursion it is possible to create strings whose
1034 decoding will exhaust the amount of stack space available on the host
1035 machine, triggering a memory fault.  The limit tries to prevent this
1036 from happening by restricting recursion to 2048 levels of nesting.
1038 The default is for this limit to be enabled, but disabling it may be
1039 necessary in order to demangle truly complicated names.  Note however
1040 that if the recursion limit is disabled then stack exhaustion is
1041 possible and any bug reports about such an event will be rejected.
1043 @item -D
1044 @itemx --dynamic
1045 @cindex dynamic symbols
1046 Display the dynamic symbols rather than the normal symbols.  This is
1047 only meaningful for dynamic objects, such as certain types of shared
1048 libraries.
1050 @item -f @var{format}
1051 @itemx --format=@var{format}
1052 @cindex @command{nm} format
1053 @cindex @command{nm} compatibility
1054 Use the output format @var{format}, which can be @code{bsd},
1055 @code{sysv}, @code{posix} or @code{just-symbols}.  The default is @code{bsd}.
1056 Only the first character of @var{format} is significant; it can be
1057 either upper or lower case.
1059 @item -g
1060 @itemx --extern-only
1061 @cindex external symbols
1062 Display only external symbols.
1064 @item -h
1065 @itemx --help
1066 Show a summary of the options to @command{nm} and exit.
1068 @item --ifunc-chars=@var{CHARS}
1069 When display GNU indirect function symbols @command{nm} will default
1070 to using the @code{i} character for both local indirect functions and
1071 global indirect functions.  The @option{--ifunc-chars} option allows
1072 the user to specify a string containing one or two characters. The
1073 first character will be used for global indirect function symbols and
1074 the second character, if present, will be used for local indirect
1075 function symbols.
1077 @item j
1078 The same as @option{--format=just-symbols}.
1080 @item -l
1081 @itemx --line-numbers
1082 @cindex symbol line numbers
1083 For each symbol, use debugging information to try to find a filename and
1084 line number.  For a defined symbol, look for the line number of the
1085 address of the symbol.  For an undefined symbol, look for the line
1086 number of a relocation entry which refers to the symbol.  If line number
1087 information can be found, print it after the other symbol information.
1089 @item --inlines
1090 @cindex objdump inlines
1091 When option @option{-l} is active, if the address belongs to a
1092 function that was inlined, then this option causes the source 
1093 information for all enclosing scopes back to the first non-inlined
1094 function to be printed as well.  For example, if @code{main} inlines
1095 @code{callee1} which inlines @code{callee2}, and address is from
1096 @code{callee2}, the source information for @code{callee1} and @code{main}
1097 will also be printed.
1099 @item -n
1100 @itemx -v
1101 @itemx --numeric-sort
1102 Sort symbols numerically by their addresses, rather than alphabetically
1103 by their names.
1105 @item -p
1106 @itemx --no-sort
1107 @cindex sorting symbols
1108 Do not bother to sort the symbols in any order; print them in the order
1109 encountered.
1111 @item -P
1112 @itemx --portability
1113 Use the POSIX.2 standard output format instead of the default format.
1114 Equivalent to @samp{-f posix}.
1116 @item -r
1117 @itemx --reverse-sort
1118 Reverse the order of the sort (whether numeric or alphabetic); let the
1119 last come first.
1121 @item -S
1122 @itemx --print-size
1123 Print both value and size of defined symbols for the @code{bsd} output style.
1124 This option has no effect for object formats that do not record symbol
1125 sizes, unless @samp{--size-sort} is also used in which case a
1126 calculated size is displayed.
1128 @item -s
1129 @itemx --print-armap
1130 @cindex symbol index, listing
1131 When listing symbols from archive members, include the index: a mapping
1132 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
1133 contain definitions for which names.
1135 @item -t @var{radix}
1136 @itemx --radix=@var{radix}
1137 Use @var{radix} as the radix for printing the symbol values.  It must be
1138 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
1140 @item -u
1141 @itemx --undefined-only
1142 @cindex external symbols
1143 @cindex undefined symbols
1144 Display only undefined symbols (those external to each object file).
1145 By default both defined and undefined symbols are displayed.
1147 @item -U
1148 @itemx --defined-only
1149 @cindex external symbols
1150 @cindex undefined symbols
1151 Display only defined symbols for each object file.
1152 By default both defined and undefined symbols are displayed.
1154 @item -V
1155 @itemx --version
1156 Show the version number of @command{nm} and exit.
1158 @item -X
1159 This option is ignored for compatibility with the AIX version of
1160 @command{nm}.  It takes one parameter which must be the string
1161 @option{32_64}.  The default mode of AIX @command{nm} corresponds
1162 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
1164 @item --plugin @var{name}
1165 @cindex plugins
1166 Load the plugin called @var{name} to add support for extra target
1167 types.  This option is only available if the toolchain has been built
1168 with plugin support enabled.
1170 If @option{--plugin} is not provided, but plugin support has been
1171 enabled then @command{nm} iterates over the files in
1172 @file{$@{libdir@}/bfd-plugins} in alphabetic order and the first
1173 plugin that claims the object in question is used.
1175 Please note that this plugin search directory is @emph{not} the one
1176 used by @command{ld}'s @option{-plugin} option.  In order to make
1177 @command{nm} use the  linker plugin it must be copied into the
1178 @file{$@{libdir@}/bfd-plugins} directory.  For GCC based compilations
1179 the linker plugin is called @file{liblto_plugin.so.0.0.0}.  For Clang
1180 based compilations it is called @file{LLVMgold.so}.  The GCC plugin
1181 is always backwards compatible with earlier versions, so it is
1182 sufficient to just copy the newest one.
1184 @item --size-sort
1185 Sort symbols by size.  For ELF objects symbol sizes are read from the
1186 ELF, for other object types the symbol sizes are computed as the
1187 difference between the value of the symbol and the value of the symbol
1188 with the next higher value.  If the @code{bsd} output format is used
1189 the size of the symbol is printed, rather than the value, and
1190 @samp{-S} must be used in order both size and value to be printed.
1192 Note - this option does not work if @option{--undefined-only} has been
1193 enabled as undefined symbols have no size.
1195 @item --special-syms
1196 Display symbols which have a target-specific special meaning.  These
1197 symbols are usually used by the target for some special processing and
1198 are not normally helpful when included in the normal symbol lists.
1199 For example for ARM targets this option would skip the mapping symbols
1200 used to mark transitions between ARM code, THUMB code and data.
1202 @item --synthetic
1203 Include synthetic symbols in the output.  These are special symbols
1204 created by the linker for various purposes.  They are not shown by
1205 default since they are not part of the binary's original source code.
1207 @item --unicode=@var{[default|invalid|locale|escape|hex|highlight]}
1208 Controls the display of UTF-8 encoded multibyte characters in strings.
1209 The default (@option{--unicode=default}) is to give them no special
1210 treatment.  The @option{--unicode=locale} option displays the sequence
1211 in the current locale, which may or may not support them.  The options
1212 @option{--unicode=hex} and @option{--unicode=invalid} display them as
1213 hex byte sequences enclosed by either angle brackets or curly braces.
1215 The @option{--unicode=escape} option displays them as escape sequences
1216 (@var{\uxxxx}) and the @option{--unicode=highlight} option displays
1217 them as escape sequences highlighted in red (if supported by the
1218 output device).  The colouring is intended to draw attention to the
1219 presence of unicode sequences where they might not be expected.
1221 @item -W
1222 @itemx --no-weak
1223 Do not display weak symbols.
1225 @item --with-symbol-versions
1226 @item --without-symbol-versions
1227 Enables or disables the display of symbol version information.  The
1228 version string is displayed as a suffix to the symbol name, preceded
1229 by an @@ character.  For example @samp{foo@@VER_1}.  If the version is
1230 the default version to be used when resolving unversioned references
1231 to the symbol then it is displayed as a suffix preceded by two @@
1232 characters.  For example @samp{foo@@@@VER_2}.  By default, symbol
1233 version information is displayed.
1235 @item --target=@var{bfdname}
1236 @cindex object code format
1237 Specify an object code format other than your system's default format.
1238 @xref{Target Selection}, for more information.
1240 @end table
1242 @c man end
1244 @ignore
1245 @c man begin SEEALSO nm
1246 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1247 @c man end
1248 @end ignore
1250 @node objcopy
1251 @chapter objcopy
1253 @c man title objcopy copy and translate object files
1255 @smallexample
1256 @c man begin SYNOPSIS objcopy
1257 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1258         [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1259         [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1260         [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1261         [@option{-S}|@option{--strip-all}]
1262         [@option{-g}|@option{--strip-debug}]
1263         [@option{--strip-unneeded}]
1264         [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1265         [@option{--keep-file-symbols}]
1266         [@option{--keep-section-symbols}]
1267         [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1268         [@option{--strip-unneeded-symbol=}@var{symbolname}]
1269         [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1270         [@option{--localize-hidden}]
1271         [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1272         [@option{--globalize-symbol=}@var{symbolname}]
1273         [@option{--globalize-symbols=}@var{filename}]
1274         [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1275         [@option{-w}|@option{--wildcard}]
1276         [@option{-x}|@option{--discard-all}]
1277         [@option{-X}|@option{--discard-locals}]
1278         [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1279         [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1280         [@option{--interleave-width=}@var{width}]
1281         [@option{-j} @var{sectionpattern}|@option{--only-section=}@var{sectionpattern}]
1282         [@option{-R} @var{sectionpattern}|@option{--remove-section=}@var{sectionpattern}]
1283         [@option{--keep-section=}@var{sectionpattern}]
1284         [@option{--remove-relocations=}@var{sectionpattern}]
1285         [@option{--strip-section-headers}]
1286         [@option{-p}|@option{--preserve-dates}]
1287         [@option{-D}|@option{--enable-deterministic-archives}]
1288         [@option{-U}|@option{--disable-deterministic-archives}]
1289         [@option{--debugging}]
1290         [@option{--gap-fill=}@var{val}]
1291         [@option{--pad-to=}@var{address}]
1292         [@option{--set-start=}@var{val}]
1293         [@option{--adjust-start=}@var{incr}]
1294         [@option{--change-addresses=}@var{incr}]
1295         [@option{--change-section-address} @var{sectionpattern}@{=,+,-@}@var{val}]
1296         [@option{--change-section-lma} @var{sectionpattern}@{=,+,-@}@var{val}]
1297         [@option{--change-section-vma} @var{sectionpattern}@{=,+,-@}@var{val}]
1298         [@option{--change-warnings}] [@option{--no-change-warnings}]
1299         [@option{--set-section-flags} @var{sectionpattern}=@var{flags}]
1300         [@option{--set-section-alignment} @var{sectionpattern}=@var{align}]
1301         [@option{--add-section} @var{sectionname}=@var{filename}]
1302         [@option{--dump-section} @var{sectionname}=@var{filename}]
1303         [@option{--update-section} @var{sectionname}=@var{filename}]
1304         [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1305         [@option{--long-section-names} @{enable,disable,keep@}]
1306         [@option{--change-leading-char}] [@option{--remove-leading-char}]
1307         [@option{--reverse-bytes=}@var{num}]
1308         [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1309         [@option{--redefine-sym} @var{old}=@var{new}]
1310         [@option{--redefine-syms=}@var{filename}]
1311         [@option{--weaken}]
1312         [@option{--keep-symbols=}@var{filename}]
1313         [@option{--strip-symbols=}@var{filename}]
1314         [@option{--strip-unneeded-symbols=}@var{filename}]
1315         [@option{--keep-global-symbols=}@var{filename}]
1316         [@option{--localize-symbols=}@var{filename}]
1317         [@option{--weaken-symbols=}@var{filename}]
1318         [@option{--add-symbol} @var{name}=[@var{section}:]@var{value}[,@var{flags}]]
1319         [@option{--alt-machine-code=}@var{index}]
1320         [@option{--prefix-symbols=}@var{string}]
1321         [@option{--prefix-sections=}@var{string}]
1322         [@option{--prefix-alloc-sections=}@var{string}]
1323         [@option{--add-gnu-debuglink=}@var{path-to-file}]
1324         [@option{--only-keep-debug}]
1325         [@option{--strip-dwo}]
1326         [@option{--extract-dwo}]
1327         [@option{--extract-symbol}]
1328         [@option{--writable-text}]
1329         [@option{--readonly-text}]
1330         [@option{--pure}]
1331         [@option{--impure}]
1332         [@option{--file-alignment=}@var{num}]
1333         [@option{--heap=}@var{reserve}[,@var{commit}]]
1334         [@option{--image-base=}@var{address}]
1335         [@option{--section-alignment=}@var{num}]
1336         [@option{--stack=}@var{reserve}[,@var{commit}]]
1337         [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1338         [@option{--compress-debug-sections}]
1339         [@option{--decompress-debug-sections}]
1340         [@option{--elf-stt-common=@var{val}}]
1341         [@option{--merge-notes}]
1342         [@option{--no-merge-notes}]
1343         [@option{--verilog-data-width=@var{val}}]
1344         [@option{-v}|@option{--verbose}]
1345         [@option{-V}|@option{--version}]
1346         [@option{--help}] [@option{--info}]
1347         @var{infile} [@var{outfile}]
1348 @c man end
1349 @end smallexample
1351 @c man begin DESCRIPTION objcopy
1352 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1353 file to another.  @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1354 read and write the object files.  It can write the destination object
1355 file in a format different from that of the source object file.  The
1356 exact behavior of @command{objcopy} is controlled by command-line options.
1357 Note that @command{objcopy} should be able to copy a fully linked file
1358 between any two formats. However, copying a relocatable object file
1359 between any two formats may not work as expected.
1361 @command{objcopy} creates temporary files to do its translations and
1362 deletes them afterward.  @command{objcopy} uses @sc{bfd} to do all its
1363 translation work; it has access to all the formats described in @sc{bfd}
1364 and thus is able to recognize most formats without being told
1365 explicitly.  @xref{BFD,,BFD,ld.info,Using LD}.
1367 @command{objcopy} can be used to generate S-records by using an output
1368 target of @samp{srec} (e.g., use @samp{-O srec}).
1370 @command{objcopy} can be used to generate a raw binary file by using an
1371 output target of @samp{binary} (e.g., use @option{-O binary}).  When
1372 @command{objcopy} generates a raw binary file, it will essentially produce
1373 a memory dump of the contents of the input object file.  All symbols and
1374 relocation information will be discarded.  The memory dump will start at
1375 the load address of the lowest section copied into the output file.
1377 When generating an S-record or a raw binary file, it may be helpful to
1378 use @option{-S} to remove sections containing debugging information.  In
1379 some cases @option{-R} will be useful to remove sections which contain
1380 information that is not needed by the binary file.
1382 Note---@command{objcopy} is not able to change the endianness of its input
1383 files.  If the input format has an endianness (some formats do not),
1384 @command{objcopy} can only copy the inputs into file formats that have the
1385 same endianness or which have no endianness (e.g., @samp{srec}).
1386 (However, see the @option{--reverse-bytes} option.)
1388 @c man end
1390 @c man begin OPTIONS objcopy
1392 @table @env
1393 @item @var{infile}
1394 @itemx @var{outfile}
1395 The input and output files, respectively.
1396 If you do not specify @var{outfile}, @command{objcopy} creates a
1397 temporary file and destructively renames the result with
1398 the name of @var{infile}.
1400 @item -I @var{bfdname}
1401 @itemx --input-target=@var{bfdname}
1402 Consider the source file's object format to be @var{bfdname}, rather than
1403 attempting to deduce it.  @xref{Target Selection}, for more information.
1405 @item -O @var{bfdname}
1406 @itemx --output-target=@var{bfdname}
1407 Write the output file using the object format @var{bfdname}.
1408 @xref{Target Selection}, for more information.
1410 @item -F @var{bfdname}
1411 @itemx --target=@var{bfdname}
1412 Use @var{bfdname} as the object format for both the input and the output
1413 file; i.e., simply transfer data from source to destination with no
1414 translation.  @xref{Target Selection}, for more information.
1416 @item -B @var{bfdarch}
1417 @itemx --binary-architecture=@var{bfdarch}
1418 Useful when transforming a architecture-less input file into an object file.
1419 In this case the output architecture can be set to @var{bfdarch}.  This
1420 option will be ignored if the input file has a known @var{bfdarch}.  You
1421 can access this binary data inside a program by referencing the special
1422 symbols that are created by the conversion process.  These symbols are
1423 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1424 _binary_@var{objfile}_size.  e.g. you can transform a picture file into
1425 an object file and then access it in your code using these symbols.
1427 @item -j @var{sectionpattern}
1428 @itemx --only-section=@var{sectionpattern}
1429 Copy only the indicated sections from the input file to the output file.
1430 This option may be given more than once.  Note that using this option
1431 inappropriately may make the output file unusable.  Wildcard
1432 characters are accepted in @var{sectionpattern}.
1434 If the first character of @var{sectionpattern} is the exclamation
1435 point (!) then matching sections will not be copied, even if earlier
1436 use of @option{--only-section} on the same command line would
1437 otherwise copy it.  For example:
1439 @smallexample
1440   --only-section=.text.* --only-section=!.text.foo
1441 @end smallexample
1443 will copy all sectinos matching '.text.*' but not the section
1444 '.text.foo'.
1446 @item -R @var{sectionpattern}
1447 @itemx --remove-section=@var{sectionpattern}
1448 Remove any section matching @var{sectionpattern} from the output file.
1449 This option may be given more than once.  Note that using this option
1450 inappropriately may make the output file unusable.  Wildcard
1451 characters are accepted in @var{sectionpattern}.  Using both the
1452 @option{-j} and @option{-R} options together results in undefined
1453 behaviour.
1455 If the first character of @var{sectionpattern} is the exclamation
1456 point (!) then matching sections will not be removed even if an
1457 earlier use of @option{--remove-section} on the same command line
1458 would otherwise remove it.  For example:
1460 @smallexample
1461   --remove-section=.text.* --remove-section=!.text.foo
1462 @end smallexample
1464 will remove all sections matching the pattern '.text.*', but will not
1465 remove the section '.text.foo'.
1467 @item --keep-section=@var{sectionpattern}
1468 When removing sections from the output file, keep sections that match
1469 @var{sectionpattern}.
1471 @item --remove-relocations=@var{sectionpattern}
1472 Remove non-dynamic relocations from the output file for any section
1473 matching @var{sectionpattern}.  This option may be given more than
1474 once.  Note that using this option inappropriately may make the output
1475 file unusable, and attempting to remove a dynamic relocation section
1476 such as @samp{.rela.plt} from an executable or shared library with
1477 @option{--remove-relocations=.plt} will not work.  Wildcard characters
1478 are accepted in @var{sectionpattern}.
1479 For example:
1481 @smallexample
1482   --remove-relocations=.text.*
1483 @end smallexample
1485 will remove the relocations for all sections matching the pattern
1486 '.text.*'.
1488 If the first character of @var{sectionpattern} is the exclamation
1489 point (!) then matching sections will not have their relocation
1490 removed even if an earlier use of @option{--remove-relocations} on the
1491 same command line would otherwise cause the relocations to be removed.
1492 For example:
1494 @smallexample
1495   --remove-relocations=.text.* --remove-relocations=!.text.foo
1496 @end smallexample
1498 will remove all relocations for sections matching the pattern
1499 '.text.*', but will not remove relocations for the section
1500 '.text.foo'.
1502 @item --strip-section-headers
1503 Strip section header   This option is specific to ELF files.
1504 Implies @option{--strip-all} and @option{--merge-notes}.
1506 @item -S
1507 @itemx --strip-all
1508 Do not copy relocation and symbol information from the source file.
1509 Also deletes debug sections.
1511 @item -g
1512 @itemx --strip-debug
1513 Do not copy debugging symbols or sections from the source file.
1515 @item --strip-unneeded
1516 Remove all symbols that are not needed for relocation processing in
1517 addition to debugging symbols and sections stripped by
1518 @option{--strip-debug}.
1520 @item -K @var{symbolname}
1521 @itemx --keep-symbol=@var{symbolname}
1522 When stripping symbols, keep symbol @var{symbolname} even if it would
1523 normally be stripped.  This option may be given more than once.
1525 @item -N @var{symbolname}
1526 @itemx --strip-symbol=@var{symbolname}
1527 Do not copy symbol @var{symbolname} from the source file.  This option
1528 may be given more than once.
1530 @item --strip-unneeded-symbol=@var{symbolname}
1531 Do not copy symbol @var{symbolname} from the source file unless it is needed
1532 by a relocation.  This option may be given more than once.
1534 @item -G @var{symbolname}
1535 @itemx --keep-global-symbol=@var{symbolname}
1536 Keep only symbol @var{symbolname} global.  Make all other symbols local
1537 to the file, so that they are not visible externally.  This option may
1538 be given more than once.  Note: this option cannot be used in
1539 conjunction with the @option{--globalize-symbol} or
1540 @option{--globalize-symbols} options.
1542 @item --localize-hidden
1543 In an ELF object, mark all symbols that have hidden or internal visibility
1544 as local.  This option applies on top of symbol-specific localization options
1545 such as @option{-L}.
1547 @item -L @var{symbolname}
1548 @itemx --localize-symbol=@var{symbolname}
1549 Convert a global or weak symbol called @var{symbolname} into a local
1550 symbol, so that it is not visible externally.  This option may be
1551 given more than once.  Note - unique symbols are not converted.
1553 @item -W @var{symbolname}
1554 @itemx --weaken-symbol=@var{symbolname}
1555 Make symbol @var{symbolname} weak. This option may be given more than once.
1557 @item --globalize-symbol=@var{symbolname}
1558 Give symbol @var{symbolname} global scoping so that it is visible
1559 outside of the file in which it is defined.  This option may be given
1560 more than once.  Note: this option cannot be used in conjunction with
1561 the @option{-G} or @option{--keep-global-symbol} options.
1563 @item -w
1564 @itemx --wildcard
1565 Permit regular expressions in @var{symbolname}s used in other command
1566 line options.  The question mark (?), asterisk (*), backslash (\) and
1567 square brackets ([]) operators can be used anywhere in the symbol
1568 name.  If the first character of the symbol name is the exclamation
1569 point (!) then the sense of the switch is reversed for that symbol.
1570 For example:
1572 @smallexample
1573   -w -W !foo -W fo*
1574 @end smallexample
1576 would cause objcopy to weaken all symbols that start with ``fo''
1577 except for the symbol ``foo''.
1579 @item -x
1580 @itemx --discard-all
1581 Do not copy non-global symbols from the source file.
1582 @c FIXME any reason to prefer "non-global" to "local" here?
1584 @item -X
1585 @itemx --discard-locals
1586 Do not copy compiler-generated local symbols.
1587 (These usually start with @samp{L} or @samp{.}.)
1589 @item -b @var{byte}
1590 @itemx --byte=@var{byte}
1591 If interleaving has been enabled via the @option{--interleave} option
1592 then start the range of bytes to keep at the @var{byte}th byte.
1593 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1594 @var{breadth} is the value given by the @option{--interleave} option.
1596 @item -i [@var{breadth}]
1597 @itemx --interleave[=@var{breadth}]
1598 Only copy a range out of every @var{breadth} bytes.  (Header data is
1599 not affected).  Select which byte in the range begins the copy with
1600 the @option{--byte} option.  Select the width of the range with the
1601 @option{--interleave-width} option.
1603 This option is useful for creating files to program @sc{rom}.  It is
1604 typically used with an @code{srec} output target.  Note that
1605 @command{objcopy} will complain if you do not specify the
1606 @option{--byte} option as well.
1608 The default interleave breadth is 4, so with @option{--byte} set to 0,
1609 @command{objcopy} would copy the first byte out of every four bytes
1610 from the input to the output.
1612 @item --interleave-width=@var{width}
1613 When used with the @option{--interleave} option, copy @var{width}
1614 bytes at a time.  The start of the range of bytes to be copied is set
1615 by the @option{--byte} option, and the extent of the range is set with
1616 the @option{--interleave} option.
1618 The default value for this option is 1.  The value of @var{width} plus
1619 the @var{byte} value set by the @option{--byte} option must not exceed
1620 the interleave breadth set by the @option{--interleave} option.
1622 This option can be used to create images for two 16-bit flashes interleaved
1623 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1624 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1625 commands.  If the input was '12345678' then the outputs would be
1626 '1256' and '3478' respectively.
1628 @item -p
1629 @itemx --preserve-dates
1630 Set the access and modification dates of the output file to be the same
1631 as those of the input file.
1633 This option also copies the date stored in a PE format file's header,
1634 unless the SOURCE_DATE_EPOCH environment variable is defined.  If it
1635 is defined then this variable will be used as the date stored in the
1636 header, interpreted as the number of seconds since the Unix epoch.
1638 @item -D
1639 @itemx --enable-deterministic-archives
1640 @cindex deterministic archives
1641 @kindex --enable-deterministic-archives
1642 Operate in @emph{deterministic} mode.  When copying archive members
1643 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1644 and use consistent file modes for all files.
1646 If @file{binutils} was configured with
1647 @option{--enable-deterministic-archives}, then this mode is on by default.
1648 It can be disabled with the @samp{-U} option, below.
1650 @item -U
1651 @itemx --disable-deterministic-archives
1652 @cindex deterministic archives
1653 @kindex --enable-deterministic-archives
1654 Do @emph{not} operate in @emph{deterministic} mode.  This is the
1655 inverse of the @option{-D} option, above: when copying archive members
1656 and writing the archive index, use their actual UID, GID, timestamp,
1657 and file mode values.
1659 This is the default unless @file{binutils} was configured with
1660 @option{--enable-deterministic-archives}.
1662 @item --debugging
1663 Convert debugging information, if possible.  This is not the default
1664 because only certain debugging formats are supported, and the
1665 conversion process can be time consuming.
1667 @item --gap-fill @var{val}
1668 Fill gaps between sections with @var{val}.  This operation applies to
1669 the @emph{load address} (LMA) of the sections.  It is done by increasing
1670 the size of the section with the lower address, and filling in the extra
1671 space created with @var{val}.
1673 @item --pad-to @var{address}
1674 Pad the output file up to the load address @var{address}.  This is
1675 done by increasing the size of the last section.  The extra space is
1676 filled in with the value specified by @option{--gap-fill} (default zero).
1678 @item --set-start @var{val}
1679 Set the start address (also known as the entry address) of the new
1680 file to @var{val}.  Not all object file formats support setting the
1681 start address.
1683 @item --change-start @var{incr}
1684 @itemx --adjust-start @var{incr}
1685 @cindex changing start address
1686 Change the start address (also known as the entry address) by adding
1687 @var{incr}.  Not all object file formats support setting the start
1688 address.
1690 @item --change-addresses @var{incr}
1691 @itemx --adjust-vma @var{incr}
1692 @cindex changing object addresses
1693 Change the VMA and LMA addresses of all sections, as well as the start
1694 address, by adding @var{incr}.  Some object file formats do not permit
1695 section addresses to be changed arbitrarily.  Note that this does not
1696 relocate the sections; if the program expects sections to be loaded at a
1697 certain address, and this option is used to change the sections such
1698 that they are loaded at a different address, the program may fail.
1700 @item --change-section-address @var{sectionpattern}@{=,+,-@}@var{val}
1701 @itemx --adjust-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1702 @cindex changing section address
1703 Set or change both the VMA address and the LMA address of any section
1704 matching @var{sectionpattern}.  If @samp{=} is used, the section
1705 address is set to @var{val}.  Otherwise, @var{val} is added to or
1706 subtracted from the section address.  See the comments under
1707 @option{--change-addresses}, above. If @var{sectionpattern} does not
1708 match any sections in the input file, a warning will be issued, unless
1709 @option{--no-change-warnings} is used.
1711 @item --change-section-lma @var{sectionpattern}@{=,+,-@}@var{val}
1712 @cindex changing section LMA
1713 Set or change the LMA address of any sections matching
1714 @var{sectionpattern}.  The LMA address is the address where the
1715 section will be loaded into memory at program load time.  Normally
1716 this is the same as the VMA address, which is the address of the
1717 section at program run time, but on some systems, especially those
1718 where a program is held in ROM, the two can be different.  If @samp{=}
1719 is used, the section address is set to @var{val}.  Otherwise,
1720 @var{val} is added to or subtracted from the section address.  See the
1721 comments under @option{--change-addresses}, above.  If
1722 @var{sectionpattern} does not match any sections in the input file, a
1723 warning will be issued, unless @option{--no-change-warnings} is used.
1725 @item --change-section-vma @var{sectionpattern}@{=,+,-@}@var{val}
1726 @cindex changing section VMA
1727 Set or change the VMA address of any section matching
1728 @var{sectionpattern}.  The VMA address is the address where the
1729 section will be located once the program has started executing.
1730 Normally this is the same as the LMA address, which is the address
1731 where the section will be loaded into memory, but on some systems,
1732 especially those where a program is held in ROM, the two can be
1733 different.  If @samp{=} is used, the section address is set to
1734 @var{val}.  Otherwise, @var{val} is added to or subtracted from the
1735 section address.  See the comments under @option{--change-addresses},
1736 above.  If @var{sectionpattern} does not match any sections in the
1737 input file, a warning will be issued, unless
1738 @option{--no-change-warnings} is used.
1740 Note - changing the VMA of sections in a fully linked binary can be
1741 dangerous since there may be code that expects the sections to be
1742 located at their old address.
1744 @item --change-warnings
1745 @itemx --adjust-warnings
1746 If @option{--change-section-address} or @option{--change-section-lma} or
1747 @option{--change-section-vma} is used, and the section pattern does not
1748 match any sections, issue a warning.  This is the default.
1750 @item --no-change-warnings
1751 @itemx --no-adjust-warnings
1752 Do not issue a warning if @option{--change-section-address} or
1753 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1754 if the section pattern does not match any sections.
1756 @item --set-section-flags @var{sectionpattern}=@var{flags}
1757 Set the flags for any sections matching @var{sectionpattern}.  The
1758 @var{flags} argument is a comma separated string of flag names.  The
1759 recognized names are @samp{alloc}, @samp{contents}, @samp{load},
1760 @samp{noload}, @samp{readonly}, @samp{code}, @samp{data}, @samp{rom},
1761 @samp{exclude}, @samp{share}, @samp{debug}, and @samp{large}.
1762 You can set the @samp{contents} flag for a section which does not have
1763 contents, but it is not meaningful to clear the @samp{contents} flag of a
1764 section which does have contents--just remove the section instead.  Not all
1765 flags are meaningful for all object file formats.  In particular the
1766 @samp{share} flag is only meaningful for COFF format files and not for ELF
1767 format files.  The ELF x86-64 specific flag @samp{large} corresponds to
1768 SHF_X86_64_LARGE.
1770 @item --set-section-alignment @var{sectionpattern}=@var{align}
1771 Set the alignment for any sections matching @var{sectionpattern}.
1772 @var{align} specifies the alignment in bytes and must be a power of
1773 two, i.e. 1, 2, 4, 8@dots{}.
1775 Note - setting a section's alignment will not automatically align its
1776 LMA or VMA addresses.  If those need to be changed as well then the
1777 @option{--change-section-lma} and/or @option{--change-section-vma}
1778 options should be used.  Also note that changing VMAs can cause
1779 problems in fully linked binaries where there may be code that expects
1780 the contents of the sections to be located at their old address.
1782 @item --add-section @var{sectionname}=@var{filename}
1783 Add a new section named @var{sectionname} while copying the file.  The
1784 contents of the new section are taken from the file @var{filename}.  The
1785 size of the section will be the size of the file.  This option only
1786 works on file formats which can support sections with arbitrary names.
1787 Note - it may be necessary to use the @option{--set-section-flags}
1788 option to set the attributes of the newly created section.
1790 @item --dump-section @var{sectionname}=@var{filename}
1791 Place the contents of section named @var{sectionname} into the file
1792 @var{filename}, overwriting any contents that may have been there
1793 previously.  This option is the inverse of @option{--add-section}.
1794 This option is similar to the @option{--only-section} option except
1795 that it does not create a formatted file, it just dumps the contents
1796 as raw binary data, without applying any relocations.  The option can
1797 be specified more than once.
1799 @item --update-section @var{sectionname}=@var{filename}
1800 Replace the existing contents of a section named @var{sectionname}
1801 with the contents of file @var{filename}.  The size of the section
1802 will be adjusted to the size of the file.  The section flags for
1803 @var{sectionname} will be unchanged.  For ELF format files the section
1804 to segment mapping will also remain unchanged, something which is not
1805 possible using @option{--remove-section} followed by
1806 @option{--add-section}.  The option can be specified more than once.
1808 Note - it is possible to use @option{--rename-section} and
1809 @option{--update-section} to both update and rename a section from one
1810 command line.  In this case, pass the original section name to
1811 @option{--update-section}, and the original and new section names to
1812 @option{--rename-section}.
1814 @item --add-symbol @var{name}=[@var{section}:]@var{value}[,@var{flags}]
1815 Add a new symbol named @var{name} while copying the file.  This option may be
1816 specified multiple times.  If the @var{section} is given, the symbol will be
1817 associated with and relative to that section, otherwise it will be an ABS
1818 symbol.  Specifying an undefined section will result in a fatal error.  There
1819 is no check for the value, it will be taken as specified.  Symbol flags can
1820 be specified and not all flags will be meaningful for all object file
1821 formats.  By default, the symbol will be global.  The special flag
1822 'before=@var{othersym}' will insert the new symbol in front of the specified
1823 @var{othersym}, otherwise the symbol(s) will be added at the end of the
1824 symbol table in the order they appear.
1826 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1827 Rename a section from @var{oldname} to @var{newname}, optionally
1828 changing the section's flags to @var{flags} in the process.  This has
1829 the advantage over using a linker script to perform the rename in that
1830 the output stays as an object file and does not become a linked
1831 executable.  This option accepts the same set of flags as the
1832 @option{--set-section-flags} option.
1834 This option is particularly helpful when the input format is binary,
1835 since this will always create a section called .data.  If for example,
1836 you wanted instead to create a section called .rodata containing binary
1837 data you could use the following command line to achieve it:
1839 @smallexample
1840   objcopy -I binary -O <output_format> -B <architecture> \
1841    --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1842    <input_binary_file> <output_object_file>
1843 @end smallexample
1845 @item --long-section-names @{enable,disable,keep@}
1846 Controls the handling of long section names when processing @code{COFF}
1847 and @code{PE-COFF} object formats.  The default behaviour, @samp{keep},
1848 is to preserve long section names if any are present in the input file.
1849 The @samp{enable} and @samp{disable} options forcibly enable or disable
1850 the use of long section names in the output object; when @samp{disable}
1851 is in effect, any long section names in the input object will be truncated.
1852 The @samp{enable} option will only emit long section names if any are
1853 present in the inputs; this is mostly the same as @samp{keep}, but it
1854 is left undefined whether the @samp{enable} option might force the
1855 creation of an empty string table in the output file.
1857 @item --change-leading-char
1858 Some object file formats use special characters at the start of
1859 symbols.  The most common such character is underscore, which compilers
1860 often add before every symbol.  This option tells @command{objcopy} to
1861 change the leading character of every symbol when it converts between
1862 object file formats.  If the object file formats use the same leading
1863 character, this option has no effect.  Otherwise, it will add a
1864 character, or remove a character, or change a character, as
1865 appropriate.
1867 @item --remove-leading-char
1868 If the first character of a global symbol is a special symbol leading
1869 character used by the object file format, remove the character.  The
1870 most common symbol leading character is underscore.  This option will
1871 remove a leading underscore from all global symbols.  This can be useful
1872 if you want to link together objects of different file formats with
1873 different conventions for symbol names.  This is different from
1874 @option{--change-leading-char} because it always changes the symbol name
1875 when appropriate, regardless of the object file format of the output
1876 file.
1878 @item --reverse-bytes=@var{num}
1879 Reverse the bytes in a section with output contents.  A section length must
1880 be evenly divisible by the value given in order for the swap to be able to
1881 take place. Reversing takes place before the interleaving is performed.
1883 This option is used typically in generating ROM images for problematic
1884 target systems.  For example, on some target boards, the 32-bit words
1885 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1886 regardless of the CPU byte order.  Depending on the programming model, the
1887 endianness of the ROM may need to be modified.
1889 Consider a simple file with a section containing the following eight
1890 bytes:  @code{12345678}.
1892 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1893 output file would be ordered @code{21436587}.
1895 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1896 output file would be ordered @code{43218765}.
1898 By using @samp{--reverse-bytes=2} for the above example, followed by
1899 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1900 output file would be ordered @code{34127856}.
1902 @item --srec-len=@var{ival}
1903 Meaningful only for srec output.  Set the maximum length of the Srecords
1904 being produced to @var{ival}.  This length covers both address, data and
1905 crc fields.
1907 @item --srec-forceS3
1908 Meaningful only for srec output.  Avoid generation of S1/S2 records,
1909 creating S3-only record format.
1911 @item --redefine-sym @var{old}=@var{new}
1912 Change the name of a symbol @var{old}, to @var{new}.  This can be useful
1913 when one is trying link two things together for which you have no
1914 source, and there are name collisions.
1916 @item --redefine-syms=@var{filename}
1917 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1918 listed in the file @var{filename}.  @var{filename} is simply a flat file,
1919 with one symbol pair per line.  Line comments may be introduced by the hash
1920 character.  This option may be given more than once.
1922 @item --weaken
1923 Change all global symbols in the file to be weak.  This can be useful
1924 when building an object which will be linked against other objects using
1925 the @option{-R} option to the linker.  This option is only effective when
1926 using an object file format which supports weak symbols.
1928 @item --keep-symbols=@var{filename}
1929 Apply @option{--keep-symbol} option to each symbol listed in the file
1930 @var{filename}.  @var{filename} is simply a flat file, with one symbol
1931 name per line.  Line comments may be introduced by the hash character.
1932 This option may be given more than once.
1934 @item --strip-symbols=@var{filename}
1935 Apply @option{--strip-symbol} option to each symbol listed in the file
1936 @var{filename}.  @var{filename} is simply a flat file, with one symbol
1937 name per line.  Line comments may be introduced by the hash character.
1938 This option may be given more than once.
1940 @item --strip-unneeded-symbols=@var{filename}
1941 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1942 the file @var{filename}.  @var{filename} is simply a flat file, with one
1943 symbol name per line.  Line comments may be introduced by the hash
1944 character.  This option may be given more than once.
1946 @item --keep-global-symbols=@var{filename}
1947 Apply @option{--keep-global-symbol} option to each symbol listed in the
1948 file @var{filename}.  @var{filename} is simply a flat file, with one
1949 symbol name per line.  Line comments may be introduced by the hash
1950 character.  This option may be given more than once.
1952 @item --localize-symbols=@var{filename}
1953 Apply @option{--localize-symbol} option to each symbol listed in the file
1954 @var{filename}.  @var{filename} is simply a flat file, with one symbol
1955 name per line.  Line comments may be introduced by the hash character.
1956 This option may be given more than once.
1958 @item --globalize-symbols=@var{filename}
1959 Apply @option{--globalize-symbol} option to each symbol listed in the file
1960 @var{filename}.  @var{filename} is simply a flat file, with one symbol
1961 name per line.  Line comments may be introduced by the hash character.
1962 This option may be given more than once.  Note: this option cannot be
1963 used in conjunction with the @option{-G} or @option{--keep-global-symbol}
1964 options.
1966 @item --weaken-symbols=@var{filename}
1967 Apply @option{--weaken-symbol} option to each symbol listed in the file
1968 @var{filename}.  @var{filename} is simply a flat file, with one symbol
1969 name per line.  Line comments may be introduced by the hash character.
1970 This option may be given more than once.
1972 @item --alt-machine-code=@var{index}
1973 If the output architecture has alternate machine codes, use the
1974 @var{index}th code instead of the default one.  This is useful in case
1975 a machine is assigned an official code and the tool-chain adopts the
1976 new code, but other applications still depend on the original code
1977 being used.  For ELF based architectures if the @var{index}
1978 alternative does not exist then the value is treated as an absolute
1979 number to be stored in the e_machine field of the ELF header.
1981 @item --writable-text
1982 Mark the output text as writable.  This option isn't meaningful for all
1983 object file formats.
1985 @item --readonly-text
1986 Make the output text write protected.  This option isn't meaningful for all
1987 object file formats.
1989 @item --pure
1990 Mark the output file as demand paged.  This option isn't meaningful for all
1991 object file formats.
1993 @item --impure
1994 Mark the output file as impure.  This option isn't meaningful for all
1995 object file formats.
1997 @item --prefix-symbols=@var{string}
1998 Prefix all symbols in the output file with @var{string}.
2000 @item --prefix-sections=@var{string}
2001 Prefix all section names in the output file with @var{string}.
2003 @item --prefix-alloc-sections=@var{string}
2004 Prefix all the names of all allocated sections in the output file with
2005 @var{string}.
2007 @item --add-gnu-debuglink=@var{path-to-file}
2008 Creates a .gnu_debuglink section which contains a reference to
2009 @var{path-to-file} and adds it to the output file.  Note: the file at
2010 @var{path-to-file} must exist.  Part of the process of adding the
2011 .gnu_debuglink section involves embedding a checksum of the contents
2012 of the debug info file into the section.
2014 If the debug info file is built in one location but it is going to be
2015 installed at a later time into a different location then do not use
2016 the path to the installed location.  The @option{--add-gnu-debuglink}
2017 option will fail because the installed file does not exist yet.
2018 Instead put the debug info file in the current directory and use the
2019 @option{--add-gnu-debuglink} option without any directory components,
2020 like this:
2022 @smallexample
2023  objcopy --add-gnu-debuglink=foo.debug
2024 @end smallexample
2026 At debug time the debugger will attempt to look for the separate debug
2027 info file in a set of known locations.  The exact set of these
2028 locations varies depending upon the distribution being used, but it
2029 typically includes:
2031 @table @code
2033 @item * The same directory as the executable.
2035 @item * A sub-directory of the directory containing the executable
2036 called .debug
2038 @item * A global debug directory such as /usr/lib/debug.
2039 @end table
2041 As long as the debug info file has been installed into one of these
2042 locations before the debugger is run everything should work
2043 correctly.
2045 @item --keep-section-symbils
2046 When stripping a file, perhaps with @option{--strip-debug} or
2047 @option{--strip-unneeded}, retain any symbols specifying section names,
2048 which would otherwise get stripped.
2050 @item --keep-file-symbols
2051 When stripping a file, perhaps with @option{--strip-debug} or
2052 @option{--strip-unneeded}, retain any symbols specifying source file names,
2053 which would otherwise get stripped.
2055 @item --only-keep-debug
2056 Strip a file, removing contents of any sections that would not be
2057 stripped by @option{--strip-debug} and leaving the debugging sections
2058 intact.  In ELF files, this preserves all note sections in the output.
2060 Note - the section headers of the stripped sections are preserved,
2061 including their sizes, but the contents of the section are discarded.
2062 The section headers are preserved so that other tools can match up the
2063 debuginfo file with the real executable, even if that executable has
2064 been relocated to a different address space.
2066 The intention is that this option will be used in conjunction with
2067 @option{--add-gnu-debuglink} to create a two part executable.  One a
2068 stripped binary which will occupy less space in RAM and in a
2069 distribution and the second a debugging information file which is only
2070 needed if debugging abilities are required.  The suggested procedure
2071 to create these files is as follows:
2073 @enumerate
2074 @item Link the executable as normal.  Assuming that it is called
2075 @code{foo} then...
2076 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2077 create a file containing the debugging info.
2078 @item Run @code{objcopy --strip-debug foo} to create a
2079 stripped executable.
2080 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2081 to add a link to the debugging info into the stripped executable.
2082 @end enumerate
2084 Note---the choice of @code{.dbg} as an extension for the debug info
2085 file is arbitrary.  Also the @code{--only-keep-debug} step is
2086 optional.  You could instead do this:
2088 @enumerate
2089 @item Link the executable as normal.
2090 @item Copy @code{foo} to  @code{foo.full}
2091 @item Run @code{objcopy --strip-debug foo}
2092 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2093 @end enumerate
2095 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
2096 full executable.  It does not have to be a file created by the
2097 @option{--only-keep-debug} switch.
2099 Note---this switch is only intended for use on fully linked files.  It
2100 does not make sense to use it on object files where the debugging
2101 information may be incomplete.  Besides the gnu_debuglink feature
2102 currently only supports the presence of one filename containing
2103 debugging information, not multiple filenames on a one-per-object-file
2104 basis.
2106 @item --strip-dwo
2107 Remove the contents of all DWARF .dwo sections, leaving the
2108 remaining debugging sections and all symbols intact.
2109 This option is intended for use by the compiler as part of
2110 the @option{-gsplit-dwarf} option, which splits debug information
2111 between the .o file and a separate .dwo file.  The compiler
2112 generates all debug information in the same file, then uses
2113 the @option{--extract-dwo} option to copy the .dwo sections to
2114 the .dwo file, then the @option{--strip-dwo} option to remove
2115 those sections from the original .o file.
2117 @item --extract-dwo
2118 Extract the contents of all DWARF .dwo sections.  See the
2119 @option{--strip-dwo} option for more information.
2121 @item --file-alignment @var{num}
2122 Specify the file alignment.  Sections in the file will always begin at
2123 file offsets which are multiples of this number.  This defaults to
2124 512.
2125 [This option is specific to PE targets.]
2127 @item --heap @var{reserve}
2128 @itemx --heap @var{reserve},@var{commit}
2129 Specify the number of bytes of memory to reserve (and optionally commit)
2130 to be used as heap for this program.
2131 [This option is specific to PE targets.]
2133 @item --image-base @var{value}
2134 Use @var{value} as the base address of your program or dll.  This is
2135 the lowest memory location that will be used when your program or dll
2136 is loaded.  To reduce the need to relocate and improve performance of
2137 your dlls, each should have a unique base address and not overlap any
2138 other dlls.  The default is 0x400000 for executables, and 0x10000000
2139 for dlls.
2140 [This option is specific to PE targets.]
2142 @item --section-alignment @var{num}
2143 [This option is specific to PE targets.]
2145 Sets the section alignment field in the PE header - if one is present
2146 in the binary.  Sections in memory will always begin at addresses
2147 which are a multiple of this number.  Defaults to 0x1000.
2149 Note - this option will also set the alignment field in each section's
2150 flags.
2152 Note - if a section's LMA or VMA addresses are no longer aligned, and
2153 those addresses have not been set via the @option{--set-section-lma} or
2154 @option{--set-section-vma} options, and the file has been fully
2155 relocated then a warning message will be issued.  It will then be up
2156 to the user to decide if the LMA and VMA need updating.
2158 @item --stack @var{reserve}
2159 @itemx --stack @var{reserve},@var{commit}
2160 Specify the number of bytes of memory to reserve (and optionally commit)
2161 to be used as stack for this program.
2162 [This option is specific to PE targets.]
2164 @item --subsystem @var{which}
2165 @itemx --subsystem @var{which}:@var{major}
2166 @itemx --subsystem @var{which}:@var{major}.@var{minor}
2167 Specifies the subsystem under which your program will execute.  The
2168 legal values for @var{which} are @code{native}, @code{windows},
2169 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
2170 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}.  You may optionally set
2171 the subsystem version also.  Numeric values are also accepted for
2172 @var{which}.
2173 [This option is specific to PE targets.]
2175 @item --extract-symbol
2176 Keep the file's section flags and symbols but remove all section data.
2177 Specifically, the option:
2179 @itemize
2180 @item removes the contents of all sections;
2181 @item sets the size of every section to zero; and
2182 @item sets the file's start address to zero.
2183 @end itemize
2185 This option is used to build a @file{.sym} file for a VxWorks kernel.
2186 It can also be a useful way of reducing the size of a @option{--just-symbols}
2187 linker input file.
2189 @item --compress-debug-sections
2190 Compress DWARF debug sections using zlib with SHF_COMPRESSED from the
2191 ELF ABI.  Note - if compression would actually make a section
2192 @emph{larger}, then it is not compressed.
2194 @item --compress-debug-sections=none
2195 @itemx --compress-debug-sections=zlib
2196 @itemx --compress-debug-sections=zlib-gnu
2197 @itemx --compress-debug-sections=zlib-gabi
2198 @itemx --compress-debug-sections=zstd
2199 For ELF files, these options control how DWARF debug sections are
2200 compressed.  @option{--compress-debug-sections=none} is equivalent
2201 to @option{--decompress-debug-sections}.
2202 @option{--compress-debug-sections=zlib} and
2203 @option{--compress-debug-sections=zlib-gabi} are equivalent to
2204 @option{--compress-debug-sections}.
2205 @option{--compress-debug-sections=zlib-gnu} compresses DWARF debug sections
2206 using the obsoleted zlib-gnu format.  The debug sections are renamed to begin
2207 with @samp{.zdebug}.
2208 @option{--compress-debug-sections=zstd} compresses DWARF debug
2209 sections using zstd.  Note - if compression would actually make a section
2210 @emph{larger}, then it is not compressed nor renamed.
2212 @item --decompress-debug-sections
2213 Decompress DWARF debug sections.  For a @samp{.zdebug} section, the original
2214 name is restored.
2216 @item --elf-stt-common=yes
2217 @itemx --elf-stt-common=no
2218 For ELF files, these options control whether common symbols should be
2219 converted to the @code{STT_COMMON} or @code{STT_OBJECT} type.
2220 @option{--elf-stt-common=yes} converts common symbol type to
2221 @code{STT_COMMON}. @option{--elf-stt-common=no} converts common symbol
2222 type to @code{STT_OBJECT}.
2224 @item --merge-notes
2225 @itemx --no-merge-notes
2226 For ELF files, attempt (or do not attempt) to reduce the size of any
2227 SHT_NOTE type sections by removing duplicate notes.
2229 @item -V
2230 @itemx --version
2231 Show the version number of @command{objcopy}.
2233 @item --verilog-data-width=@var{bytes}
2234 For Verilog output, this options controls the number of bytes
2235 converted for each output data element.  The input target controls the
2236 endianness of the conversion.
2238 @item -v
2239 @itemx --verbose
2240 Verbose output: list all object files modified.  In the case of
2241 archives, @samp{objcopy -V} lists all members of the archive.
2243 @item --help
2244 Show a summary of the options to @command{objcopy}.
2246 @item --info
2247 Display a list showing all architectures and object formats available.
2248 @end table
2250 @c man end
2252 @ignore
2253 @c man begin SEEALSO objcopy
2254 ld(1), objdump(1), and the Info entries for @file{binutils}.
2255 @c man end
2256 @end ignore
2258 @node objdump
2259 @chapter objdump
2261 @cindex object file information
2262 @kindex objdump
2264 @c man title objdump display information from object files
2266 @smallexample
2267 @c man begin SYNOPSIS objdump
2268 objdump [@option{-a}|@option{--archive-headers}]
2269         [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
2270         [@option{-C}|@option{--demangle}[=@var{style}] ]
2271         [@option{-d}|@option{--disassemble}[=@var{symbol}]]
2272         [@option{-D}|@option{--disassemble-all}]
2273         [@option{-z}|@option{--disassemble-zeroes}]
2274         [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
2275         [@option{-f}|@option{--file-headers}]
2276         [@option{-F}|@option{--file-offsets}]
2277         [@option{--file-start-context}]
2278         [@option{-g}|@option{--debugging}]
2279         [@option{-e}|@option{--debugging-tags}]
2280         [@option{-h}|@option{--section-headers}|@option{--headers}]
2281         [@option{-i}|@option{--info}]
2282         [@option{-j} @var{section}|@option{--section=}@var{section}]
2283         [@option{-l}|@option{--line-numbers}]
2284         [@option{-S}|@option{--source}]
2285         [@option{--source-comment}[=@var{text}]]
2286         [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
2287         [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
2288         [@option{-p}|@option{--private-headers}]
2289         [@option{-P} @var{options}|@option{--private=}@var{options}]
2290         [@option{-r}|@option{--reloc}]
2291         [@option{-R}|@option{--dynamic-reloc}]
2292         [@option{-s}|@option{--full-contents}]
2293         [@option{-Z}|@option{--decompress}]
2294         [@option{-W[lLiaprmfFsoORtUuTgAck]}|
2295          @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links]]
2296         [@option{-WK}|@option{--dwarf=follow-links}]
2297         [@option{-WN}|@option{--dwarf=no-follow-links}]
2298         [@option{-wD}|@option{--dwarf=use-debuginfod}]
2299         [@option{-wE}|@option{--dwarf=do-not-use-debuginfod}]
2300         [@option{-L}|@option{--process-links}]
2301         [@option{--ctf=}@var{section}]
2302         [@option{--sframe=}@var{section}]
2303         [@option{-G}|@option{--stabs}]
2304         [@option{-t}|@option{--syms}]
2305         [@option{-T}|@option{--dynamic-syms}]
2306         [@option{-x}|@option{--all-headers}]
2307         [@option{-w}|@option{--wide}]
2308         [@option{--start-address=}@var{address}]
2309         [@option{--stop-address=}@var{address}]
2310         [@option{--no-addresses}]
2311         [@option{--prefix-addresses}]
2312         [@option{--[no-]show-raw-insn}]
2313         [@option{--adjust-vma=}@var{offset}]
2314         [@option{--show-all-symbols}]
2315         [@option{--dwarf-depth=@var{n}}]
2316         [@option{--dwarf-start=@var{n}}]
2317         [@option{--ctf-parent=}@var{section}]
2318         [@option{--no-recurse-limit}|@option{--recurse-limit}]
2319         [@option{--special-syms}]
2320         [@option{--prefix=}@var{prefix}]
2321         [@option{--prefix-strip=}@var{level}]
2322         [@option{--insn-width=}@var{width}]
2323         [@option{--visualize-jumps[=color|=extended-color|=off]}
2324         [@option{--disassembler-color=[off|terminal|on|extended]}
2325         [@option{-U} @var{method}] [@option{--unicode=}@var{method}]
2326         [@option{-V}|@option{--version}]
2327         [@option{-H}|@option{--help}]
2328         @var{objfile}@dots{}
2329 @c man end
2330 @end smallexample
2332 @c man begin DESCRIPTION objdump
2334 @command{objdump} displays information about one or more object files.
2335 The options control what particular information to display.  This
2336 information is mostly useful to programmers who are working on the
2337 compilation tools, as opposed to programmers who just want their
2338 program to compile and work.
2340 @var{objfile}@dots{} are the object files to be examined.  When you
2341 specify archives, @command{objdump} shows information on each of the member
2342 object files.
2344 @c man end
2346 @c man begin OPTIONS objdump
2348 The long and short forms of options, shown here as alternatives, are
2349 equivalent.  At least one option from the list
2350 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
2352 @table @env
2353 @item -a
2354 @itemx --archive-header
2355 @cindex archive headers
2356 If any of the @var{objfile} files are archives, display the archive
2357 header information (in a format similar to @samp{ls -l}).  Besides the
2358 information you could list with @samp{ar tv}, @samp{objdump -a} shows
2359 the object file format of each archive member.
2361 @item --adjust-vma=@var{offset}
2362 @cindex section addresses in objdump
2363 @cindex VMA in objdump
2364 When dumping information, first add @var{offset} to all the section
2365 addresses.  This is useful if the section addresses do not correspond to
2366 the symbol table, which can happen when putting sections at particular
2367 addresses when using a format which can not represent section addresses,
2368 such as a.out.
2370 @item -b @var{bfdname}
2371 @itemx --target=@var{bfdname}
2372 @cindex object code format
2373 Specify that the object-code format for the object files is
2374 @var{bfdname}.  This option may not be necessary; @var{objdump} can
2375 automatically recognize many formats.
2377 For example,
2378 @example
2379 objdump -b oasys -m vax -h fu.o
2380 @end example
2381 @noindent
2382 displays summary information from the section headers (@option{-h}) of
2383 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
2384 file in the format produced by Oasys compilers.  You can list the
2385 formats available with the @option{-i} option.
2386 @xref{Target Selection}, for more information.
2388 @item -C
2389 @itemx --demangle[=@var{style}]
2390 @cindex demangling in objdump
2391 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2392 Besides removing any initial underscore prepended by the system, this
2393 makes C++ function names readable.  Different compilers have different
2394 mangling styles. The optional demangling style argument can be used to
2395 choose an appropriate demangling style for your compiler. @xref{c++filt},
2396 for more information on demangling.
2398 @item --recurse-limit
2399 @itemx --no-recurse-limit
2400 @itemx --recursion-limit
2401 @itemx --no-recursion-limit
2402 Enables or disables a limit on the amount of recursion performed
2403 whilst demangling strings.  Since the name mangling formats allow for
2404 an infinite level of recursion it is possible to create strings whose
2405 decoding will exhaust the amount of stack space available on the host
2406 machine, triggering a memory fault.  The limit tries to prevent this
2407 from happening by restricting recursion to 2048 levels of nesting.
2409 The default is for this limit to be enabled, but disabling it may be
2410 necessary in order to demangle truly complicated names.  Note however
2411 that if the recursion limit is disabled then stack exhaustion is
2412 possible and any bug reports about such an event will be rejected.
2414 @item -g
2415 @itemx --debugging
2416 Display debugging information.  This attempts to parse STABS
2417 debugging format information stored in the file and print it out using
2418 a C like syntax.  If no STABS debugging was found this option
2419 falls back on the @option{-W} option to print any DWARF information in
2420 the file.
2422 @item -e
2423 @itemx --debugging-tags
2424 Like @option{-g}, but the information is generated in a format compatible
2425 with ctags tool.
2427 @item -d
2428 @itemx --disassemble
2429 @itemx --disassemble=@var{symbol}
2430 @cindex disassembling object code
2431 @cindex machine instructions
2432 Display the assembler mnemonics for the machine instructions from the
2433 input file.  This option only disassembles those sections which are 
2434 expected to contain instructions.  If the optional @var{symbol}
2435 argument is given, then display the assembler mnemonics starting at
2436 @var{symbol}.  If @var{symbol} is a function name then disassembly
2437 will stop at the end of the function, otherwise it will stop when the
2438 next symbol is encountered.  If there are no matches for @var{symbol}
2439 then nothing will be displayed.
2441 Note if the @option{--dwarf=follow-links} option is enabled
2442 then any symbol tables in linked debug info files will be read in and
2443 used when disassembling.
2445 @item -D
2446 @itemx --disassemble-all
2447 Like @option{-d}, but disassemble the contents of all non-empty
2448 non-bss sections, not just those expected to contain instructions.
2449 @option{-j} may be used to select specific sections.
2451 This option also has a subtle effect on the disassembly of
2452 instructions in code sections.  When option @option{-d} is in effect
2453 objdump will assume that any symbols present in a code section occur
2454 on the boundary between instructions and it will refuse to disassemble
2455 across such a boundary.  When option @option{-D} is in effect however
2456 this assumption is supressed.  This means that it is possible for the
2457 output of @option{-d} and @option{-D} to differ if, for example, data
2458 is stored in code sections.
2460 If the target is an ARM architecture this switch also has the effect
2461 of forcing the disassembler to decode pieces of data found in code
2462 sections as if they were instructions.
2464 Note if the @option{--dwarf=follow-links} option is enabled
2465 then any symbol tables in linked debug info files will be read in and
2466 used when disassembling.
2468 @item --no-addresses
2469 When disassembling, don't print addresses on each line or for symbols
2470 and relocation offsets.  In combination with @option{--no-show-raw-insn}
2471 this may be useful for comparing compiler output.
2473 @item --prefix-addresses
2474 When disassembling, print the complete address on each line.  This is
2475 the older disassembly format.
2477 @item -EB
2478 @itemx -EL
2479 @itemx --endian=@{big|little@}
2480 @cindex endianness
2481 @cindex disassembly endianness
2482 Specify the endianness of the object files.  This only affects
2483 disassembly.  This can be useful when disassembling a file format which
2484 does not describe endianness information, such as S-records.
2486 @item -f
2487 @itemx --file-headers
2488 @cindex object file header
2489 Display summary information from the overall header of
2490 each of the @var{objfile} files.
2492 @item -F
2493 @itemx --file-offsets
2494 @cindex object file offsets
2495 When disassembling sections, whenever a symbol is displayed, also
2496 display the file offset of the region of data that is about to be
2497 dumped.  If zeroes are being skipped, then when disassembly resumes,
2498 tell the user how many zeroes were skipped and the file offset of the
2499 location from where the disassembly resumes.  When dumping sections,
2500 display the file offset of the location from where the dump starts.
2502 @item --file-start-context
2503 @cindex source code context
2504 Specify that when displaying interlisted source code/disassembly
2505 (assumes @option{-S}) from a file that has not yet been displayed, extend the
2506 context to the start of the file.
2508 @item -h
2509 @itemx --section-headers
2510 @itemx --headers
2511 @cindex section headers
2512 Display summary information from the section headers of the
2513 object file.
2515 File segments may be relocated to nonstandard addresses, for example by
2516 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
2517 @command{ld}.  However, some object file formats, such as a.out, do not
2518 store the starting address of the file segments.  In those situations,
2519 although @command{ld} relocates the sections correctly, using @samp{objdump
2520 -h} to list the file section headers cannot show the correct addresses.
2521 Instead, it shows the usual addresses, which are implicit for the
2522 target.
2524 Note, in some cases it is possible for a section to have both the
2525 READONLY and the NOREAD attributes set.  In such cases the NOREAD
2526 attribute takes precedence, but @command{objdump} will report both
2527 since the exact setting of the flag bits might be important.
2529 @item -H
2530 @itemx --help
2531 Print a summary of the options to @command{objdump} and exit.
2533 @item -i
2534 @itemx --info
2535 @cindex architectures available
2536 @cindex object formats available
2537 Display a list showing all architectures and object formats available
2538 for specification with @option{-b} or @option{-m}.
2540 @item -j @var{name}
2541 @itemx --section=@var{name}
2542 @cindex section information
2543 Display information for section @var{name}.  This option may be
2544 specified multiple times.
2546 @item -L
2547 @itemx --process-links
2548 Display the contents of non-debug sections found in separate debuginfo
2549 files that are linked to the main file.  This option automatically
2550 implies the @option{-WK} option, and only sections requested by other
2551 command line options will be displayed.
2553 @item -l
2554 @itemx --line-numbers
2555 @cindex source filenames for object files
2556 Label the display (using debugging information) with the filename and
2557 source line numbers corresponding to the object code or relocs shown.
2558 Only useful with @option{-d}, @option{-D}, or @option{-r}.
2560 @item -m @var{machine}
2561 @itemx --architecture=@var{machine}
2562 @cindex architecture
2563 @cindex disassembly architecture
2564 Specify the architecture to use when disassembling object files.  This
2565 can be useful when disassembling object files which do not describe
2566 architecture information, such as S-records.  You can list the available
2567 architectures with the @option{-i} option.
2569 For most architectures it is possible to supply an architecture
2570 name and a machine name, separated by a colon.  For example
2571 @samp{foo:bar} would refer to the @samp{bar} machine type in the
2572 @samp{foo} architecture.  This can be helpful if objdump has been
2573 configured to support multiple architectures.
2575 If the target is an ARM architecture then this switch has an
2576 additional effect.  It restricts the disassembly to only those
2577 instructions supported by the architecture specified by @var{machine}.
2578 If it is necessary to use this switch because the input file does not
2579 contain any architecture information, but it is also desired to
2580 disassemble all the instructions use @option{-marm}.
2582 @item -M @var{options}
2583 @itemx --disassembler-options=@var{options}
2584 Pass target specific information to the disassembler.  Only supported on
2585 some targets.  If it is necessary to specify more than one
2586 disassembler option then multiple @option{-M} options can be used or
2587 can be placed together into a comma separated list.
2589 For ARC, @option{dsp} controls the printing of DSP instructions,
2590 @option{spfp} selects the printing of FPX single precision FP
2591 instructions, @option{dpfp} selects the printing of FPX double
2592 precision FP instructions, @option{quarkse_em} selects the printing of
2593 special QuarkSE-EM instructions, @option{fpuda} selects the printing
2594 of double precision assist instructions, @option{fpus} selects the
2595 printing of FPU single precision FP instructions, while @option{fpud}
2596 selects the printing of FPU double precision FP instructions.
2597 Additionally, one can choose to have all the immediates printed in
2598 hexadecimal using @option{hex}.  By default, the short immediates are
2599 printed using the decimal representation, while the long immediate
2600 values are printed as hexadecimal.
2602 @option{cpu=...} allows one to enforce a particular ISA when disassembling
2603 instructions, overriding the @option{-m} value or whatever is in the ELF file.
2604 This might be useful to select ARC EM or HS ISA, because architecture is same
2605 for those and disassembler relies on private ELF header data to decide if code
2606 is for EM or HS.  This option might be specified multiple times - only the
2607 latest value will be used.  Valid values are same as for the assembler
2608 @option{-mcpu=...} option.
2610 If the target is an ARM architecture then this switch can be used to
2611 select which register name set is used during disassembler.  Specifying
2612 @option{-M reg-names-std} (the default) will select the register names as
2613 used in ARM's instruction set documentation, but with register 13 called
2614 'sp', register 14 called 'lr' and register 15 called 'pc'.  Specifying
2615 @option{-M reg-names-apcs} will select the name set used by the ARM
2616 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2617 just use @samp{r} followed by the register number.
2619 There are also two variants on the APCS register naming scheme enabled
2620 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2621 use the ARM/Thumb Procedure Call Standard naming conventions.  (Either
2622 with the normal register names or the special register names).
2624 This option can also be used for ARM architectures to force the
2625 disassembler to interpret all instructions as Thumb instructions by
2626 using the switch @option{--disassembler-options=force-thumb}.  This can be
2627 useful when attempting to disassemble thumb code produced by other
2628 compilers.
2630 For AArch64 targets this switch can be used to set whether instructions are
2631 disassembled as the most general instruction using the @option{-M no-aliases}
2632 option or whether instruction notes should be generated as comments in the
2633 disasssembly using @option{-M notes}.
2635 For the x86, some of the options duplicate functions of the @option{-m}
2636 switch, but allow finer grained control.
2637 @table @code
2638 @item x86-64
2639 @itemx i386
2640 @itemx i8086
2641 Select disassembly for the given architecture.
2643 @item intel
2644 @itemx att
2645 Select between intel syntax mode and AT&T syntax mode.
2647 @item amd64
2648 @itemx intel64
2649 Select between AMD64 ISA and Intel64 ISA.
2651 @item intel-mnemonic
2652 @itemx att-mnemonic
2653 Select between intel mnemonic mode and AT&T mnemonic mode.
2654 Note: @code{intel-mnemonic} implies @code{intel} and
2655 @code{att-mnemonic} implies @code{att}.
2657 @item addr64
2658 @itemx addr32
2659 @itemx addr16
2660 @itemx data32
2661 @itemx data16
2662 Specify the default address size and operand size.  These five options
2663 will be overridden if @code{x86-64}, @code{i386} or @code{i8086}
2664 appear later in the option string.
2666 @item suffix
2667 When in AT&T mode and also for a limited set of instructions when in Intel
2668 mode, instructs the disassembler to print a mnemonic suffix even when the
2669 suffix could be inferred by the operands or, for certain instructions, the
2670 execution mode's defaults.
2671 @end table
2673 For PowerPC, the @option{-M} argument @option{raw} selects
2674 disasssembly of hardware insns rather than aliases.  For example, you
2675 will see @code{rlwinm} rather than @code{clrlwi}, and @code{addi}
2676 rather than @code{li}.  All of the @option{-m} arguments for
2677 @command{gas} that select a CPU are supported.  These are:
2678 @option{403}, @option{405}, @option{440}, @option{464}, @option{476},
2679 @option{601}, @option{603}, @option{604}, @option{620}, @option{7400},
2680 @option{7410}, @option{7450}, @option{7455}, @option{750cl},
2681 @option{821}, @option{850}, @option{860}, @option{a2}, @option{booke},
2682 @option{booke32}, @option{cell}, @option{com}, @option{e200z2}, @option{e200z4},
2683 @option{e300}, @option{e500}, @option{e500mc}, @option{e500mc64},
2684 @option{e500x2}, @option{e5500}, @option{e6500}, @option{efs},
2685 @option{power4}, @option{power5}, @option{power6}, @option{power7},
2686 @option{power8}, @option{power9}, @option{power10}, @option{power11},
2687 @option{ppc}, @option{ppc32}, @option{ppc64}, @option{ppc64bridge},
2688 @option{ppcps}, @option{pwr}, @option{pwr2}, @option{pwr4}, @option{pwr5},
2689 @option{pwr5x}, @option{pwr6}, @option{pwr7}, @option{pwr8}, @option{pwr9},
2690 @option{pwr10}, @option{pwr11}, @option{pwrx}, @option{titan}, @option{vle},
2691 and @option{future}.
2692 @option{32} and @option{64} modify the default or a prior CPU
2693 selection, disabling and enabling 64-bit insns respectively.  In
2694 addition, @option{altivec}, @option{any}, @option{lsp}, @option{htm},
2695 @option{vsx}, @option{spe} and  @option{spe2} add capabilities to a
2696 previous @emph{or later} CPU selection.
2697 @option{any} will disassemble any opcode known to
2698 binutils, but in cases where an opcode has two different meanings or
2699 different arguments, you may not see the disassembly you expect.
2700 If you disassemble without giving a CPU selection, a default will be
2701 chosen from information gleaned by BFD from the object files headers,
2702 but the result again may not be as you expect.
2704 For MIPS, this option controls the printing of instruction mnemonic
2705 names and register names in disassembled instructions.  Multiple
2706 selections from the following may be specified as a comma separated
2707 string, and invalid options are ignored:
2709 @table @code
2710 @item no-aliases
2711 Print the 'raw' instruction mnemonic instead of some pseudo
2712 instruction mnemonic.  I.e., print 'daddu' or 'or' instead of 'move',
2713 'sll' instead of 'nop', etc.
2715 @item msa
2716 Disassemble MSA instructions.
2718 @item virt
2719 Disassemble the virtualization ASE instructions.
2721 @item xpa
2722 Disassemble the eXtended Physical Address (XPA) ASE instructions.
2724 @item gpr-names=@var{ABI}
2725 Print GPR (general-purpose register) names as appropriate
2726 for the specified ABI.  By default, GPR names are selected according to
2727 the ABI of the binary being disassembled.
2729 @item fpr-names=@var{ABI}
2730 Print FPR (floating-point register) names as
2731 appropriate for the specified ABI.  By default, FPR numbers are printed
2732 rather than names.
2734 @item cp0-names=@var{ARCH}
2735 Print CP0 (system control coprocessor; coprocessor 0) register names
2736 as appropriate for the CPU or architecture specified by
2737 @var{ARCH}.  By default, CP0 register names are selected according to
2738 the architecture and CPU of the binary being disassembled.
2740 @item hwr-names=@var{ARCH}
2741 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2742 as appropriate for the CPU or architecture specified by
2743 @var{ARCH}.  By default, HWR names are selected according to
2744 the architecture and CPU of the binary being disassembled.
2746 @item reg-names=@var{ABI}
2747 Print GPR and FPR names as appropriate for the selected ABI.
2749 @item reg-names=@var{ARCH}
2750 Print CPU-specific register names (CP0 register and HWR names)
2751 as appropriate for the selected CPU or architecture.
2752 @end table
2754 For any of the options listed above, @var{ABI} or
2755 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2756 rather than names, for the selected types of registers.
2757 You can list the available values of @var{ABI} and @var{ARCH} using
2758 the @option{--help} option.
2760 For VAX, you can specify function entry addresses with @option{-M
2761 entry:0xf00ba}.  You can use this multiple times to properly
2762 disassemble VAX binary files that don't contain symbol tables (like
2763 ROM dumps).  In these cases, the function entry mask would otherwise
2764 be decoded as VAX instructions, which would probably lead the rest
2765 of the function being wrongly disassembled.
2767 @item -p
2768 @itemx --private-headers
2769 Print information that is specific to the object file format.  The exact
2770 information printed depends upon the object file format.  For some
2771 object file formats, no additional information is printed.
2773 @item -P @var{options}
2774 @itemx --private=@var{options}
2775 Print information that is specific to the object file format.  The
2776 argument @var{options} is a comma separated list that depends on the
2777 format (the lists of options is displayed with the help).
2779 For XCOFF, the available options are:
2780 @table @code
2781 @item header
2782 @item aout
2783 @item sections
2784 @item syms
2785 @item relocs
2786 @item lineno,
2787 @item loader
2788 @item except
2789 @item typchk
2790 @item traceback
2791 @item toc
2792 @item ldinfo
2793 @end table
2795 For PE, the available options are:
2796 @table @code
2797 @item header
2798 @item sections
2799 @end table
2801 Not all object formats support this option.  In particular the ELF
2802 format does not use it.
2804 @item -r
2805 @itemx --reloc
2806 @cindex relocation entries, in object file
2807 Print the relocation entries of the file.  If used with @option{-d} or
2808 @option{-D}, the relocations are printed interspersed with the
2809 disassembly.
2811 @item -R
2812 @itemx --dynamic-reloc
2813 @cindex dynamic relocation entries, in object file
2814 Print the dynamic relocation entries of the file.  This is only
2815 meaningful for dynamic objects, such as certain types of shared
2816 libraries.  As for @option{-r}, if used with @option{-d} or
2817 @option{-D}, the relocations are printed interspersed with the
2818 disassembly.
2820 @item -s
2821 @itemx --full-contents
2822 @cindex sections, full contents
2823 @cindex object file sections
2824 Display the full contents of sections, often used in combination with
2825 @option{-j} to request specific sections.  By default all non-empty
2826 non-bss sections are displayed.  By default any compressed section
2827 will be displayed in its compressed form.  In order to see the
2828 contents in a decompressed form add the @option{-Z} option to the
2829 command line.
2831 @item -S
2832 @itemx --source
2833 @cindex source disassembly
2834 @cindex disassembly, with source
2835 Display source code intermixed with disassembly, if possible.  Implies
2836 @option{-d}.
2838 @item --show-all-symbols
2839 When disassembling, show all the symbols that match a given address,
2840 not just the first one.
2842 @item --source-comment[=@var{txt}]
2843 @cindex source disassembly
2844 @cindex disassembly, with source
2845 Like the @option{-S} option, but all source code lines are displayed
2846 with a prefix of @var{txt}.  Typically @var{txt} will be a comment
2847 string which can be used to distinguish the assembler code from the
2848 source code.  If @var{txt} is not provided then a default string of
2849 @var{``# ``} (hash followed by a space), will be used.
2851 @item --prefix=@var{prefix}
2852 @cindex Add prefix to absolute paths
2853 Specify @var{prefix} to add to the absolute paths when used with
2854 @option{-S}.
2856 @item --prefix-strip=@var{level}
2857 @cindex Strip absolute paths
2858 Indicate how many initial directory names to strip off the hardwired
2859 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2861 @item --show-raw-insn
2862 When disassembling instructions, print the instruction in hex as well as
2863 in symbolic form.  This is the default except when
2864 @option{--prefix-addresses} is used.
2866 @item --no-show-raw-insn
2867 When disassembling instructions, do not print the instruction bytes.
2868 This is the default when @option{--prefix-addresses} is used.
2870 @item --insn-width=@var{width}
2871 @cindex Instruction width
2872 Display @var{width} bytes on a single line when disassembling
2873 instructions.
2875 @item --visualize-jumps[=color|=extended-color|=off]
2876 Visualize jumps that stay inside a function by drawing ASCII art between
2877 the start and target addresses.  The optional @option{=color} argument
2878 adds color to the output using simple terminal colors.  Alternatively
2879 the @option{=extended-color} argument will add color using 8bit
2880 colors, but these might not work on all terminals.
2882 If it is necessary to disable the @option{visualize-jumps} option
2883 after it has previously been enabled then use
2884 @option{visualize-jumps=off}.
2886 @item --disassembler-color=off
2887 @itemx --disassembler-color=terminal
2888 @itemx --disassembler-color=on|color|colour
2889 @itemx --disassembler-color=extened|extended-color|extened-colour
2890 Enables or disables the use of colored syntax highlighting in
2891 disassembly output.  The default behaviour is determined via a
2892 configure time option.  Note, not all architectures support colored
2893 syntax highlighting, and depending upon the terminal used, colored
2894 output may not actually be legible.
2896 The @option{on} argument adds colors using simple terminal colors.
2898 The @option{terminal} argument does the same, but only if the output
2899 device is a terminal.
2901 The @option{extended-color} argument is similar to the @option{on}
2902 argument, but it uses 8-bit colors.  These may not work on all
2903 terminals.
2905 The @option{off} argument disables colored disassembly.
2907 @item -W[lLiaprmfFsoORtUuTgAckK]
2908 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
2909 @include debug.options.texi
2911 @item --dwarf-check
2912 Enable additional checks for consistency of Dwarf information.
2914 @include ctf.options.texi
2916 @include sframe.options.texi
2918 @item -G
2919 @itemx --stabs
2920 @cindex stab
2921 @cindex .stab
2922 @cindex debug symbols
2923 @cindex ELF object file format
2924 Display the full contents of any sections requested.  Display the
2925 contents of the .stab and .stab.index and .stab.excl sections from an
2926 ELF file.  This is only useful on systems (such as Solaris 2.0) in which
2927 @code{.stab} debugging symbol-table entries are carried in an ELF
2928 section.  In most other file formats, debugging symbol-table entries are
2929 interleaved with linkage symbols, and are visible in the @option{--syms}
2930 output.
2932 @item --start-address=@var{address}
2933 @cindex start-address
2934 Start displaying data at the specified address.  This affects the output
2935 of the @option{-d}, @option{-r} and @option{-s} options.
2937 @item --stop-address=@var{address}
2938 @cindex stop-address
2939 Stop displaying data at the specified address.  This affects the output
2940 of the @option{-d}, @option{-r} and @option{-s} options.
2942 @item -t
2943 @itemx --syms
2944 @cindex symbol table entries, printing
2945 Print the symbol table entries of the file.
2946 This is similar to the information provided by the @samp{nm} program,
2947 although the display format is different.  The format of the output
2948 depends upon the format of the file being dumped, but there are two main
2949 types.  One looks like this:
2951 @smallexample
2952 [  4](sec  3)(fl 0x00)(ty   0)(scl   3) (nx 1) 0x00000000 .bss
2953 [  6](sec  1)(fl 0x00)(ty   0)(scl   2) (nx 0) 0x00000000 fred
2954 @end smallexample
2956 where the number inside the square brackets is the number of the entry
2957 in the symbol table, the @var{sec} number is the section number, the
2958 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2959 symbol's type, the @var{scl} number is the symbol's storage class and
2960 the @var{nx} value is the number of auxiliary entries associated with
2961 the symbol.  The last two fields are the symbol's value and its name.
2963 The other common output format, usually seen with ELF based files,
2964 looks like this:
2966 @smallexample
2967 00000000 l    d  .bss   00000000 .bss
2968 00000000 g       .text  00000000 fred
2969 @end smallexample
2971 Here the first number is the symbol's value (sometimes referred to as
2972 its address).  The next field is actually a set of characters and
2973 spaces indicating the flag bits that are set on the symbol.  These
2974 characters are described below.  Next is the section with which the
2975 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2976 not connected with any section), or @emph{*UND*} if the section is
2977 referenced in the file being dumped, but not defined there.
2979 After the section name comes another field, a number, which for common
2980 symbols is the alignment and for other symbol is the size.  Finally
2981 the symbol's name is displayed.
2983 The flag characters are divided into 7 groups as follows:
2984 @table @code
2985 @item l
2986 @itemx g
2987 @itemx u
2988 @itemx !
2989 The symbol is a local (l), global (g), unique global (u), neither
2990 global nor local (a space) or both global and local (!).  A
2991 symbol can be neither local or global for a variety of reasons, e.g.,
2992 because it is used for debugging, but it is probably an indication of
2993 a bug if it is ever both local and global.  Unique global symbols are
2994 a GNU extension to the standard set of ELF symbol bindings.  For such
2995 a symbol the dynamic linker will make sure that in the entire process
2996 there is just one symbol with this name and type in use.
2998 @item w
2999 The symbol is weak (w) or strong (a space).
3001 @item C
3002 The symbol denotes a constructor (C) or an ordinary symbol (a space).
3004 @item W
3005 The symbol is a warning (W) or a normal symbol (a space).  A warning
3006 symbol's name is a message to be displayed if the symbol following the
3007 warning symbol is ever referenced.
3009 @item I
3010 @item i
3011 The symbol is an indirect reference to another symbol (I), a function
3012 to be evaluated during reloc processing (i) or a normal symbol (a
3013 space).
3015 @item d
3016 @itemx D
3017 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
3018 normal symbol (a space).
3020 @item F
3021 @item f
3022 @item O
3023 The symbol is the name of a function (F) or a file (f) or an object
3024 (O) or just a normal symbol (a space).
3025 @end table
3027 @item -T
3028 @itemx --dynamic-syms
3029 @cindex dynamic symbol table entries, printing
3030 Print the dynamic symbol table entries of the file.  This is only
3031 meaningful for dynamic objects, such as certain types of shared
3032 libraries.  This is similar to the information provided by the @samp{nm}
3033 program when given the @option{-D} (@option{--dynamic}) option.
3035 The output format is similar to that produced by the @option{--syms}
3036 option, except that an extra field is inserted before the symbol's
3037 name, giving the version information associated with the symbol.
3038 If the version is the default version to be used when resolving
3039 unversioned references to the symbol then it's displayed as is,
3040 otherwise it's put into parentheses.
3042 @item --special-syms
3043 When displaying symbols include those which the target considers to be
3044 special in some way and which would not normally be of interest to the
3045 user.
3047 @item -U @var{[d|i|l|e|x|h]}
3048 @itemx --unicode=@var{[default|invalid|locale|escape|hex|highlight]}
3049 Controls the display of UTF-8 encoded multibyte characters in strings.
3050 The default (@option{--unicode=default}) is to give them no special
3051 treatment.  The @option{--unicode=locale} option displays the sequence
3052 in the current locale, which may or may not support them.  The options
3053 @option{--unicode=hex} and @option{--unicode=invalid} display them as
3054 hex byte sequences enclosed by either angle brackets or curly braces.
3056 The @option{--unicode=escape} option displays them as escape sequences
3057 (@var{\uxxxx}) and the @option{--unicode=highlight} option displays
3058 them as escape sequences highlighted in red (if supported by the
3059 output device).  The colouring is intended to draw attention to the
3060 presence of unicode sequences where they might not be expected.
3062 @item -V
3063 @itemx --version
3064 Print the version number of @command{objdump} and exit.
3066 @item -x
3067 @itemx --all-headers
3068 @cindex all header information, object file
3069 @cindex header information, all
3070 Display all available header information, including the symbol table and
3071 relocation entries.  Using @option{-x} is equivalent to specifying all of
3072 @option{-a -f -h -p -r -t}.
3074 @item -w
3075 @itemx --wide
3076 @cindex wide output, printing
3077 Format some lines for output devices that have more than 80 columns.
3078 Also do not truncate symbol names when they are displayed.
3080 @item -z
3081 @itemx --disassemble-zeroes
3082 Normally the disassembly output will skip blocks of zeroes.  This
3083 option directs the disassembler to disassemble those blocks, just like
3084 any other data.
3086 @item -Z
3087 @itemx --decompress
3088 @cindex sections, full contents
3089 @cindex object file sections
3090 @cindex compressed section contents
3091 The @option{-Z} option is meant to be used in conunction with the
3092 @option{-s} option.  It instructs @command{objdump} to decompress any
3093 compressed sections before displaying their contents.
3094 @end table
3096 @c man end
3098 @ignore
3099 @c man begin SEEALSO objdump
3100 nm(1), readelf(1), and the Info entries for @file{binutils}.
3101 @c man end
3102 @end ignore
3104 @node ranlib
3105 @chapter ranlib
3107 @kindex ranlib
3108 @cindex archive contents
3109 @cindex symbol index
3111 @c man title ranlib generate an index to an archive
3113 @smallexample
3114 @c man begin SYNOPSIS ranlib
3115 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
3116 @c man end
3117 @end smallexample
3119 @c man begin DESCRIPTION ranlib
3121 @command{ranlib} generates an index to the contents of an archive and
3122 stores it in the archive.  The index lists each symbol defined by a
3123 member of an archive that is a relocatable object file.
3125 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
3127 An archive with such an index speeds up linking to the library and
3128 allows routines in the library to call each other without regard to
3129 their placement in the archive.
3131 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
3132 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
3133 @xref{ar}.
3135 @c man end
3137 @c man begin OPTIONS ranlib
3139 @table @env
3140 @item -h
3141 @itemx -H
3142 @itemx --help
3143 Show usage information for @command{ranlib}.
3145 @item -v
3146 @itemx -V
3147 @itemx --version
3148 Show the version number of @command{ranlib}.
3150 @item -D
3151 @cindex deterministic archives
3152 @kindex --enable-deterministic-archives
3153 Operate in @emph{deterministic} mode.  The symbol map archive member's
3154 header will show zero for the UID, GID, and timestamp.  When this
3155 option is used, multiple runs will produce identical output files.
3157 If @file{binutils} was configured with
3158 @option{--enable-deterministic-archives}, then this mode is on by
3159 default.  It can be disabled with the @samp{-U} option, described
3160 below.
3162 @item -t
3163 Update the timestamp of the symbol map of an archive.
3165 @item -U
3166 @cindex deterministic archives
3167 @kindex --enable-deterministic-archives
3168 Do @emph{not} operate in @emph{deterministic} mode.  This is the
3169 inverse of the @samp{-D} option, above: the archive index will get
3170 actual UID, GID, timestamp, and file mode values.
3172 If @file{binutils} was configured @emph{without}
3173 @option{--enable-deterministic-archives}, then this mode is on by
3174 default.
3176 @end table
3178 @c man end
3180 @ignore
3181 @c man begin SEEALSO ranlib
3182 ar(1), nm(1), and the Info entries for @file{binutils}.
3183 @c man end
3184 @end ignore
3186 @node size
3187 @chapter size
3189 @kindex size
3190 @cindex section sizes
3192 @c man title size list section sizes and total size of binary files
3194 @smallexample
3195 @c man begin SYNOPSIS size
3196 size [@option{-A}|@option{-B}|@option{-G}|@option{--format=}@var{compatibility}]
3197      [@option{--help}]
3198      [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
3199      [@option{--common}]
3200      [@option{-t}|@option{--totals}]
3201      [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
3202      [@option{-f}]
3203      [@var{objfile}@dots{}]
3204 @c man end
3205 @end smallexample
3207 @c man begin DESCRIPTION size
3209 The @sc{gnu} @command{size} utility lists the section sizes and the total
3210 size for each of the binary files @var{objfile} on its argument list.
3211 By default, one line of output is generated for each file or each
3212 module if the file is an archive.
3214 @var{objfile}@dots{} are the files to be examined.  If none are
3215 specified, the file @code{a.out} will be used instead.
3217 @c man end
3219 @c man begin OPTIONS size
3221 The command-line options have the following meanings:
3223 @table @env
3224 @item -A
3225 @itemx -B
3226 @itemx -G
3227 @itemx --format=@var{compatibility}
3228 @cindex @command{size} display format
3229 Using one of these options, you can choose whether the output from @sc{gnu}
3230 @command{size} resembles output from System V @command{size} (using @option{-A},
3231 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
3232 @option{--format=berkeley}).  The default is the one-line format similar to
3233 Berkeley's.  Alternatively, you can choose the GNU format output
3234 (using @option{-G}, or @option{--format=gnu}), this is similar to
3235 Berkeley's output format, but sizes are counted differently.
3236 @c Bonus for doc-source readers: you can also say --format=strange (or
3237 @c anything else that starts with 's') for sysv, and --format=boring (or
3238 @c anything else that starts with 'b') for Berkeley.
3240 Here is an example of the Berkeley (default) format of output from
3241 @command{size}:
3242 @smallexample
3243 $ size --format=Berkeley ranlib size
3244    text    data     bss     dec     hex filename
3245  294880   81920   11592  388392   5ed28 ranlib
3246  294880   81920   11888  388688   5ee50 size
3247 @end smallexample
3249 The Berkeley style output counts read only data in the @code{text}
3250 column, not in the @code{data} column, the @code{dec} and @code{hex}
3251 columns both display the sum of the @code{text}, @code{data}, and
3252 @code{bss} columns in decimal and hexadecimal respectively.
3254 The GNU format counts read only data in the @code{data} column, not
3255 the @code{text} column, and only displays the sum of the @code{text},
3256 @code{data}, and @code{bss} columns once, in the @code{total} column.
3257 The @option{--radix} option can be used to change the number base for
3258 all columns.  Here is the same data displayed with GNU conventions:
3260 @smallexample
3261 $ size --format=GNU ranlib size
3262       text       data        bss      total filename
3263     279880      96920      11592     388392 ranlib
3264     279880      96920      11888     388688 size
3265 @end smallexample
3267 @noindent
3268 This is the same data, but displayed closer to System V conventions:
3270 @smallexample
3271 $ size --format=SysV ranlib size
3272 ranlib  :
3273 section         size         addr
3274 .text         294880         8192
3275 .data          81920       303104
3276 .bss           11592       385024
3277 Total         388392
3280 size  :
3281 section         size         addr
3282 .text         294880         8192
3283 .data          81920       303104
3284 .bss           11888       385024
3285 Total         388688
3286 @end smallexample
3288 @item --help
3289 @itemx -h
3290 @itemx -H
3291 @item -?
3292 Show a summary of acceptable arguments and options.
3294 @item -d
3295 @itemx -o
3296 @itemx -x
3297 @itemx --radix=@var{number}
3298 @cindex @command{size} number format
3299 @cindex radix for section sizes
3300 Using one of these options, you can control whether the size of each
3301 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
3302 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
3303 @option{--radix=16}).  In @option{--radix=@var{number}}, only the three
3304 values (8, 10, 16) are supported.  The total size is always given in two
3305 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
3306 octal and hexadecimal if you're using @option{-o}.
3308 @item --common
3309 Print total size of common symbols in each file.  When using Berkeley
3310 or GNU format these are included in the bss size.
3312 @item -t
3313 @itemx --totals
3314 Show totals of all objects listed (Berkeley or GNU format mode only).
3316 @item --target=@var{bfdname}
3317 @cindex object code format
3318 Specify that the object-code format for @var{objfile} is
3319 @var{bfdname}.  This option may not be necessary; @command{size} can
3320 automatically recognize many formats.
3321 @xref{Target Selection}, for more information.
3323 @item -v
3324 @item -V
3325 @itemx --version
3326 Display the version number of @command{size}.
3328 @item -f
3329 Ignored.  This option is used by other versions of the @command{size}
3330 program, but it is not supported by the GNU Binutils version.
3332 @end table
3334 @c man end
3336 @ignore
3337 @c man begin SEEALSO size
3338 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
3339 @c man end
3340 @end ignore
3342 @node strings
3343 @chapter strings
3344 @kindex strings
3345 @cindex listings strings
3346 @cindex printing strings
3347 @cindex strings, printing
3349 @c man title strings print the sequences of printable characters in files
3351 @smallexample
3352 @c man begin SYNOPSIS strings
3353 strings [@option{-afovV}] [@option{-}@var{min-len}]
3354         [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
3355         [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
3356         [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
3357         [@option{-U} @var{method}] [@option{--unicode=}@var{method}]
3358         [@option{-}] [@option{--all}] [@option{--print-file-name}]
3359         [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
3360         [@option{-w}] [@option{--include-all-whitespace}]
3361         [@option{-s}] [@option{--output-separator} @var{sep_string}]
3362         [@option{--help}] [@option{--version}] @var{file}@dots{}
3363 @c man end
3364 @end smallexample
3366 @c man begin DESCRIPTION strings
3368 For each @var{file} given, @sc{gnu} @command{strings} prints the
3369 printable character sequences that are at least 4 characters long (or
3370 the number given with the options below) and are followed by an
3371 unprintable character.
3373 Depending upon how the strings program was configured it will default
3374 to either displaying all the printable sequences that it can find in
3375 each file, or only those sequences that are in loadable, initialized
3376 data sections.  If the file type is unrecognizable, or if strings is
3377 reading from stdin then it will always display all of the printable
3378 sequences that it can find.
3380 For backwards compatibility any file that occurs after a command-line
3381 option of just @option{-} will also be scanned in full, regardless of
3382 the presence of any @option{-d} option.
3384 @command{strings} is mainly useful for determining the contents of
3385 non-text files.
3387 @c man end
3389 @c man begin OPTIONS strings
3391 @table @env
3392 @item -a
3393 @itemx --all
3394 @itemx -
3395 Scan the whole file, regardless of what sections it contains or
3396 whether those sections are loaded or initialized.  Normally this is
3397 the default behaviour, but strings can be configured so that the
3398 @option{-d} is the default instead.
3400 The @option{-} option is position dependent and forces strings to
3401 perform full scans of any file that is mentioned after the @option{-}
3402 on the command line, even if the @option{-d} option has been
3403 specified.
3405 @item -d
3406 @itemx --data
3407 Only print strings from initialized, loaded data sections in the
3408 file.  This may reduce the amount of garbage in the output, but it
3409 also exposes the strings program to any security flaws that may be
3410 present in the BFD library used to scan and load sections.  Strings
3411 can be configured so that this option is the default behaviour.  In
3412 such cases the @option{-a} option can be used to avoid using the BFD
3413 library and instead just print all of the strings found in the file.
3415 @item -f
3416 @itemx --print-file-name
3417 Print the name of the file before each string.
3419 @item --help
3420 Print a summary of the program usage on the standard output and exit.
3422 @item -@var{min-len}
3423 @itemx -n @var{min-len}
3424 @itemx --bytes=@var{min-len}
3425 Print sequences of displayable characters that are at least
3426 @var{min-len} characters long.  If not specified a default minimum
3427 length of 4 is used.  The distinction between displayable and
3428 non-displayable characters depends upon the setting of the 
3429 @option{-e} and @option{-U} options.  Sequences are always terminated
3430 at control characters such as new-line and carriage-return, but not
3431 the tab character.
3433 @item -o
3434 Like @samp{-t o}.  Some other versions of @command{strings} have @option{-o}
3435 act like @samp{-t d} instead.  Since we can not be compatible with both
3436 ways, we simply chose one.
3438 @item -t @var{radix}
3439 @itemx --radix=@var{radix}
3440 Print the offset within the file before each string.  The single
3441 character argument specifies the radix of the offset---@samp{o} for
3442 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
3444 @item -e @var{encoding}
3445 @itemx --encoding=@var{encoding}
3446 Select the character encoding of the strings that are to be found.
3447 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
3448 characters (default), @samp{S} =
3449 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
3450 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
3451 littleendian.  Useful for finding wide character strings. (@samp{l}
3452 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
3454 @item -U @var{[d|i|l|e|x|h]}
3455 @itemx --unicode=@var{[default|invalid|locale|escape|hex|highlight]}
3456 Controls the display of UTF-8 encoded multibyte characters in strings.
3457 The default (@option{--unicode=default}) is to give them no special
3458 treatment, and instead rely upon the setting of the
3459 @option{--encoding} option.  The other values for this option
3460 automatically enable @option{--encoding=S}.
3462 The @option{--unicode=invalid} option treats them as non-graphic
3463 characters and hence not part of a valid string.  All the remaining
3464 options treat them as valid string characters.
3466 The @option{--unicode=locale} option displays them in the current
3467 locale, which may or may not support UTF-8 encoding.  The
3468 @option{--unicode=hex} option displays them as hex byte sequences
3469 enclosed between @var{<>} characters.  The @option{--unicode=escape}
3470 option displays them as escape sequences (@var{\uxxxx}) and the
3471 @option{--unicode=highlight} option displays them as escape sequences
3472 highlighted in red (if supported by the output device).  The colouring
3473 is intended to draw attention to the presence of unicode sequences
3474 where they might not be expected.
3476 @item -T @var{bfdname}
3477 @itemx --target=@var{bfdname}
3478 @cindex object code format
3479 Specify an object code format other than your system's default format.
3480 @xref{Target Selection}, for more information.
3482 @item -v
3483 @itemx -V
3484 @itemx --version
3485 Print the program version number on the standard output and exit.
3487 @item -w
3488 @itemx --include-all-whitespace
3489 By default tab and space characters are included in the strings that
3490 are displayed, but other whitespace characters, such a newlines and
3491 carriage returns, are not.  The @option{-w} option changes this so
3492 that all whitespace characters are considered to be part of a string.
3494 @item -s
3495 @itemx --output-separator
3496 By default, output strings are delimited by a new-line. This option
3497 allows you to supply any string to be used as the output record
3498 separator.  Useful with --include-all-whitespace where strings
3499 may contain new-lines internally.
3500 @end table
3502 @c man end
3504 @ignore
3505 @c man begin SEEALSO strings
3506 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
3507 and the Info entries for @file{binutils}.
3508 @c man end
3509 @end ignore
3511 @node strip
3512 @chapter strip
3514 @kindex strip
3515 @cindex removing symbols
3516 @cindex discarding symbols
3517 @cindex symbols, discarding
3519 @c man title strip discard symbols and other data from object files
3521 @smallexample
3522 @c man begin SYNOPSIS strip
3523 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
3524       [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
3525       [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
3526       [@option{-s}|@option{--strip-all}]
3527       [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
3528       [@option{--strip-dwo}]
3529       [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
3530       [@option{-M}|@option{--merge-notes}][@option{--no-merge-notes}]
3531       [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
3532       [@option{-w}|@option{--wildcard}]
3533       [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
3534       [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
3535       [@option{--keep-section=}@var{sectionpattern}]
3536       [@option{--remove-relocations=}@var{sectionpattern}]
3537       [@option{--strip-section-headers}]
3538       [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
3539       [@option{-D}|@option{--enable-deterministic-archives}]
3540       [@option{-U}|@option{--disable-deterministic-archives}]
3541       [@option{--keep-section-symbols}]
3542       [@option{--keep-file-symbols}]
3543       [@option{--only-keep-debug}]
3544       [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
3545       [@option{--help}] [@option{--info}]
3546       @var{objfile}@dots{}
3547 @c man end
3548 @end smallexample
3550 @c man begin DESCRIPTION strip
3552 @sc{gnu} @command{strip} discards all symbols from object files
3553 @var{objfile}.  The list of object files may include archives.
3554 At least one object file must be given.
3556 @command{strip} modifies the files named in its argument,
3557 rather than writing modified copies under different names.
3559 @c man end
3561 @c man begin OPTIONS strip
3563 @table @env
3564 @item -F @var{bfdname}
3565 @itemx --target=@var{bfdname}
3566 Treat the original @var{objfile} as a file with the object
3567 code format @var{bfdname}, and rewrite it in the same format.
3568 @xref{Target Selection}, for more information.
3570 @item --help
3571 Show a summary of the options to @command{strip} and exit.
3573 @item --info
3574 Display a list showing all architectures and object formats available.
3576 @item -I @var{bfdname}
3577 @itemx --input-target=@var{bfdname}
3578 Treat the original @var{objfile} as a file with the object
3579 code format @var{bfdname}.
3580 @xref{Target Selection}, for more information.
3582 @item -O @var{bfdname}
3583 @itemx --output-target=@var{bfdname}
3584 Replace @var{objfile} with a file in the output format @var{bfdname}.
3585 @xref{Target Selection}, for more information.
3587 @item -R @var{sectionname}
3588 @itemx --remove-section=@var{sectionname}
3589 Remove any section named @var{sectionname} from the output file, in
3590 addition to whatever sections would otherwise be removed.  This
3591 option may be given more than once.  Note that using this option
3592 inappropriately may make the output file unusable.  The wildcard
3593 character @samp{*} may be given at the end of @var{sectionname}.  If
3594 so, then any section starting with @var{sectionname} will be removed.
3596 If the first character of @var{sectionpattern} is the exclamation
3597 point (!) then matching sections will not be removed even if an
3598 earlier use of @option{--remove-section} on the same command line
3599 would otherwise remove it.  For example:
3601 @smallexample
3602   --remove-section=.text.* --remove-section=!.text.foo
3603 @end smallexample
3605 will remove all sections matching the pattern '.text.*', but will not
3606 remove the section '.text.foo'.
3608 @item --keep-section=@var{sectionpattern}
3609 When removing sections from the output file, keep sections that match
3610 @var{sectionpattern}.
3612 @item --remove-relocations=@var{sectionpattern}
3613 Remove relocations from the output file for any section matching
3614 @var{sectionpattern}.  This option may be given more than once.  Note
3615 that using this option inappropriately may make the output file
3616 unusable.  Wildcard characters are accepted in @var{sectionpattern}.
3617 For example:
3619 @smallexample
3620   --remove-relocations=.text.*
3621 @end smallexample
3623 will remove the relocations for all sections matching the patter
3624 '.text.*'.
3626 If the first character of @var{sectionpattern} is the exclamation
3627 point (!) then matching sections will not have their relocation
3628 removed even if an earlier use of @option{--remove-relocations} on the
3629 same command line would otherwise cause the relocations to be removed.
3630 For example:
3632 @smallexample
3633   --remove-relocations=.text.* --remove-relocations=!.text.foo
3634 @end smallexample
3636 will remove all relocations for sections matching the pattern
3637 '.text.*', but will not remove relocations for the section
3638 '.text.foo'.
3640 @item --strip-section-headers
3641 Strip section headers.  This option is specific to ELF files.  Implies
3642 @option{--strip-all} and @option{--merge-notes}.
3644 @item -s
3645 @itemx --strip-all
3646 Remove all symbols.
3648 @item -g
3649 @itemx -S
3650 @itemx -d
3651 @itemx --strip-debug
3652 Remove debugging symbols only.
3654 @item --strip-dwo
3655 Remove the contents of all DWARF .dwo sections, leaving the
3656 remaining debugging sections and all symbols intact.
3657 See the description of this option in the @command{objcopy} section
3658 for more information.
3660 @item --strip-unneeded
3661 Remove all symbols that are not needed for relocation processing in
3662 addition to debugging symbols and sections stripped by
3663 @option{--strip-debug}.
3665 @item -K @var{symbolname}
3666 @itemx --keep-symbol=@var{symbolname}
3667 When stripping symbols, keep symbol @var{symbolname} even if it would
3668 normally be stripped.  This option may be given more than once.
3670 @item -M
3671 @itemx --merge-notes
3672 @itemx --no-merge-notes
3673 For ELF files, attempt (or do not attempt) to reduce the size of any
3674 SHT_NOTE type sections by removing duplicate notes.  The default is to
3675 attempt this reduction unless stripping debug or DWO information.
3677 @item -N @var{symbolname}
3678 @itemx --strip-symbol=@var{symbolname}
3679 Remove symbol @var{symbolname} from the source file. This option may be
3680 given more than once, and may be combined with strip options other than
3681 @option{-K}.
3683 @item -o @var{file}
3684 Put the stripped output in @var{file}, rather than replacing the
3685 existing file.  When this argument is used, only one @var{objfile}
3686 argument may be specified.
3688 @item -p
3689 @itemx --preserve-dates
3690 Preserve the access and modification dates of the file.
3692 @item -D
3693 @itemx --enable-deterministic-archives
3694 @cindex deterministic archives
3695 @kindex --enable-deterministic-archives
3696 Operate in @emph{deterministic} mode.  When copying archive members
3697 and writing the archive index, use zero for UIDs, GIDs, timestamps,
3698 and use consistent file modes for all files.
3700 If @file{binutils} was configured with
3701 @option{--enable-deterministic-archives}, then this mode is on by default.
3702 It can be disabled with the @samp{-U} option, below.
3704 @item -U
3705 @itemx --disable-deterministic-archives
3706 @cindex deterministic archives
3707 @kindex --enable-deterministic-archives
3708 Do @emph{not} operate in @emph{deterministic} mode.  This is the
3709 inverse of the @option{-D} option, above: when copying archive members
3710 and writing the archive index, use their actual UID, GID, timestamp,
3711 and file mode values.
3713 This is the default unless @file{binutils} was configured with
3714 @option{--enable-deterministic-archives}.
3716 @item -w
3717 @itemx --wildcard
3718 Permit regular expressions in @var{symbolname}s used in other command
3719 line options.  The question mark (?), asterisk (*), backslash (\) and
3720 square brackets ([]) operators can be used anywhere in the symbol
3721 name.  If the first character of the symbol name is the exclamation
3722 point (!) then the sense of the switch is reversed for that symbol.
3723 For example:
3725 @smallexample
3726   -w -K !foo -K fo*
3727 @end smallexample
3729 would cause strip to only keep symbols that start with the letters
3730 ``fo'', but to discard the symbol ``foo''.
3732 @item -x
3733 @itemx --discard-all
3734 Remove non-global symbols.
3736 @item -X
3737 @itemx --discard-locals
3738 Remove compiler-generated local symbols.
3739 (These usually start with @samp{L} or @samp{.}.)
3741 @item --keep-section-symbols
3742 When stripping a file, perhaps with @option{--strip-debug} or
3743 @option{--strip-unneeded}, retain any symbols specifying section names,
3744 which would otherwise get stripped.
3746 @item --keep-file-symbols
3747 When stripping a file, perhaps with @option{--strip-debug} or
3748 @option{--strip-unneeded}, retain any symbols specifying source file names,
3749 which would otherwise get stripped.
3751 @item --only-keep-debug
3752 Strip a file, emptying the contents of any sections that would not be
3753 stripped by @option{--strip-debug} and leaving the debugging sections
3754 intact.  In ELF files, this preserves all the note sections in the
3755 output as well.
3757 Note - the section headers of the stripped sections are preserved,
3758 including their sizes, but the contents of the section are discarded.
3759 The section headers are preserved so that other tools can match up the
3760 debuginfo file with the real executable, even if that executable has
3761 been relocated to a different address space.
3763 The intention is that this option will be used in conjunction with
3764 @option{--add-gnu-debuglink} to create a two part executable.  One a
3765 stripped binary which will occupy less space in RAM and in a
3766 distribution and the second a debugging information file which is only
3767 needed if debugging abilities are required.  The suggested procedure
3768 to create these files is as follows:
3770 @enumerate
3771 @item Link the executable as normal.  Assuming that it is called
3772 @code{foo} then...
3773 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
3774 create a file containing the debugging info.
3775 @item Run @code{objcopy --strip-debug foo} to create a
3776 stripped executable.
3777 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
3778 to add a link to the debugging info into the stripped executable.
3779 @end enumerate
3781 Note---the choice of @code{.dbg} as an extension for the debug info
3782 file is arbitrary.  Also the @code{--only-keep-debug} step is
3783 optional.  You could instead do this:
3785 @enumerate
3786 @item Link the executable as normal.
3787 @item Copy @code{foo} to @code{foo.full}
3788 @item Run @code{strip --strip-debug foo}
3789 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
3790 @end enumerate
3792 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
3793 full executable.  It does not have to be a file created by the
3794 @option{--only-keep-debug} switch.
3796 Note---this switch is only intended for use on fully linked files.  It
3797 does not make sense to use it on object files where the debugging
3798 information may be incomplete.  Besides the gnu_debuglink feature
3799 currently only supports the presence of one filename containing
3800 debugging information, not multiple filenames on a one-per-object-file
3801 basis.
3803 @item -V
3804 @itemx --version
3805 Show the version number for @command{strip}.
3807 @item -v
3808 @itemx --verbose
3809 Verbose output: list all object files modified.  In the case of
3810 archives, @samp{strip -v} lists all members of the archive.
3811 @end table
3813 @c man end
3815 @ignore
3816 @c man begin SEEALSO strip
3817 the Info entries for @file{binutils}.
3818 @c man end
3819 @end ignore
3821 @node c++filt, addr2line, strip, Top
3822 @chapter c++filt
3824 @kindex c++filt
3825 @cindex demangling C++ symbols
3827 @c man title cxxfilt demangle C++ and Java symbols
3829 @smallexample
3830 @c man begin SYNOPSIS cxxfilt
3831 c++filt [@option{-_}|@option{--strip-underscore}]
3832         [@option{-n}|@option{--no-strip-underscore}]
3833         [@option{-p}|@option{--no-params}]
3834         [@option{-t}|@option{--types}]
3835         [@option{-i}|@option{--no-verbose}]
3836         [@option{-r}|@option{--no-recurse-limit}]
3837         [@option{-R}|@option{--recurse-limit}]
3838         [@option{-s} @var{format}|@option{--format=}@var{format}]
3839         [@option{--help}]  [@option{--version}]  [@var{symbol}@dots{}]
3840 @c man end
3841 @end smallexample
3843 @c man begin DESCRIPTION cxxfilt
3845 @kindex cxxfilt
3846 The C++ and Java languages provide function overloading, which means
3847 that you can write many functions with the same name, providing that
3848 each function takes parameters of different types.  In order to be
3849 able to distinguish these similarly named functions C++ and Java
3850 encode them into a low-level assembler name which uniquely identifies
3851 each different version.  This process is known as @dfn{mangling}. The
3852 @command{c++filt}
3853 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
3854 MS-DOS this program is named @command{CXXFILT}.}
3855 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
3856 names into user-level names so that they can be read.
3858 Every alphanumeric word (consisting of letters, digits, underscores,
3859 dollars, or periods) seen in the input is a potential mangled name.
3860 If the name decodes into a C++ name, the C++ name replaces the
3861 low-level name in the output, otherwise the original word is output.
3862 In this way you can pass an entire assembler source file, containing
3863 mangled names, through @command{c++filt} and see the same source file
3864 containing demangled names.
3866 You can also use @command{c++filt} to decipher individual symbols by
3867 passing them on the command line:
3869 @example
3870 c++filt @var{symbol}
3871 @end example
3873 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
3874 names from the standard input instead.  All the results are printed on
3875 the standard output.  The difference between reading names from the
3876 command line versus reading names from the standard input is that
3877 command-line arguments are expected to be just mangled names and no
3878 checking is performed to separate them from surrounding text.  Thus
3879 for example:
3881 @smallexample
3882 c++filt -n _Z1fv
3883 @end smallexample
3885 will work and demangle the name to ``f()'' whereas:
3887 @smallexample
3888 c++filt -n _Z1fv,
3889 @end smallexample
3891 will not work.  (Note the extra comma at the end of the mangled
3892 name which makes it invalid).  This command however will work:
3894 @smallexample
3895 echo _Z1fv, | c++filt -n
3896 @end smallexample
3898 and will display ``f(),'', i.e., the demangled name followed by a
3899 trailing comma.  This behaviour is because when the names are read
3900 from the standard input it is expected that they might be part of an
3901 assembler source file where there might be extra, extraneous
3902 characters trailing after a mangled name.  For example:
3904 @smallexample
3905     .type   _Z1fv, @@function
3906 @end smallexample
3908 @c man end
3910 @c man begin OPTIONS cxxfilt
3912 @table @env
3913 @item -_
3914 @itemx --strip-underscore
3915 On some systems, both the C and C++ compilers put an underscore in front
3916 of every name.  For example, the C name @code{foo} gets the low-level
3917 name @code{_foo}.  This option removes the initial underscore.  Whether
3918 @command{c++filt} removes the underscore by default is target dependent.
3920 @item -n
3921 @itemx --no-strip-underscore
3922 Do not remove the initial underscore.
3924 @item -p
3925 @itemx --no-params
3926 When demangling the name of a function, do not display the types of
3927 the function's parameters.
3929 @item -t
3930 @itemx --types
3931 Attempt to demangle types as well as function names.  This is disabled
3932 by default since mangled types are normally only used internally in
3933 the compiler, and they can be confused with non-mangled names.  For example,
3934 a function called ``a'' treated as a mangled type name would be
3935 demangled to ``signed char''.
3937 @item -i
3938 @itemx --no-verbose
3939 Do not include implementation details (if any) in the demangled
3940 output.
3942 @item -r
3943 @itemx -R
3944 @itemx --recurse-limit
3945 @itemx --no-recurse-limit
3946 @itemx --recursion-limit
3947 @itemx --no-recursion-limit
3948 Enables or disables a limit on the amount of recursion performed
3949 whilst demangling strings.  Since the name mangling formats allow for
3950 an infinite level of recursion it is possible to create strings whose
3951 decoding will exhaust the amount of stack space available on the host
3952 machine, triggering a memory fault.  The limit tries to prevent this
3953 from happening by restricting recursion to 2048 levels of nesting.
3955 The default is for this limit to be enabled, but disabling it may be
3956 necessary in order to demangle truly complicated names.  Note however
3957 that if the recursion limit is disabled then stack exhaustion is
3958 possible and any bug reports about such an event will be rejected.
3960 The @option{-r} option is a synonym for the
3961 @option{--no-recurse-limit} option.  The @option{-R} option is a
3962 synonym for the @option{--recurse-limit} option.
3964 @item -s @var{format}
3965 @itemx --format=@var{format}
3966 @command{c++filt} can decode various methods of mangling, used by
3967 different compilers.  The argument to this option selects which
3968 method it uses:
3970 @table @code
3971 @item auto
3972 Automatic selection based on executable (the default method)
3973 @item gnu
3974 the one used by the @sc{gnu} C++ compiler (g++)
3975 @item lucid
3976 the one used by the Lucid compiler (lcc)
3977 @item arm
3978 the one specified by the C++ Annotated Reference Manual
3979 @item hp
3980 the one used by the HP compiler (aCC)
3981 @item edg
3982 the one used by the EDG compiler
3983 @item gnu-v3
3984 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3985 @item java
3986 the one used by the @sc{gnu} Java compiler (gcj)
3987 @item gnat
3988 the one used by the @sc{gnu} Ada compiler (GNAT).
3989 @end table
3991 @item --help
3992 Print a summary of the options to @command{c++filt} and exit.
3994 @item --version
3995 Print the version number of @command{c++filt} and exit.
3996 @end table
3998 @c man end
4000 @ignore
4001 @c man begin SEEALSO cxxfilt
4002 the Info entries for @file{binutils}.
4003 @c man end
4004 @end ignore
4006 @quotation
4007 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
4008 user interface are subject to change in future releases.  In particular,
4009 a command-line option may be required in the future to decode a name
4010 passed as an argument on the command line; in other words,
4012 @example
4013 c++filt @var{symbol}
4014 @end example
4016 @noindent
4017 may in a future release become
4019 @example
4020 c++filt @var{option} @var{symbol}
4021 @end example
4022 @end quotation
4024 @node addr2line
4025 @chapter addr2line
4027 @kindex addr2line
4028 @cindex address to file name and line number
4030 @c man title addr2line convert addresses or symbol+offset into file names and line numbers
4032 @smallexample
4033 @c man begin SYNOPSIS addr2line
4034 addr2line [@option{-a}|@option{--addresses}]
4035           [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
4036           [@option{-C}|@option{--demangle}[=@var{style}]]
4037           [@option{-r}|@option{--no-recurse-limit}]
4038           [@option{-R}|@option{--recurse-limit}]
4039           [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
4040           [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
4041           [@option{-i}|@option{--inlines}]
4042           [@option{-p}|@option{--pretty-print}]
4043           [@option{-j}|@option{--section=}@var{name}]
4044           [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
4045           [addr addr @dots{}]
4046 @c man end
4047 @end smallexample
4049 @c man begin DESCRIPTION addr2line
4051 @command{addr2line} translates addresses or symbol+offset into file names and line numbers.
4052 Given an address or symbol+offset in an executable or an offset in a section of a relocatable
4053 object, it uses the debugging information to figure out which file name and
4054 line number are associated with it.
4056 The executable or relocatable object to use is specified with the @option{-e}
4057 option.  The default is the file @file{a.out}.  The section in the relocatable
4058 object to use is specified with the @option{-j} option.
4060 @command{addr2line} has two modes of operation.
4062 In the first, hexadecimal addresses or symbol+offset are specified on the command line,
4063 and @command{addr2line} displays the file name and line number for each
4064 address.
4066 In the second, @command{addr2line} reads hexadecimal addresses or symbol+offset from
4067 standard input, and prints the file name and line number for each
4068 address on standard output.  In this mode, @command{addr2line} may be used
4069 in a pipe to convert dynamically chosen addresses.
4071 The format of the output is @samp{FILENAME:LINENO}.  By default
4072 each input address generates one line of output.
4074 Two options can generate additional lines before each
4075 @samp{FILENAME:LINENO} line (in that order).
4077 If the @option{-a} option is used then a line with the input address
4078 is displayed.
4080 If the @option{-f} option is used, then a line with the
4081 @samp{FUNCTIONNAME} is displayed.  This is the name of the function
4082 containing the address.
4084 One option can generate additional lines after the
4085 @samp{FILENAME:LINENO} line.
4087 If the @option{-i} option is used and the code at the given address is
4088 present there because of inlining by the compiler then additional
4089 lines are displayed afterwards.  One or two extra lines (if the
4090 @option{-f} option is used) are displayed for each inlined function.
4092 Alternatively if the @option{-p} option is used then each input
4093 address generates a single, long, output line containing the address,
4094 the function name, the file name and the line number.  If the
4095 @option{-i} option has also been used then any inlined functions will
4096 be displayed in the same manner, but on separate lines, and prefixed
4097 by the text @samp{(inlined by)}.
4099 If the file name or function name can not be determined,
4100 @command{addr2line} will print two question marks in their place.  If the
4101 line number can not be determined, @command{addr2line} will print 0.
4103 When symbol+offset is used, +offset is optional, except when the symbol
4104 is ambigious with a hex number. The resolved symbols can be mangled
4105 or unmangled, except unmangled symbols with + are not allowed.
4107 @c man end
4109 @c man begin OPTIONS addr2line
4111 The long and short forms of options, shown here as alternatives, are
4112 equivalent.
4114 @table @env
4115 @item -a
4116 @itemx --addresses
4117 Display the address before the function name, file and line number
4118 information.  The address is printed with a @samp{0x} prefix to easily
4119 identify it.
4121 @item -b @var{bfdname}
4122 @itemx --target=@var{bfdname}
4123 @cindex object code format
4124 Specify that the object-code format for the object files is
4125 @var{bfdname}.
4127 @item -C
4128 @itemx --demangle[=@var{style}]
4129 @cindex demangling in objdump
4130 Decode (@dfn{demangle}) low-level symbol names into user-level names.
4131 Besides removing any initial underscore prepended by the system, this
4132 makes C++ function names readable.  Different compilers have different
4133 mangling styles. The optional demangling style argument can be used to
4134 choose an appropriate demangling style for your compiler. @xref{c++filt},
4135 for more information on demangling.
4137 @item -e @var{filename}
4138 @itemx --exe=@var{filename}
4139 Specify the name of the executable for which addresses should be
4140 translated.  The default file is @file{a.out}.
4142 @item -f
4143 @itemx --functions
4144 Display function names as well as file and line number information.
4146 @item -s
4147 @itemx --basenames
4148 Display only the base of each file name.
4150 @item -i
4151 @itemx --inlines
4152 If the address belongs to a function that was inlined, the source
4153 information for all enclosing scopes back to the first non-inlined
4154 function will also be printed.  For example, if @code{main} inlines
4155 @code{callee1} which inlines @code{callee2}, and address is from
4156 @code{callee2}, the source information for @code{callee1} and @code{main}
4157 will also be printed.
4159 @item -j
4160 @itemx --section
4161 Read offsets relative to the specified section instead of absolute addresses.
4163 @item -p
4164 @itemx --pretty-print
4165 Make the output more human friendly: each location are printed on one line.
4166 If option @option{-i} is specified, lines for all enclosing scopes are
4167 prefixed with @samp{(inlined by)}.
4169 @item -r
4170 @itemx -R
4171 @itemx --recurse-limit
4172 @itemx --no-recurse-limit
4173 @itemx --recursion-limit
4174 @itemx --no-recursion-limit
4175 Enables or disables a limit on the amount of recursion performed
4176 whilst demangling strings.  Since the name mangling formats allow for
4177 an infinite level of recursion it is possible to create strings whose
4178 decoding will exhaust the amount of stack space available on the host
4179 machine, triggering a memory fault.  The limit tries to prevent this
4180 from happening by restricting recursion to 2048 levels of nesting.
4182 The default is for this limit to be enabled, but disabling it may be
4183 necessary in order to demangle truly complicated names.  Note however
4184 that if the recursion limit is disabled then stack exhaustion is
4185 possible and any bug reports about such an event will be rejected.
4187 The @option{-r} option is a synonym for the
4188 @option{--no-recurse-limit} option.  The @option{-R} option is a
4189 synonym for the @option{--recurse-limit} option.
4191 Note this option is only effective if the @option{-C} or
4192 @option{--demangle} option has been enabled.
4194 @end table
4196 @c man end
4198 @ignore
4199 @c man begin SEEALSO addr2line
4200 Info entries for @file{binutils}.
4201 @c man end
4202 @end ignore
4204 @node windmc
4205 @chapter windmc
4207 @command{windmc} may be used to generator Windows message resources.
4209 @quotation
4210 @emph{Warning:} @command{windmc} is not always built as part of the binary
4211 utilities, since it is only useful for Windows targets.
4212 @end quotation
4214 @c man title windmc generates Windows message resources
4216 @smallexample
4217 @c man begin SYNOPSIS windmc
4218 windmc [options] input-file
4219 @c man end
4220 @end smallexample
4222 @c man begin DESCRIPTION windmc
4224 @command{windmc} reads message definitions from an input file (.mc) and
4225 translate them into a set of output files.  The output files may be of
4226 four kinds:
4228 @table @code
4229 @item h
4230 A C header file containing the message definitions.
4232 @item rc
4233 A resource file compilable by the @command{windres} tool.
4235 @item bin
4236 One or more binary files containing the resource data for a specific
4237 message language.
4239 @item dbg
4240 A C include file that maps message id's to their symbolic name.
4241 @end table
4243 The exact description of these different formats is available in
4244 documentation from Microsoft.
4246 When @command{windmc} converts from the @code{mc} format to the @code{bin}
4247 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
4248 Windows Message Compiler.
4250 @c man end
4252 @c man begin OPTIONS windmc
4254 @table @env
4255 @item -a
4256 @itemx --ascii_in
4257 Specifies that the input file specified is ASCII. This is the default
4258 behaviour.
4260 @item -A
4261 @itemx --ascii_out
4262 Specifies that messages in the output @code{bin} files should be in ASCII
4263 format.
4265 @item -b
4266 @itemx --binprefix
4267 Specifies that @code{bin} filenames should have to be prefixed by the
4268 basename of the source file.
4270 @item -c
4271 @itemx --customflag
4272 Sets the customer bit in all message id's.
4274 @item -C @var{codepage}
4275 @itemx --codepage_in @var{codepage}
4276 Sets the default codepage to be used to convert input file to UTF16. The
4277 default is ocdepage 1252.
4279 @item -d
4280 @itemx --decimal_values
4281 Outputs the constants in the header file in decimal. Default is using
4282 hexadecimal output.
4284 @item -e @var{ext}
4285 @itemx --extension @var{ext}
4286 The extension for the header file. The default is .h extension.
4288 @item -F @var{target}
4289 @itemx --target @var{target}
4290 Specify the BFD format to use for a bin file as output.  This
4291 is a BFD target name; you can use the @option{--help} option to see a list
4292 of supported targets.  Normally @command{windmc} will use the default
4293 format, which is the first one listed by the @option{--help} option.
4294 @ifclear man
4295 @ref{Target Selection}.
4296 @end ifclear
4298 @item -h @var{path}
4299 @itemx --headerdir @var{path}
4300 The target directory of the generated header file. The default is the
4301 current directory.
4303 @item -H
4304 @itemx --help
4305 Displays a list of command-line options and then exits.
4307 @item -m @var{characters}
4308 @itemx --maxlength @var{characters}
4309 Instructs @command{windmc} to generate a warning if the length
4310 of any message exceeds the number specified.
4312 @item -n
4313 @itemx --nullterminate
4314 Terminate message text in @code{bin} files by zero. By default they are
4315 terminated by CR/LF.
4317 @item -o
4318 @itemx --hresult_use
4319 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
4320 file, using HRESULT definitions. Status codes are used if the flag is not
4321 specified.
4323 @item -O @var{codepage}
4324 @itemx --codepage_out @var{codepage}
4325 Sets the default codepage to be used to output text files. The default
4326 is ocdepage 1252.
4328 @item -r @var{path}
4329 @itemx --rcdir @var{path}
4330 The target directory for the generated @code{rc} script and the generated
4331 @code{bin} files that the resource compiler script includes. The default
4332 is the current directory.
4334 @item -u
4335 @itemx --unicode_in
4336 Specifies that the input file is UTF16.
4338 @item -U
4339 @itemx --unicode_out
4340 Specifies that messages in the output @code{bin} file should be in UTF16
4341 format. This is the default behaviour.
4343 @item -v
4344 @item --verbose
4345 Enable verbose mode.
4347 @item -V
4348 @item --version
4349 Prints the version number for @command{windmc}.
4351 @item -x @var{path}
4352 @itemx --xdgb @var{path}
4353 The path of the @code{dbg} C include file that maps message id's to the
4354 symbolic name. No such file is generated without specifying the switch.
4355 @end table
4357 @c man end
4359 @ignore
4360 @c man begin SEEALSO windmc
4361 the Info entries for @file{binutils}.
4362 @c man end
4363 @end ignore
4365 @node windres
4366 @chapter windres
4368 @command{windres} may be used to manipulate Windows resources.
4370 @quotation
4371 @emph{Warning:} @command{windres} is not always built as part of the binary
4372 utilities, since it is only useful for Windows targets.
4373 @end quotation
4375 @c man title windres manipulate Windows resources
4377 @smallexample
4378 @c man begin SYNOPSIS windres
4379 windres [options] [input-file] [output-file]
4380 @c man end
4381 @end smallexample
4383 @c man begin DESCRIPTION windres
4385 @command{windres} reads resources from an input file and copies them into
4386 an output file.  Either file may be in one of three formats:
4388 @table @code
4389 @item rc
4390 A text format read by the Resource Compiler.
4392 @item res
4393 A binary format generated by the Resource Compiler.
4395 @item coff
4396 A COFF object or executable.
4397 @end table
4399 The exact description of these different formats is available in
4400 documentation from Microsoft.
4402 When @command{windres} converts from the @code{rc} format to the @code{res}
4403 format, it is acting like the Windows Resource Compiler.  When
4404 @command{windres} converts from the @code{res} format to the @code{coff}
4405 format, it is acting like the Windows @code{CVTRES} program.
4407 When @command{windres} generates an @code{rc} file, the output is similar
4408 but not identical to the format expected for the input.  When an input
4409 @code{rc} file refers to an external filename, an output @code{rc} file
4410 will instead include the file contents.
4412 If the input or output format is not specified, @command{windres} will
4413 guess based on the file name, or, for the input file, the file contents.
4414 A file with an extension of @file{.rc} will be treated as an @code{rc}
4415 file, a file with an extension of @file{.res} will be treated as a
4416 @code{res} file, and a file with an extension of @file{.o} or
4417 @file{.exe} will be treated as a @code{coff} file.
4419 If no output file is specified, @command{windres} will print the resources
4420 in @code{rc} format to standard output.
4422 The normal use is for you to write an @code{rc} file, use @command{windres}
4423 to convert it to a COFF object file, and then link the COFF file into
4424 your application.  This will make the resources described in the
4425 @code{rc} file available to Windows.
4427 @c man end
4429 @c man begin OPTIONS windres
4431 @table @env
4432 @item -i @var{filename}
4433 @itemx --input @var{filename}
4434 The name of the input file.  If this option is not used, then
4435 @command{windres} will use the first non-option argument as the input file
4436 name.  If there are no non-option arguments, then @command{windres} will
4437 read from standard input.  @command{windres} can not read a COFF file from
4438 standard input.
4440 @item -o @var{filename}
4441 @itemx --output @var{filename}
4442 The name of the output file.  If this option is not used, then
4443 @command{windres} will use the first non-option argument, after any used
4444 for the input file name, as the output file name.  If there is no
4445 non-option argument, then @command{windres} will write to standard output.
4446 @command{windres} can not write a COFF file to standard output.  Note,
4447 for compatibility with @command{rc} the option @option{-fo} is also
4448 accepted, but its use is not recommended.
4450 @item -J @var{format}
4451 @itemx --input-format @var{format}
4452 The input format to read.  @var{format} may be @samp{res}, @samp{rc}, or
4453 @samp{coff}.  If no input format is specified, @command{windres} will
4454 guess, as described above.
4456 @item -O @var{format}
4457 @itemx --output-format @var{format}
4458 The output format to generate.  @var{format} may be @samp{res},
4459 @samp{rc}, or @samp{coff}.  If no output format is specified,
4460 @command{windres} will guess, as described above.
4462 @item -F @var{target}
4463 @itemx --target @var{target}
4464 Specify the BFD format to use for a COFF file as input or output.  This
4465 is a BFD target name; you can use the @option{--help} option to see a list
4466 of supported targets.  Normally @command{windres} will use the default
4467 format, which is the first one listed by the @option{--help} option.
4468 @ifclear man
4469 @ref{Target Selection}.
4470 @end ifclear
4472 @item --preprocessor @var{program}
4473 When @command{windres} reads an @code{rc} file, it runs it through the C
4474 preprocessor first.  This option may be used to specify the preprocessor
4475 to use.  The default preprocessor is @code{gcc}.
4477 @item --preprocessor-arg @var{option}
4478 When @command{windres} reads an @code{rc} file, it runs it through
4479 the C preprocessor first.  This option may be used to specify additional
4480 text to be passed to preprocessor on its command line.
4481 This option can be used multiple times to add multiple options to the
4482 preprocessor command line.
4483 If the @option{--preprocessor} option has not been specified then a
4484 default set of preprocessor arguments will be used, with any
4485 @option{--preprocessor-arg} options being placed after them on the
4486 command line.  These default arguments are @code{-E},
4487 @code{-xc-header} and @code{-DRC_INVOKED}.
4489 @item -I @var{directory}
4490 @itemx --include-dir @var{directory}
4491 Specify an include directory to use when reading an @code{rc} file.
4492 @command{windres} will pass this to the preprocessor as an @option{-I}
4493 option.  @command{windres} will also search this directory when looking for
4494 files named in the @code{rc} file.  If the argument passed to this command
4495 matches any of the supported @var{formats} (as described in the @option{-J}
4496 option), it will issue a deprecation warning, and behave just like the
4497 @option{-J} option.  New programs should not use this behaviour.  If a
4498 directory happens to match a @var{format}, simple prefix it with @samp{./}
4499 to disable the backward compatibility.
4501 @item -D @var{target}
4502 @itemx --define @var{sym}[=@var{val}]
4503 Specify a @option{-D} option to pass to the preprocessor when reading an
4504 @code{rc} file.
4506 @item -U @var{target}
4507 @itemx --undefine @var{sym}
4508 Specify a @option{-U} option to pass to the preprocessor when reading an
4509 @code{rc} file.
4511 @item -r
4512 Ignored for compatibility with rc.
4514 @item -v
4515 Enable verbose mode.  This tells you what the preprocessor is if you
4516 didn't specify one.
4518 @item -c @var{val}
4519 @item --codepage @var{val}
4520 Specify the default codepage to use when reading an @code{rc} file.
4521 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
4522 codepage code. The valid range is from zero up to 0xffff, but the
4523 validity of the codepage is host and configuration dependent.
4525 @item -l @var{val}
4526 @item --language @var{val}
4527 Specify the default language to use when reading an @code{rc} file.
4528 @var{val} should be a hexadecimal language code.  The low eight bits are
4529 the language, and the high eight bits are the sublanguage.
4531 @item --use-temp-file
4532 Use a temporary file to instead of using popen to read the output of
4533 the preprocessor. Use this option if the popen implementation is buggy
4534 on the host (eg., certain non-English language versions of Windows 95 and
4535 Windows 98 are known to have buggy popen where the output will instead
4536 go the console).
4538 @item --no-use-temp-file
4539 Use popen, not a temporary file, to read the output of the preprocessor.
4540 This is the default behaviour.
4542 @item -h
4543 @item --help
4544 Prints a usage summary.
4546 @item -V
4547 @item --version
4548 Prints the version number for @command{windres}.
4550 @item --yydebug
4551 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
4552 this will turn on parser debugging.
4553 @end table
4555 @c man end
4557 @ignore
4558 @c man begin SEEALSO windres
4559 the Info entries for @file{binutils}.
4560 @c man end
4561 @end ignore
4563 @node dlltool
4564 @chapter dlltool
4565 @cindex DLL
4566 @kindex dlltool
4568 @command{dlltool} is used to create the files needed to create dynamic
4569 link libraries (DLLs) on systems which understand PE format image
4570 files such as Windows.  A DLL contains an export table which contains
4571 information that the runtime loader needs to resolve references from a
4572 referencing program.
4574 The export table is generated by this program by reading in a
4575 @file{.def} file or scanning the @file{.a} and @file{.o} files which
4576 will be in the DLL.  A @file{.o} file can contain information in
4577 special @samp{.drectve} sections with export information.
4579 @quotation
4580 @emph{Note:} @command{dlltool} is not always built as part of the
4581 binary utilities, since it is only useful for those targets which
4582 support DLLs.
4583 @end quotation
4585 @c man title dlltool create files needed to build and use DLLs
4587 @smallexample
4588 @c man begin SYNOPSIS dlltool
4589 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
4590         [@option{-b}|@option{--base-file} @var{base-file-name}]
4591         [@option{-e}|@option{--output-exp} @var{exports-file-name}]
4592         [@option{-z}|@option{--output-def} @var{def-file-name}]
4593         [@option{-l}|@option{--output-lib} @var{library-file-name}]
4594         [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
4595         [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
4596         [@option{--exclude-symbols} @var{list}]
4597         [@option{--no-default-excludes}]
4598         [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
4599         [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
4600         [@option{-a}|@option{--add-indirect}]
4601         [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
4602         [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
4603         [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
4604         [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
4605         [@option{--use-nul-prefixed-import-tables}]
4606         [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
4607         [@option{-i}|@option{--interwork}]
4608         [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
4609         [@option{-v}|@option{--verbose}]
4610         [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
4611         [@option{--no-leading-underscore}] [@option{--leading-underscore}]
4612         [@option{--deterministic-libraries}] [@option{--non-deterministic-libraries}]
4613         [object-file @dots{}]
4614 @c man end
4615 @end smallexample
4617 @c man begin DESCRIPTION dlltool
4619 @command{dlltool} reads its inputs, which can come from the @option{-d} and
4620 @option{-b} options as well as object files specified on the command
4621 line.  It then processes these inputs and if the @option{-e} option has
4622 been specified it creates a exports file.  If the @option{-l} option
4623 has been specified it creates a library file and if the @option{-z} option
4624 has been specified it creates a def file.  Any or all of the @option{-e},
4625 @option{-l} and @option{-z} options can be present in one invocation of
4626 dlltool.
4628 When creating a DLL, along with the source for the DLL, it is necessary
4629 to have three other files.  @command{dlltool} can help with the creation of
4630 these files.
4632 The first file is a @file{.def} file which specifies which functions are
4633 exported from the DLL, which functions the DLL imports, and so on.  This
4634 is a text file and can be created by hand, or @command{dlltool} can be used
4635 to create it using the @option{-z} option.  In this case @command{dlltool}
4636 will scan the object files specified on its command line looking for
4637 those functions which have been specially marked as being exported and
4638 put entries for them in the @file{.def} file it creates.
4640 In order to mark a function as being exported from a DLL, it needs to
4641 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
4642 section of the object file.  This can be done in C by using the
4643 asm() operator:
4645 @smallexample
4646   asm (".section .drectve");
4647   asm (".ascii \"-export:my_func\"");
4649   int my_func (void) @{ @dots{} @}
4650 @end smallexample
4652 The second file needed for DLL creation is an exports file.  This file
4653 is linked with the object files that make up the body of the DLL and it
4654 handles the interface between the DLL and the outside world.  This is a
4655 binary file and it can be created by giving the @option{-e} option to
4656 @command{dlltool} when it is creating or reading in a @file{.def} file.
4658 The third file needed for DLL creation is the library file that programs
4659 will link with in order to access the functions in the DLL (an `import
4660 library').  This file can be created by giving the @option{-l} option to
4661 dlltool when it is creating or reading in a @file{.def} file.
4663 If the @option{-y} option is specified, dlltool generates a delay-import
4664 library that can be used instead of the normal import library to allow
4665 a program to link to the dll only as soon as an imported function is
4666 called for the first time. The resulting executable will need to be
4667 linked to the static delayimp library containing __delayLoadHelper2(),
4668 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
4670 @command{dlltool} builds the library file by hand, but it builds the
4671 exports file by creating temporary files containing assembler statements
4672 and then assembling these.  The @option{-S} command-line option can be
4673 used to specify the path to the assembler that dlltool will use,
4674 and the @option{-f} option can be used to pass specific flags to that
4675 assembler.  The @option{-n} can be used to prevent dlltool from deleting
4676 these temporary assembler files when it is done, and if @option{-n} is
4677 specified twice then this will prevent dlltool from deleting the
4678 temporary object files it used to build the library.
4680 Here is an example of creating a DLL from a source file @samp{dll.c} and
4681 also creating a program (from an object file called @samp{program.o})
4682 that uses that DLL:
4684 @smallexample
4685   gcc -c dll.c
4686   dlltool -e exports.o -l dll.lib dll.o
4687   gcc dll.o exports.o -o dll.dll
4688   gcc program.o dll.lib -o program
4689 @end smallexample
4692 @command{dlltool} may also be used to query an existing import library
4693 to determine the name of the DLL to which it is associated.  See the
4694 description of the @option{-I} or @option{--identify} option.
4696 @c man end
4698 @c man begin OPTIONS dlltool
4700 The command-line options have the following meanings:
4702 @table @env
4704 @item -d @var{filename}
4705 @itemx --input-def @var{filename}
4706 @cindex input .def file
4707 Specifies the name of a @file{.def} file to be read in and processed.
4709 @item -b @var{filename}
4710 @itemx --base-file @var{filename}
4711 @cindex base files
4712 Specifies the name of a base file to be read in and processed.  The
4713 contents of this file will be added to the relocation section in the
4714 exports file generated by dlltool.
4716 @item -e @var{filename}
4717 @itemx --output-exp @var{filename}
4718 Specifies the name of the export file to be created by dlltool.
4720 @item -z @var{filename}
4721 @itemx --output-def @var{filename}
4722 Specifies the name of the @file{.def} file to be created by dlltool.
4724 @item -l @var{filename}
4725 @itemx --output-lib @var{filename}
4726 Specifies the name of the library file to be created by dlltool.
4728 @item -y @var{filename}
4729 @itemx --output-delaylib @var{filename}
4730 Specifies the name of the delay-import library file to be created by dlltool.
4732 @item --deterministic-libraries
4733 @itemx --non-deterministic-libraries
4734 When creating output libraries in response to either the
4735 @option{--output-lib} or @option{--output-delaylib} options either use
4736 the value of zero for any timestamps, user ids and group ids created
4737 (@option{--deterministic-libraries}) or the actual timestamps, user
4738 ids and group ids (@option{--non-deterministic-libraries}).
4740 @item --export-all-symbols
4741 Treat all global and weak defined symbols found in the input object
4742 files as symbols to be exported.  There is a small list of symbols which
4743 are not exported by default; see the @option{--no-default-excludes}
4744 option.  You may add to the list of symbols to not export by using the
4745 @option{--exclude-symbols} option.
4747 @item --no-export-all-symbols
4748 Only export symbols explicitly listed in an input @file{.def} file or in
4749 @samp{.drectve} sections in the input object files.  This is the default
4750 behaviour.  The @samp{.drectve} sections are created by @samp{dllexport}
4751 attributes in the source code.
4753 @item --exclude-symbols @var{list}
4754 Do not export the symbols in @var{list}.  This is a list of symbol names
4755 separated by comma or colon characters.  The symbol names should not
4756 contain a leading underscore.  This is only meaningful when
4757 @option{--export-all-symbols} is used.
4759 @item --no-default-excludes
4760 When @option{--export-all-symbols} is used, it will by default avoid
4761 exporting certain special symbols.  The current list of symbols to avoid
4762 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
4763 @samp{impure_ptr}.  You may use the @option{--no-default-excludes} option
4764 to go ahead and export these special symbols.  This is only meaningful
4765 when @option{--export-all-symbols} is used.
4767 @item -S @var{path}
4768 @itemx --as @var{path}
4769 Specifies the path, including the filename, of the assembler to be used
4770 to create the exports file.
4772 @item -f @var{options}
4773 @itemx --as-flags @var{options}
4774 Specifies any specific command-line options to be passed to the
4775 assembler when building the exports file.  This option will work even if
4776 the @option{-S} option is not used.  This option only takes one argument,
4777 and if it occurs more than once on the command line, then later
4778 occurrences will override earlier occurrences.  So if it is necessary to
4779 pass multiple options to the assembler they should be enclosed in
4780 double quotes.
4782 @item -D @var{name}
4783 @itemx --dll-name @var{name}
4784 Specifies the name to be stored in the @file{.def} file as the name of
4785 the DLL when the @option{-e} option is used.  If this option is not
4786 present, then the filename given to the @option{-e} option will be
4787 used as the name of the DLL.
4789 @item -m @var{machine}
4790 @itemx -machine @var{machine}
4791 Specifies the type of machine for which the library file should be
4792 built.  @command{dlltool} has a built in default type, depending upon how
4793 it was created, but this option can be used to override that.  This is
4794 normally only useful when creating DLLs for an ARM processor, when the
4795 contents of the DLL are actually encode using Thumb instructions.
4797 @item -a
4798 @itemx --add-indirect
4799 Specifies that when @command{dlltool} is creating the exports file it
4800 should add a section which allows the exported functions to be
4801 referenced without using the import library.  Whatever the hell that
4802 means!
4804 @item -U
4805 @itemx --add-underscore
4806 Specifies that when @command{dlltool} is creating the exports file it
4807 should prepend an underscore to the names of @emph{all} exported symbols.
4809 @item --no-leading-underscore
4810 @item --leading-underscore
4811 Specifies whether standard symbol should be forced to be prefixed, or
4812 not.
4814 @item --add-stdcall-underscore
4815 Specifies that when @command{dlltool} is creating the exports file it
4816 should prepend an underscore to the names of exported @emph{stdcall}
4817 functions. Variable names and non-stdcall function names are not modified.
4818 This option is useful when creating GNU-compatible import libs for third
4819 party DLLs that were built with MS-Windows tools.
4821 @item -k
4822 @itemx --kill-at
4823 Specifies that @samp{@@<number>} suffixes should be omitted from the names
4824 of stdcall functions that will be imported from the DLL.  This is
4825 useful when creating an import library for a DLL which exports stdcall
4826 functions but without the usual @samp{@@<number>} symbol name suffix.
4828 This does not change the naming of symbols provided by the import library
4829 to programs linked against it, but only the entries in the import table
4830 (ie the .idata section).
4832 @item -A
4833 @itemx --add-stdcall-alias
4834 Specifies that when @command{dlltool} is creating the exports file it
4835 should add aliases for stdcall symbols without @samp{@@ <number>}
4836 in addition to the symbols with @samp{@@ <number>}.
4838 @item -p
4839 @itemx --ext-prefix-alias @var{prefix}
4840 Causes @command{dlltool} to create external aliases for all DLL
4841 imports with the specified prefix.  The aliases are created for both
4842 external and import symbols with no leading underscore.
4844 @item -x
4845 @itemx --no-idata4
4846 Specifies that when @command{dlltool} is creating the exports and library
4847 files it should omit the @code{.idata4} section.  This is for compatibility
4848 with certain operating systems.
4850 @item --use-nul-prefixed-import-tables
4851 Specifies that when @command{dlltool} is creating the exports and library
4852 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
4853 element. This emulates old gnu import library generation of
4854 @code{dlltool}. By default this option is turned off.
4856 @item -c
4857 @itemx --no-idata5
4858 Specifies that when @command{dlltool} is creating the exports and library
4859 files it should omit the @code{.idata5} section.  This is for compatibility
4860 with certain operating systems.
4862 @item -I @var{filename}
4863 @itemx --identify @var{filename}
4864 Specifies that @command{dlltool} should inspect the import library
4865 indicated by @var{filename} and report, on @code{stdout}, the name(s)
4866 of the associated DLL(s).  This can be performed in addition to any
4867 other operations indicated by the other options and arguments.
4868 @command{dlltool} fails if the import library does not exist or is not
4869 actually an import library. See also @option{--identify-strict}.
4871 @item --identify-strict
4872 Modifies the behavior of the @option{--identify} option, such
4873 that an error is reported if @var{filename} is associated with
4874 more than one DLL.
4876 @item -i
4877 @itemx --interwork
4878 Specifies that @command{dlltool} should mark the objects in the library
4879 file and exports file that it produces as supporting interworking
4880 between ARM and Thumb code.
4882 @item -n
4883 @itemx --nodelete
4884 Makes @command{dlltool} preserve the temporary assembler files it used to
4885 create the exports file.  If this option is repeated then dlltool will
4886 also preserve the temporary object files it uses to create the library
4887 file.
4889 @item -t @var{prefix}
4890 @itemx --temp-prefix @var{prefix}
4891 Makes @command{dlltool} use @var{prefix} when constructing the names of
4892 temporary assembler and object files.  By default, the temp file prefix
4893 is generated from the pid.
4895 @item -v
4896 @itemx --verbose
4897 Make dlltool describe what it is doing.
4899 @item -h
4900 @itemx --help
4901 Displays a list of command-line options and then exits.
4903 @item -V
4904 @itemx --version
4905 Displays dlltool's version number and then exits.
4907 @end table
4909 @c man end
4911 @menu
4912 * def file format::             The format of the dlltool @file{.def} file
4913 @end menu
4915 @node def file format
4916 @section The format of the @command{dlltool} @file{.def} file
4918 A @file{.def} file contains any number of the following commands:
4920 @table @asis
4922 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4923 The result is going to be named @var{name}@code{.exe}.
4925 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4926 The result is going to be named @var{name}@code{.dll}.
4927 Note: If you want to use LIBRARY as name then you need to quote.  Otherwise
4928 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4929 details).
4931 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4932 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4933 Declares @var{name1} as an exported symbol from the DLL, with optional
4934 ordinal number @var{integer}, or declares @var{name1} as an alias
4935 (forward) of the function @var{external-name} in the DLL.
4936 If @var{its_name} is specified, this name is used as string in export table.
4937 @var{module-name}.
4938 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4939 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4940 If you want to use LIBRARY as name then you need to quote it.
4942 @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{]} *}
4943 Declares that @var{external-name} or the exported function whose
4944 ordinal number is @var{integer} is to be imported from the file
4945 @var{module-name}.  If @var{internal-name} is specified then this is
4946 the name that the imported function will be referred to in the body of
4947 the DLL.
4948 If @var{its_name} is specified, this name is used as string in import table.
4949 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4950 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4951 If you want to use LIBRARY as name then you need to quote it.
4953 @item @code{DESCRIPTION} @var{string}
4954 Puts @var{string} into the output @file{.exp} file in the
4955 @code{.rdata} section.
4957 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4958 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4959 Generates @code{--stack} or @code{--heap}
4960 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4961 section.  The linker will see this and act upon it.
4963 @item @code{CODE} @var{attr} @code{+}
4964 @item @code{DATA} @var{attr} @code{+}
4965 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4966 Generates @code{--attr} @var{section-name} @var{attr} in the output
4967 @code{.drectve} section, where @var{attr} is one of @code{READ},
4968 @code{WRITE}, @code{EXECUTE} or @code{SHARED}.  The linker will see
4969 this and act upon it.
4971 @end table
4973 @ignore
4974 @c man begin SEEALSO dlltool
4975 The Info pages for @file{binutils}.
4976 @c man end
4977 @end ignore
4979 @node readelf
4980 @chapter readelf
4982 @cindex ELF file information
4983 @kindex readelf
4985 @c man title readelf display information about ELF files
4987 @smallexample
4988 @c man begin SYNOPSIS readelf
4989 readelf [@option{-a}|@option{--all}]
4990         [@option{-h}|@option{--file-header}]
4991         [@option{-l}|@option{--program-headers}|@option{--segments}]
4992         [@option{-S}|@option{--section-headers}|@option{--sections}]
4993         [@option{-g}|@option{--section-groups}]
4994         [@option{-t}|@option{--section-details}]
4995         [@option{-e}|@option{--headers}]
4996         [@option{-s}|@option{--syms}|@option{--symbols}]
4997         [@option{--dyn-syms}|@option{--lto-syms}]
4998         [@option{--sym-base=[0|8|10|16]}]
4999         [@option{--demangle@var{=style}}|@option{--no-demangle}]
5000         [@option{--quiet}]
5001         [@option{--recurse-limit}|@option{--no-recurse-limit}]
5002         [@option{-U} @var{method}|@option{--unicode=}@var{method}]
5003         [@option{-X}|@option{--extra-sym-info}|@option{--no-extra-sym-info}]
5004         [@option{-n}|@option{--notes}]
5005         [@option{-r}|@option{--relocs}]
5006         [@option{-u}|@option{--unwind}]
5007         [@option{-d}|@option{--dynamic}]
5008         [@option{-V}|@option{--version-info}]
5009         [@option{-A}|@option{--arch-specific}]
5010         [@option{-D}|@option{--use-dynamic}]
5011         [@option{-L}|@option{--lint}|@option{--enable-checks}]
5012         [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
5013         [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
5014         [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
5015         [@option{-z}|@option{--decompress}]
5016         [@option{-c}|@option{--archive-index}]
5017         [@option{-w[lLiaprmfFsoORtUuTgAck]}|
5018          @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links]]
5019         [@option{-wK}|@option{--debug-dump=follow-links}]
5020         [@option{-wN}|@option{--debug-dump=no-follow-links}]
5021         [@option{-wD}|@option{--debug-dump=use-debuginfod}]
5022         [@option{-wE}|@option{--debug-dump=do-not-use-debuginfod}]
5023         [@option{-P}|@option{--process-links}]
5024         [@option{--dwarf-depth=@var{n}}]
5025         [@option{--dwarf-start=@var{n}}]
5026         [@option{--ctf=}@var{section}]
5027         [@option{--ctf-parent=}@var{section}]
5028         [@option{--ctf-symbols=}@var{section}]
5029         [@option{--ctf-strings=}@var{section}]
5030         [@option{--sframe=}@var{section}]
5031         [@option{-I}|@option{--histogram}]
5032         [@option{-v}|@option{--version}]
5033         [@option{-W}|@option{--wide}]
5034         [@option{-T}|@option{--silent-truncation}]
5035         [@option{-H}|@option{--help}]
5036         @var{elffile}@dots{}
5037 @c man end
5038 @end smallexample
5040 @c man begin DESCRIPTION readelf
5042 @command{readelf} displays information about one or more ELF format object
5043 files.  The options control what particular information to display.
5045 @var{elffile}@dots{} are the object files to be examined.  32-bit and
5046 64-bit ELF files are supported, as are archives containing ELF files.
5048 This program performs a similar function to @command{objdump} but it
5049 goes into more detail and it exists independently of the @sc{bfd}
5050 library, so if there is a bug in @sc{bfd} then readelf will not be
5051 affected.
5053 @c man end
5055 @c man begin OPTIONS readelf
5057 The long and short forms of options, shown here as alternatives, are
5058 equivalent.  At least one option besides @samp{-v} or @samp{-H} must be
5059 given.
5061 @table @env
5062 @item -a
5063 @itemx --all
5064 Equivalent to specifying @option{--file-header},
5065 @option{--program-headers}, @option{--sections}, @option{--symbols},
5066 @option{--relocs}, @option{--dynamic}, @option{--notes},
5067 @option{--version-info}, @option{--arch-specific}, @option{--unwind},
5068 @option{--section-groups} and @option{--histogram}.
5070 Note - this option does not enable @option{--use-dynamic} itself, so
5071 if that option is not present on the command line then dynamic symbols
5072 and dynamic relocs will not be displayed.
5074 @item -h
5075 @itemx --file-header
5076 @cindex ELF file header information
5077 Displays the information contained in the ELF header at the start of the
5078 file.
5080 @item -l
5081 @itemx --program-headers
5082 @itemx --segments
5083 @cindex ELF program header information
5084 @cindex ELF segment information
5085 Displays the information contained in the file's segment headers, if it
5086 has any.
5088 @item --quiet
5089 @cindex quiet
5090 Suppress "no symbols" diagnostic.
5092 @item -S
5093 @itemx --sections
5094 @itemx --section-headers
5095 @cindex ELF section information
5096 Displays the information contained in the file's section headers, if it
5097 has any.
5099 @item -g
5100 @itemx --section-groups
5101 @cindex ELF section group information
5102 Displays the information contained in the file's section groups, if it
5103 has any.
5105 @item -t
5106 @itemx --section-details
5107 @cindex ELF section information
5108 Displays the detailed section information. Implies @option{-S}.
5110 @item -s
5111 @itemx --symbols
5112 @itemx --syms
5113 @cindex ELF symbol table information
5114 Displays the entries in symbol table section of the file, if it has one.
5115 If a symbol has version information associated with it then this is
5116 displayed as well.  The version string is displayed as a suffix to the
5117 symbol name, preceded by an @@ character.  For example
5118 @samp{foo@@VER_1}.  If the version is the default version to be used
5119 when resolving unversioned references to the symbol then it is
5120 displayed as a suffix preceded by two @@ characters.  For example
5121 @samp{foo@@@@VER_2}.
5123 @item --dyn-syms
5124 @cindex ELF dynamic symbol table information
5125 Displays the entries in dynamic symbol table section of the file, if it
5126 has one.  The output format is the same as the format used by the
5127 @option{--syms} option.
5129 @item --lto-syms
5130 @cindex LTO symbol table
5131 Displays the contents of any LTO symbol tables in the file.
5133 @item --sym-base=[0|8|10|16]
5134 @cindex symbol table size base
5135 Forces the size field of the symbol table to use the given base.  Any
5136 unrecognized options will be treated as @samp{0}.  @option{--sym-base=0}
5137 represents the default and legacy behaviour.  This will output sizes as decimal
5138 for numbers less than 100000.  For sizes 100000 and greater hexadecimal notation
5139 will be used with a 0x prefix.
5140 @option{--sym-base=8} will give the symbol sizes in octal.
5141 @option{--sym-base=10} will always give the symbol sizes in decimal.
5142 @option{--sym-base=16} will always give the symbol sizes in hexadecimal with a
5143 0x prefix.
5145 @item -C
5146 @itemx --demangle[=@var{style}]
5147 @cindex demangling in nm
5148 Decode (@dfn{demangle}) low-level symbol names into user-level names.
5149 This makes C++ function names readable.  Different compilers have
5150 different mangling styles.  The optional demangling style argument can
5151 be used to choose an appropriate demangling style for your
5152 compiler. @xref{c++filt}, for more information on demangling.
5154 @item --no-demangle
5155 Do not demangle low-level symbol names.  This is the default.
5157 @item --recurse-limit
5158 @itemx --no-recurse-limit
5159 @itemx --recursion-limit
5160 @itemx --no-recursion-limit
5161 Enables or disables a limit on the amount of recursion performed
5162 whilst demangling strings.  Since the name mangling formats allow for
5163 an infinite level of recursion it is possible to create strings whose
5164 decoding will exhaust the amount of stack space available on the host
5165 machine, triggering a memory fault.  The limit tries to prevent this
5166 from happening by restricting recursion to 2048 levels of nesting.
5168 The default is for this limit to be enabled, but disabling it may be
5169 necessary in order to demangle truly complicated names.  Note however
5170 that if the recursion limit is disabled then stack exhaustion is
5171 possible and any bug reports about such an event will be rejected.
5173 @item -U @var{[d|i|l|e|x|h]}
5174 @itemx --unicode=[default|invalid|locale|escape|hex|highlight]
5175 Controls the display of non-ASCII characters in identifier names.
5176 The default (@option{--unicode=locale} or @option{--unicode=default}) is
5177 to treat them as multibyte characters and display them in the current
5178 locale.  All other versions of this option treat the bytes as UTF-8
5179 encoded values and attempt to interpret them.  If they cannot be
5180 interpreted or if the @option{--unicode=invalid} option is used then
5181 they are displayed as a sequence of hex bytes, encloses in curly
5182 parethesis characters.
5184 Using the @option{--unicode=escape} option will display the characters
5185 as as unicode escape sequences (@var{\uxxxx}).  Using the
5186 @option{--unicode=hex} will display the characters as hex byte
5187 sequences enclosed between angle brackets.
5189 Using the @option{--unicode=highlight} will display the characters as 
5190 unicode escape sequences but it will also highlighted them in red,
5191 assuming that colouring is supported by the output device.  The
5192 colouring is intended to draw attention to the presence of unicode
5193 sequences when they might not be expected.
5195 @item -X
5196 @itemx --extra-sym-info
5197 When displaying details of symbols, include extra information not
5198 normally presented.  Currently this just adds the name of the section
5199 referenced by the symbol's index field, if there is one.  In the
5200 future more information may be displayed when this option is enabled.
5202 Enabling this option effectively enables the @option{--wide} option as
5203 well, at least when displaying symbol information.
5205 @item --no-extra-sym-info
5206 Disables the effect of the @option{--extra-sym-info} option.  This
5207 is the default.
5209 @item -e
5210 @itemx --headers
5211 Display all the headers in the file.  Equivalent to @option{-h -l -S}.
5213 @item -n
5214 @itemx --notes
5215 @cindex ELF notes
5216 Displays the contents of the NOTE segments and/or sections, if any.
5218 @item -r
5219 @itemx --relocs
5220 @cindex ELF reloc information
5221 Displays the contents of the file's relocation section, if it has one.
5223 @item -u
5224 @itemx --unwind
5225 @cindex unwind information
5226 Displays the contents of the file's unwind section, if it has one.  Only
5227 the unwind sections for IA64 ELF files, as well as ARM unwind tables
5228 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported.  If
5229 support is not yet implemented for your architecture you could try
5230 dumping the contents of the @var{.eh_frames} section using the
5231 @option{--debug-dump=frames} or @option{--debug-dump=frames-interp}
5232 options.
5234 @item -d
5235 @itemx --dynamic
5236 @cindex ELF dynamic section information
5237 Displays the contents of the file's dynamic section, if it has one.
5239 @item -V
5240 @itemx --version-info
5241 @cindex ELF version sections information
5242 Displays the contents of the version sections in the file, it they
5243 exist.
5245 @item -A
5246 @itemx --arch-specific
5247 Displays architecture-specific information in the file, if there
5248 is any.
5250 @item -D
5251 @itemx --use-dynamic
5252 When displaying symbols, this option makes @command{readelf} use the
5253 symbol hash tables in the file's dynamic section, rather than the
5254 symbol table sections.
5256 When displaying relocations, this option makes @command{readelf}
5257 display the dynamic relocations rather than the static relocations.
5259 @item -L
5260 @itemx --lint
5261 @itemx --enable-checks
5262 Displays warning messages about possible problems with the file(s)
5263 being examined.  If used on its own then all of the contents of the
5264 file(s) will be examined.  If used with one of the dumping options
5265 then the warning messages will only be produced for the things being
5266 displayed.
5268 @item -x <number or name>
5269 @itemx --hex-dump=<number or name>
5270 Displays the contents of the indicated section as a hexadecimal bytes.
5271 A number identifies a particular section by index in the section table;
5272 any other string identifies all sections with that name in the object file.
5274 @item -R <number or name>
5275 @itemx --relocated-dump=<number or name>
5276 Displays the contents of the indicated section as a hexadecimal
5277 bytes.  A number identifies a particular section by index in the
5278 section table; any other string identifies all sections with that name
5279 in the object file.  The contents of the section will be relocated
5280 before they are displayed.
5282 @item -p <number or name>
5283 @itemx --string-dump=<number or name>
5284 Displays the contents of the indicated section as printable strings.
5285 A number identifies a particular section by index in the section table;
5286 any other string identifies all sections with that name in the object file.
5288 @item -z
5289 @itemx --decompress
5290 Requests that the section(s) being dumped by @option{x}, @option{R} or
5291 @option{p} options are decompressed before being displayed.  If the
5292 section(s) are not compressed then they are displayed as is.
5294 @item -c
5295 @itemx --archive-index
5296 @cindex Archive file symbol index information
5297 Displays the file symbol index information contained in the header part
5298 of binary archives.  Performs the same function as the @option{t}
5299 command to @command{ar}, but without using the BFD library.  @xref{ar}.
5301 @item -w[lLiaprmfFsOoRtUuTgAckK]
5302 @itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=str-offsets,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index,=addr,=cu_index,=links,=follow-links]
5303 @include debug.options.texi
5305 @item -P
5306 @itemx --process-links
5307 Display the contents of non-debug sections found in separate debuginfo
5308 files that are linked to the main file.  This option automatically
5309 implies the @option{-wK} option, and only sections requested by other
5310 command line options will be displayed.
5312 @include ctf.options.texi
5313 @item --ctf-symbols=@var{section}
5314 @item --ctf-strings=@var{section}
5315 Specify the name of another section from which the CTF file can inherit
5316 strings and symbols.  By default, the @code{.symtab} and its linked
5317 string table are used.
5319 If either of @option{--ctf-symbols} or @option{--ctf-strings} is specified, the
5320 other must be specified as well.
5322 @item -I
5323 @itemx --histogram
5324 Display a histogram of bucket list lengths when displaying the contents
5325 of the symbol tables.
5327 @item -v
5328 @itemx --version
5329 Display the version number of readelf.
5331 @item -W
5332 @itemx --wide
5333 Don't break output lines to fit into 80 columns. By default
5334 @command{readelf} breaks section header and segment listing lines for
5335 64-bit ELF files, so that they fit into 80 columns. This option causes
5336 @command{readelf} to print each section header resp. each segment one a
5337 single line, which is far more readable on terminals wider than 80 columns.
5339 @item -T
5340 @itemx --silent-truncation
5341 Normally when readelf is displaying a symbol name, and it has to
5342 truncate the name to fit into an 80 column display, it will add a
5343 suffix of @code{[...]} to the name.  This command line option
5344 disables this behaviour, allowing 5 more characters of the name to be
5345 displayed and restoring the old behaviour of readelf (prior to release
5346 2.35).
5348 @item -H
5349 @itemx --help
5350 Display the command-line options understood by @command{readelf}.
5352 @end table
5354 @c man end
5356 @ignore
5357 @c man begin SEEALSO readelf
5358 objdump(1), and the Info entries for @file{binutils}.
5359 @c man end
5360 @end ignore
5362 @node elfedit
5363 @chapter elfedit
5365 @cindex Update ELF header
5366 @kindex elfedit
5368 @c man title elfedit update ELF header and program property of ELF files
5370 @smallexample
5371 @c man begin SYNOPSIS elfedit
5372 elfedit [@option{--input-mach=}@var{machine}]
5373         [@option{--input-type=}@var{type}]
5374         [@option{--input-osabi=}@var{osabi}]
5375         [@option{--input-abiversion=}@var{version}]
5376         @option{--output-mach=}@var{machine}
5377         @option{--output-type=}@var{type}
5378         @option{--output-osabi=}@var{osabi}
5379         @option{--output-abiversion=}@var{version}
5380         @option{--enable-x86-feature=}@var{feature}
5381         @option{--disable-x86-feature=}@var{feature}
5382         [@option{-v}|@option{--version}]
5383         [@option{-h}|@option{--help}]
5384         @var{elffile}@dots{}
5385 @c man end
5386 @end smallexample
5388 @c man begin DESCRIPTION elfedit
5390 @command{elfedit} updates the ELF header and program property of ELF
5391 files which have the matching ELF machine and file types.  The options
5392 control how and which fields in the ELF header and program property
5393 should be updated.
5395 @var{elffile}@dots{} are the ELF files to be updated.  32-bit and
5396 64-bit ELF files are supported, as are archives containing ELF files.
5397 @c man end
5399 @c man begin OPTIONS elfedit
5401 The long and short forms of options, shown here as alternatives, are
5402 equivalent. At least one of the @option{--output-mach},
5403 @option{--output-type}, @option{--output-osabi},
5404 @option{--output-abiversion},
5405 @option{--enable-x86-feature} and @option{--disable-x86-feature}
5406 options must be given.
5408 @table @env
5410 @item --input-mach=@var{machine}
5411 Set the matching input ELF machine type to @var{machine}.  If
5412 @option{--input-mach} isn't specified, it will match any ELF
5413 machine types.
5415 The supported ELF machine types are, @var{i386}, @var{IAMCU}, @var{L1OM},
5416 @var{K1OM} and @var{x86-64}.
5418 @item --output-mach=@var{machine}
5419 Change the ELF machine type in the ELF header to @var{machine}.  The
5420 supported ELF machine types are the same as @option{--input-mach}.
5422 @item --input-type=@var{type}
5423 Set the matching input ELF file type to @var{type}.  If
5424 @option{--input-type} isn't specified, it will match any ELF file types.
5426 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
5428 @item --output-type=@var{type}
5429 Change the ELF file type in the ELF header to @var{type}.  The
5430 supported ELF types are the same as @option{--input-type}.
5432 @item --input-osabi=@var{osabi}
5433 Set the matching input ELF file OSABI to @var{osabi}.  If
5434 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
5436 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
5437 @var{GNU}, @var{Linux} (alias for @var{GNU}),
5438 @var{Solaris}, @var{AIX}, @var{Irix},
5439 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
5440 @var{NSK}, @var{AROS} and @var{FenixOS}.
5442 @item --output-osabi=@var{osabi}
5443 Change the ELF OSABI in the ELF header to @var{osabi}.  The
5444 supported ELF OSABI are the same as @option{--input-osabi}.
5446 @item --input-abiversion=@var{version}
5447 Set the matching input ELF file ABIVERSION to @var{version}.
5448 @var{version} must be between 0 and 255.  If @option{--input-abiversion}
5449 isn't specified, it will match any ELF ABIVERSIONs.
5451 @item --output-abiversion=@var{version}
5452 Change the ELF ABIVERSION in the ELF header to @var{version}.
5453 @var{version} must be between 0 and 255.
5455 @item --enable-x86-feature=@var{feature}
5456 Set the @var{feature} bit in program property in @var{exec} or @var{dyn}
5457 ELF files with machine types of @var{i386} or @var{x86-64}.  The
5458 supported features are, @var{ibt}, @var{shstk}, @var{lam_u48} and
5459 @var{lam_u57}.
5461 @item --disable-x86-feature=@var{feature}
5462 Clear the @var{feature} bit in program property in @var{exec} or
5463 @var{dyn} ELF files with machine types of @var{i386} or @var{x86-64}.
5464 The supported features are the same as @option{--enable-x86-feature}.
5466 Note: @option{--enable-x86-feature} and @option{--disable-x86-feature}
5467 are available only on hosts with @samp{mmap} support.
5469 @item -v
5470 @itemx --version
5471 Display the version number of @command{elfedit}.
5473 @item -h
5474 @itemx --help
5475 Display the command-line options understood by @command{elfedit}.
5477 @end table
5479 @c man end
5481 @ignore
5482 @c man begin SEEALSO elfedit
5483 readelf(1), and the Info entries for @file{binutils}.
5484 @c man end
5485 @end ignore
5487 @node Common Options
5488 @chapter Common Options
5490 The following command-line options are supported by all of the
5491 programs described in this manual.
5493 @c man begin OPTIONS
5494 @table @env
5495 @include at-file.texi
5496 @c man end
5498 @item --help
5499 Display the command-line options supported by the program.
5501 @item --version
5502 Display the version number of the program.
5504 @c man begin OPTIONS
5505 @end table
5506 @c man end
5508 @node Selecting the Target System
5509 @chapter Selecting the Target System
5511 You can specify two aspects of the target system to the @sc{gnu}
5512 binary file utilities, each in several ways:
5514 @itemize @bullet
5515 @item
5516 the target
5518 @item
5519 the architecture
5520 @end itemize
5522 In the following summaries, the lists of ways to specify values are in
5523 order of decreasing precedence.  The ways listed first override those
5524 listed later.
5526 The commands to list valid values only list the values for which the
5527 programs you are running were configured.  If they were configured with
5528 @option{--enable-targets=all}, the commands list most of the available
5529 values, but a few are left out; not all targets can be configured in at
5530 once because some of them can only be configured @dfn{native} (on hosts
5531 with the same type as the target system).
5533 @menu
5534 * Target Selection::
5535 * Architecture Selection::
5536 @end menu
5538 @node Target Selection
5539 @section Target Selection
5541 A @dfn{target} is an object file format.  A given target may be
5542 supported for multiple architectures (@pxref{Architecture Selection}).
5543 A target selection may also have variations for different operating
5544 systems or architectures.
5546 The command to list valid target values is @samp{objdump -i}
5547 (the first column of output contains the relevant information).
5549 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
5550 @samp{a.out-sunos-big}.
5552 You can also specify a target using a configuration triplet.  This is
5553 the same sort of name that is passed to @file{configure} to specify a
5554 target.  When you use a configuration triplet as an argument, it must be
5555 fully canonicalized.  You can see the canonical version of a triplet by
5556 running the shell script @file{config.sub} which is included with the
5557 sources.
5559 Some sample configuration triplets are: @samp{m68k-hp-bsd},
5560 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
5562 @subheading @command{objdump} Target
5564 Ways to specify:
5566 @enumerate
5567 @item
5568 command-line option: @option{-b} or @option{--target}
5570 @item
5571 environment variable @code{GNUTARGET}
5573 @item
5574 deduced from the input file
5575 @end enumerate
5577 @subheading @command{objcopy} and @command{strip} Input Target
5579 Ways to specify:
5581 @enumerate
5582 @item
5583 command-line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
5585 @item
5586 environment variable @code{GNUTARGET}
5588 @item
5589 deduced from the input file
5590 @end enumerate
5592 @subheading @command{objcopy} and @command{strip} Output Target
5594 Ways to specify:
5596 @enumerate
5597 @item
5598 command-line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
5600 @item
5601 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
5603 @item
5604 environment variable @code{GNUTARGET}
5606 @item
5607 deduced from the input file
5608 @end enumerate
5610 @subheading @command{nm}, @command{size}, and @command{strings} Target
5612 Ways to specify:
5614 @enumerate
5615 @item
5616 command-line option: @option{--target}
5618 @item
5619 environment variable @code{GNUTARGET}
5621 @item
5622 deduced from the input file
5623 @end enumerate
5625 @node Architecture Selection
5626 @section Architecture Selection
5628 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
5629 to run.  Its name may contain a colon, separating the name of the
5630 processor family from the name of the particular @sc{cpu}.
5632 The command to list valid architecture values is @samp{objdump -i} (the
5633 second column contains the relevant information).
5635 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
5637 @subheading @command{objdump} Architecture
5639 Ways to specify:
5641 @enumerate
5642 @item
5643 command-line option: @option{-m} or @option{--architecture}
5645 @item
5646 deduced from the input file
5647 @end enumerate
5649 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
5651 Ways to specify:
5653 @enumerate
5654 @item
5655 deduced from the input file
5656 @end enumerate
5658 @node debuginfod
5659 @chapter debuginfod
5660 @cindex separate debug files
5662 debuginfod is a web service that indexes ELF/DWARF debugging resources
5663 by build-id and serves them over HTTP.  For more information see:
5664 @emph{https://sourceware.org/elfutils/Debuginfod.html}
5666 Binutils can be built with the debuginfod client library
5667 @code{libdebuginfod} using the @option{--with-debuginfod} configure option.
5668 This option is enabled by default if @code{libdebuginfod} is installed
5669 and found at configure time. This allows @command{objdump} and
5670 @command{readelf} to automatically query debuginfod servers for
5671 separate debug files when the files are otherwise not found.
5673 debuginfod is packaged with elfutils, starting with version 0.178.
5674 You can get the latest version from `https://sourceware.org/elfutils/'.
5676 The DWARF info dumping tools (@command{readelf} and @command{objdump})
5677 have options to control when they should access the debuginfod
5678 servers.  By default this access is enabled.
5680 @node Reporting Bugs
5681 @chapter Reporting Bugs
5682 @cindex bugs
5683 @cindex reporting bugs
5685 Your bug reports play an essential role in making the binary utilities
5686 reliable.
5688 Reporting a bug may help you by bringing a solution to your problem, or
5689 it may not.  But in any case the principal function of a bug report is
5690 to help the entire community by making the next version of the binary
5691 utilities work better.  Bug reports are your contribution to their
5692 maintenance.
5694 In order for a bug report to serve its purpose, you must include the
5695 information that enables us to fix the bug.
5697 @menu
5698 * Bug Criteria::                Have you found a bug?
5699 * Bug Reporting::               How to report bugs
5700 @end menu
5702 @node Bug Criteria
5703 @section Have You Found a Bug?
5704 @cindex bug criteria
5706 If you are not sure whether you have found a bug, here are some guidelines:
5708 @itemize @bullet
5709 @cindex fatal signal
5710 @cindex crash
5711 @item
5712 If a binary utility gets a fatal signal, for any input whatever, that is
5713 a bug.  Reliable utilities never crash.
5715 @cindex error on valid input
5716 @item
5717 If a binary utility produces an error message for valid input, that is a
5718 bug.
5720 @item
5721 If you are an experienced user of binary utilities, your suggestions for
5722 improvement are welcome in any case.
5723 @end itemize
5725 @node Bug Reporting
5726 @section How to Report Bugs
5727 @cindex bug reports
5728 @cindex bugs, reporting
5730 A number of companies and individuals offer support for @sc{gnu}
5731 products.  If you obtained the binary utilities from a support
5732 organization, we recommend you contact that organization first.
5734 You can find contact information for many support companies and
5735 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
5736 distribution.
5738 @ifset BUGURL
5739 In any event, we also recommend that you send bug reports for the binary
5740 utilities to @value{BUGURL}.
5741 @end ifset
5743 The fundamental principle of reporting bugs usefully is this:
5744 @strong{report all the facts}.  If you are not sure whether to state a
5745 fact or leave it out, state it!
5747 Often people omit facts because they think they know what causes the
5748 problem and assume that some details do not matter.  Thus, you might
5749 assume that the name of a file you use in an example does not matter.
5750 Well, probably it does not, but one cannot be sure.  Perhaps the bug is
5751 a stray memory reference which happens to fetch from the location where
5752 that pathname is stored in memory; perhaps, if the pathname were
5753 different, the contents of that location would fool the utility into
5754 doing the right thing despite the bug.  Play it safe and give a
5755 specific, complete example.  That is the easiest thing for you to do,
5756 and the most helpful.
5758 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
5759 it is new to us.  Therefore, always write your bug reports on the assumption
5760 that the bug has not been reported previously.
5762 Sometimes people give a few sketchy facts and ask, ``Does this ring a
5763 bell?''  This cannot help us fix a bug, so it is basically useless.  We
5764 respond by asking for enough details to enable us to investigate.
5765 You might as well expedite matters by sending them to begin with.
5767 To enable us to fix the bug, you should include all these things:
5769 @itemize @bullet
5770 @item
5771 The version of the utility.  Each utility announces it if you start it
5772 with the @option{--version} argument.
5774 Without this, we will not know whether there is any point in looking for
5775 the bug in the current version of the binary utilities.
5777 @item
5778 Any patches you may have applied to the source, including any patches
5779 made to the @code{BFD} library.
5781 @item
5782 The type of machine you are using, and the operating system name and
5783 version number.
5785 @item
5786 What compiler (and its version) was used to compile the utilities---e.g.
5787 ``@code{gcc-2.7}''.
5789 @item
5790 The command arguments you gave the utility to observe the bug.  To
5791 guarantee you will not omit something important, list them all.  A copy
5792 of the Makefile (or the output from make) is sufficient.
5794 If we were to try to guess the arguments, we would probably guess wrong
5795 and then we might not encounter the bug.
5797 @item
5798 A complete input file, or set of input files, that will reproduce the
5799 bug.  If the utility is reading an object file or files, then it is
5800 generally most helpful to send the actual object files.
5802 If the source files were produced exclusively using @sc{gnu} programs
5803 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
5804 may be OK to send the source files rather than the object files.  In
5805 this case, be sure to say exactly what version of @command{gcc}, or
5806 whatever, was used to produce the object files.  Also say how
5807 @command{gcc}, or whatever, was configured.
5809 @item
5810 A description of what behavior you observe that you believe is
5811 incorrect.  For example, ``It gets a fatal signal.''
5813 Of course, if the bug is that the utility gets a fatal signal, then we
5814 will certainly notice it.  But if the bug is incorrect output, we might
5815 not notice unless it is glaringly wrong.  You might as well not give us
5816 a chance to make a mistake.
5818 Even if the problem you experience is a fatal signal, you should still
5819 say so explicitly.  Suppose something strange is going on, such as your
5820 copy of the utility is out of sync, or you have encountered a bug in
5821 the C library on your system.  (This has happened!)  Your copy might
5822 crash and ours would not.  If you told us to expect a crash, then when
5823 ours fails to crash, we would know that the bug was not happening for
5824 us.  If you had not told us to expect a crash, then we would not be able
5825 to draw any conclusion from our observations.
5827 @item
5828 If you wish to suggest changes to the source, send us context diffs, as
5829 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
5830 option.  Always send diffs from the old file to the new file.  If you
5831 wish to discuss something in the @command{ld} source, refer to it by
5832 context, not by line number.
5834 The line numbers in our development sources will not match those in your
5835 sources.  Your line numbers would convey no useful information to us.
5836 @end itemize
5838 Here are some things that are not necessary:
5840 @itemize @bullet
5841 @item
5842 A description of the envelope of the bug.
5844 Often people who encounter a bug spend a lot of time investigating
5845 which changes to the input file will make the bug go away and which
5846 changes will not affect it.
5848 This is often time consuming and not very useful, because the way we
5849 will find the bug is by running a single example under the debugger
5850 with breakpoints, not by pure deduction from a series of examples.
5851 We recommend that you save your time for something else.
5853 Of course, if you can find a simpler example to report @emph{instead}
5854 of the original one, that is a convenience for us.  Errors in the
5855 output will be easier to spot, running under the debugger will take
5856 less time, and so on.
5858 However, simplification is not vital; if you do not want to do this,
5859 report the bug anyway and send us the entire test case you used.
5861 @item
5862 A patch for the bug.
5864 A patch for the bug does help us if it is a good one.  But do not omit
5865 the necessary information, such as the test case, on the assumption that
5866 a patch is all we need.  We might see problems with your patch and decide
5867 to fix the problem another way, or we might not understand it at all.
5869 Sometimes with programs as complicated as the binary utilities it is
5870 very hard to construct an example that will make the program follow a
5871 certain path through the code.  If you do not send us the example, we
5872 will not be able to construct one, so we will not be able to verify that
5873 the bug is fixed.
5875 And if we cannot understand what bug you are trying to fix, or why your
5876 patch should be an improvement, we will not install it.  A test case will
5877 help us to understand.
5879 @item
5880 A guess about what the bug is or what it depends on.
5882 Such guesses are usually wrong.  Even we cannot guess right about such
5883 things without first using the debugger to find the facts.
5884 @end itemize
5886 @node GNU Free Documentation License
5887 @appendix GNU Free Documentation License
5889 @include fdl.texi
5891 @node Binutils Index
5892 @unnumbered Binutils Index
5894 @printindex cp
5896 @bye